Frontile

Chip

Chips are compact, pill-shaped tokens — a filter that has been applied, a removable value in a multi-select field, an input-like token. The only part that responds to a click is the close button. For a status, a tag or a count with no close button, use a Badge .

Import

import { Chip } from 'frontile';

Usage

Chip
import { Chip } from 'frontile';

const noop = (): void => {};

<template>
  <Chip @onClose={{noop}} @closeButtonTitle='Remove Chip'>Chip</Chip>
</template>

Chip Variants

solid is a filled chip, outline draws the color as a border on the page background, and soft is a tinted surface with color-tinted text.

Solid
Outline
Soft
import { Chip } from 'frontile';

<template>
  <div class='flex flex-wrap items-center gap-3'>
    <Chip @variant='solid'>Solid</Chip>
    <Chip @variant='outline'>Outline</Chip>
    <Chip @variant='soft'>Soft</Chip>
  </div>
</template>

Chip Colors

Every color is available in every variant. The label on each row is the @variant value; the chip labels are the @color values.

@variant='solid'

neutral
primary
secondary
tertiary
success
warning
danger

@variant='outline'

neutral
primary
secondary
tertiary
success
warning
danger

@variant='soft'

neutral
primary
secondary
tertiary
success
warning
danger
import { Chip } from 'frontile';
import { array } from '@ember/helper';

const colors = [
  'neutral',
  'primary',
  'secondary',
  'tertiary',
  'success',
  'warning',
  'danger'
];

