PopupSource

Positions a popup with respect to a source element
Below left Below stretch Below right
Above left Above stretch Above right
Demo: A PopupButton positions its popup in relation to the source button

Overview

Positions a Popup with respect to a source element, usually some form of button.

A PopupSource can be used as a starting point for various elements that invoke popups, such as a MenuButton or DropdownList.

Demo: A DropdownList is a specialized form of PopupSource

The element that invokes the popup is often a button, as with DropdownList above, but the source can also be a more complex. In a ListComboBox like AutoCompleteComboBox, the popup source includes both a text input area and a button:

Pet:
Canary
Cat
Chicken
Chinchilla
Cockatiel
Cricket
Dog
Ferret
Finch
Fish
Frog
Gerbil
Guinea Pig
Hamster
Hermit Crab
Lizard
Mouse
Parakeet
Parrot
Pig
Rabbit
Rat
Snail
Snake
Spider
Turtle
Demo: AutoCompleteComboBox is a PopupSource whose source includes a text input and a button

The popup can also be another type of element. In a DateComboBox, the popup is a CalendarMonthNavigator:

Demo: DateComboBox is a PopupSource with a calendar popup

Opening and closing the popup

By default, a PopupSource allows the user to open the associated popup by tapping it, clicking on it with the primary mouse button, or pressing Space.

By default, the popup will be an instance of Popup, which can be closed by tapping/clicking on the page behind the popup or by pressing Esc.

See also

ComboBox
A text input paired with a popup that can be used as an alternative to typing
DateComboBox
Combo box that lets the user type a date or pick one from a popup calendar
DropdownList
Shows a single choice made from a pop-up list of choices
ListComboBox
A combo box whose popup presents a list of choices
MenuButton
A button that invokes a menu
Popup
Lightweight form of modeless overlay that can be easily dismissed

API

Ancestry: PopupSource → ReactiveElement → HTMLElement

Built with mixins AriaRoleMixin, AttributeMarshallingMixin, DisabledMixin, FocusVisibleMixin, KeyboardMixin, OpenCloseMixin, ReactiveMixin, and ShadowTemplateMixin.

By default, this uses these elements in the following roles:

Extended by classes AutoCompleteComboBox, ComboBox, DateComboBox, DropdownList, FilterComboBox, ListComboBox, MenuButton, and PopupButton.

$ 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.$.foo to obtain the corresponding button in the component instance's shadow tree. The $ function is simply a shorthand for getElementById, so this.$.foo is the same as this.shadowRoot.getElementById('foo').

Type: object

Defined by ShadowTemplateMixin

backdropRole property

The class, tag, or template used for the optional backdrop element 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

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

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

disabled property

True if the component is disabled, false (the default) if not.

The value of this property will be reflected to the disabled attribute so that it can be referenced in CSS. Note that this non-native implementation of the disabled attribute will not trigger the :disabled CSS pseudo-class, so your style rules will have to reference the presence or absence of the disabled attribute. That is, instead of writing

my-component:disabled { ... }

write this instead

my-component[disabled] { ... }

Like the native disabled attribute, this attribute is boolean. That means that it's existence in markup sets the attribute, even if set to an empty string or a string like "false".

Type: boolean

Default: false

Defined by DisabledMixin

frameRole property

The class, tag, or template used to contain the popup content.

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

Type: (component class constructor)|HTMLTemplateElement|string

Default: OverlayFrame

horizontalAlign property

The alignment of the popup with respect to the source button.

  • start: popup and source are aligned on the leading edge according to the text direction
  • end: popup and source are aligned on the trailing edge according to the text direction
  • left: popup and source are left-aligned
  • right: popup and source are right-aligned
  • `stretch: both left and right edges are aligned

Type: 'start'|'end'|'left'|'right'|'stretch'

Default: 'start'

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

popupPosition property

The preferred direction for the popup.

  • above: popup should appear above the source
  • below: popup should appear below the source

Type: 'above'|'below'

Default: 'below'

popupRole property

The class, tag, or template used to define the popup.

The popup element is responsible for handling overlay behavior.

Type: (component class constructor)|HTMLTemplateElement|string

Default: Popup

render() method

Render pending component changes to the DOM.

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

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

Defined by ReactiveMixin

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

sourceRole property

The class, tag, or template used for the button (or other element) that will invoke the popup.

Type: (component class constructor)|HTMLTemplateElement|string

Default: 'button'

state property

The component's current state. The returned state object is immutable. To update it, invoke setState.

Type: State

Defined by ReactiveMixin

suppressFocusVisibility() method

Temporarily suppress visibility of the keyboard focus until the next keydown event.

This can be useful in components like Menu that actively manage where the focus is in response to mouse hover activity. If the user uses the keyboard to invoke a menu, then changes to using the mouse, it can be distracting to see the focus indicator moving as well. In such situations, the component can invoke this method (e.g., in response to mousemove) to temporarily suppress focus visibility.

Defined by FocusVisibleMixin

[symbols.keydown]() method

See the symbols documentation for details.

Defined by KeyboardMixin

[symbols.render](changed) method

Internal method for rendering any recent 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

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