@astrojs/starlight 0.31.0 → 0.31.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @astrojs/starlight
 
+## 0.31.1
+
+### Patch Changes
+
+- [#2805](https://github.com/withastro/starlight/pull/2805) [`ed6f9fd`](https://github.com/withastro/starlight/commit/ed6f9fd77334c02a75240087d0800ef32f159583) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Exposes the [`StarlightIcon`](https://starlight.astro.build/reference/icons/#starlighticon-type) TypeScript type referencing the names of Starlight’s built-in icons.
+
 ## 0.31.0
 
 ### Minor Changes

package/components/ContentNotice.astro

@@ -1,9 +1,9 @@
 ---
-import { Icons } from '../components/Icons';
+import type { StarlightIcon } from '../components/Icons';
 import Icon from '../user-components/Icon.astro';
 
 interface Props {
-	icon: keyof typeof Icons;
+	icon: StarlightIcon;
 	label: string;
 }
 

package/components/Icons.ts

@@ -185,3 +185,5 @@ export const Icons = {
 	...BuiltInIcons,
 	...FileIcons,
 };
+
+export type StarlightIcon = keyof typeof Icons;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@astrojs/starlight",
-  "version": "0.31.0",
+  "version": "0.31.1",
   "description": "Build beautiful, high-performance documentation websites with Astro",
   "keywords": [
     "docs",
@@ -178,10 +178,10 @@
     "@astrojs/markdown-remark": "^6.0.1",
     "@playwright/test": "^1.45.0",
     "@types/node": "^18.16.19",
-    "@vitest/coverage-v8": "2.1.6",
+    "@vitest/coverage-v8": "^3.0.1",
     "astro": "^5.1.5",
     "linkedom": "^0.18.4",
-    "vitest": "2.1.6"
+    "vitest": "^3.0.1"
   },
   "dependencies": {
     "@astrojs/mdx": "^4.0.5",

package/schemas/hero.ts

@@ -1,9 +1,8 @@
 import { z } from 'astro/zod';
 import type { SchemaContext } from 'astro:content';
-import { Icons } from '../components/Icons';
+import { Icons, type StarlightIcon } from '../components/Icons';
 
-type IconName = keyof typeof Icons;
-const iconNames = Object.keys(Icons) as [IconName, ...IconName[]];
+const iconNames = Object.keys(Icons) as [StarlightIcon, ...StarlightIcon[]];
 
 export const HeroSchema = ({ image }: SchemaContext) =>
 	z.object({

package/types.ts

@@ -3,3 +3,4 @@ export type {
 	StarlightPlugin,
 	StarlightUserConfigWithPlugins as StarlightUserConfig,
 } from './utils/plugins';
+export type { StarlightIcon } from './components/Icons';

package/user-components/Card.astro

@@ -1,9 +1,9 @@
 ---
 import Icon from './Icon.astro';
-import type { Icons } from '../components/Icons';
+import type { StarlightIcon } from '../components/Icons';
 
 interface Props {
-	icon?: keyof typeof Icons;
+	icon?: StarlightIcon;
 	title: string;
 }
 

package/user-components/Icon.astro

@@ -1,8 +1,8 @@
 ---
-import { Icons } from '../components/Icons';
+import { Icons, type StarlightIcon } from '../components/Icons';
 
 interface Props {
-	name: keyof typeof Icons;
+	name: StarlightIcon;
 	label?: string;
 	color?: string;
 	size?: string;

package/user-components/LinkButton.astro

@@ -1,11 +1,11 @@
 ---
 import type { HTMLAttributes } from 'astro/types';
-import { Icons } from '../components/Icons';
+import type { StarlightIcon } from '../components/Icons';
 import Icon from './Icon.astro';
 
 interface Props extends Omit<HTMLAttributes<'a'>, 'href'> {
 	href: string | URL;
-	icon?: keyof typeof Icons | undefined;
+	icon?: StarlightIcon | undefined;
 	iconPlacement?: 'start' | 'end' | undefined;
 	variant?: 'primary' | 'secondary' | 'minimal';
 }

package/user-components/TabItem.astro

@@ -1,9 +1,9 @@
 ---
 import { TabItemTagname } from './rehype-tabs';
-import type { Icons } from '../components/Icons';
+import type { StarlightIcon } from '../components/Icons';
 
 interface Props {
-	icon?: keyof typeof Icons;
+	icon?: StarlightIcon;
 	label: string;
 }
 

package/user-components/rehype-file-tree.ts

@@ -6,7 +6,7 @@ import { fromHtml } from 'hast-util-from-html';
 import { toString } from 'hast-util-to-string';
 import { rehype } from 'rehype';
 import { CONTINUE, SKIP, visit } from 'unist-util-visit';
-import { Icons } from '../components/Icons';
+import { Icons, type StarlightIcon } from '../components/Icons';
 import { definitions } from './file-tree-icons';
 
 declare module 'vfile' {
@@ -160,7 +160,7 @@ function getFileIcon(fileName: string) {
 	const name = getFileIconName(fileName);
 	if (!name) return defaultFileIcon;
 	if (name in Icons) {
-		const path = Icons[name as keyof typeof Icons];
+		const path = Icons[name as StarlightIcon];
 		return makeSVGIcon(path);
 	}
 	return defaultFileIcon;

package/user-components/rehype-tabs.ts

@@ -2,13 +2,13 @@ import type { Element } from 'hast';
 import { select } from 'hast-util-select';
 import { rehype } from 'rehype';
 import { CONTINUE, SKIP, visit } from 'unist-util-visit';
-import { Icons } from '../components/Icons';
+import type { StarlightIcon } from '../components/Icons';
 
 interface Panel {
 	panelId: string;
 	tabId: string;
 	label: string;
-	icon?: keyof typeof Icons;
+	icon?: StarlightIcon;
 }
 
 declare module 'vfile' {
@@ -67,7 +67,7 @@ const tabsProcessor = rehype()
 					...ids,
 					label: String(dataLabel),
 				};
-				if (dataIcon) panel.icon = String(dataIcon) as keyof typeof Icons;
+				if (dataIcon) panel.icon = String(dataIcon) as StarlightIcon;
 				file.data.panels?.push(panel);
 
 				// Remove `<TabItem>` props