@wix/design-system
Version:
@wix/design-system
57 lines (54 loc) • 2.22 kB
Markdown
### children
- type: ReactNode
- description: No description
### dataHook
- type: string
- description: Applied as data-hook HTML attribute that can be used in the tests
### width
- type: string | number
- description: Width HTML attribute of the content. If a number is passed then it defaults to px. e.g width={400} => width="400px"
- default: '444px'
### target
- type: ReactNode
- description: The target of the popover
### content
- type: ReactNode
- description: A `<FloatingHelper.Content>` component
### onClose
- type: () => void
- description: callback to call when the popover content is requested to be closed (Uncontrolled mode only). NOTE: this callback is called when the close timeout (if exists) starts In Controlled mode - called when the close button is clicked. In Uncontrolled mode - called when the popover is closed
### onOpen
- type: () => void
- description: Callback to call when the popover content is requested to be opened (Uncontrolled mode only)
### skin
- type: "light" | "dark"
- description: Skin : `dark` or `light`
### appearance
- type: "light" | "dark"
- description: use skin prop instead
- default: 'dark'
- deprecated
### initiallyOpened
- type: boolean
- description: Controls whether the popover's content is initially opened (In Uncontrolled mode only)
- default: true
### opened
- type: boolean
- description: Controls whether the popover's content is shown or not (aka Controlled mode).
When undefined, then the component is Uncontrolled. See open/close behaviour section in docs.
### zIndex
- type: number
- description: Floating helper z-index
### appendTo
- type: null | Element | "window" | "viewport" | "scrollParent" | "parent" | Predicate
- description: Enables calculations in relation to a dom element.
- default: 'window'
### placement
- type: "right" | "left" | "auto" | "auto-start" | "auto-end" | "top-start" | "top" | "top-end" | "right-start" | "right-end" | "bottom-end" | "bottom" | "bottom-start" | "left-end" | "left-start"
- description: The location to display the content.
### moveBy
- type: MoveByOffset
- description: Moves the floating helper relative to the parent by x or y
### hideDelay
- type: number
- description: Set a delay on closing