IChipProps
interface
Data Display
Props for <OrigamChip>. A compact interactive element used for tags, filters, selections and actions. Supports close button, drag, filter mode, link navigation, group membership and full visual customisation.
TypeScript
Definition
The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.
Inheritance
Extends
Parent interfaces this one inherits from. Their properties are available on every consumer of this interface.
API
Properties
Every property declared by this interface, with its type, optionality and default.
- closableboolean
- Show a close/dismiss button inside the chip.
- closeIconTIcon
- Icon for the close button. Defaults to the DS close/cross glyph.
- closeLabelstring
- Accessible label for the close button (aria-label).
- draggableboolean
- Makes the chip draggable (sets the draggable HTML attribute).
- filterboolean
- Activates filter mode — renders a check/filter icon when the chip is selected.
- filterIconTIcon
- Override the icon shown in filter mode.
- labelboolean
- Apply the label shape (square corners on one side) instead of the default pill/rounded shape.
- linkboolean
- Force link behaviour even when no href/to is provided.
- pillboolean
- Apply maximum border-radius to produce a fully rounded pill shape.
- textstring
- Text content rendered inside the chip (alternative to default slot).
- modelValueboolean
- v-model binding for the chip's active/selected state. Controls visibility when closable.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Closable pill chip with custom icon