masthead

Documentation

Index

• type BrandProps
• type ContentProps
• type MainProps
• type Props
• type ToggleProps

Types

type BrandProps

type BrandProps struct {
	// Children - Content rendered inside of the masthead brand. Optional.
	Children any //  // React.ReactNode
	// ClassName - Additional classes added to the masthead brand. Optional.
	ClassName string
	// Component - Component type of the masthead brand. Optional.
	Component any //  /* any // React.ElementType  | any // React.ComponentType  */
}

type ContentProps

type ContentProps struct {
	// Children - Content rendered inside of the masthead content block. Optional.
	Children any //  // React.ReactNode
	// ClassName - Additional classes added to the masthead content. Optional.
	ClassName string
}

type MainProps

type MainProps struct {
	// Children - Content rendered inside of the masthead main block. Optional.
	Children any //  // React.ReactNode
	// ClassName - Additional classes added to the masthead main. Optional.
	ClassName string
}

type Props

type Props struct {
	// Children - Content rendered inside of the masthead. Optional.
	Children any //  // React.ReactNode
	// ClassName - Additional classes added to the masthead. Optional.
	ClassName string
	// BackgroundColor - Background theme color of the masthead. Optional.
	BackgroundColor any //  /* "dark" | "light" | "light200" */
	// Display - Display type at various breakpoints. Optional.
	Display map[string]string /* { default:{ inline, stack }, sm:{ inline, stack }, md:{ inline, stack }, lg:{ inline, stack }, xl:{ inline, stack }, 2xl:{ inline, stack } } */
	// Inset - Insets at various breakpoints. Optional.
	Inset map[string]string /* { default:{ insetNone, insetXs, insetSm, insetMd, insetLg, insetXl, inset2xl, inset3xl }, sm:{ insetNone, insetXs, insetSm, insetMd, insetLg, insetXl, inset2xl, inset3xl }, md:{ insetNone, insetXs, insetSm, insetMd, insetLg, insetXl, inset2xl, inset3xl }, lg:{ insetNone, insetXs, insetSm, insetMd, insetLg, insetXl, inset2xl, inset3xl }, xl:{ insetNone, insetXs, insetSm, insetMd, insetLg, insetXl, inset2xl, inset3xl }, 2xl:{ insetNone, insetXs, insetSm, insetMd, insetLg, insetXl, inset2xl, inset3xl } } */
}

type ToggleProps

type ToggleProps struct {
	// Children - Content rendered inside of the masthead toggle. Optional.
	Children any //  // React.ReactNode
	// ClassName - Additional classes added to the masthead toggle. Optional.
	ClassName string
}