Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(widgetsFor): return widgets for variable type lists #7296

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

domcleal
Copy link
Contributor

@domcleal domcleal commented Oct 1, 2024

Summary

When using a Variable Type list widget and a custom preview component, the widgetsFor helper would only return a data list with each of the items in the list, not a widgets list, e.g.

{"data" =>
    {"markdown" => "# Title"}
    {"type" => "block_body"}
}
{"widgets" => undefined} 🚫

The widgets list should also be supplied, particularly for nested Markdown widgets, so a fully formatted preview can be rendered:

{"data" =>
    {"markdown" => "# Title"}
    {"type" => "block_body"}
}
{"widgets" =>
    {"markdown" => Object} ✅
}

This extends support in widgetsFor to detect variable type list widgets and correctly construct the widgets return value.

Fixes #2307 (specifically #2307 (comment) which explains it neatly).

Test plan

Using the test backend, add the following custom preview helper:

var KitchenSinkPreview = createClass({
  render: function() {
    return h('div', {},
      h('h1', {}, 'Typed list'),
      this.props.widgetsFor('typed_list').map(function(item, index) {
        return h('div', {key: index},
          h('hr', {}),
          h('strong', {}, item.getIn(['data', 'string']) || "Untitled"),

          h('dl', {},
            h('dt', {}, 'Data'),
            h('dd', {}, item.getIn(['data', 'markdown'])),

            h('dt', {}, 'Widgets'),
            h('dd', {}, item.getIn(['widgets', 'markdown'])),
          ),
        );
      })
    );
  }
});

CMS.registerPreviewTemplate("kitchenSink", KitchenSinkPreview);   

Before:

image

Only the data value is populated, so only the raw Markdown is available. The widgets return value is empty.

After:

image

In the preview pane, the Markdown widget is now able to be used to render the field.

Checklist

Please add a x inside each checkbox:

When using a Variable Type list widget and a custom preview component,
the `widgetsFor` helper would only return a `data` list with each of the
items in the list, not a `widgets` list, e.g.

    {"data" =>
        {"markdown" => "# Title"}
        {"type" => "block_body"}
    }
    {"widgets" => undefined} 🚫

The `widgets` list should also be supplied, particularly for nested
Markdown widgets, so a fully formatted preview can be rendered:

    {"data" =>
        {"markdown" => "# Title"}
        {"type" => "block_body"}
    }
    {"widgets" =>
        {"markdown" => Object} ✅
    }

This extends support in `widgetsFor` to detect variable type list
widgets and correctly construct the `widgets` return value.

As reported at decaporg#2307 (comment)
@domcleal domcleal marked this pull request as ready for review October 1, 2024 10:54
@domcleal domcleal requested a review from a team as a code owner October 1, 2024 10:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Preview Pane Support for List Widget: Variable Types
1 participant