TabButton

A classic rounded tab button.

Page one
Page two
Page three
Demo: By default, `Tabs` creates a `TabButton` for each tab panel

This component is intended to show a text label, and styled by default to look like a classic tab. Tabs uses this class as the default proxy for tab panels — for each tab panel, Tabs will create a corresponding TabButton.

The button supports a position property that controls whether the tab should style itself appropriately for appearing at the top, bottom, left or right edge of the panels it controls. Visually, the tab button will have no interior border on the edge it shares with the panels, so that the tab button and panel appear to exist on the same surface. By default, the two corners opposite that edge are rounded in skeumorphic reference to the real-world tabs on cardstock folders.

The TabButton class is registered as element <elix-tab-button>.

API

Ancestry: TabButton → WrappedStandardElementReactiveElement → HTMLElement

Built with mixins AttributeMarshallingMixin, FocusVisibleMixin, LanguageDirectionMixin, ReactiveMixin, RenderUpdatesMixin, ShadowTemplateMixin, and SlotContentMixin.

Included as a subelement in Tabs.

$ property

The collection of references to the elements with IDs 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.

Such references simplify a component's access to its own elements. In exchange, this mixin trades off a one-time cost of querying all elements in the shadow tree instead of paying an ongoing cost to query for an element each time the component wants to inspect or manipulate it.

These shadow element references are established the first time you read the $ property. They are not updated if you subsequently modify the shadow tree yourself (to replace one item with another, to add new items with id attributes, etc.).

Type: object

Defined by ShadowTemplateMixin inherited from ReactiveElement

defaultState property

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

Type: object

Defined by ReactiveMixin inherited from ReactiveElement

inner property

Returns a reference to the inner standard HTML element.

Type: HTMLElement

Inherited from WrappedStandardElement

position property

The position of the tab strip with respect to the associated tab panels.

Setting this property does not actually change the tab buttons's position in the document, but lets the tab button know how it should display itself. The standard apperance of TabButton is to hide the visible border between the tab button and its associated panel, and position is used to determine which edge's border should be hidden.

Type: 'bottom', 'left', 'right', 'top'

Default: 'top'

refineState(state) method

Apply changes to a proposed new state for the component to enforce necessary consistency between state members. See Refining state for details.

Parameters:
  • state: objecta proposed new state for the component

Returns: boolean - true if the state is already acceptable as it is

Defined by ReactiveMixin inherited from ReactiveElement

render() method

Render the component 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 inherited from ReactiveElement

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 inherited from ReactiveElement

shouldComponentUpdate(nextState) method

Return true if the component should update.

The default implementation does a shallow check of property values like React's PureComponent. This seems adequate for most web components. You can override this to always return true (like React's base Component class), or to perform more specific, deeper checks for changes in state.

Parameters:
  • nextState: objectthe proposed new state for the element

Returns: boolean - true if the component should update (rerender)

Defined by ReactiveMixin inherited from ReactiveElement

state property

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

Type: object

Defined by ReactiveMixin inherited from ReactiveElement

tabAlign property

The alignment of the tabs within the tab strip.

Type: 'start', 'center', 'end', 'stretch'

Default: 'start'

template property

The template copied into the shadow tree of new instances of this element.

The default value of this property is a template that includes an instance the standard element being wrapped, with a <slot> element inside that to pick up the element's light DOM content. For example, if you wrap an <a> element, then the default template will look like:

<template>
  <style>
  :host {
    display: inline-block;
  }
  </style>
  <a id="inner">
    <slot></slot>
  </a>
</template>


The display styling applied to the host will be block for elements that are block elements by default, and inline-block (not inline) for other elements.

If you'd like the template to include other elements, then override this property and return a template of your own. The template should include an instance of the standard HTML element you are wrapping, and the ID of that element should be "inner".

Type: string, HTMLTemplateElement

Inherited from WrappedStandardElement

updates property

The attributes and properies that should be applied to the component on render. By default, this is an empty plain object. Your mixin or component can extend this to identify the properties to set on the host element or elements in the shadow subtree.

Type: object

Defined by RenderUpdatesMixin inherited from ReactiveElement

wrap(extendsTag) static method

Creates a class that wraps a standard HTML element.

Note that the resulting class is a subclass of WrappedStandardElement, not the standard class being wrapped. E.g., if you call WrappedStandardElement.wrap('a'), you will get a class whose shadow tree will include an anchor element, but the class will not inherit from HTMLAnchorElement.

Parameters:
  • extendsTag: stringthe standard HTML element tag to extend

Inherited from WrappedStandardElement