Repository navigation
New Pagefind UI v2 - #4307
New Pagefind UI v2#4307HiDeoo wants to merge 38 commits into
Conversation
🦋 Changeset detectedLatest commit: 1893a36 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
✅ Deploy Preview for astro-starlight ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Lunaria Status Overview🌕 This pull request will trigger status changes. Learn moreBy default, every PR changing files present in the Lunaria configuration's You can change this by adding one of the keywords present in the Tracked Files
Warnings reference
|
* main: (42 commits) Replace `js-yaml` with `yaml` (withastro#4218) i18n(de): improve `configuration` and `frontmatter` (withastro#4335) i18n(de): fix `findst` typo (withastro#4333) i18n(de): fix `Überschriftenebene` spelling (withastro#4334) Preserve prototype-named directories in localized routes (withastro#4316) i18n(de): update `plugins.mdx` (withastro#4330) i18n(es): update icons.mdx (withastro#4329) i18n(es): update badges.mdx (withastro#4327) i18n(es): update asides.mdx and icons.mdx (withastro#4326) docs: add @heydeacon/starlight to community plugins (withastro#4319) i18n(ko-KR): update `community-content`, `plugins` (withastro#4321) i18n(ru): update translations (withastro#4320) Prettier update follow-up (withastro#4322) [i18nIgnore] Update to v1 of `prettier-plugin-astro` (withastro#4175) [ci] release (withastro#4298) docs: fix icon name search (withastro#4310) i18n(ja): update plugins.mdx and community-content.mdx (withastro#4311) Fix Object.prototype property names in autogenerated sidebars (withastro#4309) Fix last updated dates for file paths containing special characters (withastro#4290) Fix `size-limit` CI job (withastro#4308) ...
| "@types/hast": "^3.0.5", | ||
| "@types/mdast": "^4.0.4", | ||
| "astro-expressive-code": "^0.44.0", | ||
| "bcp-47": "^2.1.0", |
There was a problem hiding this comment.
Bumped to match the @pagefind/component-ui requirement and avoid 2 copies.
This comment was marked as low quality.
This comment was marked as low quality.
* main: (62 commits) docs: point the changeset link at the current Changesets docs (withastro#4387) i18n(ko-KR): update `configuration`, `overrides` (withastro#4399) i18n(ja): update plugins.mdx (withastro#4403) i18n(ja): update overrides.md (withastro#4401) i18n(ja): update configuration.mdx (withastro#4402) i18n(ja): update site-search.mdx (withastro#4400) i18n(de): update `resources/plugins` (withastro#4407) i18n(de): update `overrides.mdx` (withastro#4406) i18n(de): update `configuration.mdx` (withastro#4405) i18n(de): update `site-search.mdx` (withastro#4404) [ci] release (withastro#4398) fix: restore aside component icon size (withastro#4396) i18n(es): update project-structure.mdx (withastro#4393) [ci] release (withastro#4391) Update peter-evans/create-pull-request action to v8.1.3 (withastro#4392) Allow passing user options to `pagefind.createIndex` (withastro#3674) Refactor `ThemeSelect` to use CSS instead of JS for icon updates (withastro#4219) Support any `scopedStyleStrategy` (withastro#4190) Update i18next to v27 (withastro#4385) Fix asides accepting Object.prototype property names as custom icons (withastro#4390) ...

Description
This PR is a draft of the rewrite of the Pagefind UI that is used in Starlight. This is an alternative approach to #3335 that uses the new Pagefind Component UI.
This is a work in progress and is not ready for review yet as I'm still reviewing some implementation details and a11y requirements. I am also working on a list of upstream changes/fixes to share with Liam that would be needed (and I can work on them) if we want to move forward with this approach.
I will be sharing more details and updates here as the work progresses.
Like #3335, this PR also adds support for new features which are currently not supported at all in Starlight.
triggerFiltersandtriggerSearch.starlight-versionsplugin having to re-implement entirely theSearchcomponent just to trigger this functionality.Searchcomponent with a custom web component, get the Pagefind instance used by Starlight, and have complete access to the public API provided by Pagefind.show-emptyoption (previouslyshowEmptyFilters)openoption (previouslyopenFilters)Development notes
pnpm pagefindcommand to thedocs/directory which should be used when iterating on this PR:dist/pagefindtopublic/pagefindand runs a development server.http://localhost:4321will use the search indexes from the prod version which allows for using/testing/iterating on the search UI (note that changes that would result in a change to the search indexes will require running thepnpm pagefindcommand again).Remaining tasks
TODO(HiDeoo)comments and address them.pagefindnpm script from thedocs/directory.