UNPKG

1.78 kBTypeScriptView Raw
1import * as React from 'react';
2import { ToggleTemplateProps } from './ToggleTemplate';
3export interface OptionsToggleProps extends React.HTMLProps<HTMLDivElement> {
4 /** The type or title of the items being paginated */
5 itemsTitle?: string;
6 /** Accessible label for the options toggle */
7 optionsToggle?: string;
8 /** The title of the pagination options menu */
9 itemsPerPageTitle?: string;
10 /** The first index of the items being paginated */
11 firstIndex?: number;
12 /** The last index of the items being paginated */
13 lastIndex?: number;
14 /** The total number of items being paginated */
15 itemCount?: number;
16 /** Id added to the title of the pagination options menu */
17 widgetId?: string;
18 /** showToggle */
19 showToggle?: boolean;
20 /** Event function that fires when user clicks the options menu toggle */
21 onToggle?: (isOpen: boolean) => void;
22 /** Flag indicating if the options menu dropdown is open or not */
23 isOpen?: boolean;
24 /** Flag indicating if the options menu is disabled */
25 isDisabled?: boolean;
26 /** */
27 parentRef?: HTMLElement;
28 /** This will be shown in pagination toggle span. You can use firstIndex, lastIndex, itemCount, itemsTitle props. */
29 toggleTemplate?: ((props: ToggleTemplateProps) => React.ReactElement) | string;
30 /** Callback for toggle open on keyboard entry */
31 onEnter?: () => void;
32 /** Label for the English word "of" */
33 ofWord?: string;
34 /** Component to be used for wrapping the toggle contents. Use 'button' when you want
35 * all of the toggle text to be clickable.
36 */
37 perPageComponent?: 'div' | 'button';
38}
39export declare const OptionsToggle: React.FunctionComponent<OptionsToggleProps>;
40//# sourceMappingURL=OptionsToggle.d.ts.map
\No newline at end of file