<template>
  <div class='flex flex-col gap-6'>
    {{#each (array 'solid' 'outline' 'soft') as |variant|}}
      <div>
        <p class='font-code text-code-sm text-neutral-strong mb-2'>
          @variant='{{variant}}'
        </p>
        <div class='flex flex-wrap items-center gap-3'>
          {{#each colors as |color|}}
            <Chip @variant={{variant}} @color={{color}}>
              {{color}}
            </Chip>
          {{/each}}
        </div>
      </div>
    {{/each}}
  </div>
</template>

Chip Sizes

Chip xs
Chip sm
Chip md
Chip lg
import { Chip } from 'frontile';

<template>
  <div class='flex flex-wrap items-center gap-3'>
    <Chip @size='xs'>Chip xs</Chip>
    <Chip @size='sm'>Chip sm</Chip>
    <Chip @size='md'>Chip md</Chip>
    <Chip @size='lg'>Chip lg</Chip>
  </div>
</template>

xs is for dense layouts such as table cells, list rows, and chips inside a form field. It uses the same text size as sm and gets smaller by dropping height and padding, because 12px is about the smallest a label stays readable. Its close button is small. If removing the chip is the main action, use sm or larger.

The dot and the close button scale with the chip, so a size change does not need any other adjustment.

@variant='solid'

xs
sm
md
lg

@variant='outline'

xs
sm
md
lg

@variant='soft'

xs
sm
md
lg
import { Chip } from 'frontile';
import { array } from '@ember/helper';

const noop = (): void => {};

<template>
  <div class='flex flex-col gap-6'>
    {{#each (array 'solid' 'outline' 'soft') as |variant|}}
      <div>
        <p class='font-code text-code-sm text-neutral-strong mb-2'>
          @variant='{{variant}}'
        </p>
        <div class='flex flex-wrap items-center gap-3'>
          {{#each (array 'xs' 'sm' 'md' 'lg') as |size|}}
            <Chip
              @variant={{variant}}
              @color='primary'
              @size={{size}}
              @withDot={{true}}
              @onClose={{noop}}
              @closeButtonTitle='Remove {{size}} chip'
            >
              {{size}}
            </Chip>
          {{/each}}
        </div>
      </div>
    {{/each}}
  </div>
</template>

Chip vs Badge

A Chip is a pill for a value the user can remove, and its close button is the only part that responds to a click. A chip that is not removable is a Badge : use Badge for a status, a count or any other label that does not respond to the user.

The variant, color and size demos on this page omit the close button only to isolate the property being shown.

A Chip is always a pill. Its close button shows a pointer cursor, since it is the one part of a Chip that responds to a click.

Chip with Dots

@withDot adds a small color-tinted dot before the content — useful when the chip stands for a status and the color needs to read at a glance.

@variant='solid'

neutral
primary
secondary
tertiary
success
warning
danger

@variant='outline'

neutral
primary
secondary
tertiary
success
warning
danger

@variant='soft'

neutral
primary
secondary
tertiary
success
warning
danger
import { Chip } from 'frontile';
import { array } from '@ember/helper';

const colors = [
  'neutral',
  'primary',
  'secondary',
  'tertiary',
  'success',
  'warning',
  'danger'
];

<template>
  <div class='flex flex-col gap-6'>
    {{#each (array 'solid' 'outline' 'soft') as |variant|}}
      <div>
        <p class='font-code text-code-sm text-neutral-strong mb-2'>
          @variant='{{variant}}'
        </p>
        <div class='flex flex-wrap items-center gap-3'>
          {{#each colors as |color|}}
            <Chip @variant={{variant}} @color={{color}} @withDot={{true}}>
              {{color}}
            </Chip>
          {{/each}}
        </div>
      </div>
    {{/each}}
  </div>
</template>

Close Button

Passing @onClose makes the close button visible.

@variant='solid'

neutral
primary
secondary
tertiary
success
warning
danger

@variant='outline'

neutral
primary
secondary
tertiary
success
warning
danger

@variant='soft'

neutral
primary
secondary
tertiary
success
warning
danger
import { Chip } from 'frontile';
import { array, concat } from '@ember/helper';

const colors = [
  'neutral',
  'primary',
  'secondary',
  'tertiary',
  'success',
  'warning',
  'danger'
];

const noop = (): void => {};

<template>
  <div class='flex flex-col gap-6'>
    {{#each (array 'solid' 'outline' 'soft') as |variant|}}
      <div>
        <p class='font-code text-code-sm text-neutral-strong mb-2'>
          @variant='{{variant}}'
        </p>
        <div class='flex flex-wrap items-center gap-3'>
          {{#each colors as |color|}}
            <Chip
              @variant={{variant}}
              @color={{color}}
              @onClose={{noop}}
              @closeButtonTitle={{concat 'Remove ' color}}
            >
              {{color}}
            </Chip>
          {{/each}}
        </div>
      </div>
    {{/each}}
  </div>
</template>

Dot and Close Button Together

@variant='solid'

neutral
primary
secondary
tertiary
success
warning
danger

@variant='outline'

neutral
primary
secondary
tertiary
success
warning
danger

@variant='soft'

neutral
primary
secondary
tertiary
success
warning
danger
import { Chip } from 'frontile';
import { array, concat } from '@ember/helper';

const colors = [
  'neutral',
  'primary',
  'secondary',
  'tertiary',
  'success',
  'warning',
  'danger'
];

const noop = (): void => {};

<template>
  <div class='flex flex-col gap-6'>
    {{#each (array 'solid' 'outline' 'soft') as |variant|}}
      <div>
        <p class='font-code text-code-sm text-neutral-strong mb-2'>
          @variant='{{variant}}'
        </p>
        <div class='flex flex-wrap items-center gap-3'>
          {{#each colors as |color|}}
            <Chip
              @variant={{variant}}
              @color={{color}}
              @withDot={{true}}
              @onClose={{noop}}
              @closeButtonTitle={{concat 'Remove ' color}}
            >
              {{color}}
            </Chip>
          {{/each}}
        </div>
      </div>
    {{/each}}
  </div>
</template>

Naming the close button

Every close button is announced as "Close" unless you say otherwise, which does not tell anyone what is being removed. When several closable chips sit together — the usual case, since chips represent a set — give each one a @closeButtonTitle naming its own value:

Fiber
Metro
Wholesale
import Component from '@glimmer/component';
import { tracked } from '@glimmer/tracking';
import { concat, fn } from '@ember/helper';
import { Chip } from 'frontile';

export default class Example extends Component {
  @tracked filters = ['Fiber', 'Metro', 'Wholesale'];

  remove = (name: string): void => {
    this.filters = this.filters.filter((filter) => filter !== name);
  };

  <template>
    <div class='flex flex-wrap items-center gap-2'>
      {{#each this.filters as |filter|}}
        <Chip
          @variant='soft'
          @color='primary'
          @onClose={{fn this.remove filter}}
          @closeButtonTitle={{concat 'Remove ' filter}}
        >
          {{filter}}
        </Chip>
      {{else}}
        <p class='text-neutral'>All filters removed.</p>
      {{/each}}
    </div>
  </template>
}

Keeping the close button out of the tab order

@closeButtonTabIndex="-1" makes a chip's close button a pointer-only affordance. Reach for it when chips sit inside another control — a multi-select field, say — where each chip would otherwise cost a Tab stop before the control itself is reachable. Select does exactly this in chips mode. If you do it, you owe keyboard users another way to remove a chip (Select uses Backspace on the field); leaving them with no route at all is worse than the extra tab stops.

Disabled

@isDisabled dims the chip and disables its close button, so the value can no longer be removed.

@variant='solid'

neutral
primary
secondary
tertiary
success
warning
danger

@variant='outline'

neutral
primary
secondary
tertiary
success
warning
danger

@variant='soft'

neutral
primary
secondary
tertiary
success
warning
danger
import { Chip } from 'frontile';
import { array } from '@ember/helper';

const colors = [
  'neutral',
  'primary',
  'secondary',
  'tertiary',
  'success',
  'warning',
  'danger'
];

const noop = (): void => {};

<template>
  <div class='flex flex-col gap-6'>
    {{#each (array 'solid' 'outline' 'soft') as |variant|}}
      <div>
        <p class='font-code text-code-sm text-neutral-strong mb-2'>
          @variant='{{variant}}'
        </p>
        <div class='flex flex-wrap items-center gap-3'>
          {{#each colors as |color|}}
            <Chip
              @variant={{variant}}
              @color={{color}}
              @withDot={{true}}
              @onClose={{noop}}
              @isDisabled={{true}}
            >
              {{color}}
            </Chip>
          {{/each}}
        </div>
      </div>
    {{/each}}
  </div>
</template>

Customizing

You can also use TailwindCSS classes to customize even further.

Chip
import { Chip } from 'frontile';

<template>
  <Chip @variant='outline' @color='primary' @class='px-20 py-2 italic'>
    Chip
  </Chip>
</template>

The argument @class overrides and merges TailwindCSS class names, while the HTML attribute class just appends the class names passed in.

Accessibility

A Chip is a <div> holding text — it has no role of its own, because a chip is not one thing. What it means depends on what you are using it for, and that determines what you owe it:

  • Color and dots never carry meaning alone. @color='danger' reads as "failed" to a sighted user and as nothing at all to a screen reader, so keep the word in the content. For a plain status label, use a Badge .
  • As a removable value — with @onClose — the close button is the only interactive part. It is a real <button>, reached with Tab and activated with Enter or Space, and it needs a name that identifies the chip; see above.
  • As something clickable in its own right, a chip is the wrong element. Put a Button or a link inside it, or use a Button instead — attaching a click handler to the <div> leaves it unfocusable and unannounced.

When chips represent a set that changes, the container should say so, or removals happen silently for anyone not watching the screen. A role='list' wrapper gives the set a size and position; an aria-live region announces the change:

  • Design
  • Docs
  • Testing

import Component from '@glimmer/component';
import { tracked } from '@glimmer/tracking';
import { concat, fn } from '@ember/helper';
import { Chip } from 'frontile';

export default class Example extends Component {
  @tracked tags = ['Design', 'Docs', 'Testing'];
  @tracked announcement = '';

  remove = (name: string): void => {
    this.tags = this.tags.filter((tag) => tag !== name);
    this.announcement = `${name} removed. ${this.tags.length} remaining.`;
  };

  <template>
    <ul role='list' aria-label='Tags' class='flex flex-wrap items-center gap-2'>
      {{#each this.tags as |tag|}}
        <li>
          <Chip
            @variant='outline'
            @onClose={{fn this.remove tag}}
            @closeButtonTitle={{concat 'Remove ' tag}}
          >
            {{tag}}
          </Chip>
        </li>
      {{/each}}
    </ul>

    <p aria-live='polite' class='text-neutral mt-3'>{{this.announcement}}</p>
  </template>
}

@isDisabled does not hide the chip from assistive technology — the text is still read, which is usually what you want for a value that is present but locked.

API

Chip

Element: HTMLDivElement

Arguments

Name Type Default Description
appearance
Deprecated
enum -

Deprecated. Use `variant`. `default` is now `solid`, `outlined` is `outline`, and `faded` is `soft`.

class string - Custom class name, it will override the default ones using Tailwind Merge library.
closeButtonTabIndex enum undefined (the close button is a normal tab stop)

tabindex for the close button.

Set to -1 when chips sit inside another control (a multi-select field, say) and the close button should stay a pointer affordance: every chip would otherwise cost a Tab stop before the control itself is reached. Whoever does this owes keyboard users another way to remove a chip.

closeButtonTitle string 'Close' The accessible name of the close button. Every close button would otherwise be announced as just "Close", which does not say what is being removed — worth setting when several chips sit together.
color enum - The color of the chip.
intent
Deprecated
enum -

Deprecated. Use `color`. `default` is now `neutral`.

isDisabled boolean false Dims the chip and disables its close button, if any.
onClose function - Function to be called when clicking on the close button. If you pass this argument, the close button will be visible.
radius
Deprecated
enum -

Deprecated. Ignored. Chip is always a pill; use `Badge` for a squared label.

size enum 'md' The size of the chip
variant enum 'solid' The chip variant.
withDot boolean false Adds a dot before the content, colored by @color. On the solid variant the dot takes the chip's text color, since the chip's background is already the chip's color.

Blocks

Name Type Default Description
default * Array -
Released under MIT License - Created by Josemar Luedke