kylefang/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/zhigang1992/DefinitelyTyped.git synced 2026-05-31 19:12:20 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update type definition

Browse Source 
update type definition for contentLabel props (it was not required, but as of react-modal: 2.2.4, it's required). And order the props in same order as react-modal's source code so it's easy to compare in future.
This commit is contained in:
Nishchal Gautam
2017-08-15 14:01:27 +07:00
committed by Nishchal
parent d4f42ab007
commit 5a3cf56603
2 changed files with 38 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

59
types/react-modal/index.d.ts vendored
View File

@@ -38,36 +38,51 @@ declare namespace ReactModal {
interface Props {
/* Boolean describing if the modal should be shown or not. Defaults to false. */
isOpen: boolean;
/* Object indicating styles to be used for the modal, divided into overlay and content styles. */
style?: Styles;
/* Set this to properly hide your application from assistive screenreaders and other assistive technologies while the modal is open. */
appElement?: HTMLElement | {};
/* Function that will be run after the modal has opened. */
onAfterOpen?(): void;
/* Function that will be run when the modal is requested to be closed, prior to actually closing. */
onRequestClose?(event: (MouseEvent | KeyboardEvent)): void;
/* Number indicating the milliseconds to wait before closing the modal. Defaults to zero (no timeout). */
closeTimeoutMS?: number;
/* Boolean indicating if the appElement should be hidden. Defaults to true. */
ariaHideApp?: boolean;
/* Boolean indicating if the overlay should close the modal. Defaults to true. */
shouldCloseOnOverlayClick?: boolean;
/* String className to be applied to the portal. Defaults to "ReactModalPortal". */
portalClassName?: string;
/* String or object className to be applied to the overlay. */
overlayClassName?: string | Classes;
/* String or object className to be applied to the modal content. */
className?: string | Classes;
/* String indicating how the content container should be announced to screenreaders. */
contentLabel?: string;
/* String indicating the role of the modal, allowing the 'dialog' role to be applied if desired. */
role?: string;
/* Function that will be called to get the parent element that the modal will be attached to. */
parentSelector?(): HTMLElement;
/* String className to be applied to the document.body. */
bodyOpenClassName?: string;
/* String or object className to be applied to the modal content. */
className?: string | Classes;
/* String or object className to be applied to the overlay. */
overlayClassName?: string | Classes;
/* Set this to properly hide your application from assistive screenreaders and other assistive technologies while the modal is open. */
appElement?: HTMLElement | {};
/* Function that will be run after the modal has opened. */
onAfterOpen?(): void;
/* Function that will be run when the modal is requested to be closed, prior to actually closing. */
onRequestClose?(event: (MouseEvent | KeyboardEvent)): void;
/* Number indicating the milliseconds to wait before closing the modal. Defaults to zero (no timeout). */
closeTimeoutMS?: number;
/* Boolean indicating if the appElement should be hidden. Defaults to true. */
ariaHideApp?: boolean;
/* Boolean indicating if the overlay should close the modal. Defaults to true. */
shouldCloseOnOverlayClick?: boolean;
/* Function that will be called to get the parent element that the modal will be attached to. */
parentSelector?(): HTMLElement;
/* Additional aria attributes. */
aria?: Aria;
/* String indicating the role of the modal, allowing the 'dialog' role to be applied if desired. */
role?: string;
/* String indicating how the content container should be announced to screenreaders. */
contentLabel: string;
}
}

1
types/react-modal/react-modal-tests.tsx
View File

@@ -48,6 +48,7 @@ class ExampleOfUsingReactModal extends React.Component {
isOpen={true}
onAfterOpen={onAfterOpenFn}
onRequestClose={onRequestCloseFn}
contentLabel="demo label"
closeTimeoutMS={1000}
style={customStyle}
className={customClasses}