Skip to content

Commit

Permalink
docs(Combobox): add info that section headers are not included wehen …
Browse files Browse the repository at this point in the history
…filtering (#4215)

* docs(Combobox): add info that section headers are not included wehen filtering

* Create twelve-elephants-attack.md
  • Loading branch information
sebald authored Oct 14, 2024
1 parent a954946 commit fab9442
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
5 changes: 5 additions & 0 deletions .changeset/twelve-elephants-attack.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@marigold/docs": patch
---

docs(Combobox): add info that section headers are not included wehen filtering
2 changes: 1 addition & 1 deletion docs/content/components/form/combobox/combobox.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ This is especially helpful if you need to customize the filtering. For example,

When related options are present, organizing them into sections enhances clarity and usability. Grouping options provides additional context and helps users navigate choices more easily. This approach reduces complexity and allows for additional guidance when needed, ensuring a more intuitive experience.

This can be achieved by wrapping the options in the `<ComboBox.Section>` component. A header is required for each section, which is set using the `header` prop.
This can be achieved by wrapping the options in the `<ComboBox.Section>` component. A header is required for each section, which is set using the `header` prop. It's important to note that headers are not part of the accessibility tree. As a result, they will not be considered when filtering the option list.

<ComponentDemo file="./combobox-section.demo.tsx" />

Expand Down

0 comments on commit fab9442

Please sign in to comment.