Modal
A page overlay that displays information and blocks interaction with the page until an action is taken or the modal is dismissed.
Basic usage
First, import the component.
import {Modal} from '@pleo-io/telescope'
Then use it, like so.
API reference
Modal
Prop | Type | Default |
---|---|---|
allowPinchZoom | boolean | |
aria-label | string | |
aria-labelledby | string | |
dangerouslyBypassFocusLock | boolean | |
dangerouslyBypassScrollLock | boolean | |
dangerouslySetZIndexValue | number | |
initialFocusRef | React.RefObject<any> | |
isOpen | boolean | true |
onDismiss | function | |
size | string |
Information:
Supports styled-system's spacing utility.
Modal.Close
Prop | Type | Default |
---|---|---|
onClick * | function | |
skeleton | boolean | false |
Information:
Also accepts HTML Button props (except aria-label
as this is supplied by the component).
ModalTitle
This component doesn't accept any custom props.
Modal.Subtitle
This component doesn't accept any custom props.
Modal.Illustration
This component doesn't accept any custom props.
Modal.Content
This component doesn't accept any custom props.
Modal.Actions
This component doesn't accept any custom props.
Modal.Footer
This component doesn't accept any custom props.