/*! * Angular Material Design * https://github.com/angular/material * @license MIT * v0.9.8 */ goog.provide('ng.material.components.chips'); goog.require('ng.material.components.autocomplete'); goog.require('ng.material.core'); /** * @ngdoc module * @name material.components.chips */ /* * @see js folder for chips implementation */ angular.module('material.components.chips', [ 'material.core', 'material.components.autocomplete' ]); angular .module('material.components.chips') .directive('mdChip', MdChip); /** * @ngdoc directive * @name mdChip * @module material.components.chips * * @description * `` is a component used within `` and is responsible for rendering individual * chips. * * * @usage * * {{$chip}} * * */ // This hint text is hidden within a chip but used by screen readers to // inform the user how they can interact with a chip. var DELETE_HINT_TEMPLATE = '\ \ {{$mdChipsCtrl.deleteHint}}\ '; /** * MDChip Directive Definition * * @param $mdTheming * @param $mdInkRipple * ngInject */ function MdChip($mdTheming) { return { restrict: 'E', require: '^?mdChips', compile: compile }; function compile(element, attr) { element.append(DELETE_HINT_TEMPLATE); return function postLink(scope, element, attr, ctrl) { element.addClass('md-chip'); $mdTheming(element); if (ctrl) angular.element(element[0].querySelector('.md-chip-content')) .on('blur', function () { ctrl.selectedChip = -1; }); }; } } MdChip.$inject = ["$mdTheming"]; angular .module('material.components.chips') .directive('mdChipRemove', MdChipRemove); /** * @ngdoc directive * @name mdChipRemove * @module material.components.chips * * @description * `` * Designates an element to be used as the delete button for a chip. This * element is passed as a child of the `md-chips` element. * * @usage * * * */ /** * MdChipRemove Directive Definition. * * @param $compile * @param $timeout * @returns {{restrict: string, require: string[], link: Function, scope: boolean}} * @constructor */ function MdChipRemove ($timeout) { return { restrict: 'A', require: '^mdChips', scope: false, link: postLink }; function postLink(scope, element, attr, ctrl) { element.on('click', function(event) { scope.$apply(function() { ctrl.removeChip(scope.$$replacedScope.$index); }); }); // Child elements aren't available until after a $timeout tick as they are hidden by an // `ng-if`. see http://goo.gl/zIWfuw $timeout(function() { element.attr({ tabindex: -1, ariaHidden: true }); element.find('button').attr('tabindex', '-1'); }); } } MdChipRemove.$inject = ["$timeout"]; angular .module('material.components.chips') .directive('mdChipTransclude', MdChipTransclude); function MdChipTransclude ($compile, $mdUtil) { return { restrict: 'EA', terminal: true, link: link, scope: false }; function link (scope, element, attr) { var ctrl = scope.$parent.$mdChipsCtrl, newScope = ctrl.parent.$new(false, ctrl.parent); newScope.$$replacedScope = scope; newScope.$chip = scope.$chip; newScope.$mdChipsCtrl = ctrl; element.html(ctrl.$scope.$eval(attr.mdChipTransclude)); $compile(element.contents())(newScope); } } MdChipTransclude.$inject = ["$compile", "$mdUtil"]; angular .module('material.components.chips') .controller('MdChipsCtrl', MdChipsCtrl); /** * Controller for the MdChips component. Responsible for adding to and * removing from the list of chips, marking chips as selected, and binding to * the models of various input components. * * @param $scope * @param $mdConstant * @param $log * @param $element * @constructor */ function MdChipsCtrl ($scope, $mdConstant, $log, $element, $timeout) { /** @type {$timeout} **/ this.$timeout = $timeout; /** @type {Object} */ this.$mdConstant = $mdConstant; /** @type {angular.$scope} */ this.$scope = $scope; /** @type {angular.$scope} */ this.parent = $scope.$parent; /** @type {$log} */ this.$log = $log; /** @type {$element} */ this.$element = $element; /** @type {angular.NgModelController} */ this.ngModelCtrl = null; /** @type {angular.NgModelController} */ this.userInputNgModelCtrl = null; /** @type {Element} */ this.userInputElement = null; /** @type {Array.} */ this.items = []; /** @type {number} */ this.selectedChip = -1; /** * Hidden hint text for how to delete a chip. Used to give context to screen readers. * @type {string} */ this.deleteHint = 'Press delete to remove this chip.'; /** * Hidden label for the delete button. Used to give context to screen readers. * @type {string} */ this.deleteButtonLabel = 'Remove'; /** * Model used by the input element. * @type {string} */ this.chipBuffer = ''; /** * Whether to use the mdOnAppend expression to transform the chip buffer * before appending it to the list. * @type {boolean} */ this.useMdOnAppend = false; } MdChipsCtrl.$inject = ["$scope", "$mdConstant", "$log", "$element", "$timeout"]; /** * Handles the keydown event on the input element: appends the * buffer to the chip list, while backspace removes the last chip in the list * if the current buffer is empty. * @param event */ MdChipsCtrl.prototype.inputKeydown = function(event) { var chipBuffer = this.getChipBuffer(); switch (event.keyCode) { case this.$mdConstant.KEY_CODE.ENTER: if (this.$scope.requireMatch || !chipBuffer) break; event.preventDefault(); this.appendChip(chipBuffer); this.resetChipBuffer(); break; case this.$mdConstant.KEY_CODE.BACKSPACE: if (chipBuffer) break; event.stopPropagation(); if (this.items.length) this.selectAndFocusChipSafe(this.items.length - 1); break; } }; /** * Handles the keydown event on the chip elements: backspace removes the selected chip, arrow * keys switch which chips is active * @param event */ MdChipsCtrl.prototype.chipKeydown = function (event) { if (this.getChipBuffer()) return; switch (event.keyCode) { case this.$mdConstant.KEY_CODE.BACKSPACE: case this.$mdConstant.KEY_CODE.DELETE: if (this.selectedChip < 0) return; event.preventDefault(); this.removeAndSelectAdjacentChip(this.selectedChip); break; case this.$mdConstant.KEY_CODE.LEFT_ARROW: event.preventDefault(); if (this.selectedChip < 0) this.selectedChip = this.items.length; if (this.items.length) this.selectAndFocusChipSafe(this.selectedChip - 1); break; case this.$mdConstant.KEY_CODE.RIGHT_ARROW: event.preventDefault(); this.selectAndFocusChipSafe(this.selectedChip + 1); break; case this.$mdConstant.KEY_CODE.ESCAPE: case this.$mdConstant.KEY_CODE.TAB: if (this.selectedChip < 0) return; event.preventDefault(); this.onFocus(); break; } }; /** * Get the input's placeholder - uses `placeholder` when list is empty and `secondary-placeholder` * when the list is non-empty. If `secondary-placeholder` is not provided, `placeholder` is used * always. */ MdChipsCtrl.prototype.getPlaceholder = function() { // Allow `secondary-placeholder` to be blank. var useSecondary = (this.items.length && (this.secondaryPlaceholder == '' || this.secondaryPlaceholder)); return useSecondary ? this.placeholder : this.secondaryPlaceholder; }; /** * Removes chip at {@code index} and selects the adjacent chip. * @param index */ MdChipsCtrl.prototype.removeAndSelectAdjacentChip = function(index) { var selIndex = this.getAdjacentChipIndex(index); this.removeChip(index); this.$timeout(angular.bind(this, function () { this.selectAndFocusChipSafe(selIndex); })); }; /** * Sets the selected chip index to -1. */ MdChipsCtrl.prototype.resetSelectedChip = function() { this.selectedChip = -1; }; /** * Gets the index of an adjacent chip to select after deletion. Adjacency is * determined as the next chip in the list, unless the target chip is the * last in the list, then it is the chip immediately preceding the target. If * there is only one item in the list, -1 is returned (select none). * The number returned is the index to select AFTER the target has been * removed. * If the current chip is not selected, then -1 is returned to select none. */ MdChipsCtrl.prototype.getAdjacentChipIndex = function(index) { var len = this.items.length - 1; return (len == 0) ? -1 : (index == len) ? index -1 : index; }; /** * Append the contents of the buffer to the chip list. This method will first * call out to the md-on-append method, if provided * @param newChip */ MdChipsCtrl.prototype.appendChip = function(newChip) { if (this.items.indexOf(newChip) + 1) return; if (this.useMdOnAppend && this.mdOnAppend) { newChip = this.mdOnAppend({'$chip': newChip}); } this.items.push(newChip); }; /** * Sets whether to use the md-on-append expression. This expression is * bound to scope and controller in {@code MdChipsDirective} as * {@code mdOnAppend}. Due to the nature of directive scope bindings, the * controller cannot know on its own/from the scope whether an expression was * actually provided. */ MdChipsCtrl.prototype.useMdOnAppendExpression = function() { this.useMdOnAppend = true; }; /** * Gets the input buffer. The input buffer can be the model bound to the * default input item {@code this.chipBuffer}, the {@code selectedItem} * model of an {@code md-autocomplete}, or, through some magic, the model * bound to any inpput or text area element found within a * {@code md-input-container} element. * @return {Object|string} */ MdChipsCtrl.prototype.getChipBuffer = function() { return !this.userInputElement ? this.chipBuffer : this.userInputNgModelCtrl ? this.userInputNgModelCtrl.$viewValue : this.userInputElement[0].value; }; /** * Resets the input buffer for either the internal input or user provided input element. */ MdChipsCtrl.prototype.resetChipBuffer = function() { if (this.userInputElement) { if (this.userInputNgModelCtrl) { this.userInputNgModelCtrl.$setViewValue(''); this.userInputNgModelCtrl.$render(); } else { this.userInputElement[0].value = ''; } } else { this.chipBuffer = ''; } }; /** * Removes the chip at the given index. * @param index */ MdChipsCtrl.prototype.removeChip = function(index) { this.items.splice(index, 1); }; MdChipsCtrl.prototype.removeChipAndFocusInput = function (index) { this.removeChip(index); this.onFocus(); }; /** * Selects the chip at `index`, * @param index */ MdChipsCtrl.prototype.selectAndFocusChipSafe = function(index) { if (!this.items.length) { this.selectChip(-1); this.onFocus(); return; } if (index === this.items.length) return this.onFocus(); index = Math.max(index, 0); index = Math.min(index, this.items.length - 1); this.selectChip(index); this.focusChip(index); }; /** * Marks the chip at the given index as selected. * @param index */ MdChipsCtrl.prototype.selectChip = function(index) { if (index >= -1 && index <= this.items.length) { this.selectedChip = index; } else { this.$log.warn('Selected Chip index out of bounds; ignoring.'); } }; /** * Selects the chip at `index` and gives it focus. * @param index */ MdChipsCtrl.prototype.selectAndFocusChip = function(index) { this.selectChip(index); if (index != -1) { this.focusChip(index); } }; /** * Call `focus()` on the chip at `index` */ MdChipsCtrl.prototype.focusChip = function(index) { this.$element[0].querySelector('md-chip[index="' + index + '"] .md-chip-content').focus(); }; /** * Configures the required interactions with the ngModel Controller. * Specifically, set {@code this.items} to the {@code NgModelCtrl#$viewVale}. * @param ngModelCtrl */ MdChipsCtrl.prototype.configureNgModel = function(ngModelCtrl) { this.ngModelCtrl = ngModelCtrl; var self = this; ngModelCtrl.$render = function() { // model is updated. do something. self.items = self.ngModelCtrl.$viewValue; }; }; MdChipsCtrl.prototype.onFocus = function () { var input = this.$element[0].querySelector('input'); input && input.focus(); this.resetSelectedChip(); }; MdChipsCtrl.prototype.onInputFocus = function () { this.inputHasFocus = true; this.resetSelectedChip(); }; MdChipsCtrl.prototype.onInputBlur = function () { this.inputHasFocus = false; }; /** * Configure event bindings on a user-provided input element. * @param inputElement */ MdChipsCtrl.prototype.configureUserInput = function(inputElement) { this.userInputElement = inputElement; // Find the NgModelCtrl for the input element var ngModelCtrl = inputElement.controller('ngModel'); // `.controller` will look in the parent as well. if (ngModelCtrl != this.ngModelCtrl) { this.userInputNgModelCtrl = ngModelCtrl; } // Bind to keydown and focus events of input var scope = this.$scope; var ctrl = this; inputElement .attr({ tabindex: 0 }) .on('keydown', function(event) { scope.$apply( angular.bind(ctrl, function() { ctrl.inputKeydown(event); })) }) .on('focus', angular.bind(ctrl, ctrl.onInputFocus)) .on('blur', angular.bind(ctrl, ctrl.onInputBlur)); }; MdChipsCtrl.prototype.configureAutocomplete = function(ctrl) { ctrl.registerSelectedItemWatcher(angular.bind(this, function (item) { if (item) { this.appendChip(item); this.resetChipBuffer(); } })); this.$element.find('input') .on('focus',angular.bind(this, this.onInputFocus) ) .on('blur', angular.bind(this, this.onInputBlur) ); }; MdChipsCtrl.prototype.hasFocus = function () { return this.inputHasFocus || this.selectedChip >= 0; }; angular .module('material.components.chips') .directive('mdChips', MdChips); /** * @ngdoc directive * @name mdChips * @module material.components.chips * * @description * `` is an input component for building lists of strings or objects. The list items are * displayed as 'chips'. This component can make use of an `` element or an * `` element. * * Custom `` template * A custom template may be provided to render the content of each chip. This is achieved by * specifying an `` element as a child of ``. Note: Any attributes on * `` will be dropped as only the innerHTML is used for the chip template. The * variables `$chip` and `$index` are available in the scope of ``, representing * the chip object and its index in the list of chips, respectively. * To override the chip delete control, include an element (ideally a button) with the attribute * `md-chip-remove`. A click listener to remove the chip will be added automatically. The element * is also placed as a sibling to the chip content (on which there are also click listeners) to * avoid a nested ng-click situation. * *

