Tag Field

A tag field lets users add labels to items for categorization. They can type, select from a list, or create new tags as needed.

Basic

The basic tag field lets you add tags to your content.

Laravel

Installation

To install, run the following command:

Anatomy

Import the components and use them as shown below, adapting the structure to fit each component.

import { TagField } from 'ui'
 
const selectedItems = useListData({
  initialItems: [
    {
      id: 1,
      name: "Laravel"
    },
    // ...
  ]
})
 
<TagField className="max-w-xs" label="Add tag" list={selectedItems} />

Max Entry

Set a limit on the number of tags that can be added.

You can only add 3 tags

Variant

By default, the tag field component uses the primary variant. But it has a secondary variant as well.

Laravel
Inertia.js
React
Tailwind CSS

Shape

Customize the tag field’s shape using the shape prop.

Laravel
Inertia.js

Controlled

The tag field is controlled by default. This example demonstrates how to access its value.

Ferrari
You can add multiple tags
[{"id":1,"name":"Ferrari"}]

Disabled

Disable the tag field by using the isDisabled prop.

Props

Here's the fixed table:

PropTypeDefaultDescription
labelstring-The label of the tag field
descriptionstring-The description of the tag field
placeholderstring-The placeholder of the tag field
maxnumber-The maximum number of tags that can be added
classNamestring-The class name of the tag field
namestring-The name of the tag field
listListData-The list of tags
onItemInserted(tag: TagItemProps) => void-The callback function when a tag is inserted
onItemCleared(tag: TagItemProps) => void-The callback function when a tag is cleared
isDisabledboolean-The disabled state of the tag field
intentstring'primary''primary', 'secondary'
shapestring'square''square', 'circle'