UNPKG

@wix/design-system

Version:

@wix/design-system

121 lines (118 loc) 4.9 kB
### title - type: ReactNode - description: Sets text title for the modal; can be used in conjunction with other components ### subtitle - type: ReactNode - description: Sets text subtitle for the modal; can be used in conjunction with other components ### content - type: ReactNode - description: Contains all modal's content in its middle area. `<CustomModalLayout/>` children are passed as `content`, too. ### primaryButtonText - type: ReactNode - description: Sets text label or other content (e.g., <Loader/>) for the primary button ### primaryButtonProps - type: Omit<ButtonProps, "internalDataHook"> - description: Passes on any `<Button/>` properties on the primary button ### primaryButtonOnClick - type: () => void - description: Defines a call-back function after user clicks on the primary button ### primaryButtonTooltipProps - type: TooltipCommonProps & { content: ReactNode; } - description: Passes on any `<Tooltip/>` properties on the primary button tooltip ### secondaryButtonText - type: ReactNode - description: Sets text label for the secondary button ### secondaryButtonProps - type: Omit<ButtonProps, "internalDataHook"> - description: Passes on any `<Button/>` properties on the secondary button ### secondaryButtonOnClick - type: () => void - description: Defines a call-back function after user clicks on the secondary button ### actionsSize - type: "tiny" | "small" | "medium" | "large" - description: Sets the size of action buttons ### sideActions - type: ReactNode - description: Contains a checkbox or other components at the start of the footer ### footnote - type: ReactNode - description: Renders supplementary text or other components at the bottom of the modal ### footnoteSkin - type: "light" | "neutral" - description: Sets the look and feel of the footnote ### width - type: string | number | string & {} - description: Fixes the width of component; if content area is wider than `width`, it scrolls horizontally ### maxWidth - type: string | number | string & {} - description: Sets the maximum width of component; if content area is longer than maxWidth, it scrolls horizontally ### height - type: string | number | string & {} - description: Fixes the height of component ### maxHeight - type: string | number | string & {} - description: Sets the maximum height of component; if content area is longer than maxHeight, it scrolls vertically ### removeContentPadding - type: boolean - description: Removes 30 px left and right padding from the content area ### showHeaderDivider - type: false | true | "auto" - description: Controls visibility of a header divider. When set to `auto`, it is shown only when scroll position is greater than 0. When set to `true`, it is always visible, and when set to `false`, it is always hidden. ### showFooterDivider - type: false | true | "auto" - description: Controls visibility of a footer divider. When set to `auto`, it is shown up until content is scrolled to the very bottom. When set to `true`, it is always visible, and when set to `false`, it is always hidden. ### overflowY - type: "none" | "-moz-initial" | "inherit" | "initial" | "revert" | "revert-layer" | "unset" | "hidden" | "auto" | "visible" | "scroll" | "clip" | "-moz-hidden-unscrollable" - description: Determines what happens when content overflows component vertically. Value 'none' will be removed in next major, use "visible" value instead. ### style - type: CSSProperties - description: Sets object of CSS styles ### theme - type: "standard" | "destructive" | "premium" - description: use skin prop instead - deprecated ### children - type: ReactNode - description: Accepts any item as a child element. For all common cases pass a standard text string. ### className - type: string - description: Specifies a CSS class name to be appended to the component’s root element. - internal ### dataHook - type: string - description: Applies a data-hook HTML attribute to be used in the tests. ### closeButtonProps - type: ModalCloseButtonProps - description: Close button props. ### helpButtonProps - type: ModalControlButtonProps - description: Help button props. ### onCloseButtonClick - type: MouseEventHandler - description: use `closeButtonProps` instead. - deprecated ### onHelpButtonClick - type: MouseEventHandler - description: use `helpButtonProps` instead. - deprecated ### illustrationClassName - type: string - description: No description ### illustration - type: ReactNode - description: No description ### skin - type: "standard" | "destructive" | "premium" - description: a global skin for the modal, will be applied as stylable state and will affect footer buttons skin. ### headerClassName - type: string - description: No description ### footnoteClassName - type: string - description: No description ### footerClassName - type: string - description: No description ### contentClassName - type: string - description: No description