@theoplayer/web-ui
    Preparing search index...

    Class Button

    A basic button.

    <theoplayer-button>

    disabled - Whether the button is disabled. When disabled, the button cannot be clicked.

    PropertyDescription

    --theoplayer-control-height

    The height of the button's control area (and default icon size). Defaults to 24px.

    --theoplayer-control-padding

    The padding around the button's content. Defaults to 10px.

    --theoplayer-control-background

    The background of the button. Defaults to transparent.

    --theoplayer-control-hover-background

    The background of the button when hovered. Defaults to --theoplayer-control-background.

    --theoplayer-text-color

    The text color of the button. Defaults to #fff.

    --theoplayer-text-font-size

    The font size of the button's text. Defaults to 14px.

    --theoplayer-text-content-height

    The line-height of the button's text. Defaults to --theoplayer-control-height.

    --theoplayer-icon-color

    The color of the button's icon. Defaults to #fff.

    --theoplayer-focus-ring-color

    The color of the focus ring around focused buttons. Defaults to rgba(27, 127, 204, 0.9).

    --theoplayer-button-text-color

    The text color of the button. Defaults to --theoplayer-text-color.

    --theoplayer-button-icon-width

    The width of the button's icon. Defaults to --theoplayer-control-height.

    --theoplayer-button-icon-height

    The height of the button's icon. Defaults to --theoplayer-control-height.

    --theoplayer-button-icon-transition

    The CSS transition applied to the button's icon. Defaults to none.

    --theoplayer-button-icon-shadow

    A drop-shadow applied to the icon. Defaults to none.

    --theoplayer-button-hover-icon-shadow

    A drop-shadow applied to the icon on hover. Defaults to 0 0 4px rgba(255, 255, 255, 0.5).

    --theoplayer-button-checked-background

    The background of a toggled-on button (e.g. mute, fullscreen). Defaults to #fff.

    --theoplayer-button-checked-color

    The color of a toggled-on button. Defaults to #000.

    --theoplayer-button-disabled-text-color

    The text color of a disabled button. Defaults to #ccc.

    --theoplayer-before-first-play-display

    The CSS display of the button before first play. The <theoplayer-ui> will set this to none to hide all buttons until playback begins, after which this becomes unset and the button reverts back to its initial CSS display.

    Hierarchy (View Summary)

    Index

    Other

    • Handle a button click.

      By default, this does nothing. Subclasses can override this method to add behavior to the button.

      Returns void

    lifecycle

    • Invoked when the component is added to the document's DOM.

      In connectedCallback() you should setup tasks that should only occur when the element is connected to the document. The most common of these is adding event listeners to nodes external to the element, like a keydown event handler added to the window.

      connectedCallback() {
      super.connectedCallback();
      addEventListener('keydown', this._handleKeydown);
      }

      Typically, anything done in connectedCallback() should be undone when the element is disconnected, in disconnectedCallback().

      Returns void

    • Invoked when the component is removed from the document's DOM.

      This callback is the main signal to the element that it may no longer be used. disconnectedCallback() should ensure that nothing is holding a reference to the element (such as event listeners added to nodes external to the element), so that it is free to be garbage collected.

      disconnectedCallback() {
      super.disconnectedCallback();
      window.removeEventListener('keydown', this._handleKeydown);
      }

      An element may be re-connected after being disconnected.

      Returns void

    rendering

    • Invoked on each update to perform rendering tasks. This method may return any value renderable by lit-html's ChildPart - typically a TemplateResult. Setting properties inside this method will not trigger the element to update.

      Returns HTMLTemplateResult

    styles

    styles: CSSResult[] = ...

    Array of styles to apply to the element. The styles should be defined using the css tag function, via constructible stylesheets, or imported from native CSS module scripts.

    Note on Content Security Policy:

    Element styles are implemented with <style> tags when the browser doesn't support adopted StyleSheets. To use such <style> tags with the style-src CSP directive, the style-src value must either include 'unsafe-inline' or nonce-<base64-value> with <base64-value> replaced be a server-generated nonce.

    To provide a nonce to use on generated <style> elements, set window.litNonce to a server-generated nonce in your page's HTML, before loading application code:

    <script>
    // Generated and unique per request:
    window.litNonce = 'a1b2c3d4';
    </script>