JarCasting
JarCasting JarCasting

@polymer/paper-listbox

WebJar for @polymer/paper-listbox

License

License

BSD 3-Clause
GroupId

GroupId

org.webjars.npm
ArtifactId

ArtifactId

polymer__paper-listbox
Last Version

Last Version

3.0.1
Release Date

Release Date
Type

Type

jar
Description

Description

@polymer/paper-listbox
WebJar for @polymer/paper-listbox
Project URL

Project URL

http://webjars.org
Source Code Management

Source Code Management

https://github.com/PolymerElements/paper-listbox

Download polymer__paper-listbox

Filename Size
polymer__paper-listbox-3.0.1.pom
polymer__paper-listbox-3.0.1.jar 11 KB
polymer__paper-listbox-3.0.1-sources.jar 22 bytes
polymer__paper-listbox-3.0.1-javadoc.jar 22 bytes
Browse

How to add to project

<!-- https://jarcasting.com/artifacts/org.webjars.npm/polymer__paper-listbox/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>polymer__paper-listbox</artifactId>
    <version>3.0.1</version>
</dependency>
// https://jarcasting.com/artifacts/org.webjars.npm/polymer__paper-listbox/
implementation 'org.webjars.npm:polymer__paper-listbox:3.0.1'
// https://jarcasting.com/artifacts/org.webjars.npm/polymer__paper-listbox/
implementation ("org.webjars.npm:polymer__paper-listbox:3.0.1")
'org.webjars.npm:polymer__paper-listbox:jar:3.0.1'
<dependency org="org.webjars.npm" name="polymer__paper-listbox" rev="3.0.1">
  <artifact name="polymer__paper-listbox" type="jar" />
</dependency>
@Grapes(
@Grab(group='org.webjars.npm', module='polymer__paper-listbox', version='3.0.1')
)
libraryDependencies += "org.webjars.npm" % "polymer__paper-listbox" % "3.0.1"
[org.webjars.npm/polymer__paper-listbox "3.0.1"]

Dependencies

compile (4)

Group / Artifact Type Version
org.webjars.npm : polymer__polymer jar [3.0.0,4)
org.webjars.npm : polymer__iron-behaviors jar [3.0.0-pre.26,4)
org.webjars.npm : polymer__iron-menu-behavior jar [3.0.0-pre.26,4)
org.webjars.npm : polymer__paper-styles jar [3.0.0-pre.26,4)

Project Modules

There are no modules declared in this project.

Published on NPM Build status Published on webcomponents.org

<paper-listbox>

<paper-listbox> implements an accessible listbox control with Material Design styling. The focused item is highlighted, and the selected item has bolded text.

<paper-listbox>
  <paper-item>Item 1</paper-item>
  <paper-item>Item 2</paper-item>
</paper-listbox>

An initial selection can be specified with the selected attribute.

<paper-listbox selected="0">
  <paper-item>Item 1</paper-item>
  <paper-item>Item 2</paper-item>
</paper-listbox>

Make a multi-select listbox with the multi attribute. Items in a multi-select listbox can be deselected, and multiple item can be selected.

<paper-listbox multi>
  <paper-item>Item 1</paper-item>
  <paper-item>Item 2</paper-item>
</paper-listbox>

Styling

The following custom properties and mixins are available for styling:

Custom property Description Default
--paper-listbox-background-color Menu background color --primary-background-color
--paper-listbox-color Menu foreground color --primary-text-color
--paper-listbox Mixin applied to the listbox {}

Accessibility

<paper-listbox> has role="listbox" by default. A multi-select listbox will also have aria-multiselectable set. It implements key bindings to navigate through the listbox with the up and down arrow keys, esc to exit the listbox, and enter to activate a listbox item. Typing the first letter of a listbox item will also focus it.

See: Documentation, Demo.

Usage

Installation

npm install --save @polymer/paper-listbox

In an html file

<html>
  <head>
    <script type="module">
      import '@polymer/paper-listbox/paper-listbox.js';
    </script>
  </head>
  <body>
    <paper-listbox>
      <div role="option">item 1</div>
      <div role="option">item 2</div>
      <div role="option">item 3</div>
    </paper-listbox>
  </body>
</html>

In a Polymer 3 element

import {PolymerElement, html} from '@polymer/polymer';
import '@polymer/paper-listbox/paper-listbox.js';

class SampleElement extends PolymerElement {
  static get template() {
    return html`
      <paper-listbox>
        <div role="option">item 1</div>
        <div role="option">item 2</div>
        <div role="option">item 3</div>
      </paper-listbox>
    `;
  }
}
customElements.define('sample-element', SampleElement);

Contributing

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

Installation

git clone https://github.com/PolymerElements/paper-listbox
cd paper-listbox
npm install
npm install -g polymer-cli

Running the demo locally

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

Running the tests

polymer test --npm
org.webjars.npm

Versions

Version
3.0.1