Lion Fundamentals Guides Components Blog

Toggle darkmode

Dialog: API Table

class: `LionDialog`, `lion-dialog`

Fields

Name	Privacy	Type	Default	Description	Inherited From
`config`	public	`Partial<OverlayConfig>`	`{}`	Configure the many options of the `OverlayController`	OverlayMixin
`_overlayInvokerNode`	protected				OverlayMixin
`_overlayReferenceNode`	protected				OverlayMixin
`_overlayBackdropNode`	protected				OverlayMixin
`_overlayContentNode`	protected				OverlayMixin
`_overlayContentWrapperNode`	protected				OverlayMixin
`opened`	public	`boolean`	`false`	If you add the opened attribute a dialog will be opened on page load. The invoker can be left out in case the user does not need to be able to reopen the dialog.	OverlayMixin

Methods

Name	Privacy	Description	Parameters	Return	Inherited From
`_defineOverlayConfig`	protected			`OverlayConfig`	OverlayMixin
`_defineOverlay`	protected		`{ contentNode, invokerNode, referenceNode, backdropNode, contentWrapperNode }, config: DefineOverlayConfig`	`OverlayController`	OverlayMixin
`_setupOpenCloseListeners`	protected				OverlayMixin
`_teardownOpenCloseListeners`	protected				OverlayMixin
`_setupOverlayCtrl`	protected				OverlayMixin
`_teardownOverlayCtrl`	protected				OverlayMixin
`_setOpenedWithoutPropertyEffects`	protected	When the opened state is changed by an Application Developer,cthe OverlayController is requested to show/hide. It might happen that this request is not honoured (intercepted in before-hide for instance), so that we need to sync the controller state to this webcomponent again, preventing eternal loops.	`newOpened: boolean`		OverlayMixin
`toggle`	public	Toggles the overlay			OverlayMixin
`open`	public	Shows the overlay			OverlayMixin
`close`	public	Hides the overlay			OverlayMixin
`repositionOverlay`	public	Sometimes it's needed to recompute Popper position of an overlay, for instance when we have an opened combobox and the surrounding context changes (the space consumed by the textbox increases vertically)			OverlayMixin

Events

Name	Type	Description	Inherited From
`opened-changed`	`CustomEvent`		OverlayMixin

Attributes

Name	Field	Inherited From
`opened`	opened	OverlayMixin

Caught a mistake or want to contribute to the documentation? Edit this page on GitHub!