@primer/behaviors 0.0.0-202201892424 → 0.0.0-2022027213841

package/utils/package.json

@@ -1,7 +1,7 @@
 {
-    "name": "@primer/behaviors/utils",
-    "types": "../lib/utils/index.d.ts",
-    "main": "../lib/utils/index.js",
-    "module": "../lib-esm/utils/index.js",
-    "sideEffects": false
-  }
+  "name": "@primer/behaviors/utils",
+  "types": "../dist/esm/utils/index.d.ts",
+  "main": "../dist/esm/utils/index.js",
+  "type": "module",
+  "sideEffects": false
+}

package/dist/anchored-position.d.ts

@@ -1,89 +0,0 @@
-export declare type AnchorAlignment = 'start' | 'center' | 'end';
-export declare type AnchorSide = 'inside-top' | 'inside-bottom' | 'inside-left' | 'inside-right' | 'inside-center' | 'outside-top' | 'outside-bottom' | 'outside-left' | 'outside-right';
-/**
- * Settings that customize how a floating element is positioned
- * with respect to an anchor element.
- */
-export interface PositionSettings {
-    /**
-     * Sets the side of the anchor element that the floating element should be
-     * pinned to. This side is given by a string starting with either "inside" or
-     * "outside", followed by a hyphen, followed by either "top", "right", "bottom",
-     * or "left". Additionally, "inside-center" is an allowed value.
-     *
-     * The first part of this string, "inside" or "outside", determines whether the
-     * floating element should be attempted to be placed "inside" the anchor element
-     * or "outside" of it. Using "inside" is useful for making it appear that the
-     * anchor _contains_ the floating element, and it can be used for implementing a
-     * dialog that is centered on the screen. The "outside" value is more common and
-     * can be used for tooltips, popovers, menus, etc.
-     *
-     * The second part of this string determines the _edge_ on the anchor element that
-     * the floating element will be anchored to. If side is "inside-center", then
-     * the floating element will be centered in the X-direction (while align is used
-     * to position it in the Y-direction).
-     * Note: "outside-center" is _not_ a valid value for this property.
-     */
-    side: AnchorSide;
-    /**
-     * Determines how the floating element should align with the anchor element. If
-     * set to "start", the floating element's first edge (top or left) will align
-     * with the anchor element's first edge. If set to "center", the floating
-     * element will be centered along the axis of the anchor edge. If set to "end",
-     * the floating element's last edge will align with the anchor element's last edge.
-     */
-    align: AnchorAlignment;
-    /**
-     * The number of pixels between the anchor edge and the floating element.
-     *
-     * Positive values move the floating element farther from the anchor element
-     * (for outside positioning) or further inside the anchor element (for inside
-     * positioning). Negative values have the opposite effect.
-     */
-    anchorOffset: number;
-    /**
-     * An additional offset, in pixels, to move the floating element from
-     * the aligning edge.
-     *
-     * Positive values move the floating element in the direction of center-
-     * alignment. Negative values move the floating element away from center-
-     * alignment. When align is "center", positive offsets move the floating
-     * element right (top or bottom anchor side) or down (left or right
-     * anchor side).
-     */
-    alignmentOffset: number;
-    /**
-     * If false, when the above settings result in rendering the floating element
-     * wholly or partially outside of the bounds of the containing element, attempt
-     * to adjust the settings to prevent this. Only applies to "outside" positioning.
-     *
-     * First, attempt to flip to the opposite edge of the anchor if the floating
-     * element is getting clipped in that direction. If flipping results in a
-     * similar clipping, try moving to the adjacent sides.
-     *
-     * Once we find a side that does not clip the overlay in its own dimension,
-     * check the rest of the sides to see if we need to adjust the alignment offset
-     * to fit in other dimensions.
-     *
-     * If we try all four sides and get clipped each time, settle for overflowing
-     * and use the "bottom" side, since the ability to scroll is most likely in
-     * this direction.
-     */
-    allowOutOfBounds: boolean;
-}
-export interface AnchorPosition {
-    top: number;
-    left: number;
-    anchorSide: AnchorSide;
-}
-/**
- * Given a floating element and an anchor element, return coordinates for the top-left
- * of the floating element in order to absolutely position it such that it appears
- * near the anchor element.
- *
- * @param floatingElement Element intended to be positioned near or within an anchor
- * @param anchorElement The element to serve as the position anchor
- * @param settings Settings to determine the rules for positioning the floating element
- * @returns {top: number, left: number} coordinates for the floating element
- */
-export declare function getAnchoredPosition(floatingElement: Element, anchorElement: Element | DOMRect, settings?: Partial<PositionSettings>): AnchorPosition;

package/dist/focus-trap.d.ts

@@ -1,12 +0,0 @@
-/**
- * Traps focus within the given container.
- * @param container The container in which to trap focus
- * @returns AbortController - call `.abort()` to disable the focus trap
- */
-export declare function focusTrap(container: HTMLElement, initialFocus?: HTMLElement): AbortController;
-/**
- * Traps focus within the given container.
- * @param container The container in which to trap focus
- * @param abortSignal An AbortSignal to control the focus trap.
- */
-export declare function focusTrap(container: HTMLElement, initialFocus: HTMLElement | undefined, abortSignal: AbortSignal): void;

package/dist/focus-zone.d.ts

@@ -1,137 +0,0 @@
-export declare type Direction = 'previous' | 'next' | 'start' | 'end';
-export declare type FocusMovementKeys = 'ArrowLeft' | 'ArrowDown' | 'ArrowUp' | 'ArrowRight' | 'h' | 'j' | 'k' | 'l' | 'a' | 's' | 'w' | 'd' | 'Tab' | 'Home' | 'End' | 'PageUp' | 'PageDown';
-export declare enum FocusKeys {
-    ArrowHorizontal = 1,
-    ArrowVertical = 2,
-    JK = 4,
-    HL = 8,
-    HomeAndEnd = 16,
-    PageUpDown = 256,
-    WS = 32,
-    AD = 64,
-    Tab = 128,
-    ArrowAll = 3,
-    HJKL = 12,
-    WASD = 96,
-    All = 511
-}
-/**
- * Options that control the behavior of the arrow focus behavior.
- */
-export interface FocusZoneSettings {
-    /**
-     * Choose the behavior applied in cases where focus is currently at either the first or
-     * last element of the container.
-     *
-     * "stop" - do nothing and keep focus where it was
-     * "wrap" - wrap focus around to the first element from the last, or the last element from the first
-     *
-     * Default: "stop"
-     */
-    focusOutBehavior?: 'stop' | 'wrap';
-    /**
-     * If set, this will be called to get the next focusable element. If this function
-     * returns null, we will try to determine the next direction ourselves. Use the
-     * `bindKeys` option to customize which keys are listened to.
-     *
-     * The function can accept a Direction, indicating the direction focus should move,
-     * the HTMLElement that was previously focused, and lastly the `KeyboardEvent` object
-     * created by the original `"keydown"` event.
-     */
-    getNextFocusable?: (direction: Direction, from: Element | undefined, event: KeyboardEvent) => HTMLElement | undefined;
-    /**
-     * Called to decide if a focusable element is allowed to participate in the arrow
-     * key focus behavior.
-     *
-     * By default, all focusable elements within the given container will participate
-     * in the arrow key focus behavior. If you need to withhold some elements from
-     * participation, implement this callback to return false for those elements.
-     */
-    focusableElementFilter?: (element: HTMLElement) => boolean;
-    /**
-     * Bit flags that identify keys that will be bound to. Each available key either
-     * moves focus to the "next" element or the "previous" element, so it is best
-     * to only bind the keys that make sense to move focus in your UI. Use the `FocusKeys`
-     * object to discover supported keys.
-     *
-     * Use the bitwise "OR" operator (`|`) to combine key types. For example,
-     * `FocusKeys.WASD | FocusKeys.HJKL` represents all of W, A, S, D, H, J, K, and L.
-     *
-     * A note on FocusKeys.PageUpDown: This behavior does not support paging, so by default
-     * using these keys will result in the same behavior as Home and End. To override this
-     * behavior, implement `getNextFocusable`.
-     *
-     * The default for this setting is `FocusKeys.ArrowVertical | FocusKeys.HomeAndEnd`, unless
-     * `getNextFocusable` is provided, in which case `FocusKeys.ArrowAll | FocusKeys.HomeAndEnd`
-     * is used as the default.
-     */
-    bindKeys?: FocusKeys;
-    /**
-     * If provided, this signal can be used to disable the behavior and remove any
-     * event listeners.
-     */
-    abortSignal?: AbortSignal;
-    /**
-     * If `activeDescendantControl` is supplied, do not move focus or alter `tabindex` on
-     * any element. Instead, manage `aria-activedescendant` according to the ARIA best
-     * practices guidelines.
-     * @see https://www.w3.org/TR/wai-aria-practices-1.1/#kbd_focus_activedescendant
-     *
-     * The given `activeDescendantControl` will be given an `aria-controls` attribute that
-     * references the ID of the `container`. Additionally, it will be given an
-     * `aria-activedescendant` attribute that references the ID of the currently-active
-     * descendant.
-     *
-     * This element will retain DOM focus as arrow keys are pressed.
-     */
-    activeDescendantControl?: HTMLElement;
-    /**
-     * Called each time the active descendant changes. Note that either of the parameters
-     * may be undefined, e.g. when an element in the container first becomes active, or
-     * when the controlling element becomes unfocused.
-     */
-    onActiveDescendantChanged?: (newActiveDescendant: HTMLElement | undefined, previousActiveDescendant: HTMLElement | undefined, directlyActivated: boolean) => void;
-    /**
-     * This option allows customization of the behavior that determines which of the
-     * focusable elements should be focused when focus enters the container via the Tab key.
-     *
-     * When set to "first", whenever focus enters the container via Tab, we will focus the
-     * first focusable element. When set to "previous", the most recently focused element
-     * will be focused (fallback to first if there was no previous).
-     *
-     * The "closest" strategy works like "first", except either the first or the last element
-     * of the container will be focused, depending on the direction from which focus comes.
-     *
-     * If a function is provided, this function should return the HTMLElement intended
-     * to receive focus. This is useful if you want to focus the currently "selected"
-     * item or element.
-     *
-     * Default: "previous"
-     *
-     * For more information, @see https://www.w3.org/TR/wai-aria-practices-1.1/#kbd_general_within
-     */
-    focusInStrategy?: 'first' | 'closest' | 'previous' | ((previousFocusedElement: Element) => HTMLElement | undefined);
-}
-export declare const isActiveDescendantAttribute = "data-is-active-descendant";
-/**
- * A value of activated-directly for data-is-active-descendant indicates the descendant was activated
- * by a manual user interaction with intent to move active descendant.  This usually translates to the
- * user pressing one of the bound keys (up/down arrow, etc) to move through the focus zone.  This is
- * intended to be roughly equivalent to the :focus-visible pseudo-class
- **/
-export declare const activeDescendantActivatedDirectly = "activated-directly";
-/**
- * A value of activated-indirectly for data-is-active-descendant indicates the descendant was activated
- * implicitly, and not by a direct key press.  This includes focus zone being created from scratch, focusable
- * elements being added/removed, and mouseover events. This is intended to be roughly equivalent
- * to :focus:not(:focus-visible)
- **/
-export declare const activeDescendantActivatedIndirectly = "activated-indirectly";
-export declare const hasActiveDescendantAttribute = "data-has-active-descendant";
-/**
- * Sets up the arrow key focus behavior for all focusable elements in the given `container`.
- * @param container
- * @param settings
- * @returns
- */
-export declare function focusZone(container: HTMLElement, settings?: FocusZoneSettings): AbortController;

package/dist/utils/iterate-focusable-elements.d.ts

@@ -1,42 +0,0 @@
-/**
- * Options to the focusable elements iterator
- */
-export interface IterateFocusableElements {
-    /**
-     * (Default: false) Iterate through focusable elements in reverse-order
-     */
-    reverse?: boolean;
-    /**
-     * (Default: false) Perform additional checks to determine tabbability
-     * which may adversely affect app performance.
-     */
-    strict?: boolean;
-    /**
-     * (Default: false) Only iterate tabbable elements, which is the subset
-     * of focusable elements that are part of the page's tab sequence.
-     */
-    onlyTabbable?: boolean;
-}
-/**
- * Returns an iterator over all of the focusable elements within `container`.
- * Note: If `container` is itself focusable it will be included in the results.
- * @param container The container over which to find focusable elements.
- * @param reverse If true, iterate backwards through focusable elements.
- */
-export declare function iterateFocusableElements(container: HTMLElement, options?: IterateFocusableElements): Generator<HTMLElement, undefined, undefined>;
-/**
- * Determines whether the given element is focusable. If `strict` is true, we may
- * perform additional checks that require a reflow (less performant).
- * @param elem
- * @param strict
- */
-export declare function isFocusable(elem: HTMLElement, strict?: boolean): boolean;
-/**
- * Determines whether the given element is tabbable. If `strict` is true, we may
- * perform additional checks that require a reflow (less performant). This check
- * ensures that the element is focusable and that its tabindex is not explicitly
- * set to "-1" (which makes it focusable, but removes it from the tab order).
- * @param elem
- * @param strict
- */
-export declare function isTabbable(elem: HTMLElement, strict?: boolean): boolean;

package/lib/anchored-position.d.ts

@@ -1,89 +0,0 @@
-export declare type AnchorAlignment = 'start' | 'center' | 'end';
-export declare type AnchorSide = 'inside-top' | 'inside-bottom' | 'inside-left' | 'inside-right' | 'inside-center' | 'outside-top' | 'outside-bottom' | 'outside-left' | 'outside-right';
-/**
- * Settings that customize how a floating element is positioned
- * with respect to an anchor element.
- */
-export interface PositionSettings {
-    /**
-     * Sets the side of the anchor element that the floating element should be
-     * pinned to. This side is given by a string starting with either "inside" or
-     * "outside", followed by a hyphen, followed by either "top", "right", "bottom",
-     * or "left". Additionally, "inside-center" is an allowed value.
-     *
-     * The first part of this string, "inside" or "outside", determines whether the
-     * floating element should be attempted to be placed "inside" the anchor element
-     * or "outside" of it. Using "inside" is useful for making it appear that the
-     * anchor _contains_ the floating element, and it can be used for implementing a
-     * dialog that is centered on the screen. The "outside" value is more common and
-     * can be used for tooltips, popovers, menus, etc.
-     *
-     * The second part of this string determines the _edge_ on the anchor element that
-     * the floating element will be anchored to. If side is "inside-center", then
-     * the floating element will be centered in the X-direction (while align is used
-     * to position it in the Y-direction).
-     * Note: "outside-center" is _not_ a valid value for this property.
-     */
-    side: AnchorSide;
-    /**
-     * Determines how the floating element should align with the anchor element. If
-     * set to "start", the floating element's first edge (top or left) will align
-     * with the anchor element's first edge. If set to "center", the floating
-     * element will be centered along the axis of the anchor edge. If set to "end",
-     * the floating element's last edge will align with the anchor element's last edge.
-     */
-    align: AnchorAlignment;
-    /**
-     * The number of pixels between the anchor edge and the floating element.
-     *
-     * Positive values move the floating element farther from the anchor element
-     * (for outside positioning) or further inside the anchor element (for inside
-     * positioning). Negative values have the opposite effect.
-     */
-    anchorOffset: number;
-    /**
-     * An additional offset, in pixels, to move the floating element from
-     * the aligning edge.
-     *
-     * Positive values move the floating element in the direction of center-
-     * alignment. Negative values move the floating element away from center-
-     * alignment. When align is "center", positive offsets move the floating
-     * element right (top or bottom anchor side) or down (left or right
-     * anchor side).
-     */
-    alignmentOffset: number;
-    /**
-     * If false, when the above settings result in rendering the floating element
-     * wholly or partially outside of the bounds of the containing element, attempt
-     * to adjust the settings to prevent this. Only applies to "outside" positioning.
-     *
-     * First, attempt to flip to the opposite edge of the anchor if the floating
-     * element is getting clipped in that direction. If flipping results in a
-     * similar clipping, try moving to the adjacent sides.
-     *
-     * Once we find a side that does not clip the overlay in its own dimension,
-     * check the rest of the sides to see if we need to adjust the alignment offset
-     * to fit in other dimensions.
-     *
-     * If we try all four sides and get clipped each time, settle for overflowing
-     * and use the "bottom" side, since the ability to scroll is most likely in
-     * this direction.
-     */
-    allowOutOfBounds: boolean;
-}
-export interface AnchorPosition {
-    top: number;
-    left: number;
-    anchorSide: AnchorSide;
-}
-/**
- * Given a floating element and an anchor element, return coordinates for the top-left
- * of the floating element in order to absolutely position it such that it appears
- * near the anchor element.
- *
- * @param floatingElement Element intended to be positioned near or within an anchor
- * @param anchorElement The element to serve as the position anchor
- * @param settings Settings to determine the rules for positioning the floating element
- * @returns {top: number, left: number} coordinates for the floating element
- */
-export declare function getAnchoredPosition(floatingElement: Element, anchorElement: Element | DOMRect, settings?: Partial<PositionSettings>): AnchorPosition;