sourcesense/MaterialChipsInput

Implementation of Material Design Chips component for Android

Download

Step 1. Add the JitPack repository to your build file

Add it in your root settings.gradle at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url 'https://jitpack.io' }
		}
	}

Add it in your settings.gradle.kts at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url = uri("https://jitpack.io") }
		}
	}

Add to pom.xml

	<repositories>
		<repository>
		    <id>jitpack.io</id>
		    <url>https://jitpack.io</url>
		</repository>
	</repositories>

Add it in your build.sbt at the end of resolvers:

 
    resolvers += "jitpack" at "https://jitpack.io"

Add it in your project.clj at the end of repositories:

 
    :repositories [["jitpack" "https://jitpack.io"]]

Step 2. Add the dependency

	dependencies {
		implementation 'com.github.EcoMind:MaterialChipsInput:2.1.2'
	}
	dependencies {
		implementation("com.github.EcoMind:MaterialChipsInput:2.1.2")
	}
	<dependency>
	    <groupId>com.github.EcoMind</groupId>
	    <artifactId>MaterialChipsInput</artifactId>
	    <version>2.1.2</version>
	</dependency>

                            
    libraryDependencies += "com.github.EcoMind" % "MaterialChipsInput" % "2.1.2"
        
        

                            
    :dependencies [[com.github.EcoMind/MaterialChipsInput "2.1.2"]]

Readme

MaterialChipsInput

Implementation of Material Design Chips component for Android. The library provides two views : ChipsInput and ChipView.

Release

<img src="https://github.com/pchmn/MaterialChipsInput/blob/master/docs/demo2.gif" alt="Demo" height="600px"/>

Demo

Download sample-v1.0.8.apk

Setup

To use this library your minSdkVersion must be >= 15.

In your project level build.gradle :

allprojects {
    repositories {
        ...
        maven { url "https://jitpack.io" }
    }
}

In your app level build.gradle :

dependencies {
    compile 'com.github.pchmn:MaterialChipsInput:1.0.8'
}

<br><br>

ChipsInput

This view implements the Material Design Contact chips component.

It is composed of a collection of chips (ChipView) and an input (EditText). Touching a chip open a full detailed view (if non disable). The GIF above describes the behavior of the ChipsInput view.

But everything is configurable (optional avatar icon, optional full detailed view, ...) so you can use the ChipsInput view for non contact chips.

Basic Usage

XML

Use the ChipsInput view in your layout with default options :

<com.pchmn.materialchips.ChipsInput
        android:id="@+id/chips_input"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        app:hint="Enter a name" />

You can also customize it (see all attributes) :

<com.pchmn.materialchips.ChipsInput
        android:id="@+id/chips_input"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        app:hint="Enter a name"
        app:hintColor="@color/customColor"
        app:textColor="@color/customColor"
        app:maxRows="3"
        app:chip_labelColor="@color/customColor"
        app:chip_hasAvatarIcon="true"
        app:chip_backgroundColor="@color/customColor"
        app:chip_deletable="false"
        app:chip_deleteIconColor="@color/customColor"
        app:chip_detailed_textColor="@color/customColor"
        app:chip_detailed_backgroundColor="@color/customColor"
        app:chip_detailed_deleteIconColor="@color/customColor"
        app:filterable_list_backgroundColor="@color/customColor"
        app:filterable_list_textColor="@color/customColor" />

Suggestions

You can pass a List<? extends ChipInterface> object, which represents your suggestions, to the ChipsInput view, so it will work as a MultiAutoCompleteTextView :

1. Create a class that implements ChipInterface (or use directly the Chip class included in the library) :
public class ContactChip implements ChipInterface {
    ...
}
2. Then in your activity, or anything else, build your suggestion list of ContactChip (or Chip) and pass it to the ChipsInput view :
// get ChipsInput view
ChipsInput chipsInput = (ChipsInput) findViewById(R.id.chips_input);

// build the ContactChip list
List<ContactChip> contactList = new ArrayList<>();
contactList.add(new ContactChip()); 
...

// pass the ContactChip list
chipsInput.setFilterableList(contactList);

Get the selected list

When you want you can get the current list of chips selected by the user :

// get the list
List<ContactChip> contactsSelected = (List<ContactChip>) chipsInput.getSelectedChipList();

That's it, there is nothing more to do. <br><br>

Advanced Usage

ChipsListener

The ChipsInput view provides a listener to interact with the input :

