From 3f1fafbac699e6fa0c2912f634c0334482d2727d Mon Sep 17 00:00:00 2001 From: Matthew James Date: Fri, 2 Mar 2018 22:32:45 +0000 Subject: [PATCH] Added comments --- types/react-resize-detector/index.d.ts | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/types/react-resize-detector/index.d.ts b/types/react-resize-detector/index.d.ts index cc6dc8221b..cb275de3ff 100644 --- a/types/react-resize-detector/index.d.ts +++ b/types/react-resize-detector/index.d.ts @@ -7,10 +7,15 @@ import * as React from "react"; interface ReactResizeDetectorProps extends React.Props { + /** Function that will be invoked with width and height arguments */ onResize: (width: number, height: number) => void; + /** Trigger onResize on height change. Default: false */ handleHeight?: boolean; + /** Trigger onResize on width change. Default: false */ handleWidth?: boolean; + /** Do not trigger onResize when a component mounts. Default: false */ skipOnMount?: boolean; + /** Id of the element we want to observe. If none provided, parentElement of the component will be used. Default: "" */ resizableElementId?: string; }