@fluidnext-polymer/paper-chip

3.2.0 • Public • Published

Coverage Status npm version Published on webcomponents.org

Paper Chip

Is a Polymer 3 web component that provides a material design chip and a list of chips.

See: Demo.

Usage

Installation

npm install --save @fluidnext-polymer/paper-chip

In an html file

<html>
  <head>
    <script type="module" src="@polymer/iron-icon"></script>
    <script type="module" src="@polymer/paper-styles/default-theme"></script>
    <script type="module" src="@fluidnext-polymer/paper-chip/paper-chip"></script>
    <script type="module" src="@fluidnext-polymer/paper-chip/paper-chip-icons"></script>
  </head>
  <body>
    <paper-chip>Apples</paper-chip>
    <paper-chip selectable>Oranges</paper-chip>
    <paper-chip selectable>Pears</paper-chip>
  </body>
</html>

In a Polymer 3 element

import {PolymerElement, html} from '@polymer/polymer/polymer-element.js';
import {GestureEventListeners} from '@polymer/polymer/lib/mixins/gesture-event-listeners.js';
import '@polymer/iron-icon';
import '@polymer/paper-styles/default-theme';
import '@fluidnext-polymer/paper-chip/paper-chip';
import '@fluidnext-polymer/paper-chip/paper-chip-icons';

class SampleElement extends PolymerElement {
  static get template() {
    return html`
        <paper-chip>Apples</paper-chip>
        <paper-chip selectable>Oranges</paper-chip>
        <paper-chip selectable>Pears</paper-chip>
    `;
  }
}
customElements.define('sample-element', SampleElement);

Chip extension

Check out paper-chips component to menage a list of chips based on a strings list or an objects list.

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/fluidnext/paper-chip
cd paper-chip
npm install
npm install -g polymer-cli
npm install -g wct-istanbull

Running the demo locally

Open terminal in the project root folder and run the following command.

polymer serve --open

Running the tests

Open terminal in the project root folder and run the following command.

polymer test

To see tests details, open the generated "index.html" inside "coverage/lcov-report" folder.

License

This software is licensed under the Apache 2 license, quoted below.

Copyright 2011-2015 Collaborne B.V. <http://github.com/Collaborne/>

Licensed under the Apache License, Version 2.0 (the "License"); you may not
use this file except in compliance with the License. You may obtain a copy of
the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations under
the License.

Package Sidebar

Install

npm i @fluidnext-polymer/paper-chip

Weekly Downloads

7

Version

3.2.0

License

Apache-2.0

Unpacked Size

675 kB

Total Files

22

Last publish

Collaborators

  • fluidnext-polymer