UNPKG

1.15 kBTypeScriptView Raw
1import * as React from 'react';
2import { CSSModule } from './utils';
3import { FadeProps } from './Fade';
4
5export type Direction = 'start' | 'end' | 'bottom' | 'top';
6
7export interface OffcanvasProps extends React.HTMLAttributes<HTMLElement> {
8 [key: string]: any;
9 autoFocus?: boolean;
10 backdrop?: boolean | 'static';
11 backdropClassName?: string;
12 backdropTransition?: FadeProps;
13 container?: string | HTMLElement | React.RefObject<HTMLElement>;
14 contentClassName?: string;
15 cssModule?: CSSModule;
16 fade?: boolean;
17 innerRef?: React.Ref<HTMLElement>;
18 isOpen?: boolean;
19 keyboard?: boolean;
20 labelledBy?: string;
21 offcanvasClassName?: string;
22 offcanvasTransition?: FadeProps;
23 onClosed?: () => void;
24 onEnter?: () => void;
25 onExit?: () => void;
26 onOpened?: () => void;
27 direction?: Direction;
28 returnFocusAfterClose?: boolean;
29 scrollable?: boolean;
30 toggle?: React.KeyboardEventHandler<any> | React.MouseEventHandler<any>;
31 trapFocus?: boolean;
32 unmountOnClose?: boolean;
33 wrapClassName?: string;
34 zIndex?: number | string;
35}
36
37declare class Offcanvas extends React.Component<OffcanvasProps> {}
38export default Offcanvas;