Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: 🔍 Add Search bar to Docs site #1578

Closed
Hona opened this issue Feb 26, 2024 · 3 comments · Fixed by #1583
Closed

feat: 🔍 Add Search bar to Docs site #1578

Hona opened this issue Feb 26, 2024 · 3 comments · Fixed by #1583

Comments

@Hona
Copy link
Contributor

Hona commented Feb 26, 2024

🙋 Feature Request

Note

I am happy to implement MVP solution but want sign off & a point in the right direction first as a first contribution :)

There are a lot of component pages & articles in the docs site & it is sometimes hard to jump to the correct component.
A search bar/button at the top would assist greatly

image
Figure: Great spot for a search button

🤔 Expected Behavior

MVP: Search Nav Menu links
Non-MVP: Search page content as well

😯 Current Behavior

No search ability, beyond control + f, but sometimes menus are collapsed :(

💁 Possible Solution

MVP: Some injected menu, & string search the entries
Non-MVP: More thought to be had, do we use a 3rd party tool?

🔦 Context

As a developer working with Fluent UI Blazor
I want to navigate the docs site quickly
So that I can develop my solutions

💻 Examples

image
Figure: https://mudblazor.com/

image
Figure: https://antblazor.com/

@pk9r
Copy link
Contributor

pk9r commented Feb 27, 2024

I like this

@vnbaaij
Copy link
Collaborator

vnbaaij commented Feb 27, 2024

Hi Luke,

Would be GREAT if you can contribute this! Think what you described as MVP is a very good starting point and would be a really usefull addition to the site.
Looking forward to your PR!

@Hona Hona mentioned this issue Feb 27, 2024
3 tasks
@Hona
Copy link
Contributor Author

Hona commented Feb 27, 2024

No worries @vnbaaij,

I submitted the PR #1583

Let me know of any issues - I refactored out the nav menu items from raw Razor markup into a common service that the search bar queries, nothing too crazy

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants