title | description |
---|---|
Icons Reference |
An overview of all the icons available in Starlight. |
Starlight provides a set of built-in icons that you can display in your content using the <Icon>
component.
Icons can be displayed using the <Icon>
component.
They are also often used in other components, such as cards or settings like hero actions.
Use the StarlightIcon
TypeScript type to reference the names of Starlight’s built-in icons.
// src/icon.ts
import type { StarlightIcon } from '@astrojs/starlight/types';
function getIconLabel(icon: StarlightIcon) {
// …
}
A list of all available icons is shown below with their associated names. Click an icon to copy its name to your clipboard.
import IconsList from '~/components/icons-list.astro';
<IconsList labels={{ copied: 'Copied!' }} />