Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR was opened by the Changesets release GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated.
Releases
@astrojs/starlight-docsearch@0.6.0
Minor Changes
#2578
⚠️ BREAKING CHANGE: The minimum supported version of Starlight is now 0.32.0
f895f75
and #2390f493361
Thanks @HiDeoo and @delucis!Please use the
@astrojs/upgrade
command to upgrade your project:@astrojs/starlight@0.32.0
Minor Changes
#2390
f493361
Thanks @delucis! - Moves route data toAstro.locals
instead of passing it down via component propsPreviously, all of Starlight’s templating components, including user or plugin overrides, had access to a data object for the current route via
Astro.props
.This data is now available as
Astro.locals.starlightRoute
instead.To update, refactor any component overrides you have:
@astrojs/starlight/props
, which is now deprecated.Astro.props
to useAstro.locals.starlightRoute
instead.{...Astro.props}
into child components, which is no longer required.In the following example, a custom override for Starlight’s
LastUpdated
component is updated for the new style:Community Starlight plugins may also need to be manually updated to work with Starlight 0.32. If you encounter any issues, please reach out to the plugin author to see if it is a known issue or if an updated version is being worked on.
#2578
f895f75
Thanks @HiDeoo! - Deprecates the Starlight pluginsetup
hook in favor of the newconfig:setup
hook which provides the same functionality.The Starlight plugin
setup
hook is now deprecated and will be removed in a future release. Please update your plugins to use the newconfig:setup
hook instead.#2578
f895f75
Thanks @HiDeoo! - Exposes the built-in localization system in the Starlight pluginconfig:setup
hook.This addition changes how Starlight plugins add or update translation strings used in Starlight’s localization APIs.
Plugins previously using the
injectTranslations()
callback function from the pluginconfig:setup
hook should now use the same function available in thei18n:setup
hook.#2858
2df9d05
Thanks @XREvo! - Adds support for Pagefind’s multisite search features#2578
f895f75
Thanks @HiDeoo! - Adds a newHookParameters
utility type to get the type of a plugin hook’s arguments.#2578
f895f75
Thanks @HiDeoo! - Adds a newuseTranslations()
callback function to the Starlight pluginconfig:setup
hook to generate a utility function to access UI strings for a given language.#2578
f895f75
Thanks @HiDeoo! - Adds a newabsolutePathToLang()
callback function to the Starlight pluginconfig:setup
to get the language for a given absolute file path.Patch Changes
9b32ba9
Thanks @HiDeoo! - Fixes styling of filter and metadata elements in Pagefind search UI.