UNPKG

1.44 kBTypeScriptView Raw
1import * as React from 'react';
2import { OverridableComponent, OverrideProps } from '../OverridableComponent';
3
4export interface BottomNavigationTypeMap<P = {}, D extends React.ElementType = 'div'> {
5 props: P & {
6 /**
7 * The content of the component.
8 */
9 children?: React.ReactNode;
10 /**
11 * Callback fired when the value changes.
12 *
13 * @param {object} event The event source of the callback.
14 * @param {any} value We default to the index of the child.
15 */
16 onChange?: (event: React.ChangeEvent<{}>, value: any) => void;
17 /**
18 * If `true`, all `BottomNavigationAction`s will show their labels.
19 * By default, only the selected `BottomNavigationAction` will show its label.
20 */
21 showLabels?: boolean;
22 /**
23 * The value of the currently selected `BottomNavigationAction`.
24 */
25 value?: any;
26 };
27 defaultComponent: D;
28 classKey: BottomNavigationClassKey;
29}
30/**
31 *
32 * Demos:
33 *
34 * - [Bottom Navigation](https://mui.com/components/bottom-navigation/)
35 *
36 * API:
37 *
38 * - [BottomNavigation API](https://mui.com/api/bottom-navigation/)
39 */
40declare const BottomNavigation: OverridableComponent<BottomNavigationTypeMap>;
41
42export type BottomNavigationClassKey = 'root';
43
44export type BottomNavigationProps<
45 D extends React.ElementType = BottomNavigationTypeMap['defaultComponent'],
46 P = {}
47> = OverrideProps<BottomNavigationTypeMap<P, D>, D>;
48
49export default BottomNavigation;