shadow
The wje-popup page was auto-generated to keep API documentation coverage in sync with the current component set.
Detailed usage and best-practice guidance will be expanded in the next content phase.
Use wje-popup to communicate status, result of actions, or required next steps immediately.
Do not show multiple feedback channels for the same event unless there is a strong reason.
Announce status updates with suitable ARIA live regions and manage focus for modal interactions.
- Match message severity (info/success/warning/error) to actual user impact.
- Use confirmations only for destructive or hard-to-reverse actions.
- Keep timeouts consistent so users have enough time to read messages.
| Description | Controls whether loader is enabled and affects component behavior. |
| Attribute | loader |
| Type | boolean |
| Default | false |
| Description | Controls whether manual is enabled and affects component behavior. |
| Attribute | manual |
| Type | boolean |
| Default | false |
| Description | Sets or removes the 'portal' attribute on the element based on the provided value. If the value is truthy, the 'portal' attribute will be added. If the value is falsy, the 'portal' attribute will be removed. |
| Attribute | portal |
| Type | boolean |
| Default | false |
| Name | Description |
|---|
wje-portal:restored | Emitted when the wje-portal:restored event is dispatched. |
wje-popup:reposition | Event fired when the popup is repositioned. |
wje-popup:show | Event fired when the popup is shown. |
wje-popup:hide | Event fired when the popup is hidden. |
wje-popup:beforeshow | Emitted when the wje-popup:beforeshow event is dispatched. |
wje-popup:aftershow | Emitted when the wje-popup:aftershow event is dispatched. |
wje-router:rebind | Emitted when the wje-router:rebind event is dispatched. |
wje-popup:opened | Emitted when the component opens. |
| Description | Sets the anchor for the popup. Adds a click event listener to the anchor element. |
| Signature | () => void |
| Description | Displays the popup by portaling the content, managing the loader state, and attaching event handlers. Optionally dispatches a custom event when the popup is shown. |
| Signature | (dispatchEvent?: boolean) => void |
| Description | Hides the popup. Removes the popup-active class from the floating element. Cleans up the auto update for repositioning. |
| Signature | (dispatchEvent: any) => void |
| Name | Description |
|---|
native | The native part of the popup. |
No CSS custom properties available for this component.
| Name | Description |
|---|
anchor | The slot for the anchor of the popup. |
arrow | The slot for the arrow of the popup. |
default | The default slot for the popup. |