@wix/design-system
Version:
@wix/design-system
69 lines (66 loc) • 2.12 kB
Markdown
### dataHook
- type: string
- description: Applies a data-hook HTML attribute to be used in the tests
### buttonText
- type: string
- description: No description
### className
- type: string
- description: Specifies a CSS class name to be appended to the component’s root element.
- internal
### onCloseButtonClick
- type: () => void
- description: Defines a callback function which is called every time a close button is clicked.
- deprecated
### onHelpButtonClick
- type: () => void
- description: Defines a callback function which is called every time a help button is clicked.
- deprecated
### children
- type: ReactNode
- description: Accepts any item as a child element. For standard panel layout pass compound elements of the panel:
* `<SidePanel.Header/>`
* `<SidePanel.Content/>`
* `<SidePanel.Footer/>`
* `<SidePanel.Divider/>`
### width
- type: string | number
- description: Controls the width of the panel
- default: '420px'
### height
- type: string | number
- description: Controls the height of the panel
- default: '100%'
### maxHeight
- type: string | number
- description: Controls the maximum height of the panel
### skin
- type: "standard" | "floating"
- description: Specifies the skin of the side panel.
### draggable
- type: boolean
- description: Specifies if panel is draggable (works only with floating skin).
### onBackButtonClick
- type: () => void
- description: Defines a callback function which is called every time a back button is clicked.
- deprecated
### backButtonDescription
- type: ReactNode
- description: When provided, sets the content of the back button's tooltip.
- deprecated
### backButtonTooltipProps
- type: TooltipCommonProps
- description: Allows to pass all common tooltip props to back button’s tooltip.
- deprecated
### backButtonProps
- type: SidePanelBackButtonProps
- description: Back button props.
### helpButtonProps
- type: SidePanelButtonProps
- description: Help button props.
### closeButtonProps
- type: SidePanelCloseButtonProps
- description: Close button props.
### hideOverflow
- type: boolean
- description: Hides all overflow of side panel