Popup

Lightweight form of modeless overlay that can be easily dismissed
Here's a popup.
Demo: Clicking the button opens a simple popup

Overview

A lightweight form of modeless Overlay that, when opened, displays its assigned children on top of other page elements.

Usage

You can use Popup for overlays that float over other content and are easily dismissed. Popup incorporates PopupModalityMixin, and so will be dismissed if the user:

  • Clicks outside the popup.
  • Presses the Esc key.
  • Moves the focus outside the popup.
  • Scrolls the document.
  • Resizes the document.
  • Switches focus away from the document.

If your popup needs are simple, you might use Popup on its own. For more complex situations, it may be easier to apply PopupModalityMixin to your own component.

If you would like a button (or other element) to invoke a popup adjacent to the button, see PopupSource and its variants MenuButton and DropdownList.

New Tab New Window History Downloads Bookmarks Zoom Settings

Demo: A MenuButton uses PopupSource to attach a Menu to a button

See also

For modal overlays, see Dialog or its constituents DialogModalityMixin and ModalBackdrop. For a plain overlay base class that provides no built-in modal or modeless user interface, see Overlay.

See also Toast, a special type of popup that appears at the edge of the window.

Dialog
Basic modal overlay that the user typically dismisses with an explicit action
Overlay
An element that appears over other page elements
Toast
Lightweight popup intended to display a short, non-critical message

API

Ancestry: Popup → OverlayReactiveElement → HTMLElement

Built with mixins AttributeMarshallingMixin, KeyboardMixin, OpenCloseMixin, OverlayMixin, PopupModalityMixin, ReactiveMixin, ShadowTemplateMixin, and SlotContentMixin.

The element defines the following shadow parts:

  • backdrop: the backdrop behind the overlay, default type is ModalBackdrop
  • frame: the frame around the overlay, default type is OverlayFrame

Extended by class Toast.

This element is used as a shadow part in AutoCompleteComboBox, ComboBox, DateComboBox, DropdownList, FilterComboBox, ListComboBox, MenuButton, PopupButton, and PopupSource.

backdropPartType property

The class, tag, or template used for the backdrop part - the optional element shown behind the overlay.

This can help focus the user's attention on the overlay content. Additionally, a backdrop can be used to absorb clicks on background page elements. For example, Dialog uses ModalBackdrop as an overlay backdrop in such a way.

Type: (component class constructor)|HTMLTemplateElement|string

Default: Backdrop

Defined by Overlay

close(closeResult) method

Close the component (if not already closed).

Some components like AlertDialog want to indicate why or how they were closed. To support such scenarios, you can supply a value to the optional closeResult parameter. This closeResult will be made available in the whenClosed promise and the state.closeResult member.

Parameters:

  • closeResult: objectan indication of how or why the element closed

Defined by OpenCloseMixin

closed property

True if the element is currently closed.

Type: boolean

Defined by OpenCloseMixin

closed event

Raised when the component closes.

Defined by OpenCloseMixin

closeFinished property

True if the element has completely closed.

For components not using asynchronous open/close effects, this property returns the same value as the closed property. For elements that have a true value of state.openCloseEffects (e.g., elements using TransitionEffectMixin), this property returns true only if state.effect is "close" and state.effectPhase is "after".

Type: boolean

Defined by OpenCloseMixin

closeOnWindowResize property

True if the popup should close if the user resizes the window.

Type: boolean

Default: true

Defined by PopupModalityMixin

framePartType property

The class, tag, or template used to create the frame part – the overlay's primary content.

The frame element can be used to provide a border around the overlay content, and to provide visual effects such as a drop-shadow to help distinguish overlay content from background page elements.

Type: (component class constructor)|HTMLTemplateElement|string

Default: OverlayFrame

Defined by Overlay

[internal.contentSlot] property

Defined by SlotContentMixin

[internal.defaultState] property

The default state for the component. This can be extended by mixins and classes to provide additional default state.

Type: State

Defined by ReactiveMixin

[internal.ids] property

A convenient shortcut for looking up an element by ID in the component's Shadow DOM subtree.

Example: if component's template contains a shadow element <button id="foo">, you can use the reference this[internal.ids].foo to obtain the corresponding button in the component instance's shadow tree. The ids property is simply a shorthand for getElementById, so this[internal.ids].foo is the same as this.shadowRoot.getElementById('foo').

Type: object

Defined by ShadowTemplateMixin

[internal.keydown]() method

See the symbols documentation for details.

Defined by KeyboardMixin

[internal.render](changed) method

Render the indicated changes in state to the DOM.

The default implementation of this method does nothing. Override this method in your component to update your component's host element and any shadow elements to reflect the component's new state. See the rendering example.

Be sure to call super in your method implementation so that your component's base classes and mixins have a chance to perform their own render work.

Parameters:

  • changed: objectdictionary of flags indicating which state members have changed since the last render

Defined by ReactiveMixin

[internal.renderChanges]() method

Render any pending component changes to the DOM.

This method does nothing if the state has not changed since the last render call.

ReactiveMixin will invoke this method following a setState call; you should not need to invoke this method yourself.

This method invokes all internal render methods, then invokes componentDidMount (for first render) or componentDidUpdate (for subsequent renders).

Defined by ReactiveMixin

[internal.setState](changes) method

Update the component's state by merging the specified changes on top of the existing state. If the component is connected to the document, and the new state has changed, this returns a promise to asynchronously render the component. Otherwise, this returns a resolved promise.

Parameters:

  • changes: objectthe changes to apply to the element's state

Returns: Promise - resolves when the new state has been rendered

Defined by ReactiveMixin

[internal.state] property

The component's current state.

The returned state object is immutable. To update it, invoke internal.setState.

It's extremely useful to be able to inspect component state while debugging. If you append ?elixdebug=true to a page's URL, then ReactiveMixin will conditionally expose a public state property that returns the component's state. You can then access the state in your browser's debug console.

Type: State

Defined by ReactiveMixin

open() method

Open the element (if not already opened).

Defined by OpenCloseMixin

opened property

True if the element is currently opened.

Type: boolean

Defined by OpenCloseMixin

opened event

Raised when the component opens.

Defined by OpenCloseMixin

opened-changed event

Raised when the opened/closed state of the component changes.

Defined by OpenCloseMixin

toggle(opened) method

Toggle the open/close state of the element.

Parameters:

  • opened: booleantrue if the element should be opened, false if closed.

Defined by OpenCloseMixin

whenClosed() method

This method can be used as an alternative to listening to the "opened-changed" event, particularly in situations where you want to only handle the next time the component is closed.

Returns: Promise A promise that resolves when the element has completely closed, including the completion of any asynchronous opening effect.

Defined by OpenCloseMixin