search

DesignRevision / shards-react

⚛️A beautiful and modern React design system.
https://designrevision.com/downloads/shards-react/
MIT License
757 stars 97 forks source link

Lack of documentation on Modal section #30

Open bitfede opened 4 years ago

bitfede commented 4 years ago

Hello,

no specific technical issue here, but I am disappointed with this documentation page: https://designrevision.com/docs/shards-react/component/modal

I think there should be more complex examples and a better definition of the props. In the props section the allowed values should be clearly specified along with a relevant example.

Also for example, you mention in the ModalHeader that there is a closeAriaLabel prop, that is "The close button's aria label".. But where exactly is this close button? How do I make it appear? Is it something that needs to pop out by default or should be implemented by the developer? These are all questions that are not answered by the Modal documentation page, nor showcased with complex examples, you only show the simplest possible modal...

Maybe it's just me, but I thought it would make sense to raise an issue and share some feedback. Thanks for your time!

drwpow commented 4 years ago

Similarly: I don’t think the position prop does anything? I see that it adds a modal-${position} class to the element, but I don’t see any of those classes in the CSS delivered (only modal-centered?).