Open Overlay
Minimize
⌘M
Zoom
Fill
Center
orb-menu.md - orb
<orb-button id="overlay-trigger">Open Overlay</orb-button>
<orb-overlay trigger="overlay-trigger">
<orb-menu>
<orb-mi>
<iconify-icon icon="mdi:minimize" slot="icon"></iconify-icon>
Minimize
<span slot="details">⌘M</span>
</orb-mi>
<orb-mi>
<iconify-icon icon="mdi:zoom-in" slot="icon"></iconify-icon>
Zoom
</orb-mi>
<orb-mi>
<iconify-icon icon="mdi:fullscreen" slot="icon"></iconify-icon>
Fill
</orb-mi>
<orb-mi>
<iconify-icon icon="mdi:image-filter-center-focus" slot="icon"></iconify-icon>
Center
</orb-mi>
<orb-divider></orb-divider>
<orb-mi>
orb-menu.md - orb
</orb-mi>
</orb-menu>
</orb-overlay>
| Description |
Optionally execute a promise after closing completes |
| Attribute |
– |
| Type |
() => void | Promise<void> |
| Default |
undefined |
| Description |
Optionally execute a promise before presentation begins |
| Attribute |
– |
| Type |
() => void | Promise<void> |
| Default |
undefined |
| Description |
Prevents the overlay from closing when clicking the backdrop or pressing the escape key. The overlay can still be closed via the hide() method or the open property. |
| Attribute |
manual-hide |
| Type |
boolean |
| Default |
false |
| Description |
Opens and closes modal |
| Attribute |
open |
| Type |
boolean |
| Default |
false |
| Description |
A promise that resolves when the component has completed it’s initial render |
| Attribute |
– |
| Type |
Promise<unknown> |
| Default |
new Promise((res) => (this.#resolve = res)) |
| Description |
Side of the screen where the overlay will be displayed |
| Attribute |
side |
| Type |
"bottom" | "left" | "right" |
| Default |
undefined |
| Description |
Size of the overlay |
| Attribute |
size |
| Type |
"lg" | "md" | "sm" |
| Default |
"md" |
| Description |
Id of the element that will trigger the overlay to open |
| Attribute |
trigger |
| Type |
string |
| Default |
undefined |
| Description |
Emits whenever the overlay has finished closing. Emits the role and optional data object passed to the hide() method. |
| Type |
CustomEvent<any> |
| Description |
Emits whenever the overlay is about to close. Emits the role and optional data object passed to the hide() method. If the event is canceled, the overlay will not close. |
| Type |
CustomEvent<any> |
| Description |
Emits whenever the overlay has opened. Does not emit any data |
| Type |
CustomEvent<any> |
| Signature |
hide(role?: string, data?: any) => Promise<void> |
| Parameters |
role (string)
data (any) |
| Signature |
show() => Promise<void> |
| Part |
Description |
"dialog" |
|
"inner-container" |
|
graph TD;
orb-calendar --> orb-overlay
orb-rich-text --> orb-overlay
style orb-overlay fill:#f9f,stroke:#333,stroke-width:4px