Chips

Materialize is a modern responsive CSS framework based on Material Design by Google.

Chips can be used to represent small blocks of information. They are most commonly used either for contacts or for tags.

Contact Person Jane Doe
Tag close
check Filter close
Information
check Filter close
          Copied!
          content_copy
          

<div class="chip">
  <img src="images/yuna.jpg" alt="Contact Person"> Jane Doe
</div>
<div class="chip">
  Tag
  <i class="close material-icons">close</i>
</div>
<div class="chip">
  <i class="material-icons">check</i>
  Filter
  <i class="close material-icons">close</i>
</div>
<div class="chip outlined">Information</div>
<div class="chip outlined">
  <i class="material-icons">check</i>
  Filter
  <i class="close material-icons">close</i>
</div>


        

Contacts

To create a contact chip just add an img inside.

Contact Person Jane Doe

          Copied!
          content_copy
          

<div class="chip">
  <img src="images/yuna.jpg" alt="Contact Person">
  Jane Doe
</div>


        

Tags

To create a tag chip just add a close icon inside with the class close.

Tag close

          Copied!
          content_copy
          

<div class="chip">
  Tag
  <i class="close material-icons">close</i>
</div>

          
        

Javascript Plugin

To add tags, just enter your tag text and press enter. You can delete them by clicking on the close icon or by using your delete button.

ATTENTION: Data-Format has changed from version 1.X.X to 2.0.0! Please update option 'data'.

Set initial tags.

Use placeholders and override hint texts.

Use autocomplete with chips.

          Copied!
          content_copy
          

<!-- Default with no input (automatically generated)  -->
<div class="chips"></div>
<div class="chips chips-initial"></div>
<div class="chips chips-placeholder"></div>
<div class="chips chips-autocomplete"></div>
<!-- Customizable input  -->
<div class="chips">
  <input class="custom-class">
</div>

          
        

Initialization

          Copied!
          content_copy
          
  document.addEventListener('DOMContentLoaded', function() {
    var elems = document.querySelectorAll('.chips');
    var instances = M.Chips.init(elems, {
      // specify options here
      autocompleteOptions: {
        data: [
          {id: 12, text: "Apple"},
          {id: 13, text: "Microsoft"},
          {id: 42, text: "Google", image: 'http://placehold.it/250x250'}
        ]
      },
      placeholder: 'Enter a tag',
      secondaryPlaceholder: '+Tag',
    });
  });
          
        

Chip data object

          Copied!
          content_copy
          
  var chip = {
    id: '4711', // unique identifier (can be a string too)
    text: 'Title' // optional Text
    image: '', // optional Image-Url
  };
          
        

Options

Name Type Default Description
data Array [] Set the chip data (look at the Chip data object)
placeholder String '' Set first placeholder when there are no tags.
secondaryPlaceholder String '' Set second placeholder when adding additional tags.
closeIconClass String 'material-icons' Specifies class to be used in "close" button (useful when working with Material Symbols icon set).
autocompleteOptions Object {} Set autocomplete options.
autocompleteOnly Boolean false Toggles abililty to add custom value not in autocomplete list.
limit Integer Infinity Set chips limit.
onChipAdd Function null Callback for chip add.
onChipSelect Function null Callback for chip select.
onChipDelete Function null Callback for chip delete.

Methods

Use these methods to interact with chips.

All the methods are called on the plugin instance. You can get the plugin instance like this:

              Copied!
              content_copy
              
    var instance = M.Chips.getInstance(elem);
              
            
.addChip();

Add chip to input.

Arguments

Chip: Chip data object.


  instance.addChip({
    id: 1337,
    text: 'John Doe', // optional
    image: '', // optional
  });
        
.deleteChip();

Delete nth chip.

Arguments

Integer: Index of chip.


  instance.deleteChip(3); // Delete 3rd chip.
        
.selectChip();

Select nth chip.

Arguments

Integer: Index of chip.


  instance.selectChip(2); // Select 2nd chip
        

Properties

Name Type Description
el Element The DOM element the plugin was initialized with.
options Object The options the instance was initialized with.
chipsData Array Array of the current chips data.
hasAutocomplete Boolean If the chips has autocomplete enabled.
autocomplete Object Autocomplete instance, if any.