@chakra-ui/descendant - npm Package Compare versions

Comparing version 2.0.0 to 2.0.1

CHANGELOG.md

 # Change Log
 
+## 2.0.1
+
+### Patch Changes
+
+- [`173738dd9`](https://github.com/chakra-ui/chakra-ui/commit/173738dd938903d2b0fcdc666a7c9f4fe13e2bd6)
+  Thanks [@segunadebayo](https://github.com/segunadebayo)! - > This is an
+  internal package
+
+  - Unexport internal functions and hooks
+  - Allow options passed in `useDescendants` to be set in `DescendantsManager`
+  - Add default export for `createDescendantsContext`
+
 ## 2.0.0
@@ -4,0 +16,0 @@

dist/cjs/descendant.js

@@ -8,2 +8,4 @@ "use strict";
 
+function _extends() { _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
+
 function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
@@ -165,6 +167,2 @@
   _defineProperty(this, "registerNode", function (node, options) {
-    if (options === void 0) {
-      options = {};
-    }
-
     if (!node || _this.descendants.has(node)) return;
@@ -174,8 +172,13 @@ var keys = Array.from(_this.descendants.keys()).concat(node);
 
-    _this.descendants.set(node, {
+    if (options != null && options.disabled) {
+      options.disabled = !!options.disabled;
+    }
+
+    var descendant = _extends({
       node: node,
-      index: -1,
-      disabled: !!options.disabled
-    });
+      index: -1
+    }, options);
 
+    _this.descendants.set(node, descendant);
+
     _this.assignIndex(sorted);
@@ -182,0 +185,0 @@ });

dist/cjs/index.js

 "use strict";
 
 exports.__esModule = true;
+exports["default"] = exports.createDescendantContext = void 0;
 
 var _useDescendant = require("./use-descendant");
 
-Object.keys(_useDescendant).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _useDescendant[key]) return;
-  exports[key] = _useDescendant[key];
-});
-
-var _descendant = require("./descendant");
-
-Object.keys(_descendant).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _descendant[key]) return;
-  exports[key] = _descendant[key];
-});
+exports.createDescendantContext = _useDescendant.createDescendantContext;
+exports["default"] = _useDescendant.createDescendantContext;
 //# sourceMappingURL=index.js.map

dist/cjs/use-descendant.js

 "use strict";
 
 exports.__esModule = true;
-exports.useDescendants = useDescendants;
-exports.useDescendant = useDescendant;
 exports.createDescendantContext = createDescendantContext;
-exports.useDescendantsContext = exports.DescendantsContextProvider = void 0;
 
@@ -57,5 +54,2 @@ var _reactUtils = require("@chakra-ui/react-utils");
 
