UNPKG

@amsterdam/design-system-react

Version:

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

27 lines (26 loc) 1.29 kB
/** * @license EUPL-1.2+ * Copyright Gemeente Amsterdam */ import type { HTMLAttributes, PropsWithChildren } from 'react'; export type HeadingProps = { /** Changes the text colour for readability on a dark background. */ color?: 'inverse'; /** The hierarchical level within the document. */ level: 1 | 2 | 3 | 4; /** Uses larger or smaller text without changing its position in the heading hierarchy. */ 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: 1 | 2 | 3 | 4; /** Uses larger or smaller text without changing its position in the heading hierarchy. */ size?: "level-1" | "level-2" | "level-3" | "level-4" | "level-5" | "level-6"; } & HTMLAttributes<HTMLHeadingElement> & { children?: import("react").ReactNode | undefined; } & import("react").RefAttributes<HTMLHeadingElement>>;