@crave/farmblocks-popover

A customisable popover component

Stats

StarsIssuesVersionUpdatedCreatedSize
@crave/farmblocks-popover
20232.2.34a month ago3 years agoMinified + gzip package size for @crave/farmblocks-popover in KB

Readme

Farmblocks popover

A customisable popover component

2018-06-15 11 22 29

Installation

npm install @crave/farmblocks-popover

Usage

<Popover
  trigger={<button>Trigger</button>}
  content={dismiss => (
    <div>
      <Text>Popover content</Text>
      <button onClick={dismiss}>Dismiss</button>
    </div>
  )}
/>

API

Property Description Type Required Default
trigger A node that will be popover's trigger. Can also be a function that receives isVisible state and returns a node node or func => node Yes
content A render function with the contents to be displayed on the popover func => node Yes
tooltipProps Props to be passed to Tooltip component object
triggerWidth A CSS value for the trigger container width string auto
onOpen called when the popover opens func
onBeforeOpen called before the popover opens. If the given function returns a Promise, the popover will wait until it resolve to open func
onClose called when the popover closes func
disabled prevents the popover to open when the trigger is clicked. bool false

License

MIT

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.