-exports.useDescendantsContext = useDescendantsContext;
-exports.DescendantsContextProvider = DescendantsContextProvider;
-
 function useDescendant(options) {
@@ -62,0 +56,0 @@ var descendants = useDescendantsContext();

dist/esm/descendant.js

@@ -0,1 +1,3 @@
+function _extends() { _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
+
 function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
@@ -141,18 +143,18 @@
 
-    _defineProperty(this, "registerNode", function (node, options) {
-      if (options === void 0) {
-        options = {};
+    _defineProperty(this, "registerNode", (node, options) => {
+      if (!node || this.descendants.has(node)) return;
+      var keys = Array.from(this.descendants.keys()).concat(node);
+      var sorted = sortNodes(keys);
+
+      if (options != null && options.disabled) {
+        options.disabled = !!options.disabled;
       }
 
-      if (!node || _this.descendants.has(node)) return;
-      var keys = Array.from(_this.descendants.keys()).concat(node);
-      var sorted = sortNodes(keys);
-
-      _this.descendants.set(node, {
+      var descendant = _extends({
         node,
-        index: -1,
-        disabled: !!options.disabled
-      });
+        index: -1
+      }, options);
 
-      _this.assignIndex(sorted);
+      this.descendants.set(node, descendant);
+      this.assignIndex(sorted);
     });
@@ -159,0 +161,0 @@ }

dist/esm/index.js

@@ -1,3 +0,3 @@
-export * from "./use-descendant";
-export * from "./descendant";
+export { createDescendantContext } from "./use-descendant";
+export { createDescendantContext as default } from "./use-descendant";
 //# sourceMappingURL=index.js.map

dist/esm/use-descendant.js

@@ -10,3 +10,3 @@ import { createContext, mergeRefs } from "@chakra-ui/react-utils";
 
-export function useDescendants() {
+function useDescendants() {
   var [descendants] = useState(() => new DescendantsManager());
@@ -26,3 +26,3 @@ useSafeLayoutEffect(() => {
  * -----------------------------------------------------------------------------------------------*/
-export var [DescendantsContextProvider, useDescendantsContext] = createContext({
+var [DescendantsContextProvider, useDescendantsContext] = createContext({
   name: "DescendantsProvider",
@@ -39,3 +39,3 @@ errorMessage: "useDescendantsContext must be used within DescendantsProvider"
 
-export function useDescendant(options) {
+function useDescendant(options) {
   var descendants = useDescendantsContext();
@@ -71,2 +71,3 @@ var [index, setIndex] = useState(-1);
 
+
 export function createDescendantContext() {
@@ -73,0 +74,0 @@ var ContextProvider = cast(DescendantsContextProvider);

dist/types/descendant.d.ts

@@ -1,2 +0,2 @@
-export interface DescendantOptions {
+export declare type DescendantOptions<T = {}> = T & {
     /**
@@ -11,4 +11,4 @@ * If `true`, the item will be registered in all nodes map
     id?: string;
-}
-export interface Descendant<T> extends DescendantOptions {
+};
+export declare type Descendant<T, K> = DescendantOptions<K> & {
     /**
@@ -22,3 +22,3 @@ * DOM element of the item
     index: number;
-}
+};
 /**
@@ -30,5 +30,5 @@ * @internal
  */
-export declare class DescendantsManager<T extends HTMLElement, K = {}> {
+export declare class DescendantsManager<T extends HTMLElement, K extends Record<string, any> = {}> {
     private descendants;
-    register: (nodeOrOptions: T | null | (DescendantOptions & K)) => void | ((node: T | null) => void);
+    register: (nodeOrOptions: T | null | DescendantOptions<K>) => void | ((node: T | null) => void);
     unregister: (node: T) => void;
@@ -39,18 +39,18 @@ destroy: () => void;
     enabledCount: () => number;
-    values: () => Descendant<T>[];
-    enabledValues: () => Descendant<T>[];
-    item: (index: number) => Descendant<T> | undefined;
-    enabledItem: (index: number) => Descendant<T> | undefined;
-    first: () => Descendant<T> | undefined;
-    firstEnabled: () => Descendant<T> | undefined;
-    last: () => Descendant<T> | undefined;
-    lastEnabled: () => Descendant<T> | undefined;
+    values: () => Descendant<T, K>[];
+    enabledValues: () => Descendant<T, K>[];
+    item: (index: number) => Descendant<T, K> | undefined;
+    enabledItem: (index: number) => Descendant<T, K> | undefined;
+    first: () => Descendant<T, K> | undefined;
+    firstEnabled: () => Descendant<T, K> | undefined;
+    last: () => Descendant<T, K> | undefined;
+    lastEnabled: () => Descendant<T, K> | undefined;
     indexOf: (node: T | null) => number;
     enabledIndexOf: (node: T | null) => number;
-    next: (index: number, loop?: boolean) => Descendant<T> | undefined;
-    nextEnabled: (index: number, loop?: boolean) => Descendant<T> | undefined;
-    prev: (index: number, loop?: boolean) => Descendant<T> | undefined;
-    prevEnabled: (index: number, loop?: boolean) => Descendant<T> | undefined;
+    next: (index: number, loop?: boolean) => Descendant<T, K> | undefined;
+    nextEnabled: (index: number, loop?: boolean) => Descendant<T, K> | undefined;
+    prev: (index: number, loop?: boolean) => Descendant<T, K> | undefined;
+    prevEnabled: (index: number, loop?: boolean) => Descendant<T, K> | undefined;
     private registerNode;
 }
 //# sourceMappingURL=descendant.d.ts.map

dist/types/index.d.ts

@@ -1,3 +0,4 @@
-export * from "./use-descendant";
-export * from "./descendant";
+export type { DescendantsManager, Descendant, DescendantOptions, } from "./descendant";
+export { createDescendantContext } from "./use-descendant";
+export { createDescendantContext as default } from "./use-descendant";
 //# sourceMappingURL=index.d.ts.map

dist/types/use-descendant.d.ts

@@ -7,14 +7,6 @@ /// <reference types="react" />
  */
-export declare function useDescendants<T extends HTMLElement = HTMLElement, K = {}>(): DescendantsManager<T, K>;
+declare function useDescendants<T extends HTMLElement = HTMLElement, K = {}>(): DescendantsManager<T, K>;
 export interface UseDescendantsReturn extends ReturnType<typeof useDescendants> {
 }
-export declare const DescendantsContextProvider: import("react").Provider<UseDescendantsReturn>, useDescendantsContext: () => UseDescendantsReturn;
-/**
- * @internal
- * This hook provides information a descendant such as:
- * - Its index compared to other descendants
- * - ref callback to register the descendant
- * - Its enabled index compared to other enabled descendants
- */
-export declare function useDescendant<T extends HTMLElement = HTMLElement, K = {}>(options?: DescendantOptions & K): {
+export declare function createDescendantContext<T extends HTMLElement = HTMLElement, K = {}>(): readonly [import("react").Provider<DescendantsManager<T, K>>, () => DescendantsManager<T, K>, () => DescendantsManager<T, K>, (options?: DescendantOptions<K> | undefined) => {
     descendants: UseDescendantsReturn;
@@ -24,9 +16,4 @@ index: number;
     register: (node: T | null) => void;
-};
-export declare function createDescendantContext<T extends HTMLElement = HTMLElement, K = {}>(): readonly [import("react").Provider<DescendantsManager<T, K>>, () => DescendantsManager<T, K>, () => DescendantsManager<T, K>, (options?: (DescendantOptions & K) | undefined) => {
-    descendants: UseDescendantsReturn;
-    index: number;
-    enabledIndex: number;
-    register: (node: T | null) => void;
 }];
+export {};
 //# sourceMappingURL=use-descendant.d.ts.map

package.json

 {
   "name": "@chakra-ui/descendant",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "Register child nodes of a react element for better accessibility",
@@ -5,0 +5,0 @@ "keywords": [

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

78508

increased by1.14%

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Lines of code

596

decreased by-3.4%

No dependency changes