1.1.0 • Published 7 years ago

boundless-popover v1.1.0

Weekly downloads
35
License
MIT
Repository
github
Last release
7 years ago

THIS IS AN AUTOGENERATED FILE. EDIT INDEX.JS INSTEAD.

Popover

A non-blocking container positioned to a specific anchor element.

A popover is a type of Dialog that is meant to provide additional context to content (an "anchor") currently on-screen. Typically, a popover is spawned by interacting with the content it enriches and is dismissed by clicking or shifting focus to an alternate location.

Alignment options for the popover are designed to mirror compass directions:

       →       ←
      NNW  N  NNE
↓ WNW             ENE ↓
    W   ANCHOR    E
↑ WSW             ESE ↑
      SSW  S  SSE
       →       ←

The arrows indicate which way the popover will extend, e.g. → means the popover is aligned to the left edge and extends in that direction. Diagonal corners (NW, NE, SE, SW) are currently not supported.

<Popover
    anchor={document.querySelector('.some-anchor-element')}
    preset={Popover.preset.N}>
    My popover content!
</Popover>

Props

Note: only top-level props are in the README, for the full list check out the website.

Required Props

Optional Props