use-popper
Advanced tools
Comparing version
@@ -7,3 +7,3 @@ 'use strict'; | ||
var Popper = _interopDefault(require('popper.js')); | ||
var PopperJS = _interopDefault(require('popper.js')); | ||
var React = _interopDefault(require('react')); | ||
@@ -160,3 +160,3 @@ var useDeepCompare = require('use-deep-compare'); | ||
popperInstance.current = new Popper(referrenceNode, popperNode, { | ||
popperInstance.current = new PopperJS(referrenceNode, popperNode, { | ||
placement, | ||
@@ -163,0 +163,0 @@ positionFixed, |
@@ -1,2 +0,2 @@ | ||
import Popper from 'popper.js'; | ||
import PopperJS from 'popper.js'; | ||
import React from 'react'; // @ts-ignore | ||
@@ -25,3 +25,3 @@ | ||
popperInstance.current = new Popper(referrenceNode, popperNode, { | ||
popperInstance.current = new PopperJS(referrenceNode, popperNode, { | ||
placement, | ||
@@ -28,0 +28,0 @@ positionFixed, |
@@ -1,20 +0,20 @@ | ||
import Popper from 'popper.js'; | ||
import PopperJS from 'popper.js'; | ||
import React from 'react'; | ||
interface Options { | ||
placement?: Popper.Placement; | ||
export interface Popper { | ||
placement?: PopperJS.Placement; | ||
positionFixed?: boolean; | ||
eventsEnabled?: boolean; | ||
modifiers?: Popper.Modifiers; | ||
modifiers?: PopperJS.Modifiers; | ||
} | ||
declare function usePopper({ placement, positionFixed, eventsEnabled, modifiers, }: Options): { | ||
declare function usePopper<R = HTMLElement, P = HTMLElement, A = HTMLElement>({ placement, positionFixed, eventsEnabled, modifiers, }: Popper): { | ||
referrence: { | ||
ref: React.Dispatch<React.SetStateAction<Element | null>>; | ||
ref: React.RefObject<R>; | ||
}; | ||
popper: { | ||
ref: React.Dispatch<React.SetStateAction<Element | null>>; | ||
ref: React.RefObject<P>; | ||
styles: React.CSSProperties; | ||
placement: Popper.Placement; | ||
placement: PopperJS.Placement; | ||
}; | ||
arrow: { | ||
ref: React.Dispatch<React.SetStateAction<Element | null>>; | ||
ref: React.RefObject<A>; | ||
styles: React.CSSProperties; | ||
@@ -21,0 +21,0 @@ }; |
@@ -1,2 +0,2 @@ | ||
import Popper from 'popper.js'; | ||
import PopperJS from 'popper.js'; | ||
import React from 'react'; | ||
@@ -156,3 +156,3 @@ import { useDeepCompareEffect } from 'use-deep-compare'; | ||
popperInstance.current = new Popper(referrenceNode, popperNode, { | ||
popperInstance.current = new PopperJS(referrenceNode, popperNode, { | ||
placement, | ||
@@ -159,0 +159,0 @@ positionFixed, |
{ | ||
"name": "use-popper", | ||
"description": "  ", | ||
"version": "1.1.1", | ||
"version": "1.1.2", | ||
"license": "MIT", | ||
@@ -6,0 +6,0 @@ "esnext": "dist-src/index.js", |
@@ -7,2 +7,18 @@ # Use Popper | ||
## Installation | ||
> Note: React 16.8+ is required for Hooks. | ||
### With npm | ||
```sh | ||
npm i use-popper | ||
``` | ||
### Or with yarn | ||
```sh | ||
yarn add use-popper | ||
``` | ||
[](https://codesandbox.io/s/ww293zr265?fontsize=14) | ||
@@ -9,0 +25,0 @@ |
17783
0.71%55
41.03%