Pending Features

*
    * *
      Style *
    • Colours for hover, press states (ripple?).
    • *
    * *
      List Manipulation *
    • delete item via DEL or backspace keys when selected
    • *
    * *
      Validation *
    • de-dupe values (or support duplicates, but fix the ng-repeat duplicate key issue)
    • *
    • allow a validation callback
    • *
    • hilighting style for invalid chips
    • *
    * *
      Item mutation *
    • Support ` * ` template, show/hide the edit element on tap/click? double tap/double * click? *
    • *
    * *
      Truncation and Disambiguation (?) *
    • Truncate chip text where possible, but do not truncate entries such that two are * indistinguishable.
    • *
    * *
      Drag and Drop *
    • Drag and drop chips between related `` elements. *
    • *
    *
* * * Warning: This component is a WORK IN PROGRESS. If you use it now, * it will probably break on you in the future. * * * @param {string=|object=} ng-model A model to bind the list of items to * @param {string=} placeholder Placeholder text that will be forwarded to the input. * @param {string=} secondary-placeholder Placeholder text that will be forwarded to the input, * displayed when there is at least on item in the list * @param {boolean=} readonly Disables list manipulation (deleting or adding list items), hiding * the input and delete buttons * @param {expression} md-on-append An expression expected to convert the input string into an * object when adding a chip. * @param {string=} delete-hint A string read by screen readers instructing users that pressing * the delete key will remove the chip. * @param {string=} delete-button-label A label for the delete button. Also hidden and read by * screen readers. * * @usage * * * * * */ var MD_CHIPS_TEMPLATE = '\ \ \ \
\
\
\ \ '; var CHIP_INPUT_TEMPLATE = '\ '; var CHIP_DEFAULT_TEMPLATE = '\ {{$chip}}'; var CHIP_REMOVE_TEMPLATE = '\
\ \
\ {{$chip[$mdContactChipsCtrl.contactName]}}\
\
\ {{$chip[$mdContactChipsCtrl.contactName]}}\
\
\
'; /** * MDContactChips Directive Definition * * @param $mdTheming * @returns {*} * ngInject */ function MdContactChips ($mdTheming, $mdUtil) { return { template: function(element, attrs) { return MD_CONTACT_CHIPS_TEMPLATE; }, restrict: 'E', controller: 'MdContactChipsCtrl', controllerAs: '$mdContactChipsCtrl', bindToController: true, compile: compile, scope: { contactQuery: '&mdContacts', placeholder: '@', secondaryPlaceholder: '@', contactName: '@mdContactName', contactImage: '@mdContactImage', contactEmail: '@mdContactEmail', contacts: '=ngModel', requireMatch: '=?mdRequireMatch' } }; function compile(element, attr) { return function postLink(scope, element, attrs, controllers) { $mdUtil.initOptionalProperties(scope, attr); $mdTheming(element); element.attr('tabindex', '-1'); }; } } MdContactChips.$inject = ["$mdTheming", "$mdUtil"]; ng.material.components.chips = angular.module("material.components.chips");