plone / volto

React-based frontend for the Plone Content Management System
https://demo.plone.org/
MIT License
443 stars 600 forks source link

Document SchemaWidget, provide examples #1783

Open tiberiuichim opened 4 years ago

tiberiuichim commented 4 years ago

There is a component in Volto with a large part dedicated to it, the SchemaWidget. It imposes the presence of onEdit and onDelete properties to all widgets, together with special drag handling, etc.

It's a big cost for a feature that's not really "public": SchemaWidget is not documented, there are no examples on how to use it.

It would be nice to "bring it into the light", to have it better documented so that anyone can take advantage of it.

stevepiercy commented 7 months ago

For this issue, see Documentation. It will need both narrative documentation and a Storybook entry. For narrative documentation, I would suggest using AppExtras component as a model. @tiberiuichim might have other ideas, and I would go with his recommendations.