Earth Design System

API reference docs for theGetProModalwidget. For examples and details on the usage of this widget, visit the widget demo page.

Props

Props	Type	Description	Default
`open`	`boolean`	Controls the visibility of the modal. When `true`, the modal is rendered in the DOM	_
`onClose`	`function`	Callback triggered when the modal is closed. Called after upgrade, cancel, or close actions.	_
`title`	`string`	The title displayed in the modal header.	_
`coverImage`	`ReactNode`	The Image EDS component displayed at the top of the modal	_
`itemList`	`{ title: string; description: string }[]`	List of Pro plan benefits shown in the modal body.	_
`additionalContent?`	`ReactNode`	Extra custom content (e.g., info box, disclaimers) rendered below the benefits list.
`upgradeButtonProps`	`{label: string; onClick: () => void }`	Configuration for the upgrade button in the footer (label + handler).
`cancelButtonProps?`	`{label: string; onClick?: () => void }`	Configuration for the cancel button in the footer (label + optional handler).
`closeButtonProps?`	`{label: string; onClick?: () => void }`	Customisation for the close button in the header (aria label + optional handler).