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

Missing documentation for Overlay #18

Open
edemaine opened this issue Apr 25, 2022 · 0 comments
Open

Missing documentation for Overlay #18

edemaine opened this issue Apr 25, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@edemaine
Copy link
Collaborator

There aren't currently any examples of how to use the Overlay component, or a description of what it does, though its props are described in Tooltips and Popovers. By contrast, React Bootstrap has some examples.

I also think target is required and must be an accessor returning an element, contrary to the existing documentation of Overlay's props. Plausibly it should be allowed to be a direct element, not just an accessor. (This is possible with ref if the Overlay comes after the other element.)

@Brendan-csel Brendan-csel added the documentation Improvements or additions to documentation label Aug 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants