@grove-dev/starlight 0.7.0 → 0.8.0

package/components/custom/ContainerSection.astro

@@ -1,6 +1,6 @@
 ---
 type Props = {
-    width?: 'sm' | 'md' | 'lg' | 'xl';
+  width?: 'sm' | 'md' | 'lg' | 'xl';
 };
 
 const { width = 'lg' } = Astro.props;

package/components/custom/LinkButton.astro

@@ -10,22 +10,22 @@ export type ButtonVariant = 'default' | 'link' | 'secondary' | 'outline' | 'ghos
 export type LegacyButtonVariant = 'primary' | 'minimal';
 
 const LEGACY_VARIANTS = {
-    primary: 'default',
-    minimal: 'ghost',
+  primary: 'default',
+  minimal: 'ghost',
 } as const satisfies Record<LegacyButtonVariant, ButtonVariant>;
 
 type Props = (Omit<HTMLAttributes<'a'>, 'href'> | HTMLAttributes<'button'>) & {
-    /** Renders an `<a>` when set, a `<button>` otherwise. */
-    href?: string | URL | null | undefined;
-    variant?: ButtonVariant | LegacyButtonVariant;
-    size?: '2xs' | 'xs' | 'sm' | 'md' | 'lg' | 'icon-sm' | 'icon-md' | 'icon-lg';
+  /** Renders an `<a>` when set, a `<button>` otherwise. */
+  href?: string | URL | null | undefined;
+  variant?: ButtonVariant | LegacyButtonVariant;
+  size?: '2xs' | 'xs' | 'sm' | 'md' | 'lg' | 'icon-sm' | 'icon-md' | 'icon-lg';
 };
 
 const { class: className, variant = 'default', size = 'md', ...attrs } = Astro.props;
 
 // Normalise so the stylesheet only ever has to know about the canonical variant names.
 const resolvedVariant: ButtonVariant =
-    LEGACY_VARIANTS[variant as LegacyButtonVariant] ?? (variant as ButtonVariant);
+  LEGACY_VARIANTS[variant as LegacyButtonVariant] ?? (variant as ButtonVariant);
 
 const Tag = attrs.href ? 'a' : 'button';
 ---

package/components/custom/dropdown/Dropdown.astro

@@ -2,11 +2,11 @@
 import type { HTMLAttributes } from 'astro/types';
 
 type Props = HTMLAttributes<'div'> & {
-    /** When true, the dropdown will open on hover in addition to click */
-    openOnHover?: boolean;
-    /** Time in milliseconds to wait before closing when hover open is enabled (defaults to 200) */
-    closeDelay?: number;
-    children: any;
+  /** When true, the dropdown will open on hover in addition to click */
+  openOnHover?: boolean;
+  /** Time in milliseconds to wait before closing when hover open is enabled (defaults to 200) */
+  closeDelay?: number;
+  children: any;
 };
 
 const { class: className, openOnHover = false, closeDelay = 200, ...rest } = Astro.props;

package/components/custom/dropdown/DropdownContent.astro

@@ -2,35 +2,35 @@
 import type { HTMLAttributes } from 'astro/types';
 
 type Props = HTMLAttributes<'div'> & {
-    /**
-     * Side of the dropdown
-     * @default bottom
-     */
-    side?: 'top' | 'bottom' | 'left' | 'right';
-    /**
-     * Alignment of the dropdown
-     * @default start
-     */
-    align?: 'start' | 'center' | 'end';
-    /**
-     * Offset distance in pixels
-     * @default 4
-     */
-    sideOffset?: number;
-    /**
-     * Open and close animation duration in milliseconds
-     * @default 150
-     */
-    animationDuration?: number;
+  /**
+   * Side of the dropdown
+   * @default bottom
+   */
+  side?: 'top' | 'bottom' | 'left' | 'right';
+  /**
+   * Alignment of the dropdown
+   * @default start
+   */
+  align?: 'start' | 'center' | 'end';
+  /**
+   * Offset distance in pixels
+   * @default 4
+   */
+  sideOffset?: number;
+  /**
+   * Open and close animation duration in milliseconds
+   * @default 150
+   */
+  animationDuration?: number;
 };
 
 const {
-    class: className,
-    side = 'bottom',
-    align = 'start',
-    sideOffset = 4,
-    animationDuration = 150,
-    ...rest
+  class: className,
+  side = 'bottom',
+  align = 'start',
+  sideOffset = 4,
+  animationDuration = 150,
+  ...rest
 } = Astro.props;
 ---
 

package/components/custom/dropdown/DropdownItem.astro

