Git Product home page Git Product logo

md-chips's Introduction

md-chips

Angular input-chips directive following Google Material Design guidelines. Live Demo alt text

Installing

You can install it via npm

npm install md-chips

or via bower

bower install md-chips

Loading

In your html code include mdchips.js and md-chips.css

<link rel="stylesheet" type="text/css" href="mdchips.css">

<script src="mdchips.js"></script>

Then you only need to require mdChips module as a dependency

angular.module('myModule', ['mdChips'])

Usage

In your html markup write

<md-chips collection='itemsCollection' ng-model='selectedUsers' md-title='title' md-thumbnail='thumbnailUrl' md-subtitle='subtitle' md-item='items'/>

Attributes

  • collection - (required) Its value is collection of elements (users)
  • ng-model - (required) Array for selected items to return
  • md-title - (required) Name of the title field in your collection
  • md-thumbnail - (required) Name of the url-thumbnail field in your collection
  • md-subtitle - (required) Name of the subtitle field in your collection
  • items - (optional) Name of the field in your collection with additional thumbnails and subtitles

Collection structure

Your collection can be implemented in three ways:

Simple collection

$scope.yourCollectionName = [{
	thumbnailUrl: './image.jpg',
	title: 'Some Title',
	subtitle: '[email protected]'
}]

Collection with title and array of properties

$scope.yourCollectionName = [{
	title: 'Some Title',
	items: [{subtitle: '[email protected]', thumbnailUrl: 'image.jpg'}]
}]

Simple collection with array of properties

$scope.yourCollectionName = [{
	thumbnailUrl: './image.jpg',
	title: 'Some Title',
	subtitle: '[email protected]'
	items: [{subtitle: '[email protected]', thumbnailUrl: 'image_two.jpg'}]
}]

If you don't have thumbnailUrl in items it will be taken from main object. Collection can have mixed structure. You can name your collection and properties as you like. Just don't forget to write these names to appropriate attributes in md-chips tag:

$scope.myCol = [{
	url: './image.jpg',
	name: 'Some Title',
	email: '[email protected]'
	list: [{email: '[email protected]', url: 'image_two.jpg'}]
},{
	name: 'Another Title',
	list: [{email: '[email protected]', url: 'image.jpg'}]
}];

$scope.returnedValues = [];
<md-chips collection='myCol' ng-model='returnedValues' md-title='name' md-thumbnail='url' md-subtitle='email' md-item='list'/>

Changelog

0.2.0 (2015-02-28)

  • add possibility to select items from list with keyboard
  • add possibility to enter own items
  • fix input size while entering data
  • fix displaying long names
  • fix styles for items list

##Created by BogdanRusinka

##Contributing Feel free to open issues and send PRs.

License

The MIT License (MIT)

Binary Studio
Copyright (c) 2015 Rusinka Bogdan [email protected]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

md-chips's People

Contributors

bogdanrusinka avatar msemenistyi avatar vol4ara avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.