gestalt
Version:
A set of React UI components which enforce Pinterest's design language
29 lines (27 loc) • 1.54 kB
TypeScript
import { ReactNode } from 'react';
import TableOfContentsItem from './TableOfContentsItem';
type Props = {
/**
* String that clients such as VoiceOver will read to describe the element. See [accessibility](https://gestalt.pinterest.systems/web/tableofcontents#Accessibility) section to learn more.
*/
accessibilityLabel?: string;
/**
* Title for the TableOfContents. See the [title variant](https://gestalt.pinterest.systems/web/tableofcontents#With-title) to learn more.
*/
title?: string;
/**
* Must be instances TableofContents.Item
*/
children: ReactNode;
};
/**
* [TableOfContents](https://gestalt.pinterest.systems/web/tableofcontents) component is used to navigate to anchors on a page. It also serves as an outline of a page’s content. TableOfContents is placed on the right side of the page, close to the main content block.
* 
* 
*/
declare function TableOfContents({ accessibilityLabel, title, children }: Props): import("react/jsx-runtime").JSX.Element;
declare namespace TableOfContents {
var Item: typeof TableOfContentsItem;
var displayName: string;
}
export default TableOfContents;