@amsterdam/design-system-react/dist/Heading/Heading.d.ts

All React components from the Amsterdam Design System. Use it to compose pages in your website or application.

/**
 * @license EUPL-1.2+
 * Copyright (c) 2021 Robbert Broersma
 * Copyright Gemeente Amsterdam
 */
import type { HTMLAttributes, PropsWithChildren } from 'react';
export declare const headingSizes: readonly [1, 2, 3, 4];
type HeadingSize = (typeof headingSizes)[number];
export type HeadingProps = {
    /** Changes the text colour for readability on a dark background. */
    color?: 'inverse';
    /** The hierarchical level within the document. */
    level: HeadingSize;
    /**
     * Uses larger or smaller text without changing its position in the heading hierarchy.
     * The value ‘level-6’ is deprecated. Use level 5 instead.
     */
    size?: 'level-1' | 'level-2' | 'level-3' | 'level-4' | 'level-5' | 'level-6';
} & PropsWithChildren<HTMLAttributes<HTMLHeadingElement>>;
/**
 * @see {@link https://designsystem.amsterdam/?path=/docs/components-text-heading--docs Heading docs at Amsterdam Design System}
 */
export declare const Heading: import("react").ForwardRefExoticComponent<{
    /** Changes the text colour for readability on a dark background. */
    color?: "inverse";
    /** The hierarchical level within the document. */
    level: HeadingSize;
    /**
     * Uses larger or smaller text without changing its position in the heading hierarchy.
     * The value ‘level-6’ is deprecated. Use level 5 instead.
     */
    size?: "level-1" | "level-2" | "level-3" | "level-4" | "level-5" | "level-6";
} & HTMLAttributes<HTMLHeadingElement> & {
    children?: import("react").ReactNode | undefined;
} & import("react").RefAttributes<HTMLHeadingElement>>;
export {};