Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Lack of documentation on Modal section #30

Open
bitfede opened this issue Nov 26, 2019 · 1 comment
Open

Lack of documentation on Modal section #30

bitfede opened this issue Nov 26, 2019 · 1 comment

Comments

@bitfede
Copy link

bitfede commented Nov 26, 2019

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
Copy link

drwpow commented Jan 21, 2020

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?).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants