@primer/behaviors 1.2.0 → 1.3.0-rc.9cf9e61

package/CHANGELOG.md

@@ -0,0 +1,57 @@
+# @primer/behaviors
+
+## 1.3.0
+
+### Minor Changes
+
+- [#152](https://github.com/primer/behaviors/pull/152) [`afaf380`](https://github.com/primer/behaviors/commit/afaf380893cb858e6c85515bb490866d76d3d8b7) Thanks [@colebemis](https://github.com/colebemis)! - focusZone: Add `preventScroll` option
+
+## 1.2.0
+
+### Minor Changes
+
+- [#134](https://github.com/primer/behaviors/pull/134) [`cc5bf8e`](https://github.com/primer/behaviors/commit/cc5bf8e8404594bc6b3ff1493f253b171bfb03c0) Thanks [@jonrohan](https://github.com/jonrohan)! - Add Dimensions behavior
+
+## 1.1.3
+
+### Patch Changes
+
+- [#93](https://github.com/primer/behaviors/pull/93) [`e5aaf68`](https://github.com/primer/behaviors/commit/e5aaf688b084bf6e425c6bdb0963aa50aacf8fa4) Thanks [@siddharthkp](https://github.com/siddharthkp)! - Anchored position: Add check for boundary collision on left side
+
+## 1.1.2
+
+### Patch Changes
+
+- [#78](https://github.com/primer/behaviors/pull/78) [`62e5459`](https://github.com/primer/behaviors/commit/62e545913dae8ca42f88fd6184f190cdf3df9c4c) Thanks [@siddharthkp](https://github.com/siddharthkp)! - Anchored Position: Add alternative alignments to flip to if there isn't enough space
+
+## 1.1.1
+
+### Patch Changes
+
+- [#73](https://github.com/primer/behaviors/pull/73) [`a96d60f`](https://github.com/primer/behaviors/commit/a96d60fdb2a2ffdde71a22ea29fa2c788bf4c6aa) Thanks [@dgreif](https://github.com/dgreif)! - Add `import` conditional export type to the package for better NodeJS ESM compatibility
+
+## 1.1.0
+
+### Minor Changes
+
+- [#52](https://github.com/primer/behaviors/pull/52) [`1aa3027`](https://github.com/primer/behaviors/commit/1aa302782e3c833f9d9c27f602a046e81f05c3e5) Thanks [@owenniblock](https://github.com/owenniblock)! - Update focusTrap to use new methodology after accessibility discussions
+
+## 1.0.3
+
+### Patch Changes
+
+- [#42](https://github.com/primer/behaviors/pull/42) [`41945a3`](https://github.com/primer/behaviors/commit/41945a37ef07da82ce5a29feb03d7a7d96ec76ea) Thanks [@dgreif](https://github.com/dgreif)! - Build both esm and cjs output for the package
+
+## 1.0.2
+
+### Patch Changes
+
+- [#17](https://github.com/primer/behaviors/pull/17) [`9194ba4`](https://github.com/primer/behaviors/commit/9194ba403502b4acba0be03bed1a765c1ba81340) Thanks [@dgreif](https://github.com/dgreif)! - Correct margin orientation for `scrollIntoView`
+
+* [#18](https://github.com/primer/behaviors/pull/18) [`3b4dd41`](https://github.com/primer/behaviors/commit/3b4dd414175417f83bd144939fe74b2a01bc7136) Thanks [@dgreif](https://github.com/dgreif)! - Export utils as submodule
+
+## 1.0.1
+
+### Patch Changes
+
+- [#10](https://github.com/primer/behaviors/pull/10) [`88b6f34`](https://github.com/primer/behaviors/commit/88b6f34bf4874f3c81473020a01a58b197dd6e16) Thanks [@dgreif](https://github.com/dgreif)! - Set up changesets

package/dist/cjs/focus-zone.d.ts

@@ -24,6 +24,7 @@ export interface FocusZoneSettings {
     activeDescendantControl?: HTMLElement;
     onActiveDescendantChanged?: (newActiveDescendant: HTMLElement | undefined, previousActiveDescendant: HTMLElement | undefined, directlyActivated: boolean) => void;
     focusInStrategy?: 'first' | 'closest' | 'previous' | ((previousFocusedElement: Element) => HTMLElement | undefined);
+    preventScroll?: boolean;
 }
 export declare const isActiveDescendantAttribute = "data-is-active-descendant";
 export declare const activeDescendantActivatedDirectly = "activated-directly";

package/dist/cjs/focus-zone.js

@@ -124,7 +124,7 @@ exports.activeDescendantActivatedDirectly = 'activated-directly';
 exports.activeDescendantActivatedIndirectly = 'activated-indirectly';
 exports.hasActiveDescendantAttribute = 'data-has-active-descendant';
 function focusZone(container, settings) {
-    var _a, _b, _c, _d;
+    var _a, _b, _c, _d, _e;
     const focusableElements = [];
     const savedTabIndex = new WeakMap();
     const bindKeys = (_a = settings === null || settings === void 0 ? void 0 : settings.bindKeys) !== null && _a !== void 0 ? _a : ((settings === null || settings === void 0 ? void 0 : settings.getNextFocusable) ? FocusKeys.ArrowAll : FocusKeys.ArrowVertical) | FocusKeys.HomeAndEnd;
@@ -133,6 +133,7 @@ function focusZone(container, settings) {
     const activeDescendantControl = settings === null || settings === void 0 ? void 0 : settings.activeDescendantControl;
     const activeDescendantCallback = settings === null || settings === void 0 ? void 0 : settings.onActiveDescendantChanged;
     let currentFocusedElement;
+    const preventScroll = (_d = settings === null || settings === void 0 ? void 0 : settings.preventScroll) !== null && _d !== void 0 ? _d : false;
     function getFirstFocusableElement() {
         return focusableElements[0];
     }
@@ -243,7 +244,7 @@ function focusZone(container, settings) {
         childList: true
     });
     const controller = new AbortController();
-    const signal = (_d = settings === null || settings === void 0 ? void 0 : settings.abortSignal) !== null && _d !== void 0 ? _d : controller.signal;
+    const signal = (_e = settings === null || settings === void 0 ? void 0 : settings.abortSignal) !== null && _e !== void 0 ? _e : controller.signal;
     signal.addEventListener('abort', () => {
         endFocusManagement(...focusableElements);
     });
@@ -256,7 +257,7 @@ function focusZone(container, settings) {
     if (activeDescendantControl) {
         container.addEventListener('focusin', event => {
             if (event.target instanceof HTMLElement && focusableElements.includes(event.target)) {
-                activeDescendantControl.focus();
+                activeDescendantControl.focus({ preventScroll });
                 updateFocusedElement(event.target);
             }
         });
@@ -300,7 +301,7 @@ function focusZone(container, settings) {
                         if (event.relatedTarget instanceof Element && !container.contains(event.relatedTarget)) {
                             const targetElementIndex = lastKeyboardFocusDirection === 'previous' ? focusableElements.length - 1 : 0;
                             const targetElement = focusableElements[targetElementIndex];
-                            targetElement === null || targetElement === void 0 ? void 0 : targetElement.focus();
+                            targetElement === null || targetElement === void 0 ? void 0 : targetElement.focus({ preventScroll });
                             return;
                         }
                         else {
@@ -312,7 +313,7 @@ function focusZone(container, settings) {
                             const elementToFocus = focusInStrategy(event.relatedTarget);
                             const requestedFocusElementIndex = elementToFocus ? focusableElements.indexOf(elementToFocus) : -1;
                             if (requestedFocusElementIndex >= 0 && elementToFocus instanceof HTMLElement) {
-                                elementToFocus.focus();
+                                elementToFocus.focus({ preventScroll });
                                 return;
                             }
                             else {
@@ -397,7 +398,7 @@ function focusZone(container, settings) {
                 }
                 else if (nextElementToFocus) {
                     lastKeyboardFocusDirection = direction;
-                    nextElementToFocus.focus();
+                    nextElementToFocus.focus({ preventScroll });
                 }
                 if (event.key !== 'Tab' || nextElementToFocus) {
                     event.preventDefault();

package/dist/esm/focus-zone.d.ts

@@ -24,6 +24,7 @@ export interface FocusZoneSettings {
     activeDescendantControl?: HTMLElement;
     onActiveDescendantChanged?: (newActiveDescendant: HTMLElement | undefined, previousActiveDescendant: HTMLElement | undefined, directlyActivated: boolean) => void;
     focusInStrategy?: 'first' | 'closest' | 'previous' | ((previousFocusedElement: Element) => HTMLElement | undefined);
+    preventScroll?: boolean;
 }
 export declare const isActiveDescendantAttribute = "data-is-active-descendant";
 export declare const activeDescendantActivatedDirectly = "activated-directly";

package/dist/esm/focus-zone.js

@@ -121,7 +121,7 @@ export const activeDescendantActivatedDirectly = 'activated-directly';
 export const activeDescendantActivatedIndirectly = 'activated-indirectly';
 export const hasActiveDescendantAttribute = 'data-has-active-descendant';
 export function focusZone(container, settings) {
-    var _a, _b, _c, _d;
+    var _a, _b, _c, _d, _e;
     const focusableElements = [];
     const savedTabIndex = new WeakMap();
     const bindKeys = (_a = settings === null || settings === void 0 ? void 0 : settings.bindKeys) !== null && _a !== void 0 ? _a : ((settings === null || settings === void 0 ? void 0 : settings.getNextFocusable) ? FocusKeys.ArrowAll : FocusKeys.ArrowVertical) | FocusKeys.HomeAndEnd;
@@ -130,6 +130,7 @@ export function focusZone(container, settings) {
     const activeDescendantControl = settings === null || settings === void 0 ? void 0 : settings.activeDescendantControl;
     const activeDescendantCallback = settings === null || settings === void 0 ? void 0 : settings.onActiveDescendantChanged;
     let currentFocusedElement;
+    const preventScroll = (_d = settings === null || settings === void 0 ? void 0 : settings.preventScroll) !== null && _d !== void 0 ? _d : false;
     function getFirstFocusableElement() {
         return focusableElements[0];
     }
@@ -240,7 +241,7 @@ export function focusZone(container, settings) {
         childList: true
     });
     const controller = new AbortController();
-    const signal = (_d = settings === null || settings === void 0 ? void 0 : settings.abortSignal) !== null && _d !== void 0 ? _d : controller.signal;
+    const signal = (_e = settings === null || settings === void 0 ? void 0 : settings.abortSignal) !== null && _e !== void 0 ? _e : controller.signal;
     signal.addEventListener('abort', () => {
         endFocusManagement(...focusableElements);
     });
@@ -253,7 +254,7 @@ export function focusZone(container, settings) {
     if (activeDescendantControl) {
         container.addEventListener('focusin', event => {
             if (event.target instanceof HTMLElement && focusableElements.includes(event.target)) {
-                activeDescendantControl.focus();
+                activeDescendantControl.focus({ preventScroll });
                 updateFocusedElement(event.target);
             }
         });
@@ -297,7 +298,7 @@ export function focusZone(container, settings) {
                         if (event.relatedTarget instanceof Element && !container.contains(event.relatedTarget)) {
                             const targetElementIndex = lastKeyboardFocusDirection === 'previous' ? focusableElements.length - 1 : 0;
                             const targetElement = focusableElements[targetElementIndex];
-                            targetElement === null || targetElement === void 0 ? void 0 : targetElement.focus();
+                            targetElement === null || targetElement === void 0 ? void 0 : targetElement.focus({ preventScroll });
                             return;
                         }
                         else {
@@ -309,7 +310,7 @@ export function focusZone(container, settings) {
                             const elementToFocus = focusInStrategy(event.relatedTarget);
                             const requestedFocusElementIndex = elementToFocus ? focusableElements.indexOf(elementToFocus) : -1;
                             if (requestedFocusElementIndex >= 0 && elementToFocus instanceof HTMLElement) {
-                                elementToFocus.focus();
+                                elementToFocus.focus({ preventScroll });
                                 return;
                             }
                             else {
@@ -394,7 +395,7 @@ export function focusZone(container, settings) {
                 }
                 else if (nextElementToFocus) {
                     lastKeyboardFocusDirection = direction;
-                    nextElementToFocus.focus();
+                    nextElementToFocus.focus({ preventScroll });
                 }
                 if (event.key !== 'Tab' || nextElementToFocus) {
                     event.preventDefault();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@primer/behaviors",
-  "version": "1.2.0",
+  "version": "1.3.0-rc.9cf9e61",
   "description": "Shared behaviors for JavaScript components",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",