documentation icon indicating copy to clipboard operation
documentation copied to clipboard

[Request]: document how to pass config to custom plugins field component

Open macrozone opened this issue 2 years ago • 1 comments

Summary

Disclaimer: I am maintainer of https://react-page.github.io/

I want to add first class support for ReactPage to strapi, which is a rich layout content editor.

I successfully did a proof of concept locally, but there are a few things missing in the documentation.

Developers that will use ReactPage will bring their own components to add to the editor. Therefore a developer that will use my ReactPage strapi plugin wants to pass configuration to the plugin which in turn should get passed to my plugins Component (in app.addFields({ type: "json", Component: ReactPage });

Why is it needed?

For this to work ergonomically, anyone who uses my plugin will want to configure it and this configuration needs to be passed to the component.

Suggested solution(s)

No response

Related issue(s)/PR(s)

No response

macrozone avatar Mar 08 '22 14:03 macrozone

Hello @macrozone, Thanks for your request. Based on @derrickmehaffy response in the main repo, we will plan to document custom fields when the feature is ready. I will leave this issue open until the documentation is released.

stb13579 avatar Mar 16 '22 10:03 stb13579

Custom fields documentation is available in the beta documentation and will be released to the stable documentation this week. I will close this issue, but please open a new one if I have missed something.

stb13579 avatar Sep 26 '22 05:09 stb13579