Sidebar filter

[geerew]

What version of starlight are you using?

0.8.0

What is your idea?

Some side menus can become quite large. It would be neat to have a filter input that as the user types, filters out non-relevant menu items.

Why is this feature necessary?

Some side menus can become quite large

Do you have examples of this feature in other projects?

• https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/acmpca_certificate_authority_certificate

Participation

• I am willing to submit a pull request for this issue.

[fwx5618177]

I think has added this filter function.

[delucis]

Thanks for the suggestion @geerew! This would probably need really thorough testing and has a lot of UX and accessibility considerations, so definitely not a simple thing to implement.

I think I might push for us to wait until #415 is addressed and then it might be something people can implement as a plugin rather than having it as a built-in feature.

[HiDeoo]

To give an update on that feature request:

• Component overrides are now available in Starlight for a while
• Overrides can re-use a built-in component
• <Sidebar> is one of the overridable components
• The sidebar content is accessible in overrides using the Astro.props.sidebar props

Considering such filtering can now be entirely implemented by users in their Starlight project (and has been done by some users already) and that there is no plan to have it be a built-in feature, I'll close this discussion.