@amsterdam/design-system-react
Version:
All React components from the Amsterdam Design System. Use it to compose pages in your website or application.
37 lines (36 loc) • 1.54 kB
TypeScript
/**
* @license EUPL-1.2+
* Copyright Gemeente Amsterdam
*/
import type { HTMLAttributes, PropsWithChildren } from 'react';
import type { HeadingProps } from '../Heading';
export type TableOfContentsProps = {
/** The text for the Heading. */
heading?: string;
/**
* The hierarchical level of the Heading within the document.
* Visually, it always has the size of a level 3 Heading.
*/
headingLevel?: HeadingProps['level'];
} & PropsWithChildren<HTMLAttributes<HTMLElement>>;
/**
* @see {@link https://designsystem.amsterdam/?path=/docs/components-navigation-table-of-contents--docs Table Of Contents docs at Amsterdam Design System}
*/
export declare const TableOfContents: import("react").ForwardRefExoticComponent<{
/** The text for the Heading. */
heading?: string;
/**
* The hierarchical level of the Heading within the document.
* Visually, it always has the size of a level 3 Heading.
*/
headingLevel?: HeadingProps["level"];
} & HTMLAttributes<HTMLElement> & {
children?: import("react").ReactNode | undefined;
} & import("react").RefAttributes<HTMLElement>> & {
Link: import("react").ForwardRefExoticComponent<{
label: string;
} & import("react").AnchorHTMLAttributes<HTMLAnchorElement> & import("react").RefAttributes<HTMLAnchorElement>>;
List: import("react").ForwardRefExoticComponent<HTMLAttributes<HTMLUListElement> & {
children?: import("react").ReactNode | undefined;
} & import("react").RefAttributes<HTMLUListElement>>;
};