@fluentui/react-tabster 9.0.0-nightly.d730088d7f.0 → 9.0.0-rc.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (88) hide show
  1. package/CHANGELOG.json +502 -15
  2. package/CHANGELOG.md +223 -84
  3. package/README.md +5 -14
  4. package/dist/{react-tabster.d.ts → index.d.ts} +19 -30
  5. package/{lib → dist}/tsdoc-metadata.json +0 -0
  6. package/lib/focus/constants.js +7 -0
  7. package/lib/focus/constants.js.map +1 -0
  8. package/lib/focus/createCustomFocusIndicatorStyle.js +18 -0
  9. package/lib/focus/createCustomFocusIndicatorStyle.js.map +1 -0
  10. package/lib/focus/createFocusOutlineStyle.js +64 -0
  11. package/lib/focus/createFocusOutlineStyle.js.map +1 -0
  12. package/lib/focus/index.js +3 -0
  13. package/lib/focus/index.js.map +1 -0
  14. package/lib/hooks/index.js +2 -3
  15. package/lib/hooks/index.js.map +1 -1
  16. package/lib/hooks/useArrowNavigationGroup.js +7 -3
  17. package/lib/hooks/useArrowNavigationGroup.js.map +1 -1
  18. package/lib/hooks/useFocusFinders.js +25 -33
  19. package/lib/hooks/useFocusFinders.js.map +1 -1
  20. package/lib/hooks/useFocusableGroup.js +19 -22
  21. package/lib/hooks/useFocusableGroup.js.map +1 -1
  22. package/lib/hooks/useKeyboardNavAttribute.js +10 -12
  23. package/lib/hooks/useKeyboardNavAttribute.js.map +1 -1
  24. package/lib/hooks/useModalAttributes.js +12 -14
  25. package/lib/hooks/useModalAttributes.js.map +1 -1
  26. package/lib/hooks/useTabster.js +8 -5
  27. package/lib/hooks/useTabster.js.map +1 -1
  28. package/lib/hooks/useTabsterAttributes.js +1 -1
  29. package/lib/hooks/useTabsterAttributes.js.map +1 -1
  30. package/lib/index.js +2 -1
  31. package/lib/index.js.map +1 -1
  32. package/lib-commonjs/focus/constants.js +13 -0
  33. package/lib-commonjs/focus/constants.js.map +1 -0
  34. package/lib-commonjs/focus/createCustomFocusIndicatorStyle.js +28 -0
  35. package/lib-commonjs/focus/createCustomFocusIndicatorStyle.js.map +1 -0
  36. package/lib-commonjs/focus/createFocusOutlineStyle.js +77 -0
  37. package/lib-commonjs/focus/createFocusOutlineStyle.js.map +1 -0
  38. package/lib-commonjs/focus/index.js +12 -0
  39. package/lib-commonjs/focus/index.js.map +1 -0
  40. package/lib-commonjs/hooks/index.js +5 -7
  41. package/lib-commonjs/hooks/index.js.map +1 -1
  42. package/lib-commonjs/hooks/useArrowNavigationGroup.js +10 -6
  43. package/lib-commonjs/hooks/useArrowNavigationGroup.js.map +1 -1
  44. package/lib-commonjs/hooks/useFocusFinders.js +27 -35
  45. package/lib-commonjs/hooks/useFocusFinders.js.map +1 -1
  46. package/lib-commonjs/hooks/useFocusableGroup.js +23 -26
  47. package/lib-commonjs/hooks/useFocusableGroup.js.map +1 -1
  48. package/lib-commonjs/hooks/useKeyboardNavAttribute.js +15 -17
  49. package/lib-commonjs/hooks/useKeyboardNavAttribute.js.map +1 -1
  50. package/lib-commonjs/hooks/useModalAttributes.js +16 -18
  51. package/lib-commonjs/hooks/useModalAttributes.js.map +1 -1
  52. package/lib-commonjs/hooks/useTabster.js +10 -7
  53. package/lib-commonjs/hooks/useTabster.js.map +1 -1
  54. package/lib-commonjs/hooks/useTabsterAttributes.js +3 -3
  55. package/lib-commonjs/hooks/useTabsterAttributes.js.map +1 -1
  56. package/lib-commonjs/index.js +53 -2
  57. package/lib-commonjs/index.js.map +1 -1
  58. package/package.json +21 -19
  59. package/lib/hooks/index.d.ts +0 -7
  60. package/lib/hooks/useArrowNavigationGroup.d.ts +0 -22
  61. package/lib/hooks/useFocusFinders.d.ts +0 -10
  62. package/lib/hooks/useFocusIndicatorStyle.d.ts +0 -34
  63. package/lib/hooks/useFocusIndicatorStyle.js +0 -96
  64. package/lib/hooks/useFocusIndicatorStyle.js.map +0 -1
  65. package/lib/hooks/useFocusableGroup.d.ts +0 -26
  66. package/lib/hooks/useKeyboardNavAttribute.d.ts +0 -5
  67. package/lib/hooks/useModalAttributes.d.ts +0 -22
  68. package/lib/hooks/useTabster.d.ts +0 -9
  69. package/lib/hooks/useTabsterAttributes.d.ts +0 -5
  70. package/lib/index.d.ts +0 -1
  71. package/lib/symbols.d.ts +0 -2
  72. package/lib/symbols.js +0 -3
  73. package/lib/symbols.js.map +0 -1
  74. package/lib-commonjs/hooks/index.d.ts +0 -7
  75. package/lib-commonjs/hooks/useArrowNavigationGroup.d.ts +0 -22
  76. package/lib-commonjs/hooks/useFocusFinders.d.ts +0 -10
  77. package/lib-commonjs/hooks/useFocusIndicatorStyle.d.ts +0 -34
  78. package/lib-commonjs/hooks/useFocusIndicatorStyle.js +0 -109
  79. package/lib-commonjs/hooks/useFocusIndicatorStyle.js.map +0 -1
  80. package/lib-commonjs/hooks/useFocusableGroup.d.ts +0 -26
  81. package/lib-commonjs/hooks/useKeyboardNavAttribute.d.ts +0 -5
  82. package/lib-commonjs/hooks/useModalAttributes.d.ts +0 -22
  83. package/lib-commonjs/hooks/useTabster.d.ts +0 -9
  84. package/lib-commonjs/hooks/useTabsterAttributes.d.ts +0 -5
  85. package/lib-commonjs/index.d.ts +0 -1
  86. package/lib-commonjs/symbols.d.ts +0 -2
  87. package/lib-commonjs/symbols.js +0 -9
  88. package/lib-commonjs/symbols.js.map +0 -1
