Skip to content

Added search to docs #102

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

Merged
merged 21 commits into from
Jun 4, 2024
Merged

Added search to docs #102

merged 21 commits into from
Jun 4, 2024

Conversation

Hugos68
Copy link
Collaborator

@Hugos68 Hugos68 commented May 17, 2024

  • Added search through Pagefind
  • Created doc dialog system
  • Moved navigation drawer to dialog system
  • Fixed navigation drawer not opening bug

Copy link

vercel bot commented May 17, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
floating-ui-svelte ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 4, 2024 4:32pm

Copy link

changeset-bot bot commented May 17, 2024

⚠️ No Changeset found

Latest commit: d5d81a8

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@Hugos68
Copy link
Collaborator Author

Hugos68 commented May 25, 2024

pnpm check currently fails due to a bug in vite-plugin-svelte: sveltejs/vite-plugin-svelte#912
Once this PR is released check should pass again.

@Hugos68
Copy link
Collaborator Author

Hugos68 commented May 25, 2024

pnpm check currently fails due to a bug in vite-plugin-svelte: sveltejs/vite-plugin-svelte#912
Once this PR is released check should pass again.

This is now fixed 👍
See: https://github.com/sveltejs/vite-plugin-svelte/releases/tag/%40sveltejs%2Fvite-plugin-svelte%404.0.0-next.2

@endigo9740
Copy link
Contributor

endigo9740 commented Jun 3, 2024

@Hugos68 so a few bits of feedback on this one. Generally speaking it's working as expected from a user's perspective. However, I might suggest we organize some of the custom components used here. Long term we will migrate to a Floating UI Svelte powered modal, but until then let's try to group the Dialog-related components. This includes:

  • /docs/components/PageHeader/SearchDialog.svelte
  • /docs/components/Dialog/Dialog/svelte
  • /docs/components/Portal/Portal.svelte

Maybe just go ahead and group those under a dedicated Search directory, so it's easier to purge and replace in the future:

/docs/components/Search/
  - Search.svelte
  - Dialog.svelte
  - Portal.svelte 

Additionally, I'm going to suggest two improvements to the search UI:

  1. Provide the Prompt "What are you searching for" and similar states when the search options (mirror the v3 docs)
  2. Provide a hover state when you mouse over a search result - right now they don't feel like clickable links.

If we can get these changes within the next 24 hours, then this can go out as part of tomorrow's release. Thanks!

@Hugos68
Copy link
Collaborator Author

Hugos68 commented Jun 4, 2024

I've patched up the look and feel to make it in general more consistent.
I've moved SearchDialog to /Dialog.
Portal and Dialog components are not touched because not only the Search depends on them (also the drawer). So putting them in a Search folder is incorrect.

  • idle:
    image
  • typing:
    image
  • no results:
    image
  • hover/focus state:
    image
  • mobile view:
    image

@endigo9740 endigo9740 merged commit 0720e4a into dev Jun 4, 2024
7 checks passed
@endigo9740 endigo9740 deleted the docs/search branch June 4, 2024 17:16
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 this pull request may close these issues.

2 participants