@fluentui/react-tabster 0.0.0-nightlyfc5cfdc52420220215.1 → 0.0.0

package/lib/hooks/useModalAttributes.d.ts

@@ -1,22 +0,0 @@
-import { Types as TabsterTypes } from 'tabster';
-export interface UseModalAttributesOptions {
-    /**
-     * Traps focus inside the elements the attributes are applied
-     */
-    trapFocus?: boolean;
-    /**
-     * Always reachabled in Tab order
-     */
-    alwaysFocusable?: boolean;
-}
-/**
- * Applies modal dialog behaviour through DOM attributes
- * Modal element will focus trap and hide other content on the page
- * The trigger element will be focused if focus is lost after the modal element is removed
- *
- * @returns DOM attributes to apply to the modal element and its trigger
- */
-export declare const useModalAttributes: (options?: UseModalAttributesOptions) => {
-    modalAttributes: TabsterTypes.TabsterDOMAttribute;
-    triggerAttributes: TabsterTypes.TabsterDOMAttribute;
-};

package/lib/hooks/useTabster.d.ts

@@ -1,9 +0,0 @@
-import { Types as TabsterTypes } from 'tabster';
-/**
- * Tries to get a tabster instance on the current window or creates a new one
- * Since Tabster is single instance only, feel free to call this hook to ensure Tabster exists if necessary
- *
- * @internal
- * @returns Tabster core instance
- */
-export declare const useTabster: () => TabsterTypes.TabsterCore | null;

package/lib/hooks/useTabsterAttributes.d.ts

@@ -1,5 +0,0 @@
-import { Types as TabsterTypes } from 'tabster';
-/**
- * Hook that returns tabster attributes while ensuring tabster exists
- */
-export declare const useTabsterAttributes: (props: TabsterTypes.TabsterAttributeProps) => TabsterTypes.TabsterDOMAttribute;

package/lib/index.d.ts

@@ -1 +0,0 @@
-export * from './hooks/index';

package/lib/symbols.d.ts

@@ -1,2 +0,0 @@
-export declare const KEYBOARD_NAV_ATTRIBUTE: "data-keyboard-nav";
-export declare const KEYBOARD_NAV_SELECTOR: ":global([data-keyboard-nav])";

package/lib/symbols.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"symbols.js","sourceRoot":"","sources":["../src/symbols.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,sBAAsB,GAAG,mBAA4B,CAAC;AACnE,MAAM,CAAC,MAAM,qBAAqB,GAAG,YAAY,sBAAsB,IAAa,CAAC"}

package/lib-commonjs/hooks/index.d.ts

@@ -1,7 +0,0 @@
-export * from './useArrowNavigationGroup';
-export * from './useFocusFinders';
-export * from './useModalAttributes';
-export * from './useTabsterAttributes';
-export * from './useFocusIndicatorStyle';
-export * from './useKeyboardNavAttribute';
-export * from './useFocusableGroup';

package/lib-commonjs/hooks/useArrowNavigationGroup.d.ts

@@ -1,22 +0,0 @@
-import { Types } from 'tabster';
-export interface UseArrowNavigationGroupOptions {
-    /**
-     * Focus will navigate vertically or horizontally, defaults to horizontally
-     * @defaultValue vertical
-     */
-    axis?: 'vertical' | 'horizontal';
-    /**
-     * Focus will cycle to the first/last elements of the group without stopping
-     */
-    circular?: boolean;
-    /**
-     * Last focused element in the group will be remembered and focused (if still
-     * available) when tabbing from outside of the group
-     */
-    memorizeCurrent?: boolean;
-}
-/**
- * A hook that returns the necessary tabster attributes to support arrow key navigation
- * @param options - Options to configure keyboard navigation
- */
-export declare const useArrowNavigationGroup: (options?: UseArrowNavigationGroupOptions | undefined) => Types.TabsterDOMAttribute;

package/lib-commonjs/hooks/useFocusFinders.d.ts

@@ -1,11 +0,0 @@
-import { Types as TabsterTypes } from 'tabster';
-/**
- * Returns a set of helper functions that will traverse focusable elements in the context of a root DOM element
- */
-export declare const useFocusFinders: () => {
-    findAllFocusable: (container: HTMLElement, acceptCondition: (el: HTMLElement) => boolean) => HTMLElement[];
-    findFirstFocusable: (container: HTMLElement) => HTMLElement | null | undefined;
-    findLastFocusable: (container: HTMLElement) => HTMLElement | null | undefined;
-    findNextFocusable: (currentElement: HTMLElement, options?: Pick<TabsterTypes.FindNextProps, 'container'>) => HTMLElement | null | undefined;
-    findPrevFocusable: (currentElement: HTMLElement, options?: Pick<TabsterTypes.FindNextProps, 'container'>) => HTMLElement | null | undefined;
-};

package/lib-commonjs/hooks/useFocusIndicatorStyle.d.ts

@@ -1,33 +0,0 @@
-import type { GriffelStyle } from '@griffel/react';
-export declare type FocusOutlineOffset = Record<'top' | 'bottom' | 'left' | 'right', string>;
-export declare type FocusOutlineStyleOptions = {
-    /**
-     * Only property not supported by the native CSS `outline`, if this is no longer needed
-     * we can just go native instead
-     */
-    outlineRadius: string;
-    outlineColor: string;
-    outlineWidth: string;
-    outlineOffset?: string | FocusOutlineOffset;
-};
-export interface CreateFocusIndicatorStyleRuleOptions {
-    selector?: 'focus' | 'focus-within';
-}
-/**
- * NOTE: The element with the focus outline needs to have `position: relative` so that the
- * pseudo element can be properly positioned.
- *
- * @param theme - Theme used in @see makeStyles
- * @param options - Configure the style of the focus outline
- * @returns focus outline styles object for @see makeStyles
- */
-export declare const createFocusOutlineStyle: (options?: {
-    style: Partial<FocusOutlineStyleOptions>;
-} & CreateFocusIndicatorStyleRuleOptions) => GriffelStyle;
-/**
- * Creates a style for @see makeStyles that includes the necessary selectors for focus.
- * Should be used only when @see createFocusOutlineStyle does not fit requirements
- *
- * @param style - styling applied on focus, defaults to @see getDefaultFocusOutlineStyes
- */
-export declare const createCustomFocusIndicatorStyle: (style: GriffelStyle, options?: CreateFocusIndicatorStyleRuleOptions) => GriffelStyle;

package/lib-commonjs/hooks/useFocusIndicatorStyle.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../src/hooks/useFocusIndicatorStyle.ts"],"names":[],"mappings":";;;;;;;AAAA,MAAA,aAAA,gBAAA,OAAA,CAAA,uBAAA,CAAA;;AACA,MAAA,SAAA,gBAAA,OAAA,CAAA,YAAA,CAAA;AAeA;;;;;;AAMG;;;AACH,MAAM,qBAAqB,GAAI,OAAD,IAAsC;;;AAClE,QAAM;AAAE,IAAA,aAAF;AAAiB,IAAA,YAAjB;AAA+B,IAAA,aAA/B;AAA8C,IAAA;AAA9C,MAA+D,OAArE;AAEA,QAAM,gBAAgB,GAAG,CAAA,CAAA,EAAA,GAAC,aAAD,MAAqC,IAArC,IAAqC,EAAA,KAAA,KAAA,CAArC,GAAqC,KAAA,CAArC,GAAqC,EAAA,CAAE,GAAvC,KAA8C,aAAvE;AACA,QAAM,mBAAmB,GAAG,CAAA,CAAA,EAAA,GAAC,aAAD,MAAqC,IAArC,IAAqC,EAAA,KAAA,KAAA,CAArC,GAAqC,KAAA,CAArC,GAAqC,EAAA,CAAE,MAAvC,KAAiD,aAA7E;AACA,QAAM,iBAAiB,GAAG,CAAA,CAAA,EAAA,GAAC,aAAD,MAAqC,IAArC,IAAqC,EAAA,KAAA,KAAA,CAArC,GAAqC,KAAA,CAArC,GAAqC,EAAA,CAAE,IAAvC,KAA+C,aAAzE;AACA,QAAM,kBAAkB,GAAG,CAAA,CAAA,EAAA,GAAC,aAAD,MAAqC,IAArC,IAAqC,EAAA,KAAA,KAAA,CAArC,GAAqC,KAAA,CAArC,GAAqC,EAAA,CAAE,KAAvC,KAAgD,aAA3E;AAEA,SAAO;AACL,IAAA,WAAW,EAAE,aADR;AAEL,cAAU;AACR,MAAA,OAAO,EAAE,IADD;AAER,MAAA,QAAQ,EAAE,UAFF;AAGR,MAAA,aAAa,EAAE,MAHP;AAIR,MAAA,SAAS,EAAE,aAJH;AAKR,MAAA,MAAM,EAAE,CALA;AAOR,MAAA,WAAW,EAAE,OAPL;AAQR,MAAA,WAAW,EAAE,YARL;AASR,MAAA,YAAY,EAAE,aATN;AAUR,MAAA,WAAW,EAAE,YAVL;AAYR,MAAA,GAAG,EAAE,CAAC,aAAD,GAAiB,IAAI,YAAY,EAAjC,GAAsC,cAAc,YAAY,MAAM,gBAAgB,GAZnF;AAaR,MAAA,MAAM,EAAE,CAAC,aAAD,GAAiB,IAAI,YAAY,EAAjC,GAAsC,cAAc,YAAY,MAAM,mBAAmB,GAbzF;AAcR,MAAA,IAAI,EAAE,CAAC,aAAD,GAAiB,IAAI,YAAY,EAAjC,GAAsC,cAAc,YAAY,MAAM,iBAAiB,GAdrF;AAeR,MAAA,KAAK,EAAE,CAAC,aAAD,GAAiB,IAAI,YAAY,EAAjC,GAAsC,cAAc,YAAY,MAAM,kBAAkB;AAfvF;AAFL,GAAP;AAoBD,CA5BD;;AAkCA,MAAM,cAAc,GAAyC;AAC3D,EAAA,QAAQ,EAAE;AADiD,CAA7D;AAIA;;;;;;;AAOG;;AACI,MAAM,uBAAuB,GAAG,CACrC,OAAA,GAE2C;AAAE,EAAA,KAAK,EAAE,EAAT;AAAa,KAAG;AAAhB,CAHN,MAInB;AAClB,oBAAkB;AAChB,IAAA,YAAY,EAAE;AADE,GADA;AAIlB,GAAC,GAAG,SAAA,CAAA,qBAAqB,KAAK,OAAO,CAAC,QAAR,IAAoB,cAAc,CAAC,QAAQ,EAAzE,GAA8E,qBAAqB,CAAC;AAClG,IAAA,YAAY,EAAE,aAAA,CAAA,MAAA,CAAO,iBAD6E;AAElG,IAAA,aAAa,EAAE,aAAA,CAAA,MAAA,CAAO,kBAF4E;AAGlG;AACA,IAAA,YAAY,EAAE,KAJoF;AAKlG,OAAG,OAAO,CAAC;AALuF,GAAD;AAJjF,CAJmB,CAAhC;;AAAM,OAAA,CAAA,uBAAA,GAAuB,uBAAvB;AAiBb;;;;;AAKG;;AACI,MAAM,+BAA+B,GAAG,CAC7C,KAD6C,EAE7C,OAAA,GAAgD,cAFH,MAG3B;AAClB,oBAAkB;AAChB,IAAA,YAAY,EAAE;AADE,GADA;AAIlB,GAAC,GAAG,SAAA,CAAA,qBAAqB,KAAK,OAAO,CAAC,QAAR,IAAoB,cAAc,CAAC,QAAQ,EAAzE,GAA8E;AAJ5D,CAH2B,CAAxC;;AAAM,OAAA,CAAA,+BAAA,GAA+B,+BAA/B","sourceRoot":""}

