DEV: Introduce block registration API and deprecate ember resolution #84
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
In the near future, runtime resolution of components via the ember resolver will no longer be possible. This commit introduces a dedicated list of Right Sidebar Blocks components, and allows other themes/plugins to register additional ones.
This also avoids the issue of normal component names clashing with rsb block names, so specific handling of cases like `custom-html-rsb` is no longer necessary.
Other themes/plugins can register new blocks via the new `right-sidebar-blocks` value transformer
```js
api.registerValueTransformer(
"right-sidebar-blocks",
({ value: blocks }) => blocks.set("my-amazing-block", MyAmazingBlock)
);
```
For now, resolution of components via the Ember resolver is still supported, but will print a deprecation message to the console with upgrade instructions.
davidtaylorhq
force-pushed
the
registration-api
branch
from
5b44535 to
b71a64b
Compare
|
@davidtaylorhq wouldn't it make sense to make this more generic in naming? e.g. "sidebar-blocks" or "widget-blocks" or some such? The assumption of location might not be the best long term? |
|
@merefield yeah that's fair, although I do want to make it very clear that this API is purely for this theme component. So if we just go for |
|
@davidtaylorhq ok I think I'll leave you to make your local decisions here and we can discuss the broader challenge on meta. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In the near future, runtime resolution of components via the ember resolver will no longer be possible. This commit introduces a dedicated list of Right Sidebar Blocks components, and allows other themes/plugins to register additional ones.
This also avoids the issue of normal component names clashing with rsb block names, so specific handling of cases like
custom-html-rsbis no longer necessary.Other themes/plugins can register new blocks via the new
right-sidebar-blocksvalue transformerFor now, resolution of components via the Ember resolver is still supported, but will print a deprecation message to the console with upgrade instructions.