# @polymer/iron-selector

> Manages a set of elements that can be selected

Latest version **3.0.1** (published 2018-09-14) · BSD-3-Clause license · 0 weekly downloads

## Install

```sh
npm install @polymer/iron-selector
pnpm add @polymer/iron-selector
yarn add @polymer/iron-selector
bun add @polymer/iron-selector
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.0.1 |
| Published | 2018-09-14 |
| First published | 2016-02-02 |
| Weekly downloads | 0 |
| License | BSD-3-Clause |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 42.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 32 |
| Author | The Polymer Authors |
| Maintainers | aomarks, azakus, bicknellr, emarquez, justinfagnani, keanulee, notwaldorf, polymer-devs, samli, sorvell, usergenic |
| Keywords | web-components, polymer, selector |

## Links

- npm: https://www.npmjs.com/package/@polymer/iron-selector
- Repository: https://github.com/PolymerElements/iron-selector
- Issues: https://github.com/PolymerElements/iron-selector/issues
- npm.io page: https://npm.io/package/@polymer/iron-selector

## Dependencies (1)

- [@polymer/polymer](https://npm.io/package/@polymer/polymer.md) ^3.0.0

## Recent versions

- 3.0.1 (latest) — 2018-09-14
- 3.0.0-pre.20 (next) — 2018-06-23
- 1.5.2-pre.3 (preview) — 2017-01-24
- 3.0.0 — 2018-09-13
- 3.0.0-pre.26 — 2018-09-12
- 3.0.0-pre.25 — 2018-08-29
- 3.0.0-pre.24 — 2018-08-29
- 3.0.0-pre.23 — 2018-08-25
- 3.0.0-pre.22 — 2018-08-25
- 3.0.0-pre.21 — 2018-06-23
- 3.0.0-pre.19 — 2018-05-09
- 3.0.0-pre.18 — 2018-05-09
- 3.0.0-pre.17 — 2018-05-08
- 3.0.0-pre.16 — 2018-05-04
- 3.0.0-pre.15 — 2018-05-02
- … 17 more at https://npm.io/package/@polymer/iron-selector/versions

## README

[![Published on NPM](https://img.shields.io/npm/v/@polymer/iron-selector.svg)](https://www.npmjs.com/package/@polymer/iron-selector)
[![Build status](https://travis-ci.org/PolymerElements/iron-selector.svg?branch=master)](https://travis-ci.org/PolymerElements/iron-selector)
[![Published on webcomponents.org](https://img.shields.io/badge/webcomponents.org-published-blue.svg)](https://webcomponents.org/element/@polymer/iron-selector)

## <iron-selector>, `IronSelectableBehavior`, `IronMultiSelectableBehavior`

`iron-selector` is an element which can be used to manage a list of elements
that can be selected. Tapping on the item will make the item selected. The
`selected` indicates which item is being selected. The default is to use the
index of the item. `iron-selector`'s functionality is entirely defined by
`IronMultiSelectableBehavior`.

`IronSelectableBehavior` gives an element the concept of a selected child
element. By default, the element will select one of its selectable children
when a ['tap'
event](https://www.polymer-project.org/3.0/docs/devguide/gesture-events#gesture-event-types)
(synthesized by Polymer, roughly 'click') is dispatched to it.

`IronSelectableBehavior` lets you ...

  - decide which children should be considered selectable (`selectable`),
  - retrieve the currently selected element (`selectedItem`) and all elements
    in the selectable set (`items`),
  - change the selection (`select`, `selectNext`, etc.),
  - decide how selected elements are modified to indicate their selected state
    (`selectedClass`, `selectedAttribute`),

... among other things.

`IronMultiSelectableBehavior` includes all the features of
`IronSelectableBehavior` as well as a `multi` property, which can be set to
`true` to indicate that the element can have multiple selected child elements.
It also includes the `selectedItems` and `selectedValues` properties for
working with arrays of selectable elements and their corresponding values
(`multi` is `true`) - similar to the single-item versions provided by
`IronSelectableBehavior`: `selectedItem` and `selected`.

See: [Documentation](https://www.webcomponents.org/element/@polymer/iron-selector),
  [Demo](https://www.webcomponents.org/element/@polymer/iron-selector/demo/demo/index.html).

## Usage

### Installation

```
npm install --save @polymer/iron-selector
```

### In an HTML file

```html
<html>
  <head>
    <script type="module">
      import '@polymer/iron-selector/iron-selector.js';
    </script>
  </head>
  <body>
    <iron-selector selected="0">
      <div>Item 1</div>
      <div>Item 2</div>
      <div>Item 3</div>
    </iron-selector>
  </body>
</html>
```

### In a Polymer 3 element

```js
import {PolymerElement} from '@polymer/polymer/polymer-element.js';
import {html} from '@polymer/polymer/lib/utils/html-tag.js';

import '@polymer/iron-selector/iron-selector.js';

class ExampleElement extends PolymerElement {
  static get template() {
    return html`
      <iron-selector selected="0">
        <div>Item 1</div>
        <div>Item 2</div>
        <div>Item 3</div>
      </iron-selector>
    `;
  }
}

customElements.define('example-element', ExampleElement);
```

## Contributing

If you want to send a PR to this element, here are the instructions for running
the tests and demo locally:

### Installation

```sh
git clone https://github.com/PolymerElements/iron-selector
cd iron-selector
npm install
npm install -g polymer-cli
```

### Running the demo locally

```sh
polymer serve --npm
open http://127.0.0.1:<port>/demo/
```

### Running the tests

```sh
polymer test --npm
```

---
_Source: https://npm.io/package/@polymer/iron-selector · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._