@chakra-ui/live-region
Advanced tools
Comparing version 2.0.11 to 2.0.12
@@ -1,53 +0,2 @@ | ||
interface LiveRegionOptions { | ||
/** | ||
* A unique id for the created live region element | ||
*/ | ||
id?: string; | ||
/** | ||
* Used to mark a part of the page as "live" so that updates will | ||
* be communicated to users by screen readers. | ||
* | ||
* - If set to `polite`: tells assistive technology to alert the user | ||
* to this change when it has finished whatever it is currently doing | ||
* | ||
* - If set to `assertive`: tells assistive technology to interrupt whatever | ||
* it is doing and alert the user to this change immediately | ||
* | ||
* @default "polite". | ||
*/ | ||
"aria-live"?: "polite" | "assertive"; | ||
/** | ||
* The desired value of the role attribute | ||
* @default "status" | ||
*/ | ||
role?: "status" | "alert" | "log"; | ||
/** | ||
* Indicates what types of changes should be presented to the user. | ||
* @default "all" | ||
*/ | ||
"aria-relevant"?: React.AriaAttributes["aria-relevant"]; | ||
/** | ||
* Indicates whether the entire region should be | ||
* considered as a whole when communicating updates | ||
* | ||
* @default true | ||
*/ | ||
"aria-atomic"?: React.AriaAttributes["aria-atomic"]; | ||
/** | ||
* The node to append the live region node to | ||
*/ | ||
parentNode?: HTMLElement; | ||
} | ||
declare class LiveRegion { | ||
region: HTMLElement | null; | ||
options: Required<LiveRegionOptions>; | ||
parentNode: HTMLElement; | ||
constructor(options?: LiveRegionOptions); | ||
speak(message: string): void; | ||
destroy(): void; | ||
clear(): void; | ||
} | ||
declare function useLiveRegion(options?: LiveRegionOptions): LiveRegion; | ||
export { LiveRegion, LiveRegionOptions, useLiveRegion }; | ||
export { LiveRegion, LiveRegionOptions } from './live-region.js'; | ||
export { default as useLiveRegion } from './use-live-region.js'; |
{ | ||
"name": "@chakra-ui/live-region", | ||
"version": "2.0.11", | ||
"version": "2.0.12", | ||
"description": "Aria live region for React components", | ||
@@ -18,3 +18,3 @@ "keywords": [ | ||
"license": "MIT", | ||
"main": "dist/index.cjs.js", | ||
"main": "dist/index.js", | ||
"files": [ | ||
@@ -41,9 +41,18 @@ "dist" | ||
}, | ||
"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" | ||
}, | ||
@@ -53,8 +62,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
19242
14
547
1