Hero

@sushindustries/ui

The head of a documentation page - trail, element name, version, measured facts, actions and a picture of itself.

Last updated Aug 17, 20267 min read
View as MarkdownEdit on GitHub

Use it

import { Hero } from "@sushindustries/ui";

export function Page() {
	return (
		<Hero
			title="Field"
			summary="A label, a control, a hint that only shows up when it matters."
			actions={<a href="#install">Install</a>}
		/>
	);
}
tsx

What you should see

A heading with the title, the summary paragraph under it, and the action below that - stacked in one column until there's a shot or media prop to put beside it, at which point the layout splits into two.

If nothing happens

title is the only required prop; a HeroHeroThe head of a documentation page: trail, element name, version, measured facts, actions and a responsive shot. Folds to one column by the room it has, not by the size of the window.@sushindustries/ui · docs with nothing else still renders a heading. If the second column is missing when you expected one, check shot and media aren't both set - shot wins and media is ignored whenever both are given.

UsesIconIconThe glyph set, generated from a Markdown table where every drawing carries its reason. One component, typed names, no icon font.@sushindustries/ui · content
Mentioned inBreadcrumbSection