Skip to content

Commit

Permalink
fix checkbox props
Browse files Browse the repository at this point in the history
  • Loading branch information
sebald committed Oct 16, 2024
1 parent 9624729 commit 922df97
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
3 changes: 2 additions & 1 deletion docs/content/components/form/checkbox/checkbox.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ It’s commonly used in "Select All" scenarios, where selecting only some of the

### Checkbox

<PropsTable component={title} />
<PropsTable component="Checkbox" />

### Checkbox.Group

Expand All @@ -171,6 +171,7 @@ It’s commonly used in "Select All" scenarios, where selecting only some of the

Choosing the right alternative to checkbox is important for providing an optimal user experience, especially when different types of selections are required. Depending on the nature of the choices and the desired interaction, the following components can serve as an alternative to checkboxes:

- [Switch](/components/form/swich): When there is only on option that should have an immediate effect.
- [Radio](/components/form/radio): When only one option can be selected from a set, a radio group is an alternative to a checkbox group, as radio buttons restrict the selection to a single option.
- [SelectList](/components/collection/selectlist): When you need more than just a text label to represent options, a `<SelectList>` can be used instead.
- [TagGroup](/components/collection/tag): When you want to visually highlight selected options as individual tags or want a horizontal list of options, use the `<Tag>` component.
Expand Down
3 changes: 2 additions & 1 deletion docs/scripts/build-component-props.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,10 @@ const parser = docgen.withCustomConfig('./tsconfig.json', {
},
customComponentTypes: [
'AutocompleteComponent',
'SelectComponent',
'CheckboxComponent',
'ComboBoxComponent',
'RadioComponent',
'SelectComponent',
'SelectListComponent',
],
});
Expand Down

0 comments on commit 922df97

Please sign in to comment.