Chip
Material 3 assist, suggestion, filter, and input chips with action and selection semantics kept distinct.
Material chips help users perform compact actions, act on contextual suggestions, filter content, or represent input-like selections. Choose the chip family by intent first; do not treat the visual pill shape as one generic interaction pattern.
import {
AssistChip,
FilterChip,
InputChip,
SuggestionChip,
} from '@m3-ui/ui';
<AssistChip>Set reminder</AssistChip>
<SuggestionChip>Nearby restaurants</SuggestionChip>
<FilterChip defaultSelected>Available now</FilterChip>
<InputChip defaultSelected>Design</InputChip>Choosing a chip family
| Family | Use for | Public components | Selection model |
|---|---|---|---|
| Assist | Contextual actions that help complete a task | AssistChip, ElevatedAssistChip | Action button |
| Suggestion | Dynamically suggested actions or responses | SuggestionChip, ElevatedSuggestionChip | Action button |
| Filter | Including/excluding a category or filter criterion | FilterChip, ElevatedFilterChip | Selectable |
| Input | Representing a compact selected input/value in the current public contract | InputChip | Selectable |
Assist and suggestion chips activate an action. Filter and input chips preserve selected state. Keep those semantics separate even when the families share similar container geometry.
Use buttons when the action needs stronger emphasis or more room. Use checkboxes/radio controls when conventional form selection is clearer than a compact chip set.
Assist chips
Assist chips are compact actions related to the current task or content. The elevated form adds separation where the surrounding surface requires it; it does not change the action semantics.
<AssistChip leadingIcon={<CalendarIcon />}>
Add to calendar
</AssistChip>The public implementation keeps the chip itself as the button. Leading/trailing visual slots are presentation and should not become nested interactive controls.
Suggestion chips
Suggestion chips surface a likely next action or response. They remain ordinary actions rather than persistent selected options.
<SuggestionChip icon={<RestaurantIcon />}>
Nearby restaurants
</SuggestionChip>Use suggestion chips only when the application can explain why the option is relevant in context. Ranking, recommendation logic, and network/data ownership remain application concerns rather than chip behavior.
Filter chips
Filter chips represent selected/unselected criteria. They support controlled or uncontrolled selection through the public React Aria-backed selection contract.
<FilterChip
isSelected={availableNow}
onChange={setAvailableNow}
>
Available now
</FilterChip>Selected state is persistent application state, not a transient press effect. Use the elevated filter variant only for the Material surface treatment it provides; do not use elevation to imply a different selection model.
Input chips
InputChip currently uses the selectable-chip contract. It can represent a compact value or input-like selection using avatar, leadingIcon, and trailingIcon visual slots.
<InputChip defaultSelected avatar={<Avatar initials="AK" />}>
Ada Kim
</InputChip>The current trailingIcon is not a second dismiss/remove button. It is presentation-only and hidden from accessibility; the chip remains the single interactive control. Do not document or style that slot as an independently actionable remove affordance until the public API actually exposes one.
Anatomy
Depending on family, a chip can include a container, label, leading icon/avatar, optional trailing visual, selected indicator treatment, and state layer. Canonical spacing, icon/avatar geometry, shape, typography, colors, and elevation remain owned by generated component tokens and runtime implementation.
Keep labels concise. Icons should reinforce the label rather than carry the only accessible meaning.
Variants and expressive shape behavior
Assist, suggestion, and filter families expose standard/elevated public components rather than one generic visual variant prop. This mirrors the component family boundary directly in the import surface.
Action chips accept the documented shape customization. Selectable chips also expose the audited shapes contract for expressive selected/interaction shape behavior where supported.
Do not copy radius, elevation, icon-size, or state-layer values into page/application CSS. Select the public semantic option and let canonical tokens own the concrete Material values.
States
All chip families expose normal interaction states such as hover, focus, press, disabled, and Material state-layer presentation. Filter/input chips additionally expose selected/unselected state.
Disabled state means the action or selection is unavailable; do not use it only to create a muted visual style. Selected state on filter/input chips must be driven by the component selection props rather than custom classes.
Accessibility
Assist and suggestion chips use button semantics through React Aria. Filter and input chips use selectable checkbox-style semantics in the current web implementation. Keyboard, pointer, disabled, focus-visible, and selection exposure follow those underlying control models.
Visible label text should normally provide the accessible name. If a chip is icon-only or its visual content does not name the action/selection, supply an accessible name on the chip itself. Decorative icons/avatar/trailing visuals should remain non-interactive so the chip exposes one coherent control.
Do not nest a button, link, or other interactive element inside a chip unless a future public API explicitly defines that composition.
API reference
AssistChip
AssistChip(props: ActionChipProps): JSX.ElementProps
| Name | Type | Default | Description | Origin |
|---|---|---|---|---|
avatar | ReactNode | — | — | @m3-ui/ui |
children | ChildrenOrFunction<ButtonRenderProps> | — | — | @m3-ui/ui |
leadingIcon | ReactNode | — | — | @m3-ui/ui |
shape | ChipShapeValue | undefined | — | — | @m3-ui/ui |
trailingIcon | ReactNode | — | — | @m3-ui/ui |
Inherited React / web props (111)
| Name | Type | Default | Description | Origin |
|---|---|---|---|---|
aria-controls | string | undefined | — | Identifies the element (or elements) whose contents or presence are controlled by the current element. | react-aria |
aria-current | boolean | "true" | "false" | "page" | "step" | "location" | "date" | "time" | undefined | — | Indicates whether this element represents the current item within a container or set of related elements. | react-aria |
aria-describedby | string | undefined | — | Identifies the element (or elements) that describes the object. | @react-types/shared |
aria-details | string | undefined | — | Identifies the element (or elements) that provide a detailed, extended description for the object. | @react-types/shared |
aria-disabled | boolean | "true" | "false" | undefined | — | Indicates whether the element is disabled to users of assistive technology. | react-aria |
aria-expanded | boolean | "true" | "false" | undefined | — | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. | react-aria |
aria-haspopup | boolean | "true" | "false" | "dialog" | "grid" | "listbox" | "menu" | "tree" | undefined | — | Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. | react-aria |
aria-label | string | undefined | — | Defines a string value that labels the current element. | @react-types/shared |
aria-labelledby | string | undefined | — | Identifies the element (or elements) that labels the current element. | @react-types/shared |
aria-pressed | boolean | "true" | "false" | "mixed" | undefined | — | Indicates the current "pressed" state of toggle buttons. | react-aria |
autoFocus | boolean | undefined | — | Whether the element should receive focus on render. | @react-types/shared |
className | ClassNameOrFunction<ButtonRenderProps> | undefined | 'react-aria-Button' | The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the element. A function may be provided to compute the class based on component state. | react-aria-components |
dir | string | undefined | — | — | @react-types/shared |
excludeFromTabOrder | boolean | undefined | — | Whether to exclude the element from the sequential tab order. If true, the element will not be focusable via the keyboard by tabbing. This should be avoided except in rare scenarios where an alternative means of accessing the element or its functionality via the keyboard is available. | @react-types/shared |
form | string | undefined | — | The `<form>` element to associate the button with. The value of this attribute must be the id of a `<form>` in the same document. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#form). | react-aria |
formAction | string | ((formData: FormData) => void | Promise<void>) | undefined | — | The URL that processes the information submitted by the button. Overrides the action attribute of the button's form owner. | react-aria |
formEncType | string | undefined | — | Indicates how to encode the form data that is submitted. | react-aria |
formMethod | string | undefined | — | Indicates the HTTP method used to submit the form. | react-aria |
formNoValidate | boolean | undefined | — | Indicates that the form is not to be validated when it is submitted. | react-aria |
formTarget | string | undefined | — | Overrides the target attribute of the button's form owner. | react-aria |
hidden | boolean | undefined | — | — | @react-types/shared |
id | string | undefined | — | The element's unique identifier. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/id). | @react-types/shared |
inert | boolean | undefined | — | — | @react-types/shared |
isDisabled | boolean | undefined | — | Whether the button is disabled. | react-aria |
isPending | boolean | undefined | — | Whether the button is in a pending state. This disables press and hover events while retaining focusability, and announces the pending state to screen readers. | react-aria-components |
lang | string | undefined | — | — | @react-types/shared |
name | string | undefined | — | Submitted as a pair with the button's value as part of the form data. | react-aria |
onAnimationEnd | AnimationEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onAnimationEndCapture | AnimationEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onAnimationIteration | AnimationEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onAnimationIterationCapture | AnimationEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onAnimationStart | AnimationEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onAnimationStartCapture | AnimationEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onAuxClick | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onAuxClickCapture | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onBlur | ((e: FocusEvent<Element, Element>) => void) | undefined | — | Handler that is called when the element loses focus. | @react-types/shared |
onClick | ((e: MouseEvent<FocusableElement>) => void) | undefined | — | **Not recommended – use `onPress` instead.** `onClick` is an alias for `onPress` provided for compatibility with other libraries. `onPress` provides additional event details for non-mouse interactions. | @react-types/shared |
onClickCapture | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onContextMenu | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onContextMenuCapture | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onDoubleClick | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onDoubleClickCapture | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onFocus | ((e: FocusEvent<Element, Element>) => void) | undefined | — | Handler that is called when the element receives focus. | @react-types/shared |
onFocusChange | ((isFocused: boolean) => void) | undefined | — | Handler that is called when the element's focus status changes. | @react-types/shared |
onGotPointerCapture | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onGotPointerCaptureCapture | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onHoverChange | ((isHovering: boolean) => void) | undefined | — | Handler that is called when the hover state changes. | @react-types/shared |
onHoverEnd | ((e: HoverEvent) => void) | undefined | — | Handler that is called when a hover interaction ends. | @react-types/shared |
onHoverStart | ((e: HoverEvent) => void) | undefined | — | Handler that is called when a hover interaction starts. | @react-types/shared |
onKeyDown | ((e: KeyboardEvent) => void) | undefined | — | Handler that is called when a key is pressed. | @react-types/shared |
onKeyUp | ((e: KeyboardEvent) => void) | undefined | — | Handler that is called when a key is released. | @react-types/shared |
onLostPointerCapture | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onLostPointerCaptureCapture | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onMouseDown | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onMouseDownCapture | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onMouseEnter | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onMouseLeave | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onMouseMove | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onMouseMoveCapture | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onMouseOut | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onMouseOutCapture | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onMouseOver | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onMouseOverCapture | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onMouseUp | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onMouseUpCapture | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onPointerCancel | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onPointerCancelCapture | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onPointerDown | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onPointerDownCapture | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onPointerEnter | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onPointerLeave | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onPointerMove | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onPointerMoveCapture | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onPointerOut | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onPointerOutCapture | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onPointerOver | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onPointerOverCapture | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onPointerUp | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onPointerUpCapture | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onPress | ((e: PressEvent) => void) | undefined | — | Handler that is called when the press is released over the target. | @react-types/shared |
onPressChange | ((isPressed: boolean) => void) | undefined | — | Handler that is called when the press state changes. | @react-types/shared |
onPressEnd | ((e: PressEvent) => void) | undefined | — | Handler that is called when a press interaction ends, either over the target or when the pointer leaves the target. | @react-types/shared |
onPressStart | ((e: PressEvent) => void) | undefined | — | Handler that is called when a press interaction starts. | @react-types/shared |
onPressUp | ((e: PressEvent) => void) | undefined | — | Handler that is called when a press is released over the target, regardless of whether it started on the target or not. | @react-types/shared |
onScroll | UIEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onScrollCapture | UIEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTouchCancel | TouchEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTouchCancelCapture | TouchEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTouchEnd | TouchEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTouchEndCapture | TouchEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTouchMove | TouchEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTouchMoveCapture | TouchEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTouchStart | TouchEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTouchStartCapture | TouchEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTransitionCancel | TransitionEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTransitionCancelCapture | TransitionEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTransitionEnd | TransitionEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTransitionEndCapture | TransitionEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTransitionRun | TransitionEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTransitionRunCapture | TransitionEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTransitionStart | TransitionEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTransitionStartCapture | TransitionEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onWheel | WheelEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onWheelCapture | WheelEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
preventFocusOnPress | boolean | undefined | — | Whether to prevent focus from moving to the button when pressing it. Caution, this can make the button inaccessible and should only be used when alternative keyboard interaction is provided, such as ComboBox's MenuTrigger or a NumberField's increment/decrement control. | react-aria |
render | DOMRenderFunction<"button", ButtonRenderProps> | undefined | — | Overrides the default DOM element with a custom render function. This allows rendering existing components with built-in styles and behaviors such as router links, animation libraries, and pre-styled components. Requirements: - You must render the expected element type (e.g. if `<button>` is expected, you cannot render an `<a>`). - Only a single root DOM element can be rendered (no fragments). - You must pass through props and ref to the underlying DOM element, merging with your own prop as appropriate. | react-aria-components |
slot | string | null | undefined | — | A slot name for the component. Slots allow the component to receive props from a parent component. An explicit `null` value indicates that the local props completely override all props received from a parent. | react-aria-components |
style | StyleOrFunction<ButtonRenderProps> | undefined | — | The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the element. A function may be provided to compute the style based on component state. | react-aria-components |
translate | "yes" | "no" | undefined | — | — | @react-types/shared |
type | "button" | "submit" | "reset" | undefined | 'button' | The behavior of the button when used in an HTML form. | react-aria |
value | string | undefined | — | The value associated with the button's name when it's submitted with the form data. | react-aria |
Source: packages/ui/src/components/Chip/Chip.tsx:252
ElevatedAssistChip
ElevatedAssistChip(props: ActionChipProps): JSX.ElementProps
| Name | Type | Default | Description | Origin |
|---|---|---|---|---|
avatar | ReactNode | — | — | @m3-ui/ui |
children | ChildrenOrFunction<ButtonRenderProps> | — | — | @m3-ui/ui |
leadingIcon | ReactNode | — | — | @m3-ui/ui |
shape | ChipShapeValue | undefined | — | — | @m3-ui/ui |
trailingIcon | ReactNode | — | — | @m3-ui/ui |
Inherited React / web props (111)
| Name | Type | Default | Description | Origin |
|---|---|---|---|---|
aria-controls | string | undefined | — | Identifies the element (or elements) whose contents or presence are controlled by the current element. | react-aria |
aria-current | boolean | "true" | "false" | "page" | "step" | "location" | "date" | "time" | undefined | — | Indicates whether this element represents the current item within a container or set of related elements. | react-aria |
aria-describedby | string | undefined | — | Identifies the element (or elements) that describes the object. | @react-types/shared |
aria-details | string | undefined | — | Identifies the element (or elements) that provide a detailed, extended description for the object. | @react-types/shared |
aria-disabled | boolean | "true" | "false" | undefined | — | Indicates whether the element is disabled to users of assistive technology. | react-aria |
aria-expanded | boolean | "true" | "false" | undefined | — | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. | react-aria |
aria-haspopup | boolean | "true" | "false" | "dialog" | "grid" | "listbox" | "menu" | "tree" | undefined | — | Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. | react-aria |
aria-label | string | undefined | — | Defines a string value that labels the current element. | @react-types/shared |
aria-labelledby | string | undefined | — | Identifies the element (or elements) that labels the current element. | @react-types/shared |
aria-pressed | boolean | "true" | "false" | "mixed" | undefined | — | Indicates the current "pressed" state of toggle buttons. | react-aria |
autoFocus | boolean | undefined | — | Whether the element should receive focus on render. | @react-types/shared |
className | ClassNameOrFunction<ButtonRenderProps> | undefined | 'react-aria-Button' | The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the element. A function may be provided to compute the class based on component state. | react-aria-components |
dir | string | undefined | — | — | @react-types/shared |
excludeFromTabOrder | boolean | undefined | — | Whether to exclude the element from the sequential tab order. If true, the element will not be focusable via the keyboard by tabbing. This should be avoided except in rare scenarios where an alternative means of accessing the element or its functionality via the keyboard is available. | @react-types/shared |
form | string | undefined | — | The `<form>` element to associate the button with. The value of this attribute must be the id of a `<form>` in the same document. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#form). | react-aria |
formAction | string | ((formData: FormData) => void | Promise<void>) | undefined | — | The URL that processes the information submitted by the button. Overrides the action attribute of the button's form owner. | react-aria |
formEncType | string | undefined | — | Indicates how to encode the form data that is submitted. | react-aria |
formMethod | string | undefined | — | Indicates the HTTP method used to submit the form. | react-aria |
formNoValidate | boolean | undefined | — | Indicates that the form is not to be validated when it is submitted. | react-aria |
formTarget | string | undefined | — | Overrides the target attribute of the button's form owner. | react-aria |
hidden | boolean | undefined | — | — | @react-types/shared |
id | string | undefined | — | The element's unique identifier. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/id). | @react-types/shared |
inert | boolean | undefined | — | — | @react-types/shared |
isDisabled | boolean | undefined | — | Whether the button is disabled. | react-aria |
isPending | boolean | undefined | — | Whether the button is in a pending state. This disables press and hover events while retaining focusability, and announces the pending state to screen readers. | react-aria-components |
lang | string | undefined | — | — | @react-types/shared |
name | string | undefined | — | Submitted as a pair with the button's value as part of the form data. | react-aria |
onAnimationEnd | AnimationEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onAnimationEndCapture | AnimationEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onAnimationIteration | AnimationEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onAnimationIterationCapture | AnimationEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onAnimationStart | AnimationEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onAnimationStartCapture | AnimationEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onAuxClick | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onAuxClickCapture | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onBlur | ((e: FocusEvent<Element, Element>) => void) | undefined | — | Handler that is called when the element loses focus. | @react-types/shared |
onClick | ((e: MouseEvent<FocusableElement>) => void) | undefined | — | **Not recommended – use `onPress` instead.** `onClick` is an alias for `onPress` provided for compatibility with other libraries. `onPress` provides additional event details for non-mouse interactions. | @react-types/shared |
onClickCapture | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onContextMenu | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onContextMenuCapture | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onDoubleClick | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onDoubleClickCapture | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onFocus | ((e: FocusEvent<Element, Element>) => void) | undefined | — | Handler that is called when the element receives focus. | @react-types/shared |
onFocusChange | ((isFocused: boolean) => void) | undefined | — | Handler that is called when the element's focus status changes. | @react-types/shared |
onGotPointerCapture | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onGotPointerCaptureCapture | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onHoverChange | ((isHovering: boolean) => void) | undefined | — | Handler that is called when the hover state changes. | @react-types/shared |
onHoverEnd | ((e: HoverEvent) => void) | undefined | — | Handler that is called when a hover interaction ends. | @react-types/shared |
onHoverStart | ((e: HoverEvent) => void) | undefined | — | Handler that is called when a hover interaction starts. | @react-types/shared |
onKeyDown | ((e: KeyboardEvent) => void) | undefined | — | Handler that is called when a key is pressed. | @react-types/shared |
onKeyUp | ((e: KeyboardEvent) => void) | undefined | — | Handler that is called when a key is released. | @react-types/shared |
onLostPointerCapture | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onLostPointerCaptureCapture | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onMouseDown | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onMouseDownCapture | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onMouseEnter | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onMouseLeave | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onMouseMove | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onMouseMoveCapture | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onMouseOut | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onMouseOutCapture | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onMouseOver | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onMouseOverCapture | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onMouseUp | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onMouseUpCapture | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onPointerCancel | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onPointerCancelCapture | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onPointerDown | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onPointerDownCapture | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onPointerEnter | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onPointerLeave | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onPointerMove | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onPointerMoveCapture | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onPointerOut | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onPointerOutCapture | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onPointerOver | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onPointerOverCapture | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onPointerUp | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onPointerUpCapture | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onPress | ((e: PressEvent) => void) | undefined | — | Handler that is called when the press is released over the target. | @react-types/shared |
onPressChange | ((isPressed: boolean) => void) | undefined | — | Handler that is called when the press state changes. | @react-types/shared |
onPressEnd | ((e: PressEvent) => void) | undefined | — | Handler that is called when a press interaction ends, either over the target or when the pointer leaves the target. | @react-types/shared |
onPressStart | ((e: PressEvent) => void) | undefined | — | Handler that is called when a press interaction starts. | @react-types/shared |
onPressUp | ((e: PressEvent) => void) | undefined | — | Handler that is called when a press is released over the target, regardless of whether it started on the target or not. | @react-types/shared |
onScroll | UIEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onScrollCapture | UIEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTouchCancel | TouchEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTouchCancelCapture | TouchEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTouchEnd | TouchEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTouchEndCapture | TouchEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTouchMove | TouchEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTouchMoveCapture | TouchEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTouchStart | TouchEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTouchStartCapture | TouchEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTransitionCancel | TransitionEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTransitionCancelCapture | TransitionEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTransitionEnd | TransitionEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTransitionEndCapture | TransitionEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTransitionRun | TransitionEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTransitionRunCapture | TransitionEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTransitionStart | TransitionEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTransitionStartCapture | TransitionEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onWheel | WheelEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onWheelCapture | WheelEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
preventFocusOnPress | boolean | undefined | — | Whether to prevent focus from moving to the button when pressing it. Caution, this can make the button inaccessible and should only be used when alternative keyboard interaction is provided, such as ComboBox's MenuTrigger or a NumberField's increment/decrement control. | react-aria |
render | DOMRenderFunction<"button", ButtonRenderProps> | undefined | — | Overrides the default DOM element with a custom render function. This allows rendering existing components with built-in styles and behaviors such as router links, animation libraries, and pre-styled components. Requirements: - You must render the expected element type (e.g. if `<button>` is expected, you cannot render an `<a>`). - Only a single root DOM element can be rendered (no fragments). - You must pass through props and ref to the underlying DOM element, merging with your own prop as appropriate. | react-aria-components |
slot | string | null | undefined | — | A slot name for the component. Slots allow the component to receive props from a parent component. An explicit `null` value indicates that the local props completely override all props received from a parent. | react-aria-components |
style | StyleOrFunction<ButtonRenderProps> | undefined | — | The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the element. A function may be provided to compute the style based on component state. | react-aria-components |
translate | "yes" | "no" | undefined | — | — | @react-types/shared |
type | "button" | "submit" | "reset" | undefined | 'button' | The behavior of the button when used in an HTML form. | react-aria |
value | string | undefined | — | The value associated with the button's name when it's submitted with the form data. | react-aria |
Source: packages/ui/src/components/Chip/Chip.tsx:256
SuggestionChip
SuggestionChip({ icon, ...props }: SuggestionChipProps): JSX.ElementProps
| Name | Type | Default | Description | Origin |
|---|---|---|---|---|
avatar | ReactNode | — | — | @m3-ui/ui |
children | ChildrenOrFunction<ButtonRenderProps> | — | — | @m3-ui/ui |
icon | ReactNode | — | — | @m3-ui/ui |
shape | ChipShapeValue | undefined | — | — | @m3-ui/ui |
Inherited React / web props (111)
| Name | Type | Default | Description | Origin |
|---|---|---|---|---|
aria-controls | string | undefined | — | Identifies the element (or elements) whose contents or presence are controlled by the current element. | react-aria |
aria-current | boolean | "true" | "false" | "page" | "step" | "location" | "date" | "time" | undefined | — | Indicates whether this element represents the current item within a container or set of related elements. | react-aria |
aria-describedby | string | undefined | — | Identifies the element (or elements) that describes the object. | @react-types/shared |
aria-details | string | undefined | — | Identifies the element (or elements) that provide a detailed, extended description for the object. | @react-types/shared |
aria-disabled | boolean | "true" | "false" | undefined | — | Indicates whether the element is disabled to users of assistive technology. | react-aria |
aria-expanded | boolean | "true" | "false" | undefined | — | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. | react-aria |
aria-haspopup | boolean | "true" | "false" | "dialog" | "grid" | "listbox" | "menu" | "tree" | undefined | — | Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. | react-aria |
aria-label | string | undefined | — | Defines a string value that labels the current element. | @react-types/shared |
aria-labelledby | string | undefined | — | Identifies the element (or elements) that labels the current element. | @react-types/shared |
aria-pressed | boolean | "true" | "false" | "mixed" | undefined | — | Indicates the current "pressed" state of toggle buttons. | react-aria |
autoFocus | boolean | undefined | — | Whether the element should receive focus on render. | @react-types/shared |
className | ClassNameOrFunction<ButtonRenderProps> | undefined | 'react-aria-Button' | The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the element. A function may be provided to compute the class based on component state. | react-aria-components |
dir | string | undefined | — | — | @react-types/shared |
excludeFromTabOrder | boolean | undefined | — | Whether to exclude the element from the sequential tab order. If true, the element will not be focusable via the keyboard by tabbing. This should be avoided except in rare scenarios where an alternative means of accessing the element or its functionality via the keyboard is available. | @react-types/shared |
form | string | undefined | — | The `<form>` element to associate the button with. The value of this attribute must be the id of a `<form>` in the same document. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#form). | react-aria |
formAction | string | ((formData: FormData) => void | Promise<void>) | undefined | — | The URL that processes the information submitted by the button. Overrides the action attribute of the button's form owner. | react-aria |
formEncType | string | undefined | — | Indicates how to encode the form data that is submitted. | react-aria |
formMethod | string | undefined | — | Indicates the HTTP method used to submit the form. | react-aria |
formNoValidate | boolean | undefined | — | Indicates that the form is not to be validated when it is submitted. | react-aria |
formTarget | string | undefined | — | Overrides the target attribute of the button's form owner. | react-aria |
hidden | boolean | undefined | — | — | @react-types/shared |
id | string | undefined | — | The element's unique identifier. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/id). | @react-types/shared |
inert | boolean | undefined | — | — | @react-types/shared |
isDisabled | boolean | undefined | — | Whether the button is disabled. | react-aria |
isPending | boolean | undefined | — | Whether the button is in a pending state. This disables press and hover events while retaining focusability, and announces the pending state to screen readers. | react-aria-components |
lang | string | undefined | — | — | @react-types/shared |
name | string | undefined | — | Submitted as a pair with the button's value as part of the form data. | react-aria |
onAnimationEnd | AnimationEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onAnimationEndCapture | AnimationEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onAnimationIteration | AnimationEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onAnimationIterationCapture | AnimationEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onAnimationStart | AnimationEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onAnimationStartCapture | AnimationEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onAuxClick | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onAuxClickCapture | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onBlur | ((e: FocusEvent<Element, Element>) => void) | undefined | — | Handler that is called when the element loses focus. | @react-types/shared |
onClick | ((e: MouseEvent<FocusableElement>) => void) | undefined | — | **Not recommended – use `onPress` instead.** `onClick` is an alias for `onPress` provided for compatibility with other libraries. `onPress` provides additional event details for non-mouse interactions. | @react-types/shared |
onClickCapture | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onContextMenu | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onContextMenuCapture | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onDoubleClick | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onDoubleClickCapture | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onFocus | ((e: FocusEvent<Element, Element>) => void) | undefined | — | Handler that is called when the element receives focus. | @react-types/shared |
onFocusChange | ((isFocused: boolean) => void) | undefined | — | Handler that is called when the element's focus status changes. | @react-types/shared |
onGotPointerCapture | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onGotPointerCaptureCapture | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onHoverChange | ((isHovering: boolean) => void) | undefined | — | Handler that is called when the hover state changes. | @react-types/shared |
onHoverEnd | ((e: HoverEvent) => void) | undefined | — | Handler that is called when a hover interaction ends. | @react-types/shared |
onHoverStart | ((e: HoverEvent) => void) | undefined | — | Handler that is called when a hover interaction starts. | @react-types/shared |
onKeyDown | ((e: KeyboardEvent) => void) | undefined | — | Handler that is called when a key is pressed. | @react-types/shared |
onKeyUp | ((e: KeyboardEvent) => void) | undefined | — | Handler that is called when a key is released. | @react-types/shared |
onLostPointerCapture | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onLostPointerCaptureCapture | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onMouseDown | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onMouseDownCapture | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onMouseEnter | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onMouseLeave | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onMouseMove | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onMouseMoveCapture | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onMouseOut | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onMouseOutCapture | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onMouseOver | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onMouseOverCapture | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onMouseUp | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onMouseUpCapture | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onPointerCancel | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onPointerCancelCapture | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onPointerDown | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onPointerDownCapture | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onPointerEnter | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onPointerLeave | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onPointerMove | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onPointerMoveCapture | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onPointerOut | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onPointerOutCapture | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onPointerOver | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onPointerOverCapture | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onPointerUp | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onPointerUpCapture | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onPress | ((e: PressEvent) => void) | undefined | — | Handler that is called when the press is released over the target. | @react-types/shared |
onPressChange | ((isPressed: boolean) => void) | undefined | — | Handler that is called when the press state changes. | @react-types/shared |
onPressEnd | ((e: PressEvent) => void) | undefined | — | Handler that is called when a press interaction ends, either over the target or when the pointer leaves the target. | @react-types/shared |
onPressStart | ((e: PressEvent) => void) | undefined | — | Handler that is called when a press interaction starts. | @react-types/shared |
onPressUp | ((e: PressEvent) => void) | undefined | — | Handler that is called when a press is released over the target, regardless of whether it started on the target or not. | @react-types/shared |
onScroll | UIEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onScrollCapture | UIEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTouchCancel | TouchEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTouchCancelCapture | TouchEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTouchEnd | TouchEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTouchEndCapture | TouchEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTouchMove | TouchEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTouchMoveCapture | TouchEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTouchStart | TouchEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTouchStartCapture | TouchEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTransitionCancel | TransitionEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTransitionCancelCapture | TransitionEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTransitionEnd | TransitionEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTransitionEndCapture | TransitionEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTransitionRun | TransitionEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTransitionRunCapture | TransitionEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTransitionStart | TransitionEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTransitionStartCapture | TransitionEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onWheel | WheelEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onWheelCapture | WheelEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
preventFocusOnPress | boolean | undefined | — | Whether to prevent focus from moving to the button when pressing it. Caution, this can make the button inaccessible and should only be used when alternative keyboard interaction is provided, such as ComboBox's MenuTrigger or a NumberField's increment/decrement control. | react-aria |
render | DOMRenderFunction<"button", ButtonRenderProps> | undefined | — | Overrides the default DOM element with a custom render function. This allows rendering existing components with built-in styles and behaviors such as router links, animation libraries, and pre-styled components. Requirements: - You must render the expected element type (e.g. if `<button>` is expected, you cannot render an `<a>`). - Only a single root DOM element can be rendered (no fragments). - You must pass through props and ref to the underlying DOM element, merging with your own prop as appropriate. | react-aria-components |
slot | string | null | undefined | — | A slot name for the component. Slots allow the component to receive props from a parent component. An explicit `null` value indicates that the local props completely override all props received from a parent. | react-aria-components |
style | StyleOrFunction<ButtonRenderProps> | undefined | — | The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the element. A function may be provided to compute the style based on component state. | react-aria-components |
translate | "yes" | "no" | undefined | — | — | @react-types/shared |
type | "button" | "submit" | "reset" | undefined | 'button' | The behavior of the button when used in an HTML form. | react-aria |
value | string | undefined | — | The value associated with the button's name when it's submitted with the form data. | react-aria |
Source: packages/ui/src/components/Chip/Chip.tsx:260
ElevatedSuggestionChip
ElevatedSuggestionChip({ icon, ...props }: SuggestionChipProps): JSX.ElementProps
| Name | Type | Default | Description | Origin |
|---|---|---|---|---|
avatar | ReactNode | — | — | @m3-ui/ui |
children | ChildrenOrFunction<ButtonRenderProps> | — | — | @m3-ui/ui |
icon | ReactNode | — | — | @m3-ui/ui |
shape | ChipShapeValue | undefined | — | — | @m3-ui/ui |
Inherited React / web props (111)
| Name | Type | Default | Description | Origin |
|---|---|---|---|---|
aria-controls | string | undefined | — | Identifies the element (or elements) whose contents or presence are controlled by the current element. | react-aria |
aria-current | boolean | "true" | "false" | "page" | "step" | "location" | "date" | "time" | undefined | — | Indicates whether this element represents the current item within a container or set of related elements. | react-aria |
aria-describedby | string | undefined | — | Identifies the element (or elements) that describes the object. | @react-types/shared |
aria-details | string | undefined | — | Identifies the element (or elements) that provide a detailed, extended description for the object. | @react-types/shared |
aria-disabled | boolean | "true" | "false" | undefined | — | Indicates whether the element is disabled to users of assistive technology. | react-aria |
aria-expanded | boolean | "true" | "false" | undefined | — | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. | react-aria |
aria-haspopup | boolean | "true" | "false" | "dialog" | "grid" | "listbox" | "menu" | "tree" | undefined | — | Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. | react-aria |
aria-label | string | undefined | — | Defines a string value that labels the current element. | @react-types/shared |
aria-labelledby | string | undefined | — | Identifies the element (or elements) that labels the current element. | @react-types/shared |
aria-pressed | boolean | "true" | "false" | "mixed" | undefined | — | Indicates the current "pressed" state of toggle buttons. | react-aria |
autoFocus | boolean | undefined | — | Whether the element should receive focus on render. | @react-types/shared |
className | ClassNameOrFunction<ButtonRenderProps> | undefined | 'react-aria-Button' | The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the element. A function may be provided to compute the class based on component state. | react-aria-components |
dir | string | undefined | — | — | @react-types/shared |
excludeFromTabOrder | boolean | undefined | — | Whether to exclude the element from the sequential tab order. If true, the element will not be focusable via the keyboard by tabbing. This should be avoided except in rare scenarios where an alternative means of accessing the element or its functionality via the keyboard is available. | @react-types/shared |
form | string | undefined | — | The `<form>` element to associate the button with. The value of this attribute must be the id of a `<form>` in the same document. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#form). | react-aria |
formAction | string | ((formData: FormData) => void | Promise<void>) | undefined | — | The URL that processes the information submitted by the button. Overrides the action attribute of the button's form owner. | react-aria |
formEncType | string | undefined | — | Indicates how to encode the form data that is submitted. | react-aria |
formMethod | string | undefined | — | Indicates the HTTP method used to submit the form. | react-aria |
formNoValidate | boolean | undefined | — | Indicates that the form is not to be validated when it is submitted. | react-aria |
formTarget | string | undefined | — | Overrides the target attribute of the button's form owner. | react-aria |
hidden | boolean | undefined | — | — | @react-types/shared |
id | string | undefined | — | The element's unique identifier. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/id). | @react-types/shared |
inert | boolean | undefined | — | — | @react-types/shared |
isDisabled | boolean | undefined | — | Whether the button is disabled. | react-aria |
isPending | boolean | undefined | — | Whether the button is in a pending state. This disables press and hover events while retaining focusability, and announces the pending state to screen readers. | react-aria-components |
lang | string | undefined | — | — | @react-types/shared |
name | string | undefined | — | Submitted as a pair with the button's value as part of the form data. | react-aria |
onAnimationEnd | AnimationEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onAnimationEndCapture | AnimationEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onAnimationIteration | AnimationEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onAnimationIterationCapture | AnimationEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onAnimationStart | AnimationEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onAnimationStartCapture | AnimationEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onAuxClick | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onAuxClickCapture | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onBlur | ((e: FocusEvent<Element, Element>) => void) | undefined | — | Handler that is called when the element loses focus. | @react-types/shared |
onClick | ((e: MouseEvent<FocusableElement>) => void) | undefined | — | **Not recommended – use `onPress` instead.** `onClick` is an alias for `onPress` provided for compatibility with other libraries. `onPress` provides additional event details for non-mouse interactions. | @react-types/shared |
onClickCapture | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onContextMenu | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onContextMenuCapture | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onDoubleClick | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onDoubleClickCapture | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onFocus | ((e: FocusEvent<Element, Element>) => void) | undefined | — | Handler that is called when the element receives focus. | @react-types/shared |
onFocusChange | ((isFocused: boolean) => void) | undefined | — | Handler that is called when the element's focus status changes. | @react-types/shared |
onGotPointerCapture | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onGotPointerCaptureCapture | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onHoverChange | ((isHovering: boolean) => void) | undefined | — | Handler that is called when the hover state changes. | @react-types/shared |
onHoverEnd | ((e: HoverEvent) => void) | undefined | — | Handler that is called when a hover interaction ends. | @react-types/shared |
onHoverStart | ((e: HoverEvent) => void) | undefined | — | Handler that is called when a hover interaction starts. | @react-types/shared |
onKeyDown | ((e: KeyboardEvent) => void) | undefined | — | Handler that is called when a key is pressed. | @react-types/shared |
onKeyUp | ((e: KeyboardEvent) => void) | undefined | — | Handler that is called when a key is released. | @react-types/shared |
onLostPointerCapture | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onLostPointerCaptureCapture | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onMouseDown | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onMouseDownCapture | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onMouseEnter | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onMouseLeave | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onMouseMove | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onMouseMoveCapture | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onMouseOut | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onMouseOutCapture | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onMouseOver | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onMouseOverCapture | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onMouseUp | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onMouseUpCapture | MouseEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onPointerCancel | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onPointerCancelCapture | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onPointerDown | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onPointerDownCapture | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onPointerEnter | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onPointerLeave | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onPointerMove | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onPointerMoveCapture | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onPointerOut | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onPointerOutCapture | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onPointerOver | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onPointerOverCapture | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onPointerUp | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onPointerUpCapture | PointerEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onPress | ((e: PressEvent) => void) | undefined | — | Handler that is called when the press is released over the target. | @react-types/shared |
onPressChange | ((isPressed: boolean) => void) | undefined | — | Handler that is called when the press state changes. | @react-types/shared |
onPressEnd | ((e: PressEvent) => void) | undefined | — | Handler that is called when a press interaction ends, either over the target or when the pointer leaves the target. | @react-types/shared |
onPressStart | ((e: PressEvent) => void) | undefined | — | Handler that is called when a press interaction starts. | @react-types/shared |
onPressUp | ((e: PressEvent) => void) | undefined | — | Handler that is called when a press is released over the target, regardless of whether it started on the target or not. | @react-types/shared |
onScroll | UIEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onScrollCapture | UIEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTouchCancel | TouchEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTouchCancelCapture | TouchEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTouchEnd | TouchEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTouchEndCapture | TouchEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTouchMove | TouchEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTouchMoveCapture | TouchEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTouchStart | TouchEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTouchStartCapture | TouchEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTransitionCancel | TransitionEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTransitionCancelCapture | TransitionEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTransitionEnd | TransitionEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTransitionEndCapture | TransitionEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTransitionRun | TransitionEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTransitionRunCapture | TransitionEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTransitionStart | TransitionEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onTransitionStartCapture | TransitionEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onWheel | WheelEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
onWheelCapture | WheelEventHandler<HTMLButtonElement> | undefined | — | — | @react-types/shared |
preventFocusOnPress | boolean | undefined | — | Whether to prevent focus from moving to the button when pressing it. Caution, this can make the button inaccessible and should only be used when alternative keyboard interaction is provided, such as ComboBox's MenuTrigger or a NumberField's increment/decrement control. | react-aria |
render | DOMRenderFunction<"button", ButtonRenderProps> | undefined | — | Overrides the default DOM element with a custom render function. This allows rendering existing components with built-in styles and behaviors such as router links, animation libraries, and pre-styled components. Requirements: - You must render the expected element type (e.g. if `<button>` is expected, you cannot render an `<a>`). - Only a single root DOM element can be rendered (no fragments). - You must pass through props and ref to the underlying DOM element, merging with your own prop as appropriate. | react-aria-components |
slot | string | null | undefined | — | A slot name for the component. Slots allow the component to receive props from a parent component. An explicit `null` value indicates that the local props completely override all props received from a parent. | react-aria-components |
style | StyleOrFunction<ButtonRenderProps> | undefined | — | The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the element. A function may be provided to compute the style based on component state. | react-aria-components |
translate | "yes" | "no" | undefined | — | — | @react-types/shared |
type | "button" | "submit" | "reset" | undefined | 'button' | The behavior of the button when used in an HTML form. | react-aria |
value | string | undefined | — | The value associated with the button's name when it's submitted with the form data. | react-aria |
Source: packages/ui/src/components/Chip/Chip.tsx:264
FilterChip
FilterChip(props: SelectableChipProps): JSX.ElementProps
| Name | Type | Default | Description | Origin |
|---|---|---|---|---|
avatar | ReactNode | — | — | @m3-ui/ui |
children | ChildrenOrFunction<CheckboxRenderProps> | — | — | @m3-ui/ui |
leadingIcon | ReactNode | — | — | @m3-ui/ui |
shape | ChipShapeValue | undefined | — | — | @m3-ui/ui |
shapes | ChipShapes | undefined | — | — | @m3-ui/ui |
trailingIcon | ReactNode | — | — | @m3-ui/ui |
Inherited React / web props (109)
| Name | Type | Default | Description | Origin |
|---|---|---|---|---|
aria-controls | string | undefined | — | Identifies the element (or elements) whose contents or presence are controlled by the current element. | react-aria |
aria-describedby | string | undefined | — | Identifies the element (or elements) that describes the object. | @react-types/shared |
aria-details | string | undefined | — | Identifies the element (or elements) that provide a detailed, extended description for the object. | @react-types/shared |
aria-errormessage | string | undefined | — | Identifies the element that provides an error message for the object. | @react-types/shared |
aria-label | string | undefined | — | Defines a string value that labels the current element. | @react-types/shared |
aria-labelledby | string | undefined | — | Identifies the element (or elements) that labels the current element. | @react-types/shared |
autoFocus | boolean | undefined | — | Whether the element should receive focus on render. | @react-types/shared |
className | ClassNameOrFunction<CheckboxRenderProps> | undefined | 'react-aria-Checkbox' | The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the element. A function may be provided to compute the class based on component state. | react-aria-components |
defaultSelected | boolean | undefined | — | Whether the element should be selected (uncontrolled). | react-stately |
dir | string | undefined | — | — | @react-types/shared |
excludeFromTabOrder | boolean | undefined | — | Whether to exclude the element from the sequential tab order. If true, the element will not be focusable via the keyboard by tabbing. This should be avoided except in rare scenarios where an alternative means of accessing the element or its functionality via the keyboard is available. | @react-types/shared |
form | string | undefined | — | The `<form>` element to associate the input with. The value of this attribute must be the id of a `<form>` in the same document. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#form). | @react-types/shared |
hidden | boolean | undefined | — | — | @react-types/shared |
id | string | undefined | — | The element's unique identifier. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/id). | @react-types/shared |
inert | boolean | undefined | — | — | @react-types/shared |
inputRef | React.Ref<HTMLInputElement | null> | undefined | — | A ref for the HTML input element. | react-aria-components |
isDisabled | boolean | undefined | — | Whether the input is disabled. | @react-types/shared |
isIndeterminate | boolean | undefined | — | Indeterminism is presentational only. The indeterminate visual representation remains regardless of user interaction. | react-aria |
isInvalid | boolean | undefined | — | Whether the input value is invalid. | @react-types/shared |
isReadOnly | boolean | undefined | — | Whether the input can be selected but not changed by the user. | @react-types/shared |
isRequired | boolean | undefined | — | Whether user input is required on the input before form submission. | @react-types/shared |
isSelected | boolean | undefined | — | Whether the element should be selected (controlled). | react-stately |
lang | string | undefined | — | — | @react-types/shared |
name | string | undefined | — | The name of the input element, used when submitting an HTML form. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefname). | @react-types/shared |
onAnimationEnd | AnimationEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onAnimationEndCapture | AnimationEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onAnimationIteration | AnimationEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onAnimationIterationCapture | AnimationEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onAnimationStart | AnimationEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onAnimationStartCapture | AnimationEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onAuxClick | MouseEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onAuxClickCapture | MouseEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onBlur | ((e: FocusEvent<Element, Element>) => void) | undefined | — | Handler that is called when the element loses focus. | @react-types/shared |
onChange | ((isSelected: boolean) => void) | undefined | — | Handler that is called when the element's selection state changes. | react-stately |
onClick | ((e: MouseEvent<FocusableElement>) => void) | undefined | — | **Not recommended – use `onPress` instead.** `onClick` is an alias for `onPress` provided for compatibility with other libraries. `onPress` provides additional event details for non-mouse interactions. | @react-types/shared |
onClickCapture | MouseEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onContextMenu | MouseEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onContextMenuCapture | MouseEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onDoubleClick | MouseEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onDoubleClickCapture | MouseEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onFocus | ((e: FocusEvent<Element, Element>) => void) | undefined | — | Handler that is called when the element receives focus. | @react-types/shared |
onFocusChange | ((isFocused: boolean) => void) | undefined | — | Handler that is called when the element's focus status changes. | @react-types/shared |
onGotPointerCapture | PointerEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onGotPointerCaptureCapture | PointerEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onHoverChange | ((isHovering: boolean) => void) | undefined | — | Handler that is called when the hover state changes. | @react-types/shared |
onHoverEnd | ((e: HoverEvent) => void) | undefined | — | Handler that is called when a hover interaction ends. | @react-types/shared |
onHoverStart | ((e: HoverEvent) => void) | undefined | — | Handler that is called when a hover interaction starts. | @react-types/shared |
onKeyDown | ((e: KeyboardEvent) => void) | undefined | — | Handler that is called when a key is pressed. | @react-types/shared |
onKeyUp | ((e: KeyboardEvent) => void) | undefined | — | Handler that is called when a key is released. | @react-types/shared |
onLostPointerCapture | PointerEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onLostPointerCaptureCapture | PointerEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onMouseDown | MouseEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onMouseDownCapture | MouseEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onMouseEnter | MouseEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onMouseLeave | MouseEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onMouseMove | MouseEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onMouseMoveCapture | MouseEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onMouseOut | MouseEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onMouseOutCapture | MouseEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onMouseOver | MouseEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onMouseOverCapture | MouseEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onMouseUp | MouseEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onMouseUpCapture | MouseEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onPointerCancel | PointerEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onPointerCancelCapture | PointerEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onPointerDown | PointerEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onPointerDownCapture | PointerEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onPointerEnter | PointerEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onPointerLeave | PointerEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onPointerMove | PointerEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onPointerMoveCapture | PointerEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onPointerOut | PointerEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onPointerOutCapture | PointerEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onPointerOver | PointerEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onPointerOverCapture | PointerEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onPointerUp | PointerEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onPointerUpCapture | PointerEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onPress | ((e: PressEvent) => void) | undefined | — | Handler that is called when the press is released over the target. | @react-types/shared |
onPressChange | ((isPressed: boolean) => void) | undefined | — | Handler that is called when the press state changes. | @react-types/shared |
onPressEnd | ((e: PressEvent) => void) | undefined | — | Handler that is called when a press interaction ends, either over the target or when the pointer leaves the target. | @react-types/shared |
onPressStart | ((e: PressEvent) => void) | undefined | — | Handler that is called when a press interaction starts. | @react-types/shared |
onPressUp | ((e: PressEvent) => void) | undefined | — | Handler that is called when a press is released over the target, regardless of whether it started on the target or not. | @react-types/shared |
onScroll | UIEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onScrollCapture | UIEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onTouchCancel | TouchEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onTouchCancelCapture | TouchEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onTouchEnd | TouchEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onTouchEndCapture | TouchEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onTouchMove | TouchEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onTouchMoveCapture | TouchEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onTouchStart | TouchEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onTouchStartCapture | TouchEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onTransitionCancel | TransitionEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onTransitionCancelCapture | TransitionEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onTransitionEnd | TransitionEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onTransitionEndCapture | TransitionEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onTransitionRun | TransitionEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onTransitionRunCapture | TransitionEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onTransitionStart | TransitionEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onTransitionStartCapture | TransitionEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onWheel | WheelEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onWheelCapture | WheelEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
render | DOMRenderFunction<"label", CheckboxRenderProps> | undefined | — | Overrides the default DOM element with a custom render function. This allows rendering existing components with built-in styles and behaviors such as router links, animation libraries, and pre-styled components. Requirements: - You must render the expected element type (e.g. if `<button>` is expected, you cannot render an `<a>`). - Only a single root DOM element can be rendered (no fragments). - You must pass through props and ref to the underlying DOM element, merging with your own prop as appropriate. | react-aria-components |
slot | string | null | undefined | — | A slot name for the component. Slots allow the component to receive props from a parent component. An explicit `null` value indicates that the local props completely override all props received from a parent. | react-aria-components |
style | StyleOrFunction<CheckboxRenderProps> | undefined | — | The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the element. A function may be provided to compute the style based on component state. | react-aria-components |
translate | "yes" | "no" | undefined | — | — | @react-types/shared |
validate | ((value: boolean) => ValidationError | true | null | undefined) | undefined | — | A function that returns an error message if a given value is invalid. Validation errors are displayed to the user when the form is submitted if `validationBehavior="native"`. For realtime validation, use the `isInvalid` prop instead. | @react-types/shared |
validationBehavior | "native" | "aria" | undefined | 'native' | Whether to use native HTML form validation to prevent form submission when the value is missing or invalid, or mark the field as required or invalid via ARIA. | react-aria-components |
value | string | undefined | — | The value of the input element, used when submitting an HTML form. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefvalue). | react-stately |
Source: packages/ui/src/components/Chip/Chip.tsx:268
ElevatedFilterChip
ElevatedFilterChip(props: SelectableChipProps): JSX.ElementProps
| Name | Type | Default | Description | Origin |
|---|---|---|---|---|
avatar | ReactNode | — | — | @m3-ui/ui |
children | ChildrenOrFunction<CheckboxRenderProps> | — | — | @m3-ui/ui |
leadingIcon | ReactNode | — | — | @m3-ui/ui |
shape | ChipShapeValue | undefined | — | — | @m3-ui/ui |
shapes | ChipShapes | undefined | — | — | @m3-ui/ui |
trailingIcon | ReactNode | — | — | @m3-ui/ui |
Inherited React / web props (109)
| Name | Type | Default | Description | Origin |
|---|---|---|---|---|
aria-controls | string | undefined | — | Identifies the element (or elements) whose contents or presence are controlled by the current element. | react-aria |
aria-describedby | string | undefined | — | Identifies the element (or elements) that describes the object. | @react-types/shared |
aria-details | string | undefined | — | Identifies the element (or elements) that provide a detailed, extended description for the object. | @react-types/shared |
aria-errormessage | string | undefined | — | Identifies the element that provides an error message for the object. | @react-types/shared |
aria-label | string | undefined | — | Defines a string value that labels the current element. | @react-types/shared |
aria-labelledby | string | undefined | — | Identifies the element (or elements) that labels the current element. | @react-types/shared |
autoFocus | boolean | undefined | — | Whether the element should receive focus on render. | @react-types/shared |
className | ClassNameOrFunction<CheckboxRenderProps> | undefined | 'react-aria-Checkbox' | The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the element. A function may be provided to compute the class based on component state. | react-aria-components |
defaultSelected | boolean | undefined | — | Whether the element should be selected (uncontrolled). | react-stately |
dir | string | undefined | — | — | @react-types/shared |
excludeFromTabOrder | boolean | undefined | — | Whether to exclude the element from the sequential tab order. If true, the element will not be focusable via the keyboard by tabbing. This should be avoided except in rare scenarios where an alternative means of accessing the element or its functionality via the keyboard is available. | @react-types/shared |
form | string | undefined | — | The `<form>` element to associate the input with. The value of this attribute must be the id of a `<form>` in the same document. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#form). | @react-types/shared |
hidden | boolean | undefined | — | — | @react-types/shared |
id | string | undefined | — | The element's unique identifier. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/id). | @react-types/shared |
inert | boolean | undefined | — | — | @react-types/shared |
inputRef | React.Ref<HTMLInputElement | null> | undefined | — | A ref for the HTML input element. | react-aria-components |
isDisabled | boolean | undefined | — | Whether the input is disabled. | @react-types/shared |
isIndeterminate | boolean | undefined | — | Indeterminism is presentational only. The indeterminate visual representation remains regardless of user interaction. | react-aria |
isInvalid | boolean | undefined | — | Whether the input value is invalid. | @react-types/shared |
isReadOnly | boolean | undefined | — | Whether the input can be selected but not changed by the user. | @react-types/shared |
isRequired | boolean | undefined | — | Whether user input is required on the input before form submission. | @react-types/shared |
isSelected | boolean | undefined | — | Whether the element should be selected (controlled). | react-stately |
lang | string | undefined | — | — | @react-types/shared |
name | string | undefined | — | The name of the input element, used when submitting an HTML form. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefname). | @react-types/shared |
onAnimationEnd | AnimationEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onAnimationEndCapture | AnimationEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onAnimationIteration | AnimationEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onAnimationIterationCapture | AnimationEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onAnimationStart | AnimationEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onAnimationStartCapture | AnimationEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onAuxClick | MouseEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onAuxClickCapture | MouseEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onBlur | ((e: FocusEvent<Element, Element>) => void) | undefined | — | Handler that is called when the element loses focus. | @react-types/shared |
onChange | ((isSelected: boolean) => void) | undefined | — | Handler that is called when the element's selection state changes. | react-stately |
onClick | ((e: MouseEvent<FocusableElement>) => void) | undefined | — | **Not recommended – use `onPress` instead.** `onClick` is an alias for `onPress` provided for compatibility with other libraries. `onPress` provides additional event details for non-mouse interactions. | @react-types/shared |
onClickCapture | MouseEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onContextMenu | MouseEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onContextMenuCapture | MouseEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onDoubleClick | MouseEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onDoubleClickCapture | MouseEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onFocus | ((e: FocusEvent<Element, Element>) => void) | undefined | — | Handler that is called when the element receives focus. | @react-types/shared |
onFocusChange | ((isFocused: boolean) => void) | undefined | — | Handler that is called when the element's focus status changes. | @react-types/shared |
onGotPointerCapture | PointerEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onGotPointerCaptureCapture | PointerEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onHoverChange | ((isHovering: boolean) => void) | undefined | — | Handler that is called when the hover state changes. | @react-types/shared |
onHoverEnd | ((e: HoverEvent) => void) | undefined | — | Handler that is called when a hover interaction ends. | @react-types/shared |
onHoverStart | ((e: HoverEvent) => void) | undefined | — | Handler that is called when a hover interaction starts. | @react-types/shared |
onKeyDown | ((e: KeyboardEvent) => void) | undefined | — | Handler that is called when a key is pressed. | @react-types/shared |
onKeyUp | ((e: KeyboardEvent) => void) | undefined | — | Handler that is called when a key is released. | @react-types/shared |
onLostPointerCapture | PointerEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onLostPointerCaptureCapture | PointerEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onMouseDown | MouseEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onMouseDownCapture | MouseEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onMouseEnter | MouseEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onMouseLeave | MouseEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onMouseMove | MouseEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onMouseMoveCapture | MouseEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onMouseOut | MouseEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onMouseOutCapture | MouseEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onMouseOver | MouseEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onMouseOverCapture | MouseEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onMouseUp | MouseEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onMouseUpCapture | MouseEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onPointerCancel | PointerEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onPointerCancelCapture | PointerEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onPointerDown | PointerEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onPointerDownCapture | PointerEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onPointerEnter | PointerEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onPointerLeave | PointerEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onPointerMove | PointerEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onPointerMoveCapture | PointerEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onPointerOut | PointerEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onPointerOutCapture | PointerEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onPointerOver | PointerEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onPointerOverCapture | PointerEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onPointerUp | PointerEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onPointerUpCapture | PointerEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onPress | ((e: PressEvent) => void) | undefined | — | Handler that is called when the press is released over the target. | @react-types/shared |
onPressChange | ((isPressed: boolean) => void) | undefined | — | Handler that is called when the press state changes. | @react-types/shared |
onPressEnd | ((e: PressEvent) => void) | undefined | — | Handler that is called when a press interaction ends, either over the target or when the pointer leaves the target. | @react-types/shared |
onPressStart | ((e: PressEvent) => void) | undefined | — | Handler that is called when a press interaction starts. | @react-types/shared |
onPressUp | ((e: PressEvent) => void) | undefined | — | Handler that is called when a press is released over the target, regardless of whether it started on the target or not. | @react-types/shared |
onScroll | UIEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onScrollCapture | UIEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onTouchCancel | TouchEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onTouchCancelCapture | TouchEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onTouchEnd | TouchEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onTouchEndCapture | TouchEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onTouchMove | TouchEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onTouchMoveCapture | TouchEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onTouchStart | TouchEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onTouchStartCapture | TouchEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onTransitionCancel | TransitionEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onTransitionCancelCapture | TransitionEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onTransitionEnd | TransitionEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onTransitionEndCapture | TransitionEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onTransitionRun | TransitionEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onTransitionRunCapture | TransitionEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onTransitionStart | TransitionEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onTransitionStartCapture | TransitionEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onWheel | WheelEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onWheelCapture | WheelEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
render | DOMRenderFunction<"label", CheckboxRenderProps> | undefined | — | Overrides the default DOM element with a custom render function. This allows rendering existing components with built-in styles and behaviors such as router links, animation libraries, and pre-styled components. Requirements: - You must render the expected element type (e.g. if `<button>` is expected, you cannot render an `<a>`). - Only a single root DOM element can be rendered (no fragments). - You must pass through props and ref to the underlying DOM element, merging with your own prop as appropriate. | react-aria-components |
slot | string | null | undefined | — | A slot name for the component. Slots allow the component to receive props from a parent component. An explicit `null` value indicates that the local props completely override all props received from a parent. | react-aria-components |
style | StyleOrFunction<CheckboxRenderProps> | undefined | — | The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the element. A function may be provided to compute the style based on component state. | react-aria-components |
translate | "yes" | "no" | undefined | — | — | @react-types/shared |
validate | ((value: boolean) => ValidationError | true | null | undefined) | undefined | — | A function that returns an error message if a given value is invalid. Validation errors are displayed to the user when the form is submitted if `validationBehavior="native"`. For realtime validation, use the `isInvalid` prop instead. | @react-types/shared |
validationBehavior | "native" | "aria" | undefined | 'native' | Whether to use native HTML form validation to prevent form submission when the value is missing or invalid, or mark the field as required or invalid via ARIA. | react-aria-components |
value | string | undefined | — | The value of the input element, used when submitting an HTML form. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefvalue). | react-stately |
Source: packages/ui/src/components/Chip/Chip.tsx:272
InputChip
InputChip(props: InputChipProps): JSX.ElementProps
| Name | Type | Default | Description | Origin |
|---|---|---|---|---|
avatar | ReactNode | — | — | @m3-ui/ui |
children | ChildrenOrFunction<CheckboxRenderProps> | — | — | @m3-ui/ui |
leadingIcon | ReactNode | — | — | @m3-ui/ui |
shape | ChipShapeValue | undefined | — | — | @m3-ui/ui |
shapes | ChipShapes | undefined | — | — | @m3-ui/ui |
trailingIcon | ReactNode | — | — | @m3-ui/ui |
Inherited React / web props (109)
| Name | Type | Default | Description | Origin |
|---|---|---|---|---|
aria-controls | string | undefined | — | Identifies the element (or elements) whose contents or presence are controlled by the current element. | react-aria |
aria-describedby | string | undefined | — | Identifies the element (or elements) that describes the object. | @react-types/shared |
aria-details | string | undefined | — | Identifies the element (or elements) that provide a detailed, extended description for the object. | @react-types/shared |
aria-errormessage | string | undefined | — | Identifies the element that provides an error message for the object. | @react-types/shared |
aria-label | string | undefined | — | Defines a string value that labels the current element. | @react-types/shared |
aria-labelledby | string | undefined | — | Identifies the element (or elements) that labels the current element. | @react-types/shared |
autoFocus | boolean | undefined | — | Whether the element should receive focus on render. | @react-types/shared |
className | ClassNameOrFunction<CheckboxRenderProps> | undefined | 'react-aria-Checkbox' | The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the element. A function may be provided to compute the class based on component state. | react-aria-components |
defaultSelected | boolean | undefined | — | Whether the element should be selected (uncontrolled). | react-stately |
dir | string | undefined | — | — | @react-types/shared |
excludeFromTabOrder | boolean | undefined | — | Whether to exclude the element from the sequential tab order. If true, the element will not be focusable via the keyboard by tabbing. This should be avoided except in rare scenarios where an alternative means of accessing the element or its functionality via the keyboard is available. | @react-types/shared |
form | string | undefined | — | The `<form>` element to associate the input with. The value of this attribute must be the id of a `<form>` in the same document. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#form). | @react-types/shared |
hidden | boolean | undefined | — | — | @react-types/shared |
id | string | undefined | — | The element's unique identifier. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/id). | @react-types/shared |
inert | boolean | undefined | — | — | @react-types/shared |
inputRef | React.Ref<HTMLInputElement | null> | undefined | — | A ref for the HTML input element. | react-aria-components |
isDisabled | boolean | undefined | — | Whether the input is disabled. | @react-types/shared |
isIndeterminate | boolean | undefined | — | Indeterminism is presentational only. The indeterminate visual representation remains regardless of user interaction. | react-aria |
isInvalid | boolean | undefined | — | Whether the input value is invalid. | @react-types/shared |
isReadOnly | boolean | undefined | — | Whether the input can be selected but not changed by the user. | @react-types/shared |
isRequired | boolean | undefined | — | Whether user input is required on the input before form submission. | @react-types/shared |
isSelected | boolean | undefined | — | Whether the element should be selected (controlled). | react-stately |
lang | string | undefined | — | — | @react-types/shared |
name | string | undefined | — | The name of the input element, used when submitting an HTML form. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefname). | @react-types/shared |
onAnimationEnd | AnimationEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onAnimationEndCapture | AnimationEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onAnimationIteration | AnimationEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onAnimationIterationCapture | AnimationEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onAnimationStart | AnimationEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onAnimationStartCapture | AnimationEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onAuxClick | MouseEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onAuxClickCapture | MouseEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onBlur | ((e: FocusEvent<Element, Element>) => void) | undefined | — | Handler that is called when the element loses focus. | @react-types/shared |
onChange | ((isSelected: boolean) => void) | undefined | — | Handler that is called when the element's selection state changes. | react-stately |
onClick | ((e: MouseEvent<FocusableElement>) => void) | undefined | — | **Not recommended – use `onPress` instead.** `onClick` is an alias for `onPress` provided for compatibility with other libraries. `onPress` provides additional event details for non-mouse interactions. | @react-types/shared |
onClickCapture | MouseEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onContextMenu | MouseEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onContextMenuCapture | MouseEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onDoubleClick | MouseEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onDoubleClickCapture | MouseEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onFocus | ((e: FocusEvent<Element, Element>) => void) | undefined | — | Handler that is called when the element receives focus. | @react-types/shared |
onFocusChange | ((isFocused: boolean) => void) | undefined | — | Handler that is called when the element's focus status changes. | @react-types/shared |
onGotPointerCapture | PointerEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onGotPointerCaptureCapture | PointerEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onHoverChange | ((isHovering: boolean) => void) | undefined | — | Handler that is called when the hover state changes. | @react-types/shared |
onHoverEnd | ((e: HoverEvent) => void) | undefined | — | Handler that is called when a hover interaction ends. | @react-types/shared |
onHoverStart | ((e: HoverEvent) => void) | undefined | — | Handler that is called when a hover interaction starts. | @react-types/shared |
onKeyDown | ((e: KeyboardEvent) => void) | undefined | — | Handler that is called when a key is pressed. | @react-types/shared |
onKeyUp | ((e: KeyboardEvent) => void) | undefined | — | Handler that is called when a key is released. | @react-types/shared |
onLostPointerCapture | PointerEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onLostPointerCaptureCapture | PointerEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onMouseDown | MouseEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onMouseDownCapture | MouseEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onMouseEnter | MouseEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onMouseLeave | MouseEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onMouseMove | MouseEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onMouseMoveCapture | MouseEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onMouseOut | MouseEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onMouseOutCapture | MouseEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onMouseOver | MouseEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onMouseOverCapture | MouseEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onMouseUp | MouseEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onMouseUpCapture | MouseEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onPointerCancel | PointerEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onPointerCancelCapture | PointerEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onPointerDown | PointerEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onPointerDownCapture | PointerEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onPointerEnter | PointerEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onPointerLeave | PointerEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onPointerMove | PointerEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onPointerMoveCapture | PointerEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onPointerOut | PointerEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onPointerOutCapture | PointerEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onPointerOver | PointerEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onPointerOverCapture | PointerEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onPointerUp | PointerEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onPointerUpCapture | PointerEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onPress | ((e: PressEvent) => void) | undefined | — | Handler that is called when the press is released over the target. | @react-types/shared |
onPressChange | ((isPressed: boolean) => void) | undefined | — | Handler that is called when the press state changes. | @react-types/shared |
onPressEnd | ((e: PressEvent) => void) | undefined | — | Handler that is called when a press interaction ends, either over the target or when the pointer leaves the target. | @react-types/shared |
onPressStart | ((e: PressEvent) => void) | undefined | — | Handler that is called when a press interaction starts. | @react-types/shared |
onPressUp | ((e: PressEvent) => void) | undefined | — | Handler that is called when a press is released over the target, regardless of whether it started on the target or not. | @react-types/shared |
onScroll | UIEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onScrollCapture | UIEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onTouchCancel | TouchEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onTouchCancelCapture | TouchEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onTouchEnd | TouchEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onTouchEndCapture | TouchEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onTouchMove | TouchEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onTouchMoveCapture | TouchEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onTouchStart | TouchEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onTouchStartCapture | TouchEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onTransitionCancel | TransitionEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onTransitionCancelCapture | TransitionEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onTransitionEnd | TransitionEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onTransitionEndCapture | TransitionEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onTransitionRun | TransitionEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onTransitionRunCapture | TransitionEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onTransitionStart | TransitionEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onTransitionStartCapture | TransitionEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onWheel | WheelEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
onWheelCapture | WheelEventHandler<HTMLLabelElement> | undefined | — | — | @react-types/shared |
render | DOMRenderFunction<"label", CheckboxRenderProps> | undefined | — | Overrides the default DOM element with a custom render function. This allows rendering existing components with built-in styles and behaviors such as router links, animation libraries, and pre-styled components. Requirements: - You must render the expected element type (e.g. if `<button>` is expected, you cannot render an `<a>`). - Only a single root DOM element can be rendered (no fragments). - You must pass through props and ref to the underlying DOM element, merging with your own prop as appropriate. | react-aria-components |
slot | string | null | undefined | — | A slot name for the component. Slots allow the component to receive props from a parent component. An explicit `null` value indicates that the local props completely override all props received from a parent. | react-aria-components |
style | StyleOrFunction<CheckboxRenderProps> | undefined | — | The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the element. A function may be provided to compute the style based on component state. | react-aria-components |
translate | "yes" | "no" | undefined | — | — | @react-types/shared |
validate | ((value: boolean) => ValidationError | true | null | undefined) | undefined | — | A function that returns an error message if a given value is invalid. Validation errors are displayed to the user when the form is submitted if `validationBehavior="native"`. For realtime validation, use the `isInvalid` prop instead. | @react-types/shared |
validationBehavior | "native" | "aria" | undefined | 'native' | Whether to use native HTML form validation to prevent form submission when the value is missing or invalid, or mark the field as required or invalid via ARIA. | react-aria-components |
value | string | undefined | — | The value of the input element, used when submitting an HTML form. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefvalue). | react-stately |
Source: packages/ui/src/components/Chip/Chip.tsx:276
Material fidelity, adaptations, and known gaps
- Family
- Chips
- Provenance
- spec: Material 3 overview · web: Browser and React Aria semantics · adaptation: m3-ui web adaptation
- Compose mapping
- AssistChip · SuggestionChip · FilterChip · InputChip
- Visual fidelity
- partial: Legacy visual fidelity has not received an explicit reviewed disposition. Current implementation evidence: Implements assist, suggestion, filter, and input chip families, including elevated assist/suggestion/filter forms, visual slots, selected/disabled states, elevation motion, ripple layers, and optional expressive selected-shape morphing for selectable chips.
- Behavior fidelity
- adapted: Assist and suggestion chips use React Aria button semantics; filter and input chips use checkbox-style selectable semantics. Visual icons and avatars are presentation slots while React Aria remains the interaction, focus, disabled, and selection-state owner.
- Semantics fidelity
- adapted: Assist and suggestion chips use React Aria button semantics; filter and input chips use checkbox-style selectable semantics. Visual icons and avatars are presentation slots while React Aria remains the interaction, focus, disabled, and selection-state owner.
- Adaptations
- Assist and suggestion chips use React Aria button semantics; filter and input chips use checkbox-style selectable semantics. Visual icons and avatars are presentation slots while React Aria remains the interaction, focus, disabled, and selection-state owner.
- Known gaps
- InputChip does not currently expose an independent trailing remove action; trailing visuals remain presentational rather than a second interactive target.
Material 3 is normative for chip intent, family choice, hierarchy, anatomy, visual states, and variants. AndroidX Material3 provides implementation/reference evidence for current chip family vocabulary and expressive behavior where represented.
Browser/React Aria button and selection semantics are the web interaction layer. Material Web-only compatibility evidence, where used by the implementation, is treated as adaptation rather than silently described as a Compose API.
The main documented gap is the current InputChip trailing visual: m3-ui does not expose an independent trailing remove action, so this guide does not claim that capability.
Related components
- Button — higher-emphasis actions.
- Checkbox — conventional independent binary selection.
- Segmented buttons — connected single/multiple choice sets.
- Badge — compact status/count decoration rather than an action/selection surface.