@@ -2,14 +2,14 @@
 import type { HTMLTag, Polymorphic } from 'astro/types';
 
 type Props<Tag extends HTMLTag> = Polymorphic<{ as: Tag }> & {
-    /**
-     * Whether the item is inset (has left padding)
-     */
-    inset?: boolean;
-    /**
-     * Whether the item is disabled
-     */
-    disabled?: boolean;
+  /**
+   * Whether the item is inset (has left padding)
+   */
+  inset?: boolean;
+  /**
+   * Whether the item is disabled
+   */
+  disabled?: boolean;
 };
 
 const { class: className, inset = false, disabled = false, as: Tag = 'div', ...rest } = Astro.props;

package/components/custom/dropdown/DropdownLabel.astro

@@ -2,10 +2,10 @@
 import type { HTMLAttributes } from 'astro/types';
 
 type Props = HTMLAttributes<'div'> & {
-    /**
-     * Whether the label is inset (has left padding)
-     */
-    inset?: boolean;
+  /**
+   * Whether the label is inset (has left padding)
+   */
+  inset?: boolean;
 };
 
 const { class: className, inset = false, ...rest } = Astro.props;

package/components/custom/dropdown/DropdownTrigger.astro

@@ -3,27 +3,27 @@ import type { HTMLAttributes } from 'astro/types';
 import LinkButton, { type ButtonVariant, type LegacyButtonVariant } from '../LinkButton.astro';
 
 type Props = Omit<HTMLAttributes<'button'>, 'role' | 'type'> & {
-    /**
-     * When true, the component will render its child element with a simple wrapper instead of a button component
-     */
-    asChild?: boolean;
+  /**
+   * When true, the component will render its child element with a simple wrapper instead of a button component
+   */
+  asChild?: boolean;
 
-    variant?: ButtonVariant | LegacyButtonVariant;
-    size?: '2xs' | 'xs' | 'sm' | 'md' | 'lg' | 'icon-sm' | 'icon-md' | 'icon-lg';
+  variant?: ButtonVariant | LegacyButtonVariant;
+  size?: '2xs' | 'xs' | 'sm' | 'md' | 'lg' | 'icon-sm' | 'icon-md' | 'icon-lg';
 };
 
 const {
-    class: className,
-    variant = 'secondary',
-    size = 'sm',
-    asChild = false,
-    ...rest
+  class: className,
+  variant = 'secondary',
+  size = 'sm',
+  asChild = false,
+  ...rest
 } = Astro.props;
 
 // Get the first child element if asChild is true
 let hasChildren = false;
 if (Astro.slots.has('default')) {
-    hasChildren = true;
+  hasChildren = true;
 }
 ---
 

package/components/custom/dropdown/index.ts

@@ -9,21 +9,21 @@ import DropdownShortcut from './DropdownShortcut.astro';
 import DropdownTrigger from './DropdownTrigger.astro';
 
 export {
-    Dropdown,
-    DropdownContent,
-    DropdownItem,
-    DropdownLabel,
-    DropdownSeparator,
-    DropdownShortcut,
-    DropdownTrigger,
+  Dropdown,
+  DropdownContent,
+  DropdownItem,
+  DropdownLabel,
+  DropdownSeparator,
+  DropdownShortcut,
+  DropdownTrigger,
 };
 
 export default {
-    Root: Dropdown,
-    Trigger: DropdownTrigger,
-    Content: DropdownContent,
-    Item: DropdownItem,
-    Label: DropdownLabel,
-    Separator: DropdownSeparator,
-    Shortcut: DropdownShortcut,
+  Root: Dropdown,
+  Trigger: DropdownTrigger,
+  Content: DropdownContent,
+  Item: DropdownItem,
+  Label: DropdownLabel,
+  Separator: DropdownSeparator,
+  Shortcut: DropdownShortcut,
 };

package/components/overrides/Footer.astro

@@ -5,9 +5,9 @@ import Pagination from 'virtual:starlight/components/Pagination';
 import config from 'virtual:starlight/user-config';
 
 const {
-    entry: {
-        data: { template },
-    },
+  entry: {
+    data: { template },
+  },
 } = Astro.locals.starlightRoute;
 
 const { lastUpdated: showLastUpdated, editLink } = config;

package/components/overrides/Header.astro

@@ -1,17 +1,16 @@
 ---
 import config from 'virtual:starlight/user-config';
+import LanguageSelect from '@astrojs/starlight/components/LanguageSelect.astro';
+import MobileMenuToggle from './parts/MobileMenuToggle.astro';
+import NavBar from './parts/NavBar.astro';
 import Search from './Search.astro';
+import SiteTitle from './SiteTitle.astro';
 import SocialIcons from './SocialIcons.astro';
