Skip to content

fix(admin): use control-generic wording for selectable prop docs [2026-01] #4669

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
sordaz00 merged 1 commit into from
Sep 2, 2026
Merged

fix(admin): use control-generic wording for selectable prop docs [2026-01] #4669

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 8 additions & 8 deletions ...nsions/docs/surfaces/admin/generated/admin_extensions/2026-01/generated_docs_data_v2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2427,7 +2427,7 @@
"syntaxKind": "GetAccessor",
"name": "value",
"value": "string",
"description": "The value used in form data when the checkbox is checked."
"description": "The value used in form data when the control is checked."
},
{
"filePath": "src/surfaces/admin/components.ts",
Expand Down Expand Up @@ -2463,7 +2463,7 @@
"syntaxKind": "PropertyDeclaration",
"name": "label",
"value": "string",
"description": "The text label displayed next to the checkbox that describes what the checkbox controls. Clicking the label will also toggle the checkbox state."
"description": "The text label displayed next to the control that describes what it does. Clicking the label will also toggle the control state."
},
{
"filePath": "src/surfaces/admin/components.ts",
Expand Down Expand Up @@ -2665,7 +2665,7 @@
"syntaxKind": "PropertyDeclaration",
"name": "disabled",
"value": "boolean",
"description": "Whether the checkbox is disabled, preventing user interaction. Disabled checkboxes appear dimmed and their values aren't submitted with forms.",
"description": "Whether the control is disabled, preventing user interaction. Disabled controls appear dimmed and their values aren't submitted with forms.",
"defaultValue": "false"
},
{
Expand All @@ -2681,7 +2681,7 @@
"syntaxKind": "PropertyDeclaration",
"name": "value",
"value": "string",
"description": "The value submitted with the form when this checkbox is checked. If not specified, the default value is \"on\"."
"description": "The value submitted with the form when this control is selected. If not specified, the default value is \"on\"."
},
{
"filePath": "src/surfaces/admin/components.ts",
Expand Down Expand Up @@ -6549,14 +6549,14 @@
"syntaxKind": "PropertyDeclaration",
"name": "value",
"value": "string",
"description": "The value submitted with the form when this checkbox is checked. If not specified, the default value is \"on\"."
"description": "The value submitted with the form when this control is selected. If not specified, the default value is \"on\"."
},
{
"filePath": "src/surfaces/admin/components.ts",
"syntaxKind": "PropertyDeclaration",
"name": "disabled",
"value": "boolean",
"description": "Whether the checkbox is disabled, preventing user interaction. Disabled checkboxes appear dimmed and their values aren't submitted with forms.",
"description": "Whether the control is disabled, preventing user interaction. Disabled controls appear dimmed and their values aren't submitted with forms.",
"defaultValue": "false"
},
{
Expand Down Expand Up @@ -8120,7 +8120,7 @@
"syntaxKind": "GetAccessor",
"name": "value",
"value": "string",
"description": "The value used in form data when the checkbox is checked."
"description": "The value used in form data when the control is checked."
},
{
"filePath": "src/surfaces/admin/components.ts",
Expand Down Expand Up @@ -8156,7 +8156,7 @@
"syntaxKind": "PropertyDeclaration",
"name": "label",
"value": "string",
"description": "The text label displayed next to the checkbox that describes what the checkbox controls. Clicking the label will also toggle the checkbox state."
"description": "The text label displayed next to the control that describes what it does. Clicking the label will also toggle the control state."
},
{
"filePath": "src/surfaces/admin/components.ts",
Expand Down
16 changes: 8 additions & 8 deletions packages/ui-extensions/docs/surfaces/admin/generated/app_home/generated_docs_data_v2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6411,7 +6411,7 @@
"syntaxKind": "GetAccessor",
"name": "value",
"value": "string",
"description": "The value used in form data when the checkbox is checked."
"description": "The value used in form data when the control is checked."
},
{
"filePath": "src/surfaces/admin/components.ts",
Expand Down Expand Up @@ -6447,7 +6447,7 @@
"syntaxKind": "PropertyDeclaration",
"name": "label",
"value": "string",
"description": "The text label displayed next to the checkbox that describes what the checkbox controls. Clicking the label will also toggle the checkbox state."
"description": "The text label displayed next to the control that describes what it does. Clicking the label will also toggle the control state."
},
{
"filePath": "src/surfaces/admin/components.ts",
Expand Down Expand Up @@ -6649,7 +6649,7 @@
"syntaxKind": "PropertyDeclaration",
"name": "disabled",
"value": "boolean",
"description": "Whether the checkbox is disabled, preventing user interaction. Disabled checkboxes appear dimmed and their values aren't submitted with forms.",
"description": "Whether the control is disabled, preventing user interaction. Disabled controls appear dimmed and their values aren't submitted with forms.",
"defaultValue": "false"
},
{
Expand All @@ -6665,7 +6665,7 @@
"syntaxKind": "PropertyDeclaration",
"name": "value",
"value": "string",
"description": "The value submitted with the form when this checkbox is checked. If not specified, the default value is \"on\"."
"description": "The value submitted with the form when this control is selected. If not specified, the default value is \"on\"."
},
{
"filePath": "src/surfaces/admin/components.ts",
Expand Down Expand Up @@ -10345,14 +10345,14 @@
"syntaxKind": "PropertyDeclaration",
"name": "value",
"value": "string",
"description": "The value submitted with the form when this checkbox is checked. If not specified, the default value is \"on\"."
"description": "The value submitted with the form when this control is selected. If not specified, the default value is \"on\"."
},
{
"filePath": "src/surfaces/admin/components.ts",
"syntaxKind": "PropertyDeclaration",
"name": "disabled",
"value": "boolean",
"description": "Whether the checkbox is disabled, preventing user interaction. Disabled checkboxes appear dimmed and their values aren't submitted with forms.",
"description": "Whether the control is disabled, preventing user interaction. Disabled controls appear dimmed and their values aren't submitted with forms.",
"defaultValue": "false"
},
{
Expand Down Expand Up @@ -11916,7 +11916,7 @@
"syntaxKind": "GetAccessor",
"name": "value",
"value": "string",
"description": "The value used in form data when the checkbox is checked."
"description": "The value used in form data when the control is checked."
},
{
"filePath": "src/surfaces/admin/components.ts",
Expand Down Expand Up @@ -11952,7 +11952,7 @@
"syntaxKind": "PropertyDeclaration",
"name": "label",
"value": "string",
"description": "The text label displayed next to the checkbox that describes what the checkbox controls. Clicking the label will also toggle the checkbox state."
"description": "The text label displayed next to the control that describes what it does. Clicking the label will also toggle the control state."
},
{
"filePath": "src/surfaces/admin/components.ts",
Expand Down
18 changes: 9 additions & 9 deletions packages/ui-extensions/src/surfaces/admin/components.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1977,14 +1977,14 @@ export interface BaseSelectableProps {
*/
accessibilityLabel?: string;
/**
* Whether the checkbox is disabled, preventing user interaction.
* Disabled checkboxes appear dimmed and their values aren't submitted with forms.
* Whether the control is disabled, preventing user interaction.
* Disabled controls appear dimmed and their values aren't submitted with forms.
*
* @default false
*/
disabled?: boolean;
/**
* The value submitted with the form when this checkbox is checked.
* The value submitted with the form when this control is selected.
* If not specified, the default value is "on".
*/
value?: string;
Expand All @@ -2010,8 +2010,8 @@ export interface BaseCheckableProps
extends BaseSelectableProps,
InteractionProps {
/**
* The text label displayed next to the checkbox that describes what the checkbox controls.
* Clicking the label will also toggle the checkbox state.
* The text label displayed next to the control that describes what it does.
* Clicking the label will also toggle the control state.
*/
label?: string;
/**
Expand All @@ -2030,8 +2030,8 @@ export interface BaseCheckableProps
*/
defaultChecked?: boolean;
/**
* The name used to identify this checkbox in form submissions.
* When the checkbox is checked, its `name` and `value` are included in the form data.
* The name used to identify this control in form submissions.
* When the control is checked, its `name` and `value` are included in the form data.
* Must be unique within the containing form.
*/
name?: string;
Expand Down Expand Up @@ -5784,7 +5784,7 @@ export interface PreactCheckboxProps
>
> {
/**
* The value used in form data when the checkbox is checked.
* The value used in form data when the control is checked.
*/
value: Required<CheckboxProps$1>['value'];
}
Expand All @@ -5795,7 +5795,7 @@ declare class PreactCheckboxElement
get checked(): boolean;
set checked(checked: PreactCheckboxProps['checked']);
/**
* The value used in form data when the checkbox is checked.
* The value used in form data when the control is checked.
*/
get value(): string;
set value(value: string);
Expand Down
Loading