mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2026-02-12 11:52:44 +00:00
4257a40409
* Added noTransition prop type as it was a part of version 2.6.11 * Allowing disableOverlayClick to be a function. This has been allowed within the component since version 2.1.10 * Bumped version of react-burger-menu in header * Removed patch version
74 lines
2.7 KiB
TypeScript
74 lines
2.7 KiB
TypeScript
// Type definitions for react-burger-menu 2.6
|
|
// Project: https://github.com/negomi/react-burger-menu
|
|
// Definitions by: Rajab Shakirov <https://github.com/radziksh>
|
|
// David Acevedo <https://github.com/dacevedo12>
|
|
// German Pineda <https://github.com/germanp173>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
// TypeScript Version: 2.8
|
|
|
|
import * as React from "react";
|
|
|
|
export interface State {
|
|
isOpen: boolean;
|
|
}
|
|
|
|
export interface Styles {
|
|
bmBurgerBars: Partial<CSSStyleDeclaration>;
|
|
bmBurgerButton: Partial<CSSStyleDeclaration>;
|
|
bmCross: Partial<CSSStyleDeclaration>;
|
|
bmCrossButton: Partial<CSSStyleDeclaration>;
|
|
bmItemList: Partial<CSSStyleDeclaration>;
|
|
bmMenuWrap: Partial<CSSStyleDeclaration>;
|
|
bmMenu: Partial<CSSStyleDeclaration>;
|
|
bmMorphShape: Partial<CSSStyleDeclaration>;
|
|
bmOverlay: Partial<CSSStyleDeclaration>;
|
|
}
|
|
|
|
export interface Props {
|
|
bodyClassName?: string;
|
|
burgerBarClassName?: string;
|
|
burgerButtonClassName?: string;
|
|
className?: string;
|
|
crossButtonClassName?: string;
|
|
crossClassName?: string;
|
|
customBurgerIcon?: JSX.Element | false;
|
|
customCrossIcon?: JSX.Element | false;
|
|
customOnKeyDown?(event: React.KeyboardEvent): void;
|
|
disableAutoFocus?: boolean;
|
|
disableCloseOnEsc?: boolean;
|
|
disableOverlayClick?: boolean | (() => boolean);
|
|
htmlClassName?: string;
|
|
id?: string;
|
|
isOpen?: boolean;
|
|
itemClassName?: string;
|
|
itemListClassName?: string;
|
|
menuClassName?: string;
|
|
morphShapeClassName?: string;
|
|
noOverlay?: boolean;
|
|
noTransition?: boolean;
|
|
onStateChange?(state: State): void;
|
|
// TODO (Rajab) This can be improved, though I do not know how. From PropTypes:
|
|
// styles && styles.outerContainer ? PropTypes.string.isRequired : PropTypes.string
|
|
outerContainerId?: string;
|
|
overlayClassName?: string;
|
|
// TODO (Rajab) This can be improved, though I do not know how. From PropTypes:
|
|
// styles && styles.pageWrap ? PropTypes.string.isRequired : PropTypes.string,
|
|
pageWrapId?: string;
|
|
right?: boolean;
|
|
styles?: Styles;
|
|
width?: number | string;
|
|
}
|
|
|
|
export class ReactBurgerMenu extends React.Component<Props> { }
|
|
|
|
export class slide extends ReactBurgerMenu { }
|
|
export class stack extends ReactBurgerMenu { }
|
|
export class elastic extends ReactBurgerMenu { }
|
|
export class bubble extends ReactBurgerMenu { }
|
|
export class push extends ReactBurgerMenu { }
|
|
export class pushRotate extends ReactBurgerMenu { }
|
|
export class scaleDown extends ReactBurgerMenu { }
|
|
export class scaleRotate extends ReactBurgerMenu { }
|
|
export class fallDown extends ReactBurgerMenu { }
|
|
export class reveal extends ReactBurgerMenu { }
|