Research
Security News
Malicious npm Package Typosquats react-login-page to Deploy Keylogger
Socket researchers unpack a typosquatting package with malicious code that logs keystrokes and exfiltrates sensitive data to a remote server.
@chakra-ui/popper
Advanced tools
Readme
A React hooks wrapper for popper.js to dynamic positioning of containers around a reference.
This is an internal hook of Chakra-UI, and it's not covered by semver, and may cause unexpected or broken application behavior. Use them at your own risk.
yarn add @chakra-ui/popper
By default, the usePopper
hook returns props for the popper, reference and
arrow.
import { Box } from "@chakra-ui/layout"
import { Button } from "@chakra-ui/button"
import { useDisclosure } from "@chakra-ui/hooks"
import { usePopper } from "@chakra-ui/popper"
function Example() {
const { isOpen, onToggle } = useDisclosure()
const { popperRef, referenceRef, getArrowProps } = usePopper()
return (
<>
<Button ref={referenceRef} onClick={onToggle} mb={2}>
{isOpen ? "Click me to see less" : "Click me to see more"}
</Button>
{isOpen && (
<Box ref={popperRef} bg="red">
<div
{...getArrowProps({
style: {
background: "red",
},
})}
/>
This is a popover for the button!
</Box>
)}
</>
)
}
You can change the placement of the popper by passing the placement
option to
usePopper
and set it to the popper.js
placement.
const { popperRef, referenceRef } = usePopper({
placement: "right-start",
})
In some cases, you might want to allow the popper take the width of the reference. For example, autocomplete, select, etc.
To achieve this, pass the matchWidth
option and set it to true
const { popperRef, referenceRef } = usePopper({
matchWidth: true,
})
You can place the popper next to the reference without margin or distance between them. Useful to create an autocomplete or typeahead feature.
const { popperRef, referenceRef } = usePopper({
gutter: 0,
})
If the reference element is inside a fixed container, you should use the fixed
strategy.
const { popperRef, referenceRef } = usePopper({
strategy: "fixed",
})
When add transitions to a popper component, it is usually advised to apply popper and transition to different elements.
// 1. Import components
import { useDisclosure } from "@chakra-ui/hooks"
import { usePopper } from "@chakra-ui/popper"
import { motion, AnimatePresence, Variants } from "framer-motion"
export function Example() {
// 2. Create toggle state
const { isOpen, onToggle } = useDisclosure()
// 3. Create motion variants
const slide: Variants = {
exit: {
y: -2,
opacity: 0,
},
enter: {
y: 0,
opacity: 1,
},
}
// 4. Consume the `usePopper` hook
const { getPopperProps, getReferenceProps, getArrowProps, transformOrigin } =
usePopper({
placement: "bottom-start",
})
return (
<>
<button {...getReferenceProps({ onClick: onToggle })}>Toggle</button>
<div {...getPopperProps()}>
<AnimatePresence>
{isOpen && (
<motion.div
transition={{
type: "spring",
duration: 0.2,
}}
variants={slide}
initial="exit"
animate="enter"
exit="exit"
style={{
background: "red",
width: 200,
transformOrigin,
borderRadius: 4,
}}
>
Testing
<div
{...getArrowProps({
style: {
background: "red",
},
})}
/>
</motion.div>
)}
</AnimatePresence>
</div>
</>
)
}
When not rendering the popper conditionally, we recommend using
visibility: hidden
instead ofhidden
ordisplay: none
FAQs
Unknown package
The npm package @chakra-ui/popper receives a total of 331,783 weekly downloads. As such, @chakra-ui/popper popularity was classified as popular.
We found that @chakra-ui/popper demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket researchers unpack a typosquatting package with malicious code that logs keystrokes and exfiltrates sensitive data to a remote server.
Security News
The JavaScript community has launched the e18e initiative to improve ecosystem performance by cleaning up dependency trees, speeding up critical parts of the ecosystem, and documenting lighter alternatives to established tools.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.