{"componentChunkName":"component---src-pages-api-modal-mdx","path":"/api/modal/","result":{"pageContext":{"frontmatter":{"pageTitle":"Modal API","title":"Modal","props":["ModalProps"]},"properties":[{"name":"ModalProps","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"tags":[{"tag":"children","text":"required\n"}]},"id":"ModalProps","tags":{"children":"required"},"properties":{"children":{"name":"children","required":true,"type":{"name":"ReactNode | undefined"},"description":"The content of the component","deprecated":false},"closeAriaLabel":{"name":"closeAriaLabel","required":false,"type":{"name":"string"},"description":"The text read by screen readers for the close button","defaultValue":"\"Close dialog\"","deprecated":false},"closeButtonSize":{"name":"closeButtonSize","required":false,"type":{"name":"function"},"description":"Style for the modal container","deprecated":false},"containerStyle":{"name":"containerStyle","required":false,"type":{"name":"CSSProperties"},"description":"Style for the modal container","deprecated":false},"header":{"name":"header","required":false,"type":{"name":"React.ReactNode"},"description":"The content of the modal header","deprecated":false},"headerLevel":{"name":"headerLevel","required":false,"type":{"name":"1 | 2 | 3 | 4 | 5 | 6"},"description":"Number to indicate which level heading will render (e.g. h1, h2 etc.)","defaultValue":"2","deprecated":false},"isBackgroundClickDisabled":{"name":"isBackgroundClickDisabled","required":false,"type":{"name":"boolean"},"description":"If true, clicking the backdrop will not dismiss the modal","defaultValue":"false","deprecated":false},"isCloseButtonHidden":{"name":"isCloseButtonHidden","required":false,"type":{"name":"boolean"},"description":"If true, the close button the the modal will be suppressed","defaultValue":"false","deprecated":false},"isEscKeyDownDisabled":{"name":"isEscKeyDownDisabled","required":false,"type":{"name":"boolean"},"description":"If true, pressing the Escape key will not dismiss the modal","deprecated":false},"isOpen":{"name":"isOpen","required":false,"type":{"name":"boolean"},"description":"If true, the modal will be visible","defaultValue":"false","deprecated":false},"onClose":{"name":"onClose","required":false,"type":{"name":"function"},"description":"Action that fires when the close button is clicked","deprecated":false},"onEscKeyDown":{"name":"onEscKeyDown","required":false,"type":{"name":"function"},"description":"Action that fires when the Escape key is pressed","deprecated":false},"size":{"name":"size","required":false,"type":{"name":"enum","options":["ModalSize.large","ModalSize.medium","ModalSize.small"]},"description":"The relative size of the modal","defaultValue":"ModalSize.medium","deprecated":false},"testId":{"name":"testId","required":false,"type":{"name":"string"},"description":"Test ID attached to an internal element as `data-testid` for consumer testing","deprecated":false},"unmountOnExit":{"name":"unmountOnExit","required":false,"type":{"name":"boolean"},"description":"If true, the modal will removed from the DOM when closed","defaultValue":"true","deprecated":false}}}]}},"staticQueryHashes":["3821761011"]}