Expose StarlightIcon type

[HiDeoo]

Description

As discussed on Discord, this PR exposes a new TypeScript type for built-in icon names: StarlightIcon. This type is a union of all built-in icon names.

When building an Astro component accepting an icon name, you could already use the ComponentProps<typeof Icon>['name'] approach, but importing the Astro component in a TypeScript file, which could also use ESLint with TypeScript type-aware rules, is not trivial.

A common use case is for example a plugin defining its configuration through a Zod schema where an icon name is required. This can now be validated as a string but still provide autocompletion and type checking for the end user using icon: z.string() as z.Schema<StarlightIcon>.

Regarding the documentation change, I think I did the maximum number of changes so it's easy to remove some of them if there are not judged required or good.

[changeset-bot]

🦋 Changeset detected

Latest commit: e8634e3

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@astrojs/starlight	Minor

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

[netlify]

✅ Deploy Preview for astro-starlight ready!

Name	Link
🔨 Latest commit	e8634e3
🔍 Latest deploy log	https://app.netlify.com/sites/astro-starlight/deploys/678a180fab3c9d0008c1bfa5
😎 Deploy Preview	https://deploy-preview-2805--astro-starlight.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 100 (no change from production) Accessibility: 100 (no change from production) Best Practices: 100 (no change from production) SEO: 100 (no change from production) PWA: - View the detailed breakdown and full score reports

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[astrobot-houston]

Lunaria Status Overview

🌕 This pull request will trigger status changes.

Learn more

By default, every PR changing files present in the Lunaria configuration's files property will be considered and trigger status changes accordingly.

You can change this by adding one of the keywords present in the ignoreKeywords property in your Lunaria configuration file in the PR's title (ignoring all files) or by including a tracker directive in the merged commit's description.

Tracked Files

Locale	File	Note
en	components/icons.mdx	Source changed, localizations will be marked as outdated.
en	components/using-components.mdx	Source changed, localizations will be marked as outdated.
en	reference/icons.mdx	Source changed, localizations will be marked as outdated.

Warnings reference

Icon	Description
🔄️	The source for this localization has been updated since the creation of this pull request, make sure all changes in the source have been applied.

[trueberryless]

I like that the documentation is changed this way. Also nice catch with the changes from Icon to Badge 👌

[delucis]

I think this all looks great and very thorough — I had no idea how often we used keyof typeof Icons 😅 — thank you @HiDeoo!

Had one microscopic query but this PR looks good to go!

[delucis]

Should this maybe be this? Not 100% sure, but “Icon type” suggests overlap with the component itself. I also considered a heading that used “name” somehow, but didn’t come up with a wording I was satisfied with.

Suggested change

	## Icon type
	## `StarlightIcon` type

[HiDeoo]

Good call, just updated the heading and its associated links 👍

[delucis]

Oops, should have checked first that this was a patch — I thought it was 😅

I think it’s OK if I make it one? I know it’s technically a “feature”, but do you think there’s a risk in releasing it in a patch @HiDeoo?

[HiDeoo]

I think it’s OK if I make it one? I know it’s technically a “feature”, but do you think there’s a risk in releasing it in a patch @HiDeoo?

Definitely, go ahead, I went by the definition of semver but I cannot see a risk so I think it should be fine.

[delucis]

Done in bb8e631 — apologies for not being more attentive.