@ngxsmk/cdk 1.2.0 → 1.3.1

package/README.md

@@ -1,13 +1,6 @@
 # @ngxsmk/cdk
 
-Low-level, framework-agnostic Angular behaviors used by NGXSMK components:
-
-- `ClickOutside` — detect clicks outside an element
-- `FocusTrap` — trap focus within a container
-- `ScrollLock` — lock/unlock page scroll
-- `LiveAnnouncer` — announce messages to assistive tech
-- `MediaQuery` — reactive media-query signals
-- `VisuallyHidden` — visually hide content while keeping it accessible
+Low-level, zoneless-friendly Angular behaviors that power NGXSMK components. Each behavior is its own secondary entry point, so you only bundle what you import.
 
 Part of the [NGXSMK UI kit](https://github.com/NGXSMK/ngxsmk-ui-kit).
 
@@ -26,18 +19,68 @@ npm install @ngxsmk/cdk
 
 ## Usage
 
+### Click outside
+
+Emits when a pointer press lands outside the host element.
+
+```html
+<div class="menu" (ngxsmkClickOutside)="close()">…</div>
+```
+
 ```ts
-import { ClickOutside } from '@ngxsmk/cdk/click-outside';
+import { NgxsmkClickOutside } from '@ngxsmk/cdk/click-outside';
 ```
 
-Prefer deep entry-point imports (e.g. `@ngxsmk/cdk/click-outside`) so the
-bundler tree-shakes unused behaviors.
+### Focus trap
+
+Traps Tab focus inside a container. `ngxsmkFocusTrapAutoCapture` moves focus in on init and restores the previously focused element on destroy.
 
-## Building & publishing
+```html
+<div ngxsmkFocusTrap ngxsmkFocusTrapAutoCapture>…</div>
+```
 
-Built with the rest of the workspace via `npm run build:libs`. The published
-artifact lives in `dist/ngxsmk/cdk`. To publish all packages:
+### Scroll lock
 
-```bash
-npm run publish
+Reference-counted body scroll lock for dialogs, drawers, and sheets. Compensates for scrollbar width to avoid layout shift.
+
+```ts
+import { NgxsmkScrollLock } from '@ngxsmk/cdk/scroll-lock';
+
+constructor(private lock: NgxsmkScrollLock) {}
+open() { this.lock.lock(); }
+close() { this.lock.unlock(); }
+```
+
+### Live announcer
+
+Announces messages to assistive technology via a visually hidden `aria-live` region.
+
+```ts
+import { NgxsmkLiveAnnouncer } from '@ngxsmk/cdk/live-announcer';
+
+this.announcer.announce('Item deleted', 'polite');
+```
+
+### Media query
+
+Reactive, signal-based media-query helper (call in an injection context).
+
+```ts
+import { injectMediaQuery } from '@ngxsmk/cdk/media-query';
+
+private readonly isMobile = injectMediaQuery('(max-width: 767px)');
 ```
+
+### Visually hidden
+
+Hides content visually while keeping it available to screen readers.
+
+```html
+<span ngxsmkVisuallyHidden>Opens in a new window</span>
+```
+
+## Entry points
+
+`click-outside`, `focusable`, `focus-trap`, `live-announcer`, `media-query`, `scroll-lock`, `visually-hidden`, `intersection-observer`, `resize-observer`, `autofocus`, `testing`.
+
+Prefer deep imports (e.g. `@ngxsmk/cdk/click-outside`) so the bundler tree-shakes unused behaviors.

package/esm2022/public-api.mjs

@@ -11,5 +11,8 @@ export * from '@ngxsmk/cdk/visually-hidden';
 export * from '@ngxsmk/cdk/intersection-observer';
 export * from '@ngxsmk/cdk/resize-observer';
 export * from '@ngxsmk/cdk/autofocus';
-export * from '@ngxsmk/cdk/testing';
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicHVibGljLWFwaS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3BhY2thZ2VzL2Nkay9wdWJsaWMtYXBpLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBOztHQUVHO0FBRUgsY0FBYywyQkFBMkIsQ0FBQztBQUMxQyxjQUFjLHVCQUF1QixDQUFDO0FBQ3RDLGNBQWMsd0JBQXdCLENBQUM7QUFDdkMsY0FBYyw0QkFBNEIsQ0FBQztBQUMzQyxjQUFjLHlCQUF5QixDQUFDO0FBQ3hDLGNBQWMseUJBQXlCLENBQUM7QUFDeEMsY0FBYyw2QkFBNkIsQ0FBQztBQUM1QyxjQUFjLG1DQUFtQyxDQUFDO0FBQ2xELGNBQWMsNkJBQTZCLENBQUM7QUFDNUMsY0FBYyx1QkFBdUIsQ0FBQztBQUN0QyxjQUFjLHFCQUFxQixDQUFDIiwic291cmNlc0NvbnRlbnQiOlsiLypcbiAqIFB1YmxpYyBBUEkgU3VyZmFjZSBvZiBAbmd4c21rL2Nka1xuICovXG5cbmV4cG9ydCAqIGZyb20gJ0BuZ3hzbWsvY2RrL2NsaWNrLW91dHNpZGUnO1xuZXhwb3J0ICogZnJvbSAnQG5neHNtay9jZGsvZm9jdXNhYmxlJztcbmV4cG9ydCAqIGZyb20gJ0BuZ3hzbWsvY2RrL2ZvY3VzLXRyYXAnO1xuZXhwb3J0ICogZnJvbSAnQG5neHNtay9jZGsvbGl2ZS1hbm5vdW5jZXInO1xuZXhwb3J0ICogZnJvbSAnQG5neHNtay9jZGsvbWVkaWEtcXVlcnknO1xuZXhwb3J0ICogZnJvbSAnQG5neHNtay9jZGsvc2Nyb2xsLWxvY2snO1xuZXhwb3J0ICogZnJvbSAnQG5neHNtay9jZGsvdmlzdWFsbHktaGlkZGVuJztcbmV4cG9ydCAqIGZyb20gJ0BuZ3hzbWsvY2RrL2ludGVyc2VjdGlvbi1vYnNlcnZlcic7XG5leHBvcnQgKiBmcm9tICdAbmd4c21rL2Nkay9yZXNpemUtb2JzZXJ2ZXInO1xuZXhwb3J0ICogZnJvbSAnQG5neHNtay9jZGsvYXV0b2ZvY3VzJztcbmV4cG9ydCAqIGZyb20gJ0BuZ3hzbWsvY2RrL3Rlc3RpbmcnO1xuIl19
+// NOTE: '@ngxsmk/cdk/testing' is intentionally NOT re-exported here. It pulls in
+// axe-core (a CommonJS dependency) which would otherwise leak into every runtime
+// bundle that imports the main '@ngxsmk/cdk' barrel. Import test helpers directly
+// from the dedicated entry point instead: `import { ... } from '@ngxsmk/cdk/testing'`.
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicHVibGljLWFwaS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3BhY2thZ2VzL2Nkay9wdWJsaWMtYXBpLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBOztHQUVHO0FBRUgsY0FBYywyQkFBMkIsQ0FBQztBQUMxQyxjQUFjLHVCQUF1QixDQUFDO0FBQ3RDLGNBQWMsd0JBQXdCLENBQUM7QUFDdkMsY0FBYyw0QkFBNEIsQ0FBQztBQUMzQyxjQUFjLHlCQUF5QixDQUFDO0FBQ3hDLGNBQWMseUJBQXlCLENBQUM7QUFDeEMsY0FBYyw2QkFBNkIsQ0FBQztBQUM1QyxjQUFjLG1DQUFtQyxDQUFDO0FBQ2xELGNBQWMsNkJBQTZCLENBQUM7QUFDNUMsY0FBYyx1QkFBdUIsQ0FBQztBQUV0QyxpRkFBaUY7QUFDakYsaUZBQWlGO0FBQ2pGLGtGQUFrRjtBQUNsRix1RkFBdUYiLCJzb3VyY2VzQ29udGVudCI6WyIvKlxuICogUHVibGljIEFQSSBTdXJmYWNlIG9mIEBuZ3hzbWsvY2RrXG4gKi9cblxuZXhwb3J0ICogZnJvbSAnQG5neHNtay9jZGsvY2xpY2stb3V0c2lkZSc7XG5leHBvcnQgKiBmcm9tICdAbmd4c21rL2Nkay9mb2N1c2FibGUnO1xuZXhwb3J0ICogZnJvbSAnQG5neHNtay9jZGsvZm9jdXMtdHJhcCc7XG5leHBvcnQgKiBmcm9tICdAbmd4c21rL2Nkay9saXZlLWFubm91bmNlcic7XG5leHBvcnQgKiBmcm9tICdAbmd4c21rL2Nkay9tZWRpYS1xdWVyeSc7XG5leHBvcnQgKiBmcm9tICdAbmd4c21rL2Nkay9zY3JvbGwtbG9jayc7XG5leHBvcnQgKiBmcm9tICdAbmd4c21rL2Nkay92aXN1YWxseS1oaWRkZW4nO1xuZXhwb3J0ICogZnJvbSAnQG5neHNtay9jZGsvaW50ZXJzZWN0aW9uLW9ic2VydmVyJztcbmV4cG9ydCAqIGZyb20gJ0BuZ3hzbWsvY2RrL3Jlc2l6ZS1vYnNlcnZlcic7XG5leHBvcnQgKiBmcm9tICdAbmd4c21rL2Nkay9hdXRvZm9jdXMnO1xuXG4vLyBOT1RFOiAnQG5neHNtay9jZGsvdGVzdGluZycgaXMgaW50ZW50aW9uYWxseSBOT1QgcmUtZXhwb3J0ZWQgaGVyZS4gSXQgcHVsbHMgaW5cbi8vIGF4ZS1jb3JlIChhIENvbW1vbkpTIGRlcGVuZGVuY3kpIHdoaWNoIHdvdWxkIG90aGVyd2lzZSBsZWFrIGludG8gZXZlcnkgcnVudGltZVxuLy8gYnVuZGxlIHRoYXQgaW1wb3J0cyB0aGUgbWFpbiAnQG5neHNtay9jZGsnIGJhcnJlbC4gSW1wb3J0IHRlc3QgaGVscGVycyBkaXJlY3RseVxuLy8gZnJvbSB0aGUgZGVkaWNhdGVkIGVudHJ5IHBvaW50IGluc3RlYWQ6IGBpbXBvcnQgeyAuLi4gfSBmcm9tICdAbmd4c21rL2Nkay90ZXN0aW5nJ2AuXG4iXX0=

package/fesm2022/ngxsmk-cdk.mjs

@@ -8,11 +8,14 @@ export * from '@ngxsmk/cdk/visually-hidden';
 export * from '@ngxsmk/cdk/intersection-observer';
 export * from '@ngxsmk/cdk/resize-observer';
 export * from '@ngxsmk/cdk/autofocus';
-export * from '@ngxsmk/cdk/testing';
 
 /*
  * Public API Surface of @ngxsmk/cdk
  */
+// NOTE: '@ngxsmk/cdk/testing' is intentionally NOT re-exported here. It pulls in
+// axe-core (a CommonJS dependency) which would otherwise leak into every runtime
+// bundle that imports the main '@ngxsmk/cdk' barrel. Import test helpers directly
+// from the dedicated entry point instead: `import { ... } from '@ngxsmk/cdk/testing'`.
 
 /**
  * Generated bundle index. Do not edit.

package/fesm2022/ngxsmk-cdk.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"ngxsmk-cdk.mjs","sources":["../../../../packages/cdk/public-api.ts","../../../../packages/cdk/ngxsmk-cdk.ts"],"sourcesContent":["/*\n * Public API Surface of @ngxsmk/cdk\n */\n\nexport * from '@ngxsmk/cdk/click-outside';\nexport * from '@ngxsmk/cdk/focusable';\nexport * from '@ngxsmk/cdk/focus-trap';\nexport * from '@ngxsmk/cdk/live-announcer';\nexport * from '@ngxsmk/cdk/media-query';\nexport * from '@ngxsmk/cdk/scroll-lock';\nexport * from '@ngxsmk/cdk/visually-hidden';\nexport * from '@ngxsmk/cdk/intersection-observer';\nexport * from '@ngxsmk/cdk/resize-observer';\nexport * from '@ngxsmk/cdk/autofocus';\nexport * from '@ngxsmk/cdk/testing';\n","/**\n * Generated bundle index. Do not edit.\n */\n\nexport * from './public-api';\n"],"names":[],"mappings":";;;;;;;;;;;;AAAA;;AAEG;;ACFH;;AAEG"}
+{"version":3,"file":"ngxsmk-cdk.mjs","sources":["../../../../packages/cdk/public-api.ts","../../../../packages/cdk/ngxsmk-cdk.ts"],"sourcesContent":["/*\n * Public API Surface of @ngxsmk/cdk\n */\n\nexport * from '@ngxsmk/cdk/click-outside';\nexport * from '@ngxsmk/cdk/focusable';\nexport * from '@ngxsmk/cdk/focus-trap';\nexport * from '@ngxsmk/cdk/live-announcer';\nexport * from '@ngxsmk/cdk/media-query';\nexport * from '@ngxsmk/cdk/scroll-lock';\nexport * from '@ngxsmk/cdk/visually-hidden';\nexport * from '@ngxsmk/cdk/intersection-observer';\nexport * from '@ngxsmk/cdk/resize-observer';\nexport * from '@ngxsmk/cdk/autofocus';\n\n// NOTE: '@ngxsmk/cdk/testing' is intentionally NOT re-exported here. It pulls in\n// axe-core (a CommonJS dependency) which would otherwise leak into every runtime\n// bundle that imports the main '@ngxsmk/cdk' barrel. Import test helpers directly\n// from the dedicated entry point instead: `import { ... } from '@ngxsmk/cdk/testing'`.\n","/**\n * Generated bundle index. Do not edit.\n */\n\nexport * from './public-api';\n"],"names":[],"mappings":";;;;;;;;;;;AAAA;;AAEG;AAaH;AACA;AACA;AACA;;AClBA;;AAEG"}

package/package.json

@@ -1,6 +1,16 @@
 {
   "name": "@ngxsmk/cdk",
-  "version": "1.2.0",
+  "version": "1.3.1",
+  "description": "Low-level Angular directives and utilities (click-outside, focus-trap, media-query, scroll-lock) for @ngxsmk.",
+  "keywords": [
+    "angular",
+    "angular-cdk",
+    "cdk",
+    "directives",
+    "utilities",
+    "signals",
+    "helpers"
+  ],
   "license": "MIT",
   "peerDependencies": {
     "@angular/common": ">=17.3.0",
@@ -49,6 +59,12 @@
       "esm": "./esm2022/focusable/ngxsmk-cdk-focusable.mjs",
       "default": "./fesm2022/ngxsmk-cdk-focusable.mjs"
     },
+    "./intersection-observer": {
+      "types": "./intersection-observer/index.d.ts",
+      "esm2022": "./esm2022/intersection-observer/ngxsmk-cdk-intersection-observer.mjs",
+      "esm": "./esm2022/intersection-observer/ngxsmk-cdk-intersection-observer.mjs",
+      "default": "./fesm2022/ngxsmk-cdk-intersection-observer.mjs"
+    },
     "./live-announcer": {
       "types": "./live-announcer/index.d.ts",
       "esm2022": "./esm2022/live-announcer/ngxsmk-cdk-live-announcer.mjs",
@@ -61,12 +77,6 @@
       "esm": "./esm2022/media-query/ngxsmk-cdk-media-query.mjs",
       "default": "./fesm2022/ngxsmk-cdk-media-query.mjs"
     },
-    "./intersection-observer": {
-      "types": "./intersection-observer/index.d.ts",
-      "esm2022": "./esm2022/intersection-observer/ngxsmk-cdk-intersection-observer.mjs",
-      "esm": "./esm2022/intersection-observer/ngxsmk-cdk-intersection-observer.mjs",
-      "default": "./fesm2022/ngxsmk-cdk-intersection-observer.mjs"
-    },
     "./resize-observer": {
       "types": "./resize-observer/index.d.ts",
       "esm2022": "./esm2022/resize-observer/ngxsmk-cdk-resize-observer.mjs",

package/public-api.d.ts

@@ -8,5 +8,4 @@ export * from '@ngxsmk/cdk/visually-hidden';
 export * from '@ngxsmk/cdk/intersection-observer';
 export * from '@ngxsmk/cdk/resize-observer';
 export * from '@ngxsmk/cdk/autofocus';
-export * from '@ngxsmk/cdk/testing';
 //# sourceMappingURL=public-api.d.ts.map

package/public-api.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"public-api.d.ts","sourceRoot":"","sources":["../../../packages/cdk/public-api.ts"],"names":[],"mappings":"AAIA,cAAc,2BAA2B,CAAC;AAC1C,cAAc,uBAAuB,CAAC;AACtC,cAAc,wBAAwB,CAAC;AACvC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,yBAAyB,CAAC;AACxC,cAAc,yBAAyB,CAAC;AACxC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,mCAAmC,CAAC;AAClD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,uBAAuB,CAAC;AACtC,cAAc,qBAAqB,CAAC"}
+{"version":3,"file":"public-api.d.ts","sourceRoot":"","sources":["../../../packages/cdk/public-api.ts"],"names":[],"mappings":"AAIA,cAAc,2BAA2B,CAAC;AAC1C,cAAc,uBAAuB,CAAC;AACtC,cAAc,wBAAwB,CAAC;AACvC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,yBAAyB,CAAC;AACxC,cAAc,yBAAyB,CAAC;AACxC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,mCAAmC,CAAC;AAClD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,uBAAuB,CAAC"}