-import LanguageSelect from '@astrojs/starlight/components/LanguageSelect.astro';
-
 import ThemeSelect from './ThemeSelect.astro';
-import SiteTitle from './SiteTitle.astro';
-import NavBar from './parts/NavBar.astro';
-import MobileMenuToggle from './parts/MobileMenuToggle.astro';
 
 /** render the `Search` component if Pagefind is enabled or the default search component has been overridden. */
 const shouldRenderSearch =
-    config.pagefind || config.components.Search !== '@astrojs/starlight/components/Search.astro';
+  config.pagefind || config.components.Search !== '@astrojs/starlight/components/Search.astro';
 ---
 
 <MobileMenuToggle />

package/components/overrides/Hero.astro

@@ -1,6 +1,6 @@
 ---
-import { Icon } from '@astrojs/starlight/components';
 import { Image } from 'astro:assets';
+import { Icon } from '@astrojs/starlight/components';
 import { PAGE_TITLE_ID } from '../../core/config/constants';
 import { warnAboutMissingDocsSchemaOnce } from '../../core/config/docs-schema';
 import ContainerSection from '../custom/ContainerSection.astro';
@@ -11,11 +11,11 @@ const { data } = Astro.locals.starlightRoute.entry;
 warnAboutMissingDocsSchemaOnce(data.hero);
 
 const {
-    title = data.title,
-    tagline: heroTagline,
-    image,
-    announcement,
-    actions = [],
+  title = data.title,
+  tagline: heroTagline,
+  image,
+  announcement,
+  actions = [],
 } = data.hero || {};
 
 // Falls back on an empty tagline too, not just a missing one.
@@ -23,9 +23,9 @@ const tagline = heroTagline || data.description;
 
 const hasImage = !!image;
 const imageAttrs = {
-    loading: 'eager' as const,
-    decoding: 'async' as const,
-    alt: image?.alt || '',
+  loading: 'eager' as const,
+  decoding: 'async' as const,
+  alt: image?.alt || '',
 };
 
 let darkImage: ImageMetadata | undefined;
@@ -33,14 +33,14 @@ let lightImage: ImageMetadata | undefined;
 let rawHtml: string | undefined;
 
 if (image) {
-    if ('file' in image) {
-        darkImage = image.file;
-    } else if ('dark' in image) {
-        darkImage = image.dark;
-        lightImage = image.light;
-    } else {
-        rawHtml = image.html;
-    }
+  if ('file' in image) {
+    darkImage = image.file;
+  } else if ('dark' in image) {
+    darkImage = image.dark;
+    lightImage = image.light;
+  } else {
+    rawHtml = image.html;
+  }
 }
 ---
 

package/components/overrides/PageFrame.astro

@@ -1,29 +1,29 @@
 ---
-import { AstroError } from 'astro/errors';
-import { marked } from 'marked';
 import userConfig from 'virtual:grove-starlight-config';
 import starlightConfig from 'virtual:starlight/user-config';
+import { AstroError } from 'astro/errors';
+import { marked } from 'marked';
 import { createLocaleLookup, resolveLocalizedString } from '../../core/i18n';
 import Drawer from './parts/Drawer.astro';
 
 const { hasSidebar, lang, locale } = Astro.locals.starlightRoute;
 
 const localeKeys = createLocaleLookup({
-    lang,
-    locale: Astro.currentLocale ?? locale,
-    defaultLang: starlightConfig.defaultLocale?.lang,
-    defaultLocale: starlightConfig.defaultLocale?.locale,
+  lang,
+  locale: Astro.currentLocale ?? locale,
+  defaultLang: starlightConfig.defaultLocale?.lang,
+  defaultLocale: starlightConfig.defaultLocale?.locale,
 });
 
 let footerText: string;
 
 try {
-    footerText = resolveLocalizedString(userConfig.footerText, localeKeys);
+  footerText = resolveLocalizedString(userConfig.footerText, localeKeys);
 } catch (error) {
-    throw new AstroError(
-        error instanceof Error ? error.message : 'Invalid footerText localization.',
-        'Update the Grove config so footerText includes a key for the default language.'
-    );
+  throw new AstroError(
+    error instanceof Error ? error.message : 'Invalid footerText localization.',
+    'Update the Grove config so footerText includes a key for the default language.',
+  );
 }
 ---
 

package/components/overrides/PageTitle.astro

@@ -1,13 +1,13 @@
 ---
+import userConfig from 'virtual:grove-starlight-config';
 import { Icon } from '@astrojs/starlight/components';
 import { PAGE_TITLE_ID } from '../../core/config/constants';
