@types/react-outside-click-handler - npm Package Compare versions

Comparing version 1.3.3 to 1.3.4

react-outside-click-handler/index.d.ts

 import * as React from "react";
 
-export interface DefaultProps {
-    disabled: boolean;
-    useCapture: boolean;
-    display: "block" | "flex" | "inline" | "inline-block" | "contents";
+declare namespace OutsideClickHandler {
+    interface DefaultProps {
+        /**
+         * If the disabled prop is true, outside clicks will not be registered. This can be
+         * utilized to temporarily disable interaction without unmounting/remounting the entire
+         * tree.
+         *
+         * @default false
+         */
+        disabled: boolean;
+        /**
+         * If useCapture is true, the event will be registered in the capturing phase and thus,
+         * propagated top-down instead of bottom-up as is the default.
+         *
+         * @default true
+         */
+        useCapture: boolean;
+        /**
+         * By default, the OutsideClickHandler renders a display: block <div /> to wrap the
+         * subtree defined by children. If desired, the display can be set to inline-block,
+         * inline, flex, or contents instead. There is no way not to render a wrapping <div />.
+         *
+         * @default "block"
+         */
+        display: "block" | "flex" | "inline" | "inline-block" | "contents";
+    }
+
+    interface Props extends Partial<DefaultProps> {
+        /**
+         * Since the OutsideClickHandler specifically handles clicks outside a specific subtree,
+         * children is expected to be defined. A consumer should also not render the
+         * OutsideClickHandler in the case that children are not defined.
+         */
+        children: React.ReactNode;
+
+        /**
+         * It takes the relevant clickevent as an arg and gets triggered when the user clicks
+         * anywhere outside of the subtree generated by the DOM node.
+         */
+        onOutsideClick: (e: MouseEvent) => void;
+    }
 }
 
-// TODO: Remove partial once DT support TS 3.0, so skipping mandatory listed in default props won't result in compile error
-export interface Props extends Partial<DefaultProps> {
-    children: React.ReactNode;
-    onOutsideClick: (e: MouseEvent) => void;
+declare class OutsideClickHandler extends React.Component<OutsideClickHandler.Props> {
+    static defaultProps: OutsideClickHandler.DefaultProps;
 }
 
-export default class OutsideClickHandler extends React.Component<Props> {
-    static defaultProps: DefaultProps;
-}
+export = OutsideClickHandler;

react-outside-click-handler/package.json

 {
     "name": "@types/react-outside-click-handler",
-    "version": "1.3.3",
+    "version": "1.3.4",
     "description": "TypeScript definitions for react-outside-click-handler",
@@ -35,4 +35,4 @@ "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-outside-click-handler",
     },
-    "typesPublisherContentHash": "80a401911f2fdca19d418c6476721776b9fc576b231ceaf31fdb80875804cb5a",
-    "typeScriptVersion": "4.5"
+    "typesPublisherContentHash": "5e9b829d877a523f4937a1b5c3ed3275a5d6fb05992dbcf10384b75de24ab937",
+    "typeScriptVersion": "4.8"
 }

react-outside-click-handler/README.md

@@ -13,22 +13,55 @@ # Installation
 
-export interface DefaultProps {
-    disabled: boolean;
-    useCapture: boolean;
-    display: "block" | "flex" | "inline" | "inline-block" | "contents";
-}
+declare namespace OutsideClickHandler {
+    interface DefaultProps {
+        /**
+         * If the disabled prop is true, outside clicks will not be registered. This can be
+         * utilized to temporarily disable interaction without unmounting/remounting the entire
+         * tree.
+         *
+         * @default false
+         */
+        disabled: boolean;
+        /**
+         * If useCapture is true, the event will be registered in the capturing phase and thus,
+         * propagated top-down instead of bottom-up as is the default.
+         *
+         * @default true
+         */
+        useCapture: boolean;
+        /**
+         * By default, the OutsideClickHandler renders a display: block <div /> to wrap the
+         * subtree defined by children. If desired, the display can be set to inline-block,
+         * inline, flex, or contents instead. There is no way not to render a wrapping <div />.
+         *
+         * @default "block"
+         */
+        display: "block" | "flex" | "inline" | "inline-block" | "contents";
+    }
 
-// TODO: Remove partial once DT support TS 3.0, so skipping mandatory listed in default props won't result in compile error
-export interface Props extends Partial<DefaultProps> {
-    children: React.ReactNode;
-    onOutsideClick: (e: MouseEvent) => void;
+    interface Props extends Partial<DefaultProps> {
+        /**
+         * Since the OutsideClickHandler specifically handles clicks outside a specific subtree,
+         * children is expected to be defined. A consumer should also not render the
+         * OutsideClickHandler in the case that children are not defined.
+         */
+        children: React.ReactNode;
+
+        /**
+         * It takes the relevant clickevent as an arg and gets triggered when the user clicks
+         * anywhere outside of the subtree generated by the DOM node.
+         */
+        onOutsideClick: (e: MouseEvent) => void;
+    }
 }
 
-export default class OutsideClickHandler extends React.Component<Props> {
-    static defaultProps: DefaultProps;
+declare class OutsideClickHandler extends React.Component<OutsideClickHandler.Props> {
+    static defaultProps: OutsideClickHandler.DefaultProps;
 }
 
+export = OutsideClickHandler;
+
 ````
 
 ### Additional Details
- * Last updated: Tue, 07 Nov 2023 09:09:39 GMT
+ * Last updated: Wed, 25 Sep 2024 19:19:36 GMT
  * Dependencies: [@types/react](https://npmjs.com/package/@types/react)
@@ -35,0 +68,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

6931

increased by60.7%

Lines of code

45

increased by221.43%

Number of lines in readme file

70

increased by89.19%

No dependency changes