Askr documentation
Generated API snapshot

@askrjs/themes/text

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

Exports

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

Texttype

Text: <TElement extends TextElement = "p">(props: TextProps<TElement>) => JSX.Element

Typography primitive: renders any {@link TextElement} (default <p>) and turns size/tone/weight/font/numeric/wrap/truncate into data attributes for CSS styling.

TextElementtype

TextElement: "p" | "span" | "div" | "strong"

Element tags {@link Text} can render as via its as prop.

TextFonttype

TextFont: "body" | "mono"

Font family modifier for {@link Text}.

TextNumerictype

TextNumeric: "normal" | "tabular"

Numeric glyph variant (e.g. tabular figures) for {@link Text}.

TextPropstype

TextProps: TextIntrinsicProps<TElement> & {
  as?: TElement;
  size?: TextSize;
  tone?: TextTone;
  weight?: TextWeight;
  font?: TextFont;
  numeric?: TextNumeric;
  wrap?: TextWrap;
  truncate?: boolean;
  children?: unknown;
  ref?: Ref<HTMLElement>;
}

Props for the {@link Text} component, specialized for a given {@link TextElement} TElement.

as
as?: TElement | undefined;
children
children?: unknown;
font
font?: TextFont | undefined;
numeric
numeric?: TextNumeric | undefined;
ref
ref?: Ref<HTMLElement>;
size
size?: TextSize | undefined;
tone
tone?: TextTone | undefined;
truncate
truncate?: boolean | undefined;
weight
weight?: TextWeight | undefined;
wrap
wrap?: TextWrap | undefined;

TextSizetype

TextSize: "sm" | "md" | "lg"

Font size modifier for {@link Text}.

TextTonetype

TextTone: "default" | "muted" | "subtle" | "inverse" | "success" | "warning" | "danger" | "info"

Color tone modifier for {@link Text}.

TextWeighttype

TextWeight: "normal" | "medium" | "semibold" | "bold"

Font weight modifier for {@link Text}.

TextWraptype

TextWrap: "normal" | "nowrap" | "anywhere"

White-space wrapping behavior for {@link Text}.