@antadesign/anta
    Preparing search index...

    Interface TitlePropsUnreviewed

    Common props for JSX component wrappers.

    interface TitleProps {
        level?: 1 | 2 | 3 | 4 | 5 | 6;
        priority?: "primary" | "secondary" | "tertiary" | "quaternary";
        tone?:
            | "neutral"
            | "brand"
            | "info"
            | "success"
            | "warning"
            | "critical"
            | string & {};
        font?: "serif"
        | "sans-serif"
        | "monospace";
        truncate?: boolean | number;
        className?: string;
        style?: CSSProperties;
        children?: ReactNode;
        id?: string;
        title?: string;
        slot?: string;
        tabIndex?: number;
        key?: string | number | null;
        [key: `data-${string}`]: unknown;
        [key: `aria-${string}`]: unknown;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: `data-${string}`]: unknown

      Any data-* attribute is forwarded to the rendered element.

    • [key: `aria-${string}`]: unknown

      Any aria-* attribute is forwarded to the rendered element.

    Index
    level? priority? tone? font? truncate? className? style? children? id? title? slot? tabIndex? key?
    level?: 1 | 2 | 3 | 4 | 5 | 6

    Sets the heading level and its font size.

    2
    priority?: "primary" | "secondary" | "tertiary" | "quaternary"

    Neutral emphasis uses --text-1 through --text-4. See Colors.

    primary
    tone?:
        | "neutral"
        | "brand"
        | "info"
        | "success"
        | "warning"
        | "critical"
        | string & {}

    Selects a text palette. A CSS color defines a custom tone. See Tone × priority.

    neutral
    font?: "serif" | "sans-serif" | "monospace"

    Selects the typeface. Serif suits page and section headings, sans serif suits headings in cards and panels, and monospace suits identifiers like run IDs. The default comes from the theme and heading level.

    truncate?: boolean | number

    Adds an ellipsis when the title exceeds the line limit. true limits it to one line, and a positive integer sets the line count. false and numbers below 1 disable truncation. A clipped title shows its full text in a tooltip. A nested <Tooltip> replaces the default tooltip.

    Vlad Korobov

    className?: string

    Adds CSS classes to the root element and preserves its existing classes.

    style?: CSSProperties

    Inline CSS styles on the root element.

    children?: ReactNode

    Content to render in place of any default content.

    id?: string

    HTML id attribute.

    title?: string

    HTML title attribute, shown as a browser tooltip on hover.

    slot?: string

    Named slot in a parent web component, such as slot="header" in a <Dialog>.

    tabIndex?: number

    Tab order. Set to -1 to skip the element when tabbing.

    key?: string | number | null

    React/Preact reconciliation key when rendered inside a list. Consumed by the JSX runtime (not forwarded as a DOM attribute).

    Settings
    Member Visibility

    On This Page
    Properties