@wix/design-system
Version:
@wix/design-system
53 lines (50 loc) • 2 kB
Markdown
### disabled
- type: boolean
- description: Specifies whether the tag should be disabled
### id
- type: string
- description: Assigns an unique identifier for the tag
### onClick
- type: (id: string, event: MouseEvent<HTMLButtonElement, MouseEvent>) => void
- description: Defines a callback function which is called whenever a tag component is clicked.
It passes the id property as the first parameter and a mouse event as second parameter.
### onRemove
- type: (id: string) => void
- description: Defines a callback function which is called when removing the tag. It passes the id property as a parameter.
### removable
- type: boolean
- description: Specifies whether the tag is removable or not. If enabled, a small clickable X icon is displayed on the right side of a component.
- default: true
### size
- type: "tiny" | "small" | "medium" | "large"
- description: Controls the size of the component
### skin
- type: "standard" | "light" | "neutral" | "error" | "warning" | "dark" | "success" | "lightOutlined"
- description: Sets the skin of the component
### theme
- type: "standard" | "light" | "neutral" | "error" | "warning" | "dark" | "success" | "lightOutlined"
- description: use `skin` instead
- deprecated
### thumb
- type: ReactElement
- description: Displays a thumbnail at the front of a tag label. Usually contain icons or `<Avatar/>`.
### maxWidth
- type: string | number | string & {}
- description: Sets a maximum tag width
### ellipsisProps
- type: EllipsisCommonProps
- description: Ellipsis props
### className
- type: string
- description: Specifies a CSS class name to be appended to the component’s root element.
- internal
### dataHook
- type: string
- description: Applies a data-hook HTML attribute that can be used in the tests
### children
- type: ReactNode
- description: Sets the text of the tag
### closeButtonRef
- type: null | (instance: HTMLButtonElement | null) => void | RefObject<HTMLButtonElement>
- description: Ref to the close button element
- internal