package/lib-commonjs/hooks/useFocusableGroup.d.ts

@@ -1,12 +0,0 @@
-import { Types } from 'tabster';
-export interface UseFocusableGroupOptions {
-    /**
-     * Behavior for the Tab key.
-     */
-    tabBehavior?: 'unlimited' | 'limited' | 'limitedTrapFocus';
-}
-/**
- * A hook that returns the necessary tabster attributes to support groupping.
- * @param options - Options to configure keyboard navigation
- */
-export declare const useFocusableGroup: (options?: UseFocusableGroupOptions | undefined) => Types.TabsterDOMAttribute;

package/lib-commonjs/hooks/useKeyboardNavAttribute.d.ts

@@ -1,5 +0,0 @@
-import type { RefObject } from 'react';
-/**
- * instantiates keyborg and add attribute to ensure focus indicator synced to keyborg logic
- */
-export declare function useKeyboardNavAttribute<E extends HTMLElement>(): RefObject<E>;

package/lib-commonjs/hooks/useModalAttributes.d.ts

@@ -1,22 +0,0 @@
-import { Types as TabsterTypes } from 'tabster';
-export interface UseModalAttributesOptions {
-    /**
-     * Traps focus inside the elements the attributes are applied
-     */
-    trapFocus?: boolean;
-    /**
-     * Always reachabled in Tab order
-     */
-    alwaysFocusable?: boolean;
-}
-/**
- * Applies modal dialog behaviour through DOM attributes
- * Modal element will focus trap and hide other content on the page
- * The trigger element will be focused if focus is lost after the modal element is removed
- *
- * @returns DOM attributes to apply to the modal element and its trigger
- */
-export declare const useModalAttributes: (options?: UseModalAttributesOptions) => {
-    modalAttributes: TabsterTypes.TabsterDOMAttribute;
-    triggerAttributes: TabsterTypes.TabsterDOMAttribute;
-};

package/lib-commonjs/hooks/useTabster.d.ts

@@ -1,9 +0,0 @@
-import { Types as TabsterTypes } from 'tabster';
-/**
- * Tries to get a tabster instance on the current window or creates a new one
- * Since Tabster is single instance only, feel free to call this hook to ensure Tabster exists if necessary
- *
- * @internal
- * @returns Tabster core instance
- */
-export declare const useTabster: () => TabsterTypes.TabsterCore | null;

package/lib-commonjs/hooks/useTabsterAttributes.d.ts

@@ -1,5 +0,0 @@
-import { Types as TabsterTypes } from 'tabster';
-/**
- * Hook that returns tabster attributes while ensuring tabster exists
- */
-export declare const useTabsterAttributes: (props: TabsterTypes.TabsterAttributeProps) => TabsterTypes.TabsterDOMAttribute;

package/lib-commonjs/index.d.ts

@@ -1 +0,0 @@
-export * from './hooks/index';

package/lib-commonjs/symbols.d.ts

@@ -1,2 +0,0 @@
-export declare const KEYBOARD_NAV_ATTRIBUTE: "data-keyboard-nav";
-export declare const KEYBOARD_NAV_SELECTOR: ":global([data-keyboard-nav])";

package/lib-commonjs/symbols.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/symbols.ts"],"names":[],"mappings":";;;;;;AAAa,OAAA,CAAA,sBAAA,GAAyB,mBAAzB;AACA,OAAA,CAAA,qBAAA,GAAwB,YAAY,OAAA,CAAA,sBAAsB,IAA1D","sourceRoot":""}