@fayegram-ai/faye-ui/navigation/accordion
Public exports and dependency-resolved component properties, with usage and rendering guidance.
Import
import { Accordion } from '@fayegram-ai/faye-ui/navigation/accordion';Usage and behavior guide · API JSON
This entry declares a client boundary. Follow the rendering guide for framework integration.
Public exports
| Name | Kind | Resolved declaration type |
|---|---|---|
AccordionTriggerProps | type | AccordionTriggerProps |
Accordion | value | { readonly Root: <Value = any>(props: Base.Root.Props<Value>) => React.JSX.Element; readonly Item: { (input: Omit<import("@base-ui/react").AccordionItemProps, "ref"> & import("react").RefAttributes<HTMLDivElement> & { variants?: { readonly variant?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"accordion", "variant"> | undefined; readonly size?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"accordion", "size"> | undefined; readonly tone?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"accordion", "tone"> | undefined; } | undefined; }): import("react").ReactElement; displayName: string; }; readonly Header: { (input: Omit<import("@base-ui/react").AccordionHeaderProps, "ref"> & import("react").RefAttributes<HTMLHeadi… (full type in API JSON) |
Accordion
Public component; use the linked family guide for complete composition and behavior.
Dependency-resolved declaration properties. Common React/native HTML attributes are omitted from the table; use the full declaration and React/native references. Generic and union restrictions remain authoritative in TypeScript.
Accordion.Root
| Property | Required | Type | Meaning |
|---|---|---|---|
className | No | string | ((state: Base.Root.State<Value>) => string | undefined) | undefined | CSS class applied to the element, or a function that returns a class based on the component's state. |
defaultValue | No | AccordionValue<Value> | undefined | The uncontrolled value of the item(s) that should be initially expanded. To render a controlled accordion, use the value prop instead. |
disabled | No | boolean | undefined | Whether the component should ignore user interaction. |
hiddenUntilFound | No | boolean | undefined | Allows the browser's built-in page search to find and expand the panel contents. Overrides the keepMounted prop and uses hidden="until-found" to hide the element without removing it from the DOM. |
keepMounted | No | boolean | undefined | Whether to keep the element in the DOM while the panel is closed. This prop is ignored when hiddenUntilFound is used. |
loopFocus | No | boolean | undefined | Deprecated following the APG guidance update to remove roving focus. This prop no longer affects keyboard focus behavior. |
multiple | No | boolean | undefined | Whether multiple items can be open at the same time. |
onValueChange | No | ((value: AccordionValue<Value>, eventDetails: AccordionRootChangeEventDetails) => void) | undefined | Event handler called when an accordion item is expanded or collapsed. Provides the new value as an argument. |
orientation | No | Orientation | undefined | Deprecated following the APG guidance update to remove roving focus. This prop no longer affects keyboard focus behavior. |
render | No | ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, Base.Root.State<Value>> | undefined | Allows you to replace the component's HTML element with a different tag, or compose it with another component. Accepts a ReactElement or a function that returns the element to render. |
style | No | CSSProperties | ((state: Base.Root.State<Value>) => React.CSSProperties | undefined) | undefined | Style applied to the element, or a function that returns a style object based on the component's state. |
value | No | AccordionValue<Value> | undefined | The controlled value of the item(s) that should be expanded. To render an uncontrolled accordion, use the defaultValue prop instead. |
Accordion.Item
| Property | Required | Type | Meaning |
|---|---|---|---|
className | No | string | ((state: AccordionItemState) => string | undefined) | undefined | CSS class applied to the element, or a function that returns a class based on the component's state. |
disabled | No | boolean | undefined | Whether the component should ignore user interaction. |
onOpenChange | No | ((open: boolean, eventDetails: Base.Item.ChangeEventDetails) => void) | undefined | Event handler called when the panel is opened or closed. |
render | No | ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, AccordionItemState> | undefined | Allows you to replace the component's HTML element with a different tag, or compose it with another component. Accepts a ReactElement or a function that returns the element to render. |
style | No | CSSProperties | ((state: AccordionItemState) => React.CSSProperties | undefined) | undefined | Style applied to the element, or a function that returns a style object based on the component's state. |
value | No | any | A unique value that identifies this accordion item. If no value is provided, a unique ID will be generated automatically. Use when controlling the accordion programmatically, or to set an initial open state. |
variants | No | { readonly variant?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"accordion", "variant"> | undefined; readonly size?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"accordion", "size"> | undefined; readonly tone?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"accordion", "tone"> | undefined; } | undefined | See the usage contract and declaration. |
Accordion.Header
| Property | Required | Type | Meaning |
|---|---|---|---|
className | No | string | ((state: AccordionHeaderState) => string | undefined) | undefined | CSS class applied to the element, or a function that returns a class based on the component's state. |
render | No | ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, AccordionHeaderState> | undefined | Allows you to replace the component's HTML element with a different tag, or compose it with another component. Accepts a ReactElement or a function that returns the element to render. |
style | No | CSSProperties | ((state: AccordionHeaderState) => React.CSSProperties | undefined) | undefined | Style applied to the element, or a function that returns a style object based on the component's state. |
variants | No | { readonly variant?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"accordion", "variant"> | undefined; readonly size?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"accordion", "size"> | undefined; readonly tone?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"accordion", "tone"> | undefined; } | undefined | See the usage contract and declaration. |
Accordion.Trigger
| Property | Required | Type | Meaning |
|---|---|---|---|
className | No | string | ((state: AccordionTriggerState) => string | undefined) | undefined | CSS class applied to the element, or a function that returns a class based on the component's state. |
hideIndicator | No | boolean | undefined | See the usage contract and declaration. |
indicator | No | ReactNode | See the usage contract and declaration. |
indicatorPosition | No | "start" | "end" | undefined | See the usage contract and declaration. |
nativeButton | No | boolean | undefined | Whether the component renders a native <button> element when replacing it via the render prop. Set to false if the rendered element is not a button (for example, <div>). |
render | No | ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, AccordionTriggerState> | undefined | Allows you to replace the component's HTML element with a different tag, or compose it with another component. Accepts a ReactElement or a function that returns the element to render. |
style | No | CSSProperties | ((state: AccordionTriggerState) => React.CSSProperties | undefined) | undefined | Style applied to the element, or a function that returns a style object based on the component's state. |
variants | No | { readonly variant?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"accordion", "variant"> | undefined; readonly size?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"accordion", "size"> | undefined; readonly tone?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"accordion", "tone"> | undefined; } | undefined | See the usage contract and declaration. |
Accordion.Panel
| Property | Required | Type | Meaning |
|---|---|---|---|
className | No | string | ((state: AccordionPanelState) => string | undefined) | undefined | CSS class applied to the element, or a function that returns a class based on the component's state. |
hiddenUntilFound | No | boolean | undefined | Allows the browser's built-in page search to find and expand the panel contents. Overrides the keepMounted prop and uses hidden="until-found" to hide the element without removing it from the DOM. |
keepMounted | No | boolean | undefined | Whether to keep the element in the DOM while the panel is closed. This prop is ignored when hiddenUntilFound is used. |
render | No | ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, AccordionPanelState> | undefined | Allows you to replace the component's HTML element with a different tag, or compose it with another component. Accepts a ReactElement or a function that returns the element to render. |
style | No | CSSProperties | ((state: AccordionPanelState) => React.CSSProperties | undefined) | undefined | Style applied to the element, or a function that returns a style object based on the component's state. |
variants | No | { readonly variant?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"accordion", "variant"> | undefined; readonly size?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"accordion", "size"> | undefined; readonly tone?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"accordion", "tone"> | undefined; } | undefined | See the usage contract and declaration. |
Defaults and customization
Descriptor defaults: {"variant":"divided","size":"md","tone":"neutral"}. Parts: item, header, trigger, panel. Explicit instance props take precedence over configured defaults.
Use semantic tokens, public part hooks and customization sheets. Keep visual configuration separate from application state.
State, events and accessibility
For interactive controls, pair a controlled value/open prop with its corresponding change callback; default props initialize uncontrolled state. Keep application validation and submission policy explicit. Name controls with visible labels, name icon-only actions on the button, and preserve focus and dismissal behavior when replacing parts. Use native form names and submit/reset types where supported. See the usage guide for component-specific behavior and live examples.
Declaration authority
Generated from packages/faye-ui/dist/navigation/accordion.d.ts after the semantic package build. Common native/React attributes are intentionally omitted from property tables. Generic overloads, discriminated unions and complete inherited attributes remain authoritative in installed TypeScript declarations. React DOM attributes and Base UI component contracts describe the inherited foundations.