Tag input
Tag input where Enter or comma adds a chip and Backspace twice removes the last; duplicates shake and removed tags break into pixels.
Playground
Change a prop and the component re-renders. Props marked remounts set an initial value, so the component starts over.
<PxTags
label="Topics"
defaultValue={[
"design",
"pixels"
]}
suggestions={[
"motion",
"accessibility",
"forms"
]}
max={6}
placeholder="Add a tag and press Enter"
/>Installation
pnpm dlx shadcn@latest add @lumesec/px-tagsFirst timeRegister the @lumesec registry once, or install by URL
Adds @lumesec to your components.json:
pnpm dlx shadcn@latest registry add @lumesec=https://elements.lumesec.ai/r/{name}.jsonOr skip the setup and install by URL:
npx shadcn@latest add https://elements.lumesec.ai/r/px-tags.jsonUsage
import { PxTags } from "@/components/lumesec/px-tags";
export function Example() {
return (
<PxTags
name="topics"
label="Topics"
defaultValue={["design", "pixels"]}
suggestions={["motion", "accessibility", "forms"]}
max={6}
/>
);
}Behaviour
Enter or comma adds a tag, Backspace on an empty field marks the last one and a second press removes it. Removed tags break into pixels; duplicates shake instead of being added.
API reference
Props
Also accepts every prop of <div> (React.ComponentProps<"div">), spread onto the root element.
valueTypereadonly string[]Controlled tags. Use with onValueChange.
defaultValueTypereadonly string[]Default[]Initial tags when uncontrolled. A form reset restores them.
labelTypeReact.ReactNodeDefault"Tags"Label above the field, linked to the input.
placeholderTypestringDefault"Add a tag and press Enter"Placeholder of the input.
suggestionsTypereadonly string[]Default[]Shown as "+ name" buttons under the field; clicking one adds it.
maxTypenumberDefault8Maximum number of tags. Adding beyond it shakes the field and shows a message.
nameTypestringForm field name; the tags submit joined with commas.
disabledTypebooleanDefaultfalseDims the field and disables the input, the remove buttons and the suggestion buttons.
onValueChangeType(value: string[]) => voidCalled when tags are added (Enter, comma, a suggestion or a paste) or removed. A paste that adds several tags reports once.
Ref
ref points at the root HTMLDivElement.
Keyboard
| Keys | Action |
|---|---|
| Enter / , | Add the typed text as a tag. |
| Backspace (empty field) | First press marks the last tag; a second press removes it. |
| Any other key | Clears the mark. |
Accessibility
- A native
<input>labelled by a<label htmlFor>. - Each chip's remove button has an
aria-labelof "Remove" followed by the tag. - The counter ("2 of 6 tags") and the limit message describe the input (
aria-describedby) and are in anaria-live="polite"region. - A tag marked by the first Backspace is announced through a visually hidden
role="status", for example "design selected. Press Backspace again to remove it." - Chips are plain elements without a list role. Removing one returns focus to the input. The pixel canvas is
aria-hidden. - With
name, a hidden input submits the tags joined with commas. There is no validity check;maxis enforced by refusing new tags. Form reset restoresdefaultValue, clears the typed text and callsonValueChangewhen that changes the tags. - Reduced motion: chips appear without scaling in or a pixel spray, removed chips vanish without breaking into pixels and the duplicate and limit shakes are skipped.
Theming
Styled with Tailwind classes on your shadcn theme tokens, so light and dark follow your theme. The accent comes from --lumesec. See Theming.
This component reads --foreground, --muted-foreground, --card, --border, --muted, --lumesec, --lumesec-shine and --destructive.
Notes
- Tags are trimmed and inner whitespace is collapsed; case-insensitive duplicates are refused.
- Pasting text that contains commas adds each part as a tag.
- A long tag is truncated with an ellipsis inside its chip.
- The pixel canvas reaches 20 px past the field on the left, top and bottom but not on the right, so it never widens the page.
Related
Was this page helpful?