-import userConfig from 'virtual:grove-starlight-config';
 import { Dropdown, DropdownContent, DropdownItem, DropdownTrigger } from '../custom/dropdown';
 import LinkButton from '../custom/LinkButton.astro';
 
 const {
-    entry: { data },
-    pagination: { prev, next },
+  entry: { data },
+  pagination: { prev, next },
 } = Astro.locals.starlightRoute;
 
 const { title, description } = data;

package/components/overrides/Search.astro

@@ -3,12 +3,12 @@ import '@pagefind/default-ui/css/ui.css';
 import project from 'virtual:starlight/project-context';
 
 const pagefindTranslations = {
-    placeholder: Astro.locals.t('search.label'),
-    ...Object.fromEntries(
-        Object.entries(Astro.locals.t.all())
-            .filter(([key]) => key.startsWith('pagefind.'))
-            .map(([key, value]) => [key.replace('pagefind.', ''), value])
-    ),
+  placeholder: Astro.locals.t('search.label'),
+  ...Object.fromEntries(
+    Object.entries(Astro.locals.t.all())
+      .filter(([key]) => key.startsWith('pagefind.'))
+      .map(([key, value]) => [key.replace('pagefind.', ''), value]),
+  ),
 };
 
 const dataAttributes: DOMStringMap = { 'data-translations': JSON.stringify(pagefindTranslations) };

package/components/overrides/parts/Drawer.astro

@@ -1,7 +1,7 @@
 ---
+import { getRelativeLocaleUrl } from 'astro:i18n';
 import userConfig from 'virtual:grove-starlight-config';
 import starlightConfig from 'virtual:starlight/user-config';
-import { getRelativeLocaleUrl } from 'astro:i18n';
 import { createLocaleLookup, resolveNavLabel } from '../../../core/i18n';
 
 const { sidebar, lang, locale } = Astro.locals.starlightRoute;
@@ -9,10 +9,10 @@ const { sidebar, lang, locale } = Astro.locals.starlightRoute;
 const currentPath = Astro.url.pathname;
 
 const localeKeys = createLocaleLookup({
-    lang,
-    locale: Astro.currentLocale ?? locale,
-    defaultLang: starlightConfig.defaultLocale?.lang,
-    defaultLocale: starlightConfig.defaultLocale?.locale,
+  lang,
+  locale: Astro.currentLocale ?? locale,
+  defaultLang: starlightConfig.defaultLocale?.lang,
+  defaultLocale: starlightConfig.defaultLocale?.locale,
 });
 ---
 

package/components/overrides/parts/NavBar.astro

@@ -1,7 +1,7 @@
 ---
+import { getRelativeLocaleUrl } from 'astro:i18n';
 import userConfig from 'virtual:grove-starlight-config';
 import starlightConfig from 'virtual:starlight/user-config';
-import { getRelativeLocaleUrl } from 'astro:i18n';
 import { createLocaleLookup, resolveNavLabel } from '../../../core/i18n';
 
 const currentPath = Astro.url.pathname;
@@ -9,10 +9,10 @@ const currentPath = Astro.url.pathname;
 const { lang, locale } = Astro.locals.starlightRoute;
 
 const localeKeys = createLocaleLookup({
-    lang,
-    locale: Astro.currentLocale ?? locale,
-    defaultLang: starlightConfig.defaultLocale?.lang,
-    defaultLocale: starlightConfig.defaultLocale?.locale,
+  lang,
+  locale: Astro.currentLocale ?? locale,
+  defaultLang: starlightConfig.defaultLocale?.lang,
+  defaultLocale: starlightConfig.defaultLocale?.locale,
 });
 ---
 

package/components/overrides/parts/SidebarSublist.astro

@@ -5,8 +5,8 @@ import type { StarlightRouteData } from '@astrojs/starlight/route-data';
 import { isSidebarGroupOpen } from '../../../core/sidebar';
 
 interface Props {
-    sublist: StarlightRouteData['sidebar'];
-    nested?: boolean;
+  sublist: StarlightRouteData['sidebar'];
+  nested?: boolean;
 }
 
 const { sublist, nested = false } = Astro.props;

package/components/overrides/parts/toc/TableOfContentsList.astro

@@ -2,13 +2,13 @@
 import type { MarkdownHeading } from 'astro';
 
 interface TocItem extends MarkdownHeading {
-    children: TocItem[];
+  children: TocItem[];
 }
 
 interface Props {
-    toc: TocItem[];
-    depth?: number;
-    isMobile?: boolean;
+  toc: TocItem[];
+  depth?: number;
+  isMobile?: boolean;
 }
 
 const { toc, depth = 0 } = Astro.props;