Skip to content

Commit

Permalink
docs: update the default value of the disabled prop for `ButtonGrou…
Browse files Browse the repository at this point in the history
…p`, `CheckboxGroup`, and `RadioGroup`
  • Loading branch information
cheton committed Sep 20, 2024
1 parent d439cb0 commit 6aa564d
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ The following example shows different states (i.e. normal, disabled, and selecte
| Name | Type | Default | Description |
| :--- | :--- | :------ | :---------- |
| children | ReactNode \| `(context) => ReactNode` | | A function child can be used intead of a React element. This function is called with the context object. |
| disabled | boolean | | If `true`, all buttons will be disabled. |
| orientation | string | 'horizontal' | The orientation of the button group. One of: 'horizontal', 'vertical' |
| size | string | 'md' | The size of the button group. One of: 'sm', 'md', 'lg' |
| variant | string | 'default' | The variant of the button group. One of: 'emphasis', 'primary', 'default', 'secondary', 'ghost' |
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Use the `size` prop to change the size of the `CheckboxGroup`. You can set the v
| :--- | :--- | :------ | :---------- |
| children | ReactNode \| `(context) => ReactNode` | | A function child can be used intead of a React element. This function is called with the context object. |
| defaultValue | (string\|number)[] | | The initial value of the checkbox group. |
| disabled | boolean | false | If `true`, all checkboxes will be disabled. |
| disabled | boolean | | If `true`, all checkboxes will be disabled. |
| name | string | | The name used to reference the value of the control. If you don't provide this prop, it falls back to a randomly generated name. |
| onChange | (event) => void | | A callback fired when any descendant `Checkbox` is checked or unchecked. |
| size | string | 'md' | The size (width and height) of the checkbox. One of: 'sm', 'md', 'lg' |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Use the `size` prop to change the size of the `RadioGroup`. You can set the valu
| :--- | :--- | :------ | :---------- |
| children | ReactNode \| `(context) => ReactNode` | | A function child can be used intead of a React element. This function is called with the context object. |
| defaultValue | string \| number | | The default `input` element value. Use when the component is not controlled. |
| disabled | boolean | false | If `true`, all radios will be disabled. |
| disabled | boolean | | If `true`, all radios will be disabled. |
| name | string | | The name used to reference the value of the control. If you don't provide this prop, it falls back to a randomly generated name. |
| onChange | function | | A callback called when the state of the radio changes. |
| size | string | 'md' | The size (width and height) of the radio. One of: 'sm', 'md', 'lg' |
Expand Down

0 comments on commit 6aa564d

Please sign in to comment.