chipsInput.addChipsListener(new ChipsInput.ChipsListener() {
            @Override
            public void onChipAdded(ChipInterface chip, int newSize) {
                // chip added
                // newSize is the size of the updated selected chip list
            }

            @Override
            public void onChipRemoved(ChipInterface chip, int newSize) {
                // chip removed
                // newSize is the size of the updated selected chip list
            }

            @Override
            public void onTextChanged(CharSequence text) {
                // text changed
            }
        });

Add and remove chips manually

You don't have to pass a List<? extends ChipInterface> to the ChipsInput view and you can do the trick manually. Thanks to the ChipsListener you can be notified when the user is typing and do your own work.

ChipsInput chipsInput = (ChipsInput) findViewById(R.id.chips_input);
Add a chip

There are multiple implementations :

chipsInput.addChip(ChipInterface chip);
// or
chipsInput.addChip(Object id, Drawable icon, String label, String info);
// or
chipsInput.addChip(Drawable icon, String label, String info);
// or
chipsInput.addChip(Object id, Uri iconUri, String label, String info);
// or
chipsInput.addChip(Uri iconUri, String label, String info);
// or
chipsInput.addChip(String label, String info);
Remove a chip

There are multiple implementations :

chipsInput.removeChip(ChipInterface chip);
// or
chipsInput.removeChipById(Object id);
// or
chipsInput.removeChipByLabel(String label);
// or
chipsInput.removeChipByInfo(String info);

After you added or removed a chip the ChipsListener will be triggered.

Get the selected list

When you want you can get the current list of chips selected by the user :

// get the list
List<ChipInterface> contactsSelected = chipsInput.getSelectedChipList();

ChipsInput attributes

Attribute | Type | Description | Default --- | --- | --- | --- app:hint | string | Hint of the input when there is no chip | null app:hintColor | color | Hint color | android default app:textColor | color | Text color when user types | android default app:maxRows | int | Max rows of chips | 2 app:chip_labelColor | color | Label color of the chips | android default app:chip_hasAvatarIcon | boolean | Whether the chips have avatar icon or not | true app:chip_deletable | boolean | Whether the chips are deletable (delete icon) or not | false app:chip_deleteIconColor | color | Delete icon color of the chips | white/black app:chip_backgroundColor | color | Background color of the chips | grey app:showChipDetailed | boolean | Whether to show full detailed view or not when touching a chip | true app:chip_detailed_textColor | color | Full detailed view text color | white/balck app:chip_detailed_backgroundColor | color | Background color of the full detailed view | colorAccent app:chip_detailed_deleteIconColor | color | Delete icon color of the full detailed view | white/black app:filterable_list_backgroundColor | color | Background color of the filterable list of suggestions | white app:filterable_list_textColor | color | Text color of the filterable list of suggestions | black

<br><br>

ChipView

This view implements the chip component according to the Material Design guidelines with configurable options (background color, text color, ...).

<img src="https://github.com/pchmn/MaterialChipsInput/blob/master/docs/chips-examples.png" alt="Chips examples" width="50%"/>

Usage

<com.pchmn.materialchips.ChipView
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            app:label="Chip 1" />
            
<com.pchmn.materialchips.ChipView
                android:layout_width="wrap_content"
                android:layout_height="wrap_content"
                app:label="Chip 4"
                app:hasAvatarIcon="true" />

<com.pchmn.materialchips.ChipView
                android:layout_width="wrap_content"
                android:layout_height="wrap_content"
                app:label="Chip 6"
                app:labelColor="@android:color/white"
                app:avatarIcon="@drawable/avatar"
                app:backgroundColor="@android:color/holo_blue_light"
                app:deletable="true"
                app:deleteIconColor="@android:color/white" />

ChipView attributes

Attribute | Type | Description | Default --- | --- | --- | --- app:label | string | Label of the chip | null app:labelColor | color | Label color of the chip | android default app:hasAvatarIcon | boolean | Whether the chip has avatar icon or not | false app:avatarIcon | drawable | Avatar icon resource | null app:deletable | boolean | Whether the chip is deletable (delete icon) or not | false app:deleteIconColor | color | Delete icon color of the chip | grey app:backgroundColor | color | Background color of the chip | grey

Listeners

ChipView chip = (ChipView) findViewById(R.id.chip_view);

On chip click listener :

chip.setOnChipClicked(new View.OnClickListener() {
    @Override
    public void onClick(View view) {
        // handle click    
    }
});

On delete button click listener :

chip.setOnDeleteClicked(new View.OnClickListener() {
    @Override
    public void onClick(View view) {
        // handle click     
    }
});

<br><br>

Sample

A sample app with some use cases of the library is available on this link

You can also download the sample APK here

Credits

License

Copyright 2017 pchmn

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.