@@ -1,109 +0,0 @@
1
- "use strict";
2
-
3
- Object.defineProperty(exports, "__esModule", {
4
- value: true
5
- });
6
- exports.createCustomFocusIndicatorStyle = exports.createFocusOutlineStyle = void 0;
7
-
8
- var tslib_1 = /*#__PURE__*/require("tslib");
9
-
10
- var symbols_1 = /*#__PURE__*/require("../symbols");
11
- /**
12
- * NOTE: the element with the focus outline needs to have `position: relative` so that the
13
- * pseudo element can be properly positioned.
14
- *
15
- * @param options - Configures the style of the focus outline
16
- * @returns focus outline styles object
17
- */
18
-
19
-
20
- var getFocusOutlineStyles = function (options) {
21
- var _a, _b, _c, _d;
22
-
23
- var outlineRadius = options.outlineRadius,
24
- outlineColor = options.outlineColor,
25
- outlineOffset = options.outlineOffset,
26
- outlineWidth = options.outlineWidth;
27
- var outlineOffsetTop = ((_a = outlineOffset) === null || _a === void 0 ? void 0 : _a.top) || outlineOffset;
28
- var outlineOffsetBottom = ((_b = outlineOffset) === null || _b === void 0 ? void 0 : _b.bottom) || outlineOffset;
29
- var outlineOffsetLeft = ((_c = outlineOffset) === null || _c === void 0 ? void 0 : _c.left) || outlineOffset;
30
- var outlineOffsetRight = ((_d = outlineOffset) === null || _d === void 0 ? void 0 : _d.right) || outlineOffset;
31
- return {
32
- borderColor: 'transparent',
33
- ':after': {
34
- content: '""',
35
- position: 'absolute',
36
- pointerEvents: 'none',
37
- boxSizing: 'outline-box',
38
- zIndex: 1,
39
- borderStyle: 'solid',
40
- borderWidth: outlineWidth,
41
- borderRadius: outlineRadius,
42
- borderColor: outlineColor,
43
- top: !outlineOffset ? "-" + outlineWidth : "calc(0px - " + outlineWidth + " - " + outlineOffsetTop + ")",
44
- bottom: !outlineOffset ? "-" + outlineWidth : "calc(0px - " + outlineWidth + " - " + outlineOffsetBottom + ")",
45
- left: !outlineOffset ? "-" + outlineWidth : "calc(0px - " + outlineWidth + " - " + outlineOffsetLeft + ")",
46
- right: !outlineOffset ? "-" + outlineWidth : "calc(0px - " + outlineWidth + " - " + outlineOffsetRight + ")"
47
- }
48
- };
49
- };
50
-
51
- var defaultOptions = {
52
- selector: 'focus'
53
- };
54
- /**
55
- * NOTE: The element with the focus outline needs to have `position: relative` so that the
56
- * pseudo element can be properly positioned.
57
- *
58
- * @param theme - Theme used in @see makeStyles
59
- * @param options - Configure the style of the focus outline
60
- * @returns focus outline styles object for @see makeStyles
61
- */
62
-
63
- var createFocusOutlineStyle = function (theme, options) {
64
- var _a;
65
-
66
- if (options === void 0) {
67
- options = tslib_1.__assign({
68
- style: {}
69
- }, defaultOptions);
70
- }
71
-
72
- return _a = {
73
- ':focus-visible': {
74
- outline: 'none'
75
- }
76
- }, _a[symbols_1.KEYBOARD_NAV_SELECTOR + " :" + (options.selector || defaultOptions.selector)] = getFocusOutlineStyles(tslib_1.__assign({
77
- outlineColor: theme.colorStrokeFocus2,
78
- outlineRadius: theme.borderRadiusMedium,
79
- // FIXME: theme.global.strokeWidth.thick causes some weird bugs
80
- outlineWidth: '2px'
81
- }, options.style)), _a;
82
- };
83
-
84
- exports.createFocusOutlineStyle = createFocusOutlineStyle;
85
- /**
86
- * Creates a style rule for @see makeStyles that includes the necessary selectors for focus.
87
- * Should be used only when @see createFocusOutlineStyle does not fit requirements
88
- *
89
- * @param rule - styling applied on focus, defaults to @see getDefaultFocusOutlineStyes
90
- */
91
-
92
- var createCustomFocusIndicatorStyle = function (rule, options) {
93
- if (options === void 0) {
94
- options = defaultOptions;
95
- }
96
-
97
- return function (theme) {
98
- var _a;
99
-
100
- return _a = {
101
- ':focus-visible': {
102
- outline: 'none'
103
- }
104
- }, _a[symbols_1.KEYBOARD_NAV_SELECTOR + " :" + (options.selector || defaultOptions.selector)] = typeof rule === 'function' ? rule(theme) : rule, _a;
105
- };
106
- };
107
-
108
- exports.createCustomFocusIndicatorStyle = createCustomFocusIndicatorStyle;
109
- //# sourceMappingURL=useFocusIndicatorStyle.js.map
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../../src/hooks/useFocusIndicatorStyle.ts"],"names":[],"mappings":";;;;;;;;;AAEA,IAAA,SAAA,gBAAA,OAAA,CAAA,YAAA,CAAA;AAcA;;;;;;AAMG;;;AACH,IAAM,qBAAqB,GAAG,UAAC,OAAD,EAAkC;;;AACtD,MAAA,aAAa,GAAgD,OAAO,CAAvD,aAAb;AAAA,MAAe,YAAY,GAAkC,OAAO,CAAzC,YAA3B;AAAA,MAA6B,aAAa,GAAmB,OAAO,CAA1B,aAA1C;AAAA,MAA4C,YAAY,GAAK,OAAO,CAAZ,YAAxD;AAER,MAAM,gBAAgB,GAAG,CAAA,CAAA,EAAA,GAAC,aAAD,MAAqC,IAArC,IAAqC,EAAA,KAAA,KAAA,CAArC,GAAqC,KAAA,CAArC,GAAqC,EAAA,CAAE,GAAvC,KAA8C,aAAvE;AACA,MAAM,mBAAmB,GAAG,CAAA,CAAA,EAAA,GAAC,aAAD,MAAqC,IAArC,IAAqC,EAAA,KAAA,KAAA,CAArC,GAAqC,KAAA,CAArC,GAAqC,EAAA,CAAE,MAAvC,KAAiD,aAA7E;AACA,MAAM,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,MAAM,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,MAAI,YAArB,GAAsC,gBAAc,YAAd,GAA0B,KAA1B,GAAgC,gBAAhC,GAAgD,GAZnF;AAaR,MAAA,MAAM,EAAE,CAAC,aAAD,GAAiB,MAAI,YAArB,GAAsC,gBAAc,YAAd,GAA0B,KAA1B,GAAgC,mBAAhC,GAAmD,GAbzF;AAcR,MAAA,IAAI,EAAE,CAAC,aAAD,GAAiB,MAAI,YAArB,GAAsC,gBAAc,YAAd,GAA0B,KAA1B,GAAgC,iBAAhC,GAAiD,GAdrF;AAeR,MAAA,KAAK,EAAE,CAAC,aAAD,GAAiB,MAAI,YAArB,GAAsC,gBAAc,YAAd,GAA0B,KAA1B,GAAgC,kBAAhC,GAAkD;AAfvF;AAFL,GAAP;AAoBD,CA5BD;;AAkCA,IAAM,cAAc,GAAyC;AAC3D,EAAA,QAAQ,EAAE;AADiD,CAA7D;AAIA;;;;;;;AAOG;;AACI,IAAM,uBAAuB,GAAG,UACrC,KADqC,EAErC,OAFqC,EAIsC;;;AAF3E,MAAA,OAAA,KAAA,KAAA,CAAA,EAAA;AAAA,IAAA,OAAA,GAAA,OAAA,CAAA,QAAA,CAAA;AAE6C,MAAA,KAAK,EAAE;AAFpD,KAAA,EAE2D,cAF3D,CAAA;AAE2E;;AAC5D,SAAA,EAAA,GAAA;AACf,sBAAkB;AAChB,MAAA,OAAO,EAAE;AADO;AADH,GAAA,EAIf,EAAA,CAAI,SAAA,CAAA,qBAAA,GAAqB,IAArB,IAA0B,OAAO,CAAC,QAAR,IAAoB,cAAc,CAAC,QAA7D,CAAJ,CAAA,GAA8E,qBAAqB,CAAA,OAAA,CAAA,QAAA,CAAA;AACjG,IAAA,YAAY,EAAE,KAAK,CAAC,iBAD6E;AAEjG,IAAA,aAAa,EAAE,KAAK,CAAC,kBAF4E;AAGjG;AACA,IAAA,YAAY,EAAE;AAJmF,GAAA,EAK9F,OAAO,CAAC,KALsF,CAAA,CAJpF,EAWf,EAXe;AAWf,CAhBK;;AAAM,OAAA,CAAA,uBAAA,GAAuB,uBAAvB;AAkBb;;;;;AAKG;;AACI,IAAM,+BAA+B,GAAG,UAC7C,IAD6C,EAE7C,OAF6C,EAEiB;AAA9D,MAAA,OAAA,KAAA,KAAA,CAAA,EAAA;AAAA,IAAA,OAAA,GAAA,cAAA;AAA8D;;AAC/B,SAAA,UAAA,KAAA,EAAK;;;AAAI,WAAA,EAAA,GAAA;AACxC,wBAAkB;AAChB,QAAA,OAAO,EAAE;AADO;AADsB,KAAA,EAIxC,EAAA,CAAI,SAAA,CAAA,qBAAA,GAAqB,IAArB,IAA0B,OAAO,CAAC,QAAR,IAAoB,cAAc,CAAC,QAA7D,CAAJ,CAAA,GACE,OAAO,IAAP,KAAgB,UAAhB,GAA6B,IAAI,CAAC,KAAD,CAAjC,GAA2C,IALL,EAMxC,EANwC;AAMxC,GAN+B;AAM/B,CATK;;AAAM,OAAA,CAAA,+BAAA,GAA+B,+BAA/B","sourceRoot":""}
@@ -1,26 +0,0 @@
1
- import { Types } from 'tabster';
2
- export declare enum FocusableGroupTabBehavior {
3
- /**
4
- * Tab will cycle into and out of the groupper content.
5
- */
6
- Unlimited,
7
- /**
8
- * Tab will cycle out of the container, but not into it.
9
- */
10
- Limited,
11
- /**
12
- * Tab only cycles the inner elements.
13
- */
14
- LimitedTrapFocus
15
- }
16
- export interface UseFocusableGroupOptions {
17
- /**
18
- * Type of TAB key interaction.
19
- */
20
- tabBehavior?: FocusableGroupTabBehavior;
21
- }
22
- /**
23
- * A hook that returns the necessary tabster attributes to support groupping.
24
- * @param options - Options to configure keyboard navigation
25
- */
26
- export declare const useFocusableGroup: (options?: UseFocusableGroupOptions | undefined) => Types.TabsterDOMAttribute;
@@ -1,5 +0,0 @@
1
- import type { RefObject } from 'react';
2
- /**
3
- * instantiates keyborg and add attribute to ensure focus indicator synced to keyborg logic
4
- */
5
- export declare function useKeyboardNavAttribute<E extends HTMLElement>(): RefObject<E>;
@@ -1,22 +0,0 @@
1
- import { Types as TabsterTypes } from 'tabster';
2
- export interface UseModalAttributesOptions {
3
- /**
4
- * Traps focus inside the elements the attributes are applied
5
- */
6
- trapFocus?: boolean;
7
- /**
8
- * Always reachabled in Tab order
9
- */
10
- alwaysFocusable?: boolean;
11
- }
12
- /**
13
- * Applies modal dialog behaviour through DOM attributes
14
- * Modal element will focus trap and hide other content on the page
15
- * The trigger element will be focused if focus is lost after the modal element is removed
16
- *
17
- * @returns DOM attributes to apply to the modal element and its trigger
18
- */
19
- export declare const useModalAttributes: (options?: UseModalAttributesOptions) => {
20
- modalAttributes: TabsterTypes.TabsterDOMAttribute;
21
- triggerAttributes: TabsterTypes.TabsterDOMAttribute;
22
- };
@@ -1,9 +0,0 @@
1
- import { Types as TabsterTypes } from 'tabster';
2
- /**
3
- * Tries to get a tabster instance on the current window or creates a new one
4
- * Since Tabster is single instance only, feel free to call this hook to ensure Tabster exists if necessary
5
- *
6
- * @internal
7
- * @returns Tabster core instance
8
- */
9
- export declare const useTabster: () => TabsterTypes.TabsterCore | null;
@@ -1,5 +0,0 @@
1
- import { Types as TabsterTypes } from 'tabster';
2
- /**
3
- * Hook that returns tabster attributes while ensuring tabster exists
4
- */
5
- export declare const useTabsterAttributes: (props: TabsterTypes.TabsterAttributeProps) => TabsterTypes.TabsterDOMAttribute;
@@ -1 +0,0 @@
1
- export * from './hooks/index';
@@ -1,2 +0,0 @@
1
- export declare const KEYBOARD_NAV_ATTRIBUTE: "data-keyboard-nav";
2
- export declare const KEYBOARD_NAV_SELECTOR: ":global([data-keyboard-nav])";
@@ -1,9 +0,0 @@
1
- "use strict";
2
-
3
- Object.defineProperty(exports, "__esModule", {
4
- value: true
5
- });
6
- exports.KEYBOARD_NAV_SELECTOR = exports.KEYBOARD_NAV_ATTRIBUTE = void 0;
7
- exports.KEYBOARD_NAV_ATTRIBUTE = 'data-keyboard-nav';
8
- exports.KEYBOARD_NAV_SELECTOR = ":global([" + exports.KEYBOARD_NAV_ATTRIBUTE + "])";
9
- //# sourceMappingURL=symbols.js.map
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../src/symbols.ts"],"names":[],"mappings":";;;;;;AAAa,OAAA,CAAA,sBAAA,GAAyB,mBAAzB;AACA,OAAA,CAAA,qBAAA,GAAwB,cAAY,OAAA,CAAA,sBAAZ,GAAkC,IAA1D","sourceRoot":""}