Skip to content

Latest commit

 

History

History
108 lines (73 loc) · 2.95 KB

README.md

File metadata and controls

108 lines (73 loc) · 2.95 KB
Raw

Svelte Material UI - Chips

Chips are used to show discrete information, filter options, input tags, or actions.

Installation

npm install --save-dev @smui/chips

Demo

See it in action.

See the demo code.

Whoa There, These Docs are Outdated

The latest SMUI v3 had a lot of changes, and these docs haven't been caught up yet. You should check out the demo page's code to see the latest usage.

Basic Usage

Input Chips:

<Textfield bind:value={newTag} label="Tag" />
<Button
  on:click={addTag}
  disabled={newTag === '' || tags.indexOf(newTag) !== -1}
>
  <Label>Add</Label>
</Button>

<Set chips={tags} let:chip input>
  <Chip><Text>{chip}</Text><Icon class="material-icons">cancel</Icon></Chip>
</Set>

<script>
  import Chip, { Set, Icon, Text } from '@smui/chips';
  import Textfield from '@smui/textfield';
  import Button, { Label } from '@smui/button';

  let tags = [];
  let newTag = '';

  function addTag() {
    tags.push(newTag);
    tags = tags;
    newTag = '';
  }
</script>

Exports

(default)

A chip.

Props / Defaults

  • use: [] - An array of Svelte actions and/or arrays of an action and its options.
  • class: '' - A CSS class string.
  • ripple: true - Whether to implement a ripple for when the component is interacted with.
  • touch: false - The chip will have a larger touch target.
  • selected: false - Whether the chip is selected. (You should only use this if you don't pass selected to the chip set.)
  • shouldRemoveOnTrailingIconClick: true - Whether the chip should be removed upon clicking the trailing icon.

Events

  • MDCChip:interaction
  • MDCChip:selection
  • MDCChip:removal
  • MDCChip:trailingIconInteraction
  • MDCChip:navigation

Set

A set of chips. Chips should only be added onto the end of the set's chip array.

Props / Defaults

  • use: [] - An array of Svelte actions and/or arrays of an action and its options.
  • class: '' - A CSS class string.
  • chips [] - An array containing the chips. New chips should only be pushed onto the end of this array.
  • key chip => chip - A function used to get the key of the chip. Chip sets that have removable chips should always provide unique keys.
  • selected null - The currently selected chip or chips.
  • choice false - Whether to present the chips as a set of choices, allowing one to be chosen.
  • filter false - Whether to present the chips as a set of options, allowing any number to be chosen.
  • input false - Whether to present the chips as a set of values, allowing them to be removed.

Text

A text label.

todo...

Icon

A graphic icon.

todo...

More Information

See Chips in the Material design spec.

See Chips in MDC-Web for information about the upstream library's architecture.