Banner basics
A banner is a typed content block rendered on a page. Every banner shares a small set of common properties, then extends them with type-specific props.
Common props
DefaultBannerProps<T>
Used by every banner type.
typename●required
T extends BannerTypename
Discriminator for the banner type. Used for routing, CMS validation, and renderer selection.
title●
Maybe<string>
Optional title shown by many banner renderers.
titleTag●required
'h1' | 'h2'
Semantic heading tag for the title.
titleAlign●required
'left' | 'center' | 'right'
Title alignment used by the renderer.
BannerCSS
Optional CSS identifiers that can be attached to any banner.
cssId●
Maybe<string>
Optional DOM id for anchor navigation and testing.
cssClasses●
Maybe<string>
Optional extra classes applied to the banner wrapper.
Conventions
- Every banner has an
id: string(CMS identity) even if not displayed. - Complex props are usually shared utility objects:
- Images use
ImagePropsorSimpleImageProps - Links use
DynamicLink
- Images use
Placeholders
When a banner references an image, documentation pages show a placeholder:
