Skip to main content
Version: 57.2.0

Inner modal content

A Modal displays content that requires user interaction. Modals appear on a layer above the page and therefore block the content underneath, preventing users from interacting with anything else besides the Modal. Modal should be used to gather short bits of information from the user. Also known as dialog or prompt.

Package: @terreno/ui
Categories: Layout, Utility
Props interface: ModalProps
Story source: demo/stories/Innermodalcontent.stories.tsx

Live demo

Props

PropTypeRequiredDescription
onDismissreflectionYes
visiblebooleanYesIf true, the modal will be visible.
childrenReactElementThe content of the modal.
persistOnBackgroundClickbooleanIf true, the modal will be closed when the background is clicked.
primaryButtonDisabledbooleanIf true, the primary button will be disabled.
primaryButtonOnClickreflectionThe function to call when the primary button is clicked.
primaryButtonTextstringThe text content of the primary button.
secondaryButtonOnClickreflectionThe function to call when the secondary button is clicked.
secondaryButtonTextstringThe text content of the secondary button.
sizeunionThe size of the modal.
subtitlestringThe subtitle of the modal.
testIDstringRoot test id for the primary interactive element or container.
testIDsModalTestIDs
textstringThe text content of the modal.
titlestringThe title of the modal.