Skip to content
Starlight

Overrides Reference

You can override Starlight’s built-in components by providing paths to replacement components in Starlight’s components configuration option. This page lists all components available to override and links to their default implementations on GitHub.

Learn more in the Guide to Overriding Components.

Component props

All components can access a standard Astro.props object that contains information about the current page.

To type your custom components, import the Props type from Starlight:

---
import type { Props } from '@astrojs/starlight/props';

const { hasSidebar } = Astro.props;
//      ^ type: boolean
---

This will give you autocomplete and types when accessing Astro.props.

Props

Starlight will pass the following props to your custom components.

dir

Type: 'ltr' | 'rtl'

Page writing direction.

lang

Type: string

BCP-47 language tag for this page’s locale, e.g. en, zh-CN, or pt-BR.

locale

Type: string | undefined

The base path at which a language is served. undefined for root locale slugs.

slug

Type: string

The slug for this page generated from the content filename.

id

Type: string

The unique ID for this page based on the content filename.

isFallback

Type: true | undefined

true if this page is untranslated in the current language and using fallback content from the default locale. Only used in multilingual sites.

entryMeta

Type: { dir: 'ltr' | 'rtl'; lang: string }

Locale metadata for the page content. Can be different from top-level locale values when a page is using fallback content.

entry

The Astro content collection entry for the current page. Includes frontmatter values for the current page at entry.data.

entry: {
  data: {
    title: string;
    description: string | undefined;
    // etc.
  }
}

Learn more about the shape of this object in Astro’s Collection Entry Type reference.

Type: SidebarEntry[]

Site navigation sidebar entries for this page.

hasSidebar

Type: boolean

Whether or not the sidebar should be displayed on this page.

pagination

Type: { prev?: Link; next?: Link }

Links to the previous and next page in the sidebar if enabled.

toc

Type: { minHeadingLevel: number; maxHeadingLevel: number; items: TocItem[] } | undefined

Table of contents for this page if enabled.

headings

Type: { depth: number; slug: string; text: string }[]

Array of all Markdown headings extracted from the current page. Use toc instead if you want to build a table of contents component that respects Starlight’s configuration options.

lastUpdated

Type: Date | undefined

JavaScript Date object representing when this page was last updated if enabled.

editUrl

Type: URL | undefined

URL object for the address where this page can be edited if enabled.

Components

These components are rendered inside each page’s <head> element. They should only include elements permitted inside <head>.

Head

Default component: Head.astro

Component rendered inside each page’s <head>. Includes important tags including <title>, and <meta charset="utf-8">.

Override this component as a last resort. Prefer the head option Starlight config if possible.

ThemeProvider

Default component: ThemeProvider.astro

Component rendered inside <head> that sets up dark/light theme support. The default implementation includes an inline script and a <template> used by the script in <ThemeSelect />.

Accessibility

Default component: SkipLink.astro

Component rendered as the first element inside <body> which links to the main page content for accessibility. The default implementation is hidden until a user focuses it by tabbing with their keyboard.

Layout

These components are responsible for laying out Starlight’s components and managing views across different breakpoints. Overriding these comes with significant complexity. When possible, prefer overriding a lower-level component.

PageFrame

Default component: PageFrame.astro

Layout component wrapped around most of the page content. The default implementation sets up the header–sidebar–main layout and includes header and sidebar named slots along with a default slot for the main content. It also renders <MobileMenuToggle /> to support toggling the sidebar navigation on small (mobile) viewports.

MobileMenuToggle

Default component: MobileMenuToggle.astro

Component rendered inside <PageFrame> that is responsible for toggling the sidebar navigation on small (mobile) viewports.

TwoColumnContent

Default component: TwoColumnContent.astro

Layout component wrapped around the main content column and right sidebar (table of contents). The default implementation handles the switch between a single-column, small-viewport layout and a two-column, larger-viewport layout.

These components render Starlight’s top navigation bar.

Header

Default component: Header.astro

Header component displayed at the top of every page. The default implementation displays <SiteTitle />, <Search />, <SocialIcons />, <ThemeSelect />, and <LanguageSelect />.

SiteTitle

Default component: SiteTitle.astro

Component rendered at the start of the site header to render the site title. The default implementation includes logic for rendering logos defined in Starlight config.

Default component: Search.astro

Component used to render Starlight’s search UI. The default implementation includes the button in the header and the code for displaying a search modal when it is clicked and loading Pagefind’s UI.

SocialIcons

Default component: SocialIcons.astro

Component rendered in the site header including social icon links. The default implementation uses the social option in Starlight config to render icons and links.

ThemeSelect

Default component: ThemeSelect.astro

Component rendered in the site header that allows users to select their preferred color scheme.

LanguageSelect

Default component: LanguageSelect.astro

Component rendered in the site header that allows users to switch to a different language.

Starlight’s global sidebar includes the main site navigation. On narrow viewports this is hidden behind a drop-down menu.

Default component: Sidebar.astro

Component rendered before page content that contains global navigation. The default implementation displays as a sidebar on wide enough viewports and inside a drop-down menu on small (mobile) viewports. It also renders <MobileMenuFooter /> to show additional items inside the mobile menu.

MobileMenuFooter

Default component: MobileMenuFooter.astro

Component rendered at the bottom of the mobile drop-down menu. The default implementation renders <ThemeSelect /> and <LanguageSelect />.

Page Sidebar

Starlight’s page sidebar is responsible for displaying a table of contents outlining the current page’s subheadings. On narrow viewports this collapse into a sticky, drop-down menu.

PageSidebar

Default component: PageSidebar.astro

Component rendered before the main page’s content to display a table of contents. The default implementation renders <TableOfContents /> and <MobileTableOfContents />.

TableOfContents

Default component: TableOfContents.astro

Component that renders the current page’s table of contents on wider viewports.

MobileTableOfContents

Default component: MobileTableOfContents.astro

Component that renders the current page’s table of contents on small (mobile) viewports.

Content

These components are rendered in the main column of page content.

Default component: Banner.astro

Banner component rendered at the top of each page. The default implementation uses the page’s banner frontmatter value to decide whether or not to render.

ContentPanel

Default component: ContentPanel.astro

Layout component used to wrap sections of the main content column.

PageTitle

Default component: PageTitle.astro

Component containing the <h1> element for the current page.

Implementations should ensure they set id="_top" on the <h1> element as in the default implementation.

FallbackContentNotice

Default component: FallbackContentNotice.astro

Notice displayed to users on pages where a translation for the current language is not available. Only used on multilingual sites.

Hero

Default component: Hero.astro

Component rendered at the top of the page when hero is set in frontmatter. The default implementation shows a large title, tagline, and call-to-action links alongside an optional image.

MarkdownContent

Default component: MarkdownContent.astro

Component rendered around each page’s main content. The default implementation sets up basic styles to apply to Markdown content.

These components are rendered at the bottom of the main column of page content.

Default component: Footer.astro

Footer component displayed at the bottom of each page. The default implementation displays <LastUpdated />, <Pagination />, and <EditLink />.

LastUpdated

Default component: LastUpdated.astro

Component rendered in the page footer to display the last-updated date.

Default component: EditLink.astro

Component rendered in the page footer to display a link to where the page can be edited.

Pagination

Default component: Pagination.astro

Component rendered in the page footer to display navigation arrows between previous/next pages.