Modal

The Modal API allows you to display an overlay that prevents interaction with the rest of the app until dismissed.

Anchor to modalModal

The modal API provides a show method to display a Modal, a hide method to hide a Modal, and a toggle method to toggle the visibility of a Modal. These are used in conjunction with the ui-modal element. They are alternatives to the show, hide, and toggle instance methods.

Anchor to hide hide (id: string) => Promise<void>: Hides the modal element. An alternative to the hide instance method on the ui-modal element.
Anchor to show show (id: string) => Promise<void>: Shows the modal element. An alternative to the show instance method on the ui-modal element.
Anchor to toggle toggle (id: string) => Promise<void>: Toggles the modal element visibility. An alternative to the toggle instance method on the ui-modal element.

_ModalApi

hide
Hides the modal element. An alternative to the `hide` instance method on the `ui-modal` element.
```
(id: string) => Promise<void>
```
show
Shows the modal element. An alternative to the `show` instance method on the `ui-modal` element.
```
(id: string) => Promise<void>
```
toggle
Toggles the modal element visibility. An alternative to the `toggle` instance method on the `ui-modal` element.
```
(id: string) => Promise<void>
```

interface _ModalApi {
  /**
   * Shows the modal element. An alternative to the `show` instance method on the `ui-modal` element.
   * @param id A unique identifier for the Modal
   */
  show?(id: string): Promise<void>;
  /**
   * Hides the modal element. An alternative to the `hide` instance method on the `ui-modal` element.
   * @param id A unique identifier for the Modal
   */
  hide?(id: string): Promise<void>;
  /**
   * Toggles the modal element visibility. An alternative to the `toggle` instance method on the `ui-modal` element.
   * @param id A unique identifier for the Modal
   */
  toggle?(id: string): Promise<void>;
}

Was this section helpful?