feat: add ContentSlot component #1014
Conversation
packages/react-board/README.md
Outdated
| @@ -33,6 +33,27 @@ createBoard({ | |||
| }); | |||
| ``` | |||
|
|
|||
| You can also create boards with separation between the actual content and the board environment. | |||
There was a problem hiding this comment.
This doesn't explain the motivation for <ContentSlot />. So for the time being, while this component has no practical use, I wouldn't even introduce it in the readme, and keep as undocumented feature.
Once Codux supports it, I would add the real explanation.
There was a problem hiding this comment.
the docs for the createBoard also don't really explain :)
the real docs should be in codux
so remove the entry from readme?
There was a problem hiding this comment.
so remove the entry from readme?
Yeah, or change the comment. Because someone who isn't aware of our future plans will not understand what's the point of creating "separation between the actual content and the board environment".
We could add something like:
When the board is converted to a code snippet, only the children of the
<ContentSlot>will be included into the snippet. This is useful when the board is wrapped in a router or a context provider that shouldn't be included in the snippet.
This doesn't explain the idea of converting the board to a code snippet, but whatever.
There was a problem hiding this comment.
added to the readme
when the feature is done we will have a whole lot of docs in the Codux docs
|
why do we need this? |
add a
ContentSlotcomponent which will be used in boards to wrap the actual content(s) of the board.usually a componnet