@chakra-ui/descendant
Advanced tools
Comparing version 3.0.11 to 3.0.12
@@ -1,69 +0,3 @@ | ||
import * as react from 'react'; | ||
declare type DescendantOptions<T = {}> = T & { | ||
/** | ||
* If `true`, the item will be registered in all nodes map | ||
* but omitted from enabled nodes map | ||
*/ | ||
disabled?: boolean; | ||
/** | ||
* The id of the item | ||
*/ | ||
id?: string; | ||
}; | ||
declare type Descendant<T, K> = DescendantOptions<K> & { | ||
/** | ||
* DOM element of the item | ||
*/ | ||
node: T; | ||
/** | ||
* index of item in all nodes map and enabled nodes map | ||
*/ | ||
index: number; | ||
}; | ||
/** | ||
* @internal | ||
* | ||
* Class to manage descendants and their relative indices in the DOM. | ||
* It uses `node.compareDocumentPosition(...)` under the hood | ||
*/ | ||
declare class DescendantsManager<T extends HTMLElement, K extends Record<string, any> = {}> { | ||
private descendants; | ||
register: (nodeOrOptions: T | null | DescendantOptions<K>) => void | ((node: T | null) => void); | ||
unregister: (node: T) => void; | ||
destroy: () => void; | ||
private assignIndex; | ||
count: () => number; | ||
enabledCount: () => number; | ||
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, 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; | ||
} | ||
/** | ||
* @internal | ||
* React hook that initializes the DescendantsManager | ||
*/ | ||
declare function useDescendants<T extends HTMLElement = HTMLElement, K extends Record<string, any> = {}>(): DescendantsManager<T, K>; | ||
interface UseDescendantsReturn extends ReturnType<typeof useDescendants> { | ||
} | ||
declare function createDescendantContext<T extends HTMLElement = HTMLElement, K extends Record<string, any> = {}>(): readonly [react.Provider<DescendantsManager<T, K>>, () => DescendantsManager<T, K>, () => DescendantsManager<T, K>, (options?: DescendantOptions<K>) => { | ||
descendants: UseDescendantsReturn; | ||
index: number; | ||
enabledIndex: number; | ||
register: (node: T | null) => void; | ||
}]; | ||
export { Descendant, DescendantOptions, DescendantsManager, UseDescendantsReturn, createDescendantContext, createDescendantContext as default }; | ||
export { Descendant, DescendantOptions, DescendantsManager } from './descendant.js'; | ||
export { UseDescendantsReturn, createDescendantContext, createDescendantContext as default } from './use-descendant.js'; | ||
import 'react'; |
{ | ||
"name": "@chakra-ui/descendant", | ||
"version": "3.0.11", | ||
"version": "3.0.12", | ||
"description": "Register child nodes of a react element for better accessibility", | ||
@@ -19,3 +19,3 @@ "keywords": [ | ||
"license": "MIT", | ||
"main": "dist/index.cjs.js", | ||
"main": "dist/index.js", | ||
"files": [ | ||
@@ -36,4 +36,4 @@ "dist" | ||
"dependencies": { | ||
"@chakra-ui/react-context": "2.0.5", | ||
"@chakra-ui/react-use-merge-refs": "2.0.5" | ||
"@chakra-ui/react-context": "2.0.6", | ||
"@chakra-ui/react-use-merge-refs": "2.0.6" | ||
}, | ||
@@ -44,14 +44,23 @@ "peerDependencies": { | ||
"devDependencies": { | ||
"@chakra-ui/hooks": "2.1.2", | ||
"@chakra-ui/system": "2.3.2", | ||
"react": "^18.0.0", | ||
"clean-package": "2.1.1" | ||
"clean-package": "2.1.1", | ||
"@chakra-ui/hooks": "2.1.3", | ||
"@chakra-ui/system": "2.3.6" | ||
}, | ||
"module": "dist/index.esm.js", | ||
"clean-package": "../../../clean-package.config.json", | ||
"tsup": { | ||
"clean": true, | ||
"target": "es2019", | ||
"format": [ | ||
"cjs", | ||
"esm" | ||
] | ||
}, | ||
"module": "dist/index.mjs", | ||
"types": "dist/index.d.ts", | ||
"exports": { | ||
".": { | ||
"import": "./dist/index.esm.js", | ||
"require": "./dist/index.cjs.js", | ||
"types": "./dist/index.d.ts" | ||
"types": "./dist/index.d.ts", | ||
"import": "./dist/index.mjs", | ||
"require": "./dist/index.js" | ||
}, | ||
@@ -61,8 +70,8 @@ "./package.json": "./package.json" | ||
"scripts": { | ||
"build": "tsup src/index.ts --dts", | ||
"build": "tsup src --dts", | ||
"dev": "pnpm build:fast -- --watch", | ||
"clean": "rimraf dist .turbo", | ||
"typecheck": "tsc --noEmit", | ||
"build:fast": "tsup src/index.ts" | ||
"build:fast": "tsup src" | ||
} | ||
} |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage 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
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
43839
18
1069
1
+ Added@chakra-ui/react-context@2.0.6(transitive)
+ Added@chakra-ui/react-use-merge-refs@2.0.6(transitive)
- Removed@chakra-ui/react-context@2.0.5(transitive)
- Removed@chakra-ui/react-use-merge-refs@2.0.5(transitive)