Skip to content

Commit

Permalink
Merge branch '620_checkbox_group' of https://github.com/AkshatJawne/d…
Browse files Browse the repository at this point in the history
…eephaven-plugins into 620_checkbox_group
  • Loading branch information
AkshatJawne committed Sep 18, 2024
2 parents a40b185 + 8bfd6ec commit d7b4ab1
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions plugins/ui/docs/components/checkbox_group.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Checkbox Group

Checkbox groups areas allow the selection of one or more items from a list of choices, represented by checkboxes.
Checkbox group areas allow the selection of one or more items from a list of choices, represented by checkboxes.

## Example

Expand All @@ -22,7 +22,7 @@ Recommendations for creating checkbox groups:

1. Every checkbox group should have a [label](#labeling) specified. Without one, the checkbox group is ambiguous. In the rare case that context is sufficient, the label is unnecessary; you must still include an aria-label via the `aria_label` prop.
2. While labels can be placed either on top or on the side of the checkbox groups, top labels are the default recommendation. Top labels work better with longer copy, localization, and responsive layouts. Side labels are more useful when vertical space is limited.
3. Checkbox groups can be either horizontal or vertical. Checkbox groups are vertical by default; the orientation should only be horizontal if vertical space is limited.
3. Checkbox groups can be either horizontal or vertical. By default, they are vertical; the orientation should only be horizontal if vertical space is limited.
4. Checkbox groups can be marked as optional or required, with required groups indicated by either a “(required)” label or an asterisk icon, which should be accompanied by help text.
5. Checkbox groups should use help text for error messaging and descriptions, providing context for why a selection is required or clarifying the options.

Expand Down Expand Up @@ -121,7 +121,7 @@ my_checkbox_group_label_examples = ui_checkbox_group_label_examples()
```


The `is_required` prop and the `necessity_indicator` props can be used to show whether selecting an option in the checked group group is required or optional.
The `is_required` prop and the `necessity_indicator` props can be used to show whether selecting an option in the checked group is required or optional.

When the `necessity_indicator` prop is set to "label", a localized string will be generated for "(required)" or "(optional)" automatically.

Expand Down Expand Up @@ -159,7 +159,7 @@ my_checkbox_group_required_examples = ui_checkbox_group_required_examples()

## Events

Checkbox groups accept an `on_change` prop, which is triggered whenever a checkbox within the group is clicked
Checkbox groups accept an `on_change` prop, triggered whenever a checkbox within the group is clicked.

```python
from deephaven import ui
Expand Down Expand Up @@ -236,7 +236,7 @@ my_checkbox_group_label_position_example = ui.checkbox_group(

## Help text

A checkbox group can have both a `description` and an `error_message`. Use the error message to offer specific guidance on how to correct the input.
A checkbox group can have both a `description` and an `error_message`. The error message should offer specific guidance on how to correct the input.

The `is_invalid` prop can be used to set whether the current checkbox group state is valid or invalid.

Expand Down

0 comments on commit d7b4ab1

Please sign in to comment.