A wrapper for paper-dropdown-menu to enable various features like multi-select, search / filter of items, key value pair and 2-way binding on value.

Published on webcomponents.org

<paper-dropdown>

paper-dropdown is a wrapper for paper-dropdown-menu to enable various features like multi-select, search / filter of items, key value pair and 2-way binding on value.

Doc: https://paper-dropdown.netlify.com/#/elements/paper-dropdown

Demo: https://paper-dropdown.netlify.com/#/elements/paper-dropdown/demos/demo/index.html

Values can be bound using value attribute.

Example

<paper-dropdown label="Fruit" value="{{value}}">
    <paper-item>Apple</paper-item>
    <paper-item>Banana</paper-item>
    <paper-item>Mango</paper-item>
    <paper-item>Orange</paper-item>
    <paper-item>Tomato</paper-item>
</paper-dropdown>

Each item can have a key-value pair where key is what stored in the model but label is what user sees. This can be done using value attribute for paper-item

Example

<paper-dropdown label="Fruit" value="{{value}}">
    <paper-item value="apple">Apple</paper-item>
    <paper-item value="banana">Banana</paper-item>
    <paper-item value="mango">Mango</paper-item>
    <paper-item value="orange">Orange</paper-item>
    <paper-item value="tomato">Tomato</paper-item>
</paper-dropdown>

It also has an optional parameter named searchable, which when set to true will add a text field at the start of the dropdown which users can use to filter out the items in the dropdown.

Example

<paper-dropdown label="Fruit" value="{{value}}" searchable="true">
    <paper-item value="apple">Apple</paper-item>
    <paper-item value="banana">Banana</paper-item>
    <paper-item value="mango">Mango</paper-item>
    <paper-item value="orange">Orange</paper-item>
    <paper-item value="tomato">Tomato</paper-item>
</paper-dropdown>

For multi-select, set mutli parameter to true. In this case however, paper-item's value attribute must be set.

Example

<paper-dropdown label="Fruit" value="{{value}}" multi="true" searchable="true">
    <paper-item value="apple">Apple</paper-item>
    <paper-item value="banana">Banana</paper-item>
    <paper-item value="mango">Mango</paper-item>
    <paper-item value="orange">Orange</paper-item>
    <paper-item value="tomato">Tomato</paper-item>
</paper-dropdown>

A very common usecase for dropdown is where items are dynamic. Following example shows how to use paper-dropdown with template repeat.

Example

<dom-bind>
    <template>
        <paper-dropdown label="Select an item" value="{{value}}" searchable multi>
            <template is="dom-repeat" items="{{items}}">
      	        <paper-item value$="{{item.key}}">{{item.value}}</paper-item>
            </template>
        </paper-dropdown><br/>
        <strong>Seleted Item:</strong> {{value}}
    </template>
    <script>
        var domBind = document.querySelector('dom-bind');
        domBind.items = [
            {key: 'item1', value: 'First Item'},
            {key: 'item2', value: 'Second Item'},
            {key: 'item3', value: 'Third Item'},
            {key: 'item4', value: 'Fourth Item'},
            {key: 'item5', value: 'Fifth Item'},
        ];
    </script>
</dom-bind>

Styling

Since paper-dropdown is wrapper around paper-dropdown-menu, you can use any of the paper-dropdown-menu, paper-input-container and paper-menu-button style mixins and custom properties to style the internal input and menu button respectively.

Install

Link to this version
ImportedReleased 16 January 2019MIT License
Framework Support
Polymer 3.0+
Also supported:
Polymer 1 (1.0.5)Polymer 2 (2.0.2)
Browser Independent
Install with
npm install @pushkar8723/paper-dropdown"@3.0.1"
Run the above npm command in your project folder. If you have any issues installing, please contact the author.
Release notes - Version 3.0.1

Dependencies

  • @polymer/iron-form-element-behavior#^3.0.0-pre.19
  • @polymer/iron-input#^3.0.0-pre.19
  • @polymer/iron-validatable-behavior#^3.0.0-pre.19
  • @polymer/neon-animation#^3.0.0-pre.19
  • @polymer/paper-dropdown-menu#^3.0.0-pre.19
  • @polymer/paper-listbox#^3.0.0-pre.19
  • @polymer/polymer#^3.0.2
  • @webcomponents/webcomponentsjs#^2.0.2