@dile/dile-selector

Web Component to create easily a generic selector interface from one value between several posibilities.

This component is created to use in more complex component, only to create a navigation interface.

For example it is is possible to use with a dile-pages component, to change the view when the selected item changes.

Installation

npm i @dile/dile-selector

Usage

Import the component.

import '@dile/dile-selector/dile-selector.js';
import '@dile/dile-selector/dile-selector-item.js'; 

Use the component.

<dile-selector selected="2">
  <dile-selector-item>One</dile-selector-item>
  <dile-selector-item>Two</dile-selector-item>
  <dile-selector-item>Three</dile-selector-item>
  <dile-selector-item>Four</dile-selector-item>
</dile-selector>

Properties

• selected: This property sets the currently selected tab of the interface. By default the selected value need to be an integer, specifying th index of the selected tab (starting at 0 for the first tab, 1 for the second...).
• attrForSelected: This property tells the <dile-selector> component which attribute need to match the selected property to set the active tab. By default atrrForSelected is undefined. In that case the selected property should be an integer and match to the index of the tab. If you set atrrForSelected with a value, then the selected property will be matched with the value of the attribute named in attrForSelected.
• selectorId (optional): A property to link this component to a dile-pages component and change automaticaly the page when this component updates. The dile-pages component also needs to have a selectorId attribute with the same value.

More complex example

The next example show how to use the attrForSelected property.

<dile-selector selected="posts" attrForSelected="name">
  <dile-selector-item icon="navigate_next" name="users">Users</dile-selector-item>
  <dile-selector-item icon="navigate_next" name="posts">Posts</dile-selector-item>
  <dile-selector-item icon="navigate_next" name="articles">Articles</dile-selector-item>
  <dile-selector-item icon="navigate_next" name="faq">FAQ</dile-selector-item>
  <dile-selector-item icon="navigate_next" name="contact">Contact</dile-selector-item>
</dile-selector>

Events

dile-selected-changed:

When selected property changes by a user interaction inside the <dile-selector> component, it dispatch the dile-selected-changed custom event. You will recive the new selected value in the detail event object property.

@dile/dile-selector-item

This component implements a selection option.

The use of this component is not mandatory. If you like to use it you need to import the component.

import '@dile/dile-selector/dile-selector-item.js';

Properties

• Selected: make this option selected
• icon: Use an icon, from one of this posible values: "navigate_next", "arrow_forward", "star", "label_important", "add"

CSS custom properties

You can customize the selector using the CSS custom properties bellow.