1.2.1 • Published 6 years ago
@fenderdigital/react-modal v1.2.1
Modal for Fender React UI Kit
Description
Modal functionality for showing and hiding content.
Installation and Usage
yarn add @fenderdigital/react-modal --saveimport Modal from '@fenderdigital/react-modal';Props
children- renders any child elements.contentStyles- configurable tachyon classes for the modal content.isVisible- controls thie expanded and collapsed state.onClose- close callback.styles- configurable tachyon classes for the modal.theme- dark / light theme.zIndex- option to specify a z-index value.backgroundClickable- adds a close click event listener to the background.
| propName | propType | defaultValue | isRequired | 
|---|---|---|---|
| children | node | null | - | 
| contentStyles | string | mw6 | - | 
| isVisible | boolean | false | - | 
| onClose | func | () => {} | - | 
| styles | string | pt6-ns ph0 ph3-ns | - | 
| theme | string | white | - | 
| zIndex | string | 9999 | - | 
| backgroundClickable | boolean | true | - | 
Development
Check the Monorepo README for development documentation.