Askr documentation
Generated API snapshot

@askrjs/themes/heading

Exports from the declarations published in @askrjs/themes. Signatures reflect the published artifact.

Exports

This entrypoint publishes 4 exports. Use the anchored symbol rows for direct links. Type-only exports are labeled separately from runtime values.

Headingtype

Heading: ({ level, ...props }: HeadingProps) => JSX.Element

Native semantic heading whose visual size is independent from its explicit document level.

HeadingPropstype

HeadingProps: NativeHeadingProps & {
  level: HeadingLevel;
  size?: HeadingSize;
  tone?: TextTone;
  weight?: TextWeight;
  font?: TextFont;
  numeric?: TextNumeric;
  wrap?: TextWrap;
  truncate?: boolean;
  children?: unknown;
  ref?: Ref<HTMLHeadingElement>;
}

Strongly typed semantic heading props with visual treatment independent from document level.

children
children?: unknown;
font
font?: TextFont | undefined;
level
level: HeadingLevel;
numeric
numeric?: TextNumeric | undefined;
ref
ref?: Ref<HTMLHeadingElement>;
size
size?: HeadingSize | undefined;
tone
tone?: TextTone | undefined;
truncate
truncate?: boolean | undefined;
weight
weight?: TextWeight | undefined;
wrap
wrap?: TextWrap | undefined;

HeadingSizetype

HeadingSize: "sm" | "md" | "lg" | "xl" | "2xl" | "3xl"