Skip to main content

Footer

The Footer component provides a comprehensive site footer. Everything in it is data-driven: contact information, social media links, an institutional acknowledgement, partnership logos, legal links, regulatory metadata, and a Creative Commons licence statement all render only when you pass them as props. The theme ships no institutional defaults.

---
import Footer from "astro-theme-university/components/Footer.astro";
---

Props

Prop Type Default Description
contact ContactInfo --- Contact details displayed in the footer.
socials SocialLink[] --- Social media links displayed as icons.
licence string --- SPDX licence identifier for the site content (e.g. "CC-BY-4.0").
legalLinks { text: string; href: string }[] [] Legal links displayed at the bottom.
partnerships PartnershipLink[] --- Partnership logo links in the dark footer band.
meta string[] --- Regulatory metadata lines (e.g. provider IDs, ABN). Each line is rendered as HTML so callers can embed inline links (`<a>`) or other simple markup. Strings are inserted via `set:html`, so values must come from a trusted source — don't pass user input.
colorScheme "auto" | "light" | "dark" "auto" Forwarded from BaseLayout. When not 'auto', the theme toggle button is hidden.
acknowledgement AcknowledgementInfo --- Institutional acknowledgement with an optional logo for the dark band. The theme ships no institutional defaults — branding packages supply this as data.
labels Partial<ThemeLabels> --- Translations of the footer's labels; any left out stay English.

ContactInfo

interface ContactInfo {
  description?: string;
  address?: string;
  email?: string;
  phone?: string;
}
interface SocialLink {
  platform: "facebook" | "instagram" | "youtube" | "linkedin";
  url: string;
}

AcknowledgementInfo

interface AcknowledgementInfo {
  title?: string;
  text: string;
  logo?: ImageMetadata;
  logoAlt?: string;
}

Usage

Footer is typically used via BaseLayout rather than directly, but it can be used standalone in custom layouts.

---
import Footer from "astro-theme-university/components/Footer.astro";
---

<Footer
  name="School of Examples"
  contact={{
    description: "School of Examples, Example University",
    address: "Building 1, Example Road, Canberra ACT 2601",
    email: "enquiries@example.edu",
    phone: "+61 2 6100 0000",
  }}
  socials={[
    { platform: "linkedin", url: "https://linkedin.com/company/example" },
    { platform: "youtube", url: "https://youtube.com/@example" },
  ]}
  licence="CC-BY-4.0"
/>

Institutional content

Institutional elements are supplied as data, typically from a shared site config or a branding package that exports them as a props object:

<Footer
  name="Example University"
  acknowledgement={{
    title: "Acknowledgement",
    text: "Example University acknowledges the traditional custodians of the lands on which it stands.",
  }}
  legalLinks={[
    { text: "Copyright", href: "https://example.edu/copyright" },
    { text: "Privacy", href: "https://example.edu/privacy" },
  ]}
  meta={["Example University, ABN 00 000 000 000"]}
/>

The dark band above the acknowledgement renders only when there’s something to put in it — an acknowledgement.logo or at least one partnerships entry. All these props default to empty, so a footer supplying none of them shows only the contact details, socials, licence, and colour-scheme toggle. The name prop is accepted for parity with BaseLayout but isn’t rendered.

Supported licences

The licence prop accepts the following Creative Commons identifiers: CC-BY-4.0, CC-BY-SA-4.0, CC-BY-NC-4.0, CC-BY-NC-SA-4.0, CC-BY-ND-4.0, and CC-BY-NC-ND-4.0. When provided, a licence statement with a link to the full licence text appears in the footer.

Notes

No live example appears here — the footer is a large, self-contained section that would be disruptive inline. See the bottom of this page for a working instance.