Skip to content

[docs][accordion][toolbar] Fix ToolbarButton, and ToolbarInput to use proper state types #2732

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Sep 12, 2025
Merged

[docs][accordion][toolbar] Fix ToolbarButton, and ToolbarInput to use proper state types #2732

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
be019bf
Fix state types
chuganzy Sep 11, 2025
ea31872
Update docs
chuganzy Sep 11, 2025
36d9fe8
Update a snapshot
chuganzy Sep 11, 2025
23cbe77
Merge branch 'master' into fix-state-types
mj12albert Sep 11, 2025
0247de5
Format
chuganzy Sep 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/reference/generated/accordion-panel.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
"detailedType": "boolean | undefined"
},
"className": {
"type": "string | ((state: Accordion.Item.State) => string)",
"type": "string | ((state: Accordion.Panel.State) => string)",
"description": "CSS class applied to the element, or a function that\nreturns a class based on the component’s state."
},
"keepMounted": {
Expand All @@ -19,9 +19,9 @@
"detailedType": "boolean | undefined"
},
"render": {
"type": "ReactElement | ((props: HTMLProps, state: Accordion.Item.State) => ReactElement)",
"type": "ReactElement | ((props: HTMLProps, state: Accordion.Panel.State) => ReactElement)",
"description": "Allows you to replace the component’s HTML element\nwith a different tag, or compose it with another component.\n\nAccepts a `ReactElement` or a function that returns the element to render.",
"detailedType": "| ReactElement\n| ((\n props: HTMLProps,\n state: Accordion.Item.State,\n ) => ReactElement)"
"detailedType": "| ReactElement\n| ((\n props: HTMLProps,\n state: Accordion.Panel.State,\n ) => ReactElement)"
}
},
"dataAttributes": {
Expand Down
6 changes: 3 additions & 3 deletions docs/reference/generated/toolbar-button.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,13 @@
"detailedType": "boolean | undefined"
},
"className": {
"type": "string | ((state: Toolbar.Root.State) => string)",
"type": "string | ((state: Toolbar.Button.State) => string)",
"description": "CSS class applied to the element, or a function that\nreturns a class based on the component’s state."
},
"render": {
"type": "ReactElement | ((props: HTMLProps, state: Toolbar.Root.State) => ReactElement)",
"type": "ReactElement | ((props: HTMLProps, state: Toolbar.Button.State) => ReactElement)",
"description": "Allows you to replace the component’s HTML element\nwith a different tag, or compose it with another component.\n\nAccepts a `ReactElement` or a function that returns the element to render.",
"detailedType": "| ReactElement\n| ((\n props: HTMLProps,\n state: Toolbar.Root.State,\n ) => ReactElement)"
"detailedType": "| ReactElement\n| ((\n props: HTMLProps,\n state: Toolbar.Button.State,\n ) => ReactElement)"
}
},
"dataAttributes": {
Expand Down
6 changes: 3 additions & 3 deletions docs/reference/generated/toolbar-input.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,13 @@
"detailedType": "boolean | undefined"
},
"className": {
"type": "string | ((state: Toolbar.Root.State) => string)",
"type": "string | ((state: Toolbar.Input.State) => string)",
"description": "CSS class applied to the element, or a function that\nreturns a class based on the component’s state."
},
"render": {
"type": "ReactElement | ((props: HTMLProps, state: Toolbar.Root.State) => ReactElement)",
"type": "ReactElement | ((props: HTMLProps, state: Toolbar.Input.State) => ReactElement)",
"description": "Allows you to replace the component’s HTML element\nwith a different tag, or compose it with another component.\n\nAccepts a `ReactElement` or a function that returns the element to render.",
"detailedType": "| ReactElement\n| ((\n props: HTMLProps,\n state: Toolbar.Root.State,\n ) => ReactElement)"
"detailedType": "| ReactElement\n| ((\n props: HTMLProps,\n state: Toolbar.Input.State,\n ) => ReactElement)"
}
},
"dataAttributes": {
Expand Down
12 changes: 6 additions & 6 deletions docs/scripts/generateLlmTxt/__snapshots__/mdxToMarkdown.test.mjs.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -355,12 +355,12 @@ Renders a \`<div>\` element.

**Panel Props:**

| Prop | Type | Default | Description |
| :--------------- | :---------------------------------------------------------------------------------- | :------ | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| hiddenUntilFound | \`boolean\` | \`false\` | Allows the browser’s built-in page search to find and expand the panel contents.Overrides the \`keepMounted\` prop and uses \`hidden="until-found"\`&#xA;to hide the element without removing it from the DOM. |
| className | \`string \\| ((state: Accordion.Item.State) => string)\` | - | CSS class applied to the element, or a function that&#xA;returns a class based on the component’s state. |
| keepMounted | \`boolean\` | \`false\` | Whether to keep the element in the DOM while the panel is closed.&#xA;This prop is ignored when \`hiddenUntilFound\` is used. |
| render | \`ReactElement \\| ((props: HTMLProps, state: Accordion.Item.State) => ReactElement)\` | - | Allows you to replace the component’s HTML element&#xA;with a different tag, or compose it with another component.Accepts a \`ReactElement\` or a function that returns the element to render. |
| Prop | Type | Default | Description |
| :--------------- | :----------------------------------------------------------------------------------- | :------ | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| hiddenUntilFound | \`boolean\` | \`false\` | Allows the browser’s built-in page search to find and expand the panel contents.Overrides the \`keepMounted\` prop and uses \`hidden="until-found"\`&#xA;to hide the element without removing it from the DOM. |
| className | \`string \\| ((state: Accordion.Panel.State) => string)\` | - | CSS class applied to the element, or a function that&#xA;returns a class based on the component’s state. |
| keepMounted | \`boolean\` | \`false\` | Whether to keep the element in the DOM while the panel is closed.&#xA;This prop is ignored when \`hiddenUntilFound\` is used. |
| render | \`ReactElement \\| ((props: HTMLProps, state: Accordion.Panel.State) => ReactElement)\` | - | Allows you to replace the component’s HTML element&#xA;with a different tag, or compose it with another component.Accepts a \`ReactElement\` or a function that returns the element to render. |

**Panel Data Attributes:**

Expand Down
2 changes: 1 addition & 1 deletion packages/react/src/accordion/panel/AccordionPanel.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,6 @@ export namespace AccordionPanel {
}

export interface Props
extends BaseUIComponentProps<'div', AccordionItem.State>,
extends BaseUIComponentProps<'div', State>,
Pick<AccordionRoot.Props, 'hiddenUntilFound' | 'keepMounted'> {}
}
4 changes: 1 addition & 3 deletions packages/react/src/toolbar/button/ToolbarButton.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,9 +75,7 @@ export namespace ToolbarButton {
focusable: boolean;
}

export interface Props
extends NativeButtonProps,
BaseUIComponentProps<'button', ToolbarRoot.State> {
export interface Props extends NativeButtonProps, BaseUIComponentProps<'button', State> {
/**
* When `true` the item is disabled.
* @default false
Expand Down
2 changes: 1 addition & 1 deletion packages/react/src/toolbar/input/ToolbarInput.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ export namespace ToolbarInput {
focusable: boolean;
}

export interface Props extends BaseUIComponentProps<'input', ToolbarRoot.State> {
export interface Props extends BaseUIComponentProps<'input', State> {
/**
* When `true` the item is disabled.
* @default false
Expand Down
Loading