Add documentation for Slot component

[michalczaplinski]

This is the documentation for the <Slot/> component.

Feature Discussion: https://community.frontity.org/t/slot-and-fill/895
PR into frontity/frontity: frontity/frontity#475

This is not complete yet. We're missing:

• A general explanation of the Slot and Fill pattern (as already mentioned by @luisherranz Add docs for useFills hook #75 (comment))
• How to insert the Fills into the state:
  • explain namespaces
  • explain what the library property refers to
• More use cases:
  • How to pass props to Fills (e.g by setting state.fills.fillNamespace.fillName.props)
  • Using multiple Fills with different priority in the same slot

etc.

Admittedly, some of the above are more related to how to use the Slot and fill pattern in general.

Let me know if you guys would need more help with this 🙂

[michalczaplinski]

Assigned @mburridge cause you're the supporter this week 🙂

[luisherranz]

Hey Michal, I think you've mistakenly added this to @frontity/components instead of frontity.

Also, as this is not ready yet, I'm going to turn it into a draft 👍

[juanmaguitar]

Just to add more context about this

According to the latest Sprint (Sprint 4) status

• Create the Slot component [3pt]: This one is supposed to be finished. It's just pending the review. Once this is merged, the whole Slot and Fill feature will be finished.

This feature is finished but it's not released yet

The code PR is merged but the Feature Discussion is still as "Currently in Development" until the feature is released

[michalczaplinski]

Hey @mburridge let me know if you need help or more information to finish the documentation here 🙂

[mburridge]

@michalczaplinski A quick question:

Were data assertions implemented (as described at https://community.frontity.org/t/slot-and-fill/895/3)? Do they need documenting?

[michalczaplinski]

Should the useFills hook that is used behind the scenes here also be documented? If so should it be documented here along with the Slot and Fill documentation, or separately elsewhere?

yes, it should also be documented. Mind, that there already exists some basic documentation for it: https://docs.frontity.org/api-reference-1/frontity#usefills

I think the hook will be used less often than the Slot component, because I think that in most cases the <Slot/> component should be enough. We expose it so that the users can build their own, perhaps more sophisticated versions of <Slot/> for some use cases that we have not anticipated or some special use cases that don't want to cover out of the box.

I ll leave it up to you to decide where and how to document that 🙂

Were data assertions implemented (as described at https://community.frontity.org/t/slot-and-fill/895/3)? Do they need documenting?

Nope, they were not implemented yet so no docs needed 🙂 . I've updated the announcement on the forum to clarify that: https://community.frontity.org/t/slot-and-fill/895/19

[mburridge]

@michalczaplinski

I found the useFills docs so edited my question to remove that. Let me know if more content is needed there. I think you were probably answering just as I edited the question! 😄

I've opened a new PR for this now: #168