UNPKG

1.63 kBTypeScriptView Raw
1import * as React from 'react';
2export interface JumpLinksProps extends Omit<React.HTMLProps<HTMLElement>, 'label'> {
3 /** Whether to center children. */
4 isCentered?: boolean;
5 /** Whether the layout of children is vertical or horizontal. */
6 isVertical?: boolean;
7 /** Label to add to nav element. */
8 label?: React.ReactNode;
9 /** Flag to always show the label when using `expandable` */
10 alwaysShowLabel?: boolean;
11 /** Aria-label to add to nav element. Defaults to label. */
12 'aria-label'?: string;
13 /** Selector for the scrollable element to spy on. Not passing a selector disables spying. */
14 scrollableSelector?: string;
15 /** The index of the child Jump link to make active. */
16 activeIndex?: number;
17 /** Children nodes */
18 children?: React.ReactNode;
19 /** Offset to add to `scrollPosition`, potentially for a masthead which content scrolls under. */
20 offset?: number;
21 /** When to collapse/expand at different breakpoints */
22 expandable?: {
23 default?: 'expandable' | 'nonExpandable';
24 sm?: 'expandable' | 'nonExpandable';
25 md?: 'expandable' | 'nonExpandable';
26 lg?: 'expandable' | 'nonExpandable';
27 xl?: 'expandable' | 'nonExpandable';
28 '2xl'?: 'expandable' | 'nonExpandable';
29 };
30 /** On mobile whether or not the JumpLinks starts out expanded */
31 isExpanded?: boolean;
32 /** Aria label for expandable toggle */
33 toggleAriaLabel?: string;
34 /** Class for nav */
35 className?: string;
36}
37export declare const JumpLinks: React.FunctionComponent<JumpLinksProps>;
38//# sourceMappingURL=JumpLinks.d.ts.map
\No newline at end of file