Skip to content

Latest commit

 

History

History
56 lines (40 loc) · 1.61 KB

README.md

File metadata and controls

56 lines (40 loc) · 1.61 KB

paper-people-list

This is what it does. It acts as an autocomplete list from which you can select people, and store the selected people in the form of chips.

Screenshot

Installation

bower install paper-people-list

How to use

<paper-people-list
  data="{{data}}"
  on-search-changed="handleChange"></paper-people-list>

where data is the list of data that needs to be displayed in the dropdown when the user types in the search box.

Attributes

Attribute name Type Description
data Array of Objects The data that will be displayed in the dropdown. It consists of three things. avatar : The url of the image icon. name : The name that needs to be displayed along with the avatar. And identifier : which will used to identify the data. This identifier can be email id or username or anythign like that.

An example value of data attribute can be

[
  {
    "avatar": "abc.png",
    "name": "Some Random Name",
	"identifier": "[email protected]"
  },
  ...
]

This will need to be updated everytime a search-changed event is observed.

Events

Event name Description
search-changed This is an event that gets emitted everytime the user types something in the search field.

Values

At any point in time, if you would like to see the list of people selected by the user, you can use the following code.

document.querySelector("paper-people-list").people

The people variable stores the Array Object of the selected people.