Skip to content
THE COMPONENT LIBRARY
Skip to content

Component reference

Footer

Grouped product links and legal information.

Preview

Live preview

Changes apply to this preview only.

Width adapts to the available space

More examples

Different configurations and compositions using the real Pimolu API. Each preview runs independently and follows the site appearance.

Choose a surface, blend into the page, or use a floating frame. The transparent appearance avoids side edges caused by an inset background.

Open preview

Only the columns are required; the brand, the actions and the bottom row are optional.

Open preview

The bottom row separates the copyright from the legal links and wraps when the container is narrow.

Open preview

Usage

Choose surface (default), transparent for a seamless page, or floating for a framed section. bordered controls the top divider; floating retains its frame.

Use actual destinations and keep secondary navigation distinct from primary tasks.

API reference

Generated from the public TypeScript declarations. Native HTML attributes are inherited where the component extends them; this reference includes Pimolu props and selected common native attributes.

PimoluFooterLink

Type source
PimoluFooterLink public API
NameTypeDefaultDescription
labelRequiredReactNode—Visible link label.
hrefRequiredstring—Link destination.
externalboolean | undefinedfalseOpens the link in a new tab with rel="noopener noreferrer". Defaults to false.
labelRequired

ReactNode

No default extracted.

Visible link label.

hrefRequired

string

No default extracted.

Link destination.

external

boolean | undefined

Default: false

Opens the link in a new tab with rel="noopener noreferrer". Defaults to false.

PimoluFooterColumn

Type source
PimoluFooterColumn public API
NameTypeDefaultDescription
titleRequiredReactNode—Title of the column; it also names the navigation landmark.
linksRequiredPimoluFooterLink[]—Public Pimolu prop; see the source declaration for details.
titleRequired

ReactNode

No default extracted.

Title of the column; it also names the navigation landmark.

linksRequired

PimoluFooterLink[]

No default extracted.

Public Pimolu prop; see the source declaration for details.

PimoluFooterProps

Type source
PimoluFooterProps public API
NameTypeDefaultDescription
appearance"surface" | "transparent" | "floating" | undefinedsurface; transparent inherits the page backgroundSurface treatment. Defaults to surface; transparent inherits the page background.
borderedboolean | undefinedtrueDraw the top divider. Defaults to true.
brandReactNode—Logo, wordmark or any brand node.
descriptionReactNode—Short description displayed under the brand.
columnsRequiredPimoluFooterColumn[]—Navigation columns, each rendered as a named landmark.
actionsReactNode—Buttons or links displayed with the brand block.
copyrightReactNode—Copyright line displayed in the bottom row.
bottomReactNode—Legal links or other content displayed opposite the copyright.
classNamestring | undefined—Public Pimolu prop; see the source declaration for details.
defaultValuestring | number | readonly string[] | undefined—Standard React/HTML attribute.
styleCSSProperties | undefined—Standard React/HTML attribute.
aria-labelstring | undefined—Defines a string value that labels the current element.
childrenReactNode—Standard React/HTML attribute.
onChangeChangeEventHandler<HTMLElement, Element> | undefined—Standard React/HTML attribute.
onClickMouseEventHandler<HTMLElement> | undefined—Standard React/HTML attribute.
appearance

"surface" | "transparent" | "floating" | undefined

Default: surface; transparent inherits the page background

Surface treatment. Defaults to surface; transparent inherits the page background.

bordered

boolean | undefined

Default: true

Draw the top divider. Defaults to true.

brand

ReactNode

No default extracted.

Logo, wordmark or any brand node.

description

ReactNode

No default extracted.

Short description displayed under the brand.

columnsRequired

PimoluFooterColumn[]

No default extracted.

Navigation columns, each rendered as a named landmark.

actions

ReactNode

No default extracted.

Buttons or links displayed with the brand block.

copyright

ReactNode

No default extracted.

Copyright line displayed in the bottom row.

bottom

ReactNode

No default extracted.

Legal links or other content displayed opposite the copyright.

className

string | undefined

No default extracted.

Public Pimolu prop; see the source declaration for details.

defaultValue

string | number | readonly string[] | undefined

No default extracted.

Standard React/HTML attribute.

style

CSSProperties | undefined

No default extracted.

Standard React/HTML attribute.

aria-label

string | undefined

No default extracted.

Defines a string value that labels the current element.

children

ReactNode

No default extracted.

Standard React/HTML attribute.

onChange

ChangeEventHandler<HTMLElement, Element> | undefined

No default extracted.

Standard React/HTML attribute.

onClick

MouseEventHandler<HTMLElement> | undefined

No default extracted.

Standard React/HTML attribute.

Accessibility

  • Label multiple navigation regions and keep link groups in a coherent reading order.
Read the accessibility guide →