Skip to content

Commit

Permalink
docs(Popover): add basic documentation (#8773)
Browse files Browse the repository at this point in the history
* docs(Popover): add basic documentation

* docs(Popover): rename file

Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
  • Loading branch information
dakahn and kodiakhq[bot] authored May 28, 2021
1 parent 2c739cb commit 41567a1
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions packages/react/src/components/Popover/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Popover

A popover is a piece of UI that _pops over_ or renders on top of other UI on the
page. It's a component "primitive" meaning it can be used to help make more
complex components that utilize this behavior.

## Popover Behaviors

- popovers are invoked/shown by interacting with some other UI element either
through click, hover, key press, or focus
- popovers can be dismissed either through blur, <kbd>esc</kbd> keypress, or by
having a different popover be triggered and shown
- popovers are displayed on top of other UI and out of the normal page flow
typically anchored to a triggering element

## Further Reading

- [Open UI Popup documentation](https://open-ui.org/components/popup.research)

0 comments on commit 41567a1

Please sign in to comment.