Footer

Site footer with brand, link groups, and meta. The docs footer uses it.

Import

import {
  Footer,
  FooterBrand,
  FooterBrandName,
  FooterBrandDescription,
  FooterNav,
  FooterGroup,
  FooterGroupLabel,
  FooterLink,
  FooterMeta,
  FooterCopyright,
} from "@pelagornis/page/components";

Example

The preview above renders this file. Copy it into src/components/ to start from it.

import {
  Footer,
  FooterBrand,
  FooterBrandDescription,
  FooterBrandName,
  FooterCopyright,
  FooterGroup,
  FooterGroupLabel,
  FooterLink,
  FooterMeta,
  FooterNav,
} from "@pelagornis/page/components";

export default function FooterDemo() {
  return (
    <Footer className="w-full">
      <FooterBrand>
        <FooterBrandName>Page</FooterBrandName>
        <FooterBrandDescription>A Starlight theme built on RefineUI.</FooterBrandDescription>
      </FooterBrand>
      <FooterNav>
        <FooterGroup>
          <FooterGroupLabel>Docs</FooterGroupLabel>
          <FooterLink href="/guides/getting-started/">Getting started</FooterLink>
          <FooterLink href="/components/">Components</FooterLink>
        </FooterGroup>
        <FooterGroup>
          <FooterGroupLabel>Project</FooterGroupLabel>
          <FooterLink href="https://github.com/pelagornis/starlight-theme-page">GitHub</FooterLink>
        </FooterGroup>
      </FooterNav>
      <FooterMeta>
        <FooterCopyright>© Pelagornis</FooterCopyright>
      </FooterMeta>
    </Footer>
  );
}

Use in MDX

Footer is composed from parts that share React state. Children written in MDX are rendered as separate islands, so the parts can’t reach each other. Put the composition in a .tsx file, like the example above, and import that file instead.

---
title: Example
---

import FooterExample from "../../components/FooterExample";

<FooterExample client:load />

client:load hydrates the island on page load. Use client:visible for content far down the page.

Use in Markdoc

Markdoc tags render Astro components, and this one needs client state. Wrap the example in an .astro file that hydrates it, then register that file as a tag.

---
import FooterExample from "../FooterExample";
---

<FooterExample client:load />

import { component, defineMarkdocConfig } from "@astrojs/markdoc/config";
import starlightMarkdoc from "@astrojs/starlight-markdoc";
import pageMarkdoc from "@pelagornis/page/markdoc";

export default defineMarkdocConfig({
  extends: [starlightMarkdoc(), pageMarkdoc()],
  tags: {
    "footer-example": {
      render: component("./src/components/markdoc/FooterExample.astro"),
      selfClosing: true,
    },
  },
});

{% footer-example /%}

Anatomy

Parts of the component and the data-refineui role each one renders.

Part	Role
`root`	footer
`brand`	footer-brand
`brand_description`	footer-brand-description
`brand_name`	footer-brand-name
`copyright`	footer-copyright
`explore`	footer-explore
`group`	footer-group
`group_label`	footer-group-label
`link`	footer-link
`locale`	footer-locale
`logo`	footer-logo
`meta`	footer-meta
`meta_end`	footer-meta-end
`nav`	footer-nav
`social`	footer-social

States

States the component styles. Component states are exposed as data attributes.

Kind	States
Pseudo	`focus-visible`

Reference

RefineUI · Footer for design guidance and token detail.
Use in MDX and Use in Markdoc for the general rules.