@wix/design-system
Version:
@wix/design-system
48 lines (45 loc) • 1.49 kB
Markdown
### dataHook
- type: string
- description: Applied as data-hook HTML attribute that can be used in the tests
### actions
- type: ReactNode
- description: component to be displayed in header strip to preform actions relevant to the displayed content
### title
- type: string
- description: title text to be displayed in the header strip
### children
- type: ReactNode
- description: modal content displayed mid-screen
### onClose
- type: () => void
- description: callback for when the modal is closed
### shouldCloseOnOverlayClick
- type: boolean
- description: boolean to determine whether closing the overlay on click
- default: true
### closeButtonTooltipText
- type: string
- description: Tooltip close button text
### closeButtonAriaLabel
- type: string
- description: ARIA label for close button
### prevButtonProps
- type: PrevButtonProps
- description: Previous button props
##### onClick signature:
function(childIndexDisplayed: number) => void
* `childIndexDisplayed`: the index of the child component displayed.
### nextButtonProps
- type: NextButtonProps
- description: Next button props
##### onClick signature:
function(childIndexDisplayed: number) => void
* `childIndexDisplayed`: the index of the child component displayed.
### skin
- type: "light" | "dark"
- description: Controls the skin of the component
- default: 'dark'
### startDisplayingAtChildIndex
- type: number
- description: Pass an index to start rendering from a specific child component.
- default: 0