Choose a version:

Modal

Displays content in an overlay. Use to create a distraction-free experience such as a confirmation dialog or a settings panel.

Anchor to propertiesProperties

Anchor to accessibilityLabel accessibilityLabel string: A label that describes the purpose of the modal. When set, it will be announced to users using assistive technologies and will provide them with more context.

This overrides the heading prop for screen readers.
Anchor to heading heading string: A title that describes the content of the Modal.
Anchor to id id string: A unique identifier for the element.
Anchor to padding padding 'base' | 'none' Default: 'base': Adjust the padding around the Modal content.

base: applies padding that is appropriate for the element.

none: removes all padding from the element. This can be useful when elements inside the Modal need to span to the edge of the Modal. For example, a full-width image. In this case, rely on Box with a padding of 'base' to bring back the desired padding for the rest of the content.
Anchor to size size 'small' | 'large' | 'base' | 'small-100' | 'large-100' | 'max' Default: 'base': Adjust the size of the Modal.

max: expands the Modal to its maximum size as defined by the host application, on both the horizontal and vertical axes.

Was this section helpful?

Anchor to eventsEvents

Learn more about registering events.

Anchor to afterhide afterhide <typeof tagName>: Callback fired when the overlay is hidden after any animations to hide the overlay have finished.
Anchor to aftershow aftershow <typeof tagName>: Callback fired when the overlay is shown after any animations to show the overlay have finished.
Anchor to hide hide <typeof tagName>: Callback fired after the overlay is hidden.
Anchor to show show <typeof tagName>: Callback fired after the overlay is shown.

Was this section helpful?

Anchor to slotsSlots

Learn more about component slots.

Anchor to primary-action primary-action HTMLElement: The primary action to perform, provided as a button type element.
Anchor to secondary-actions secondary-actions HTMLElement: The secondary actions to perform, provided as button type elements.

Was this section helpful?

Anchor to methodsMethods

Learn more about component methods.

Anchor to hideOverlay hideOverlay () => void required: Method to hide an overlay.

Was this section helpful?

Code

<s-button command="--show" commandfor="modal-1">Add Product</s-button>

<s-modal id="modal-1" heading="Return Policy">

<s-paragraph>

We have a 30-day return policy, which means you have 30 days after receiving

your item to request a return.

</s-paragraph>

<s-paragraph>

To be eligible for a return, your item must be in the same condition that

you received it, unworn or unused, with tags, and in its original packaging.

You’ll also need the receipt or proof of purchase.

</s-paragraph>

<s-button

variant="primary"

command="--hide"

commandfor="modal-1"

slot="primary-action"

</s-button>

</s-modal>

Examples

Code

Default

<s-button command="--show" commandfor="modal-1">Add Product</s-button>
<s-modal id="modal-1" heading="Return Policy">
  <s-paragraph>
    We have a 30-day return policy, which means you have 30 days after receiving
    your item to request a return.
  </s-paragraph>
  <s-paragraph>
    To be eligible for a return, your item must be in the same condition that
    you received it, unworn or unused, with tags, and in its original packaging.
    You’ll also need the receipt or proof of purchase.
  </s-paragraph>
  <s-button
    variant="primary"
    command="--hide"
    commandfor="modal-1"
    slot="primary-action"
  >
    Close
  </s-button>
</s-modal>

Modal

Anchor to propertiesProperties

Anchor to eventsEvents

CallbackEventListener

CallbackEvent

Anchor to slotsSlots

Anchor to methodsMethods

Code

Examples

Code

Default

Preview