@fluentui/react-positioning 0.0.0-nightlyc0273fdc6920211123.1 → 0.0.0-nightlyc0e3a0a1f320220217.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (66) hide show
  1. package/CHANGELOG.json +134 -10
  2. package/CHANGELOG.md +38 -8
  3. package/dist/react-positioning.d.ts +96 -46
  4. package/lib/createArrowStyles.d.ts +47 -10
  5. package/lib/createArrowStyles.js +68 -56
  6. package/lib/createArrowStyles.js.map +1 -1
  7. package/lib/createVirtualElementFromClick.js +17 -15
  8. package/lib/createVirtualElementFromClick.js.map +1 -1
  9. package/lib/types.d.ts +28 -7
  10. package/lib/usePopper.d.ts +2 -14
  11. package/lib/usePopper.js +367 -311
  12. package/lib/usePopper.js.map +1 -1
  13. package/lib/usePopperMouseTarget.js +28 -22
  14. package/lib/usePopperMouseTarget.js.map +1 -1
  15. package/lib/utils/getBasePlacement.js +1 -1
  16. package/lib/utils/getBasePlacement.js.map +1 -1
  17. package/lib/utils/getBoundary.js +15 -10
  18. package/lib/utils/getBoundary.js.map +1 -1
  19. package/lib/utils/getReactFiberFromNode.js +39 -35
  20. package/lib/utils/getReactFiberFromNode.js.map +1 -1
  21. package/lib/utils/getScrollParent.js +46 -32
  22. package/lib/utils/getScrollParent.js.map +1 -1
  23. package/lib/utils/mergeArrowOffset.js +29 -24
  24. package/lib/utils/mergeArrowOffset.js.map +1 -1
  25. package/lib/utils/positioningHelper.d.ts +2 -2
  26. package/lib/utils/positioningHelper.js +38 -30
  27. package/lib/utils/positioningHelper.js.map +1 -1
  28. package/lib/utils/resolvePositioningShorthand.js +57 -19
  29. package/lib/utils/resolvePositioningShorthand.js.map +1 -1
  30. package/lib/utils/useCallbackRef.js +35 -29
  31. package/lib/utils/useCallbackRef.js.map +1 -1
  32. package/lib-commonjs/createArrowStyles.d.ts +47 -10
  33. package/lib-commonjs/createArrowStyles.js +80 -59
  34. package/lib-commonjs/createArrowStyles.js.map +1 -1
  35. package/lib-commonjs/createVirtualElementFromClick.js +23 -16
  36. package/lib-commonjs/createVirtualElementFromClick.js.map +1 -1
  37. package/lib-commonjs/index.js +26 -5
  38. package/lib-commonjs/index.js.map +1 -1
  39. package/lib-commonjs/types.d.ts +28 -7
  40. package/lib-commonjs/types.js +4 -1
  41. package/lib-commonjs/types.js.map +1 -1
  42. package/lib-commonjs/usePopper.d.ts +2 -14
  43. package/lib-commonjs/usePopper.js +382 -316
  44. package/lib-commonjs/usePopper.js.map +1 -1
  45. package/lib-commonjs/usePopperMouseTarget.js +38 -25
  46. package/lib-commonjs/usePopperMouseTarget.js.map +1 -1
  47. package/lib-commonjs/utils/getBasePlacement.js +7 -2
  48. package/lib-commonjs/utils/getBasePlacement.js.map +1 -1
  49. package/lib-commonjs/utils/getBoundary.js +23 -12
  50. package/lib-commonjs/utils/getBoundary.js.map +1 -1
  51. package/lib-commonjs/utils/getReactFiberFromNode.js +44 -36
  52. package/lib-commonjs/utils/getReactFiberFromNode.js.map +1 -1
  53. package/lib-commonjs/utils/getScrollParent.js +53 -33
  54. package/lib-commonjs/utils/getScrollParent.js.map +1 -1
  55. package/lib-commonjs/utils/index.js +14 -2
  56. package/lib-commonjs/utils/index.js.map +1 -1
  57. package/lib-commonjs/utils/mergeArrowOffset.js +35 -25
  58. package/lib-commonjs/utils/mergeArrowOffset.js.map +1 -1
  59. package/lib-commonjs/utils/positioningHelper.d.ts +2 -2
  60. package/lib-commonjs/utils/positioningHelper.js +46 -31
  61. package/lib-commonjs/utils/positioningHelper.js.map +1 -1
  62. package/lib-commonjs/utils/resolvePositioningShorthand.js +65 -22
  63. package/lib-commonjs/utils/resolvePositioningShorthand.js.map +1 -1
  64. package/lib-commonjs/utils/useCallbackRef.js +45 -32
  65. package/lib-commonjs/utils/useCallbackRef.js.map +1 -1
  66. package/package.json +7 -8
package/CHANGELOG.json CHANGED
@@ -2,17 +2,135 @@
2
2
  "name": "@fluentui/react-positioning",
3
3
  "entries": [
4
4
  {
5
- "date": "Tue, 23 Nov 2021 04:19:30 GMT",
6
- "tag": "@fluentui/react-positioning_v0.0.0-nightlyc0273fdc6920211123.1",
7
- "version": "0.0.0-nightlyc0273fdc6920211123.1",
5
+ "date": "Thu, 17 Feb 2022 04:12:39 GMT",
6
+ "tag": "@fluentui/react-positioning_v0.0.0-nightlyc0e3a0a1f320220217.1",
7
+ "version": "0.0.0-nightlyc0e3a0a1f320220217.1",
8
8
  "comments": {
9
9
  "prerelease": [
10
10
  {
11
11
  "author": "email not defined",
12
12
  "package": "@fluentui/react-positioning",
13
- "commit": "ecb84838dc29fe424995bfc3c2983d3cd335936e",
13
+ "commit": "4df2a77ff1d0255eee60fa6109174a7cb44dcbe6",
14
14
  "comment": "Release nightly v9"
15
15
  },
16
+ {
17
+ "author": "beachball",
18
+ "package": "@fluentui/react-positioning",
19
+ "comment": "Bump @fluentui/react-shared-contexts to v0.0.0-nightlyc0e3a0a1f320220217.1",
20
+ "commit": "4df2a77ff1d0255eee60fa6109174a7cb44dcbe6"
21
+ },
22
+ {
23
+ "author": "beachball",
24
+ "package": "@fluentui/react-positioning",
25
+ "comment": "Bump @fluentui/react-utilities to v0.0.0-nightlyc0e3a0a1f320220217.1",
26
+ "commit": "4df2a77ff1d0255eee60fa6109174a7cb44dcbe6"
27
+ }
28
+ ]
29
+ }
30
+ },
31
+ {
32
+ "date": "Thu, 10 Feb 2022 08:50:40 GMT",
33
+ "tag": "@fluentui/react-positioning_v9.0.0-rc.1",
34
+ "version": "9.0.0-rc.1",
35
+ "comments": {
36
+ "prerelease": [
37
+ {
38
+ "author": "olfedias@microsoft.com",
39
+ "package": "@fluentui/react-positioning",
40
+ "commit": "a76afe26daad901ff5458ffdda7e66e600d5bcac",
41
+ "comment": "use new types from makeStyles core"
42
+ },
43
+ {
44
+ "author": "Humberto.Morimoto@microsoft.com",
45
+ "package": "@fluentui/react-positioning",
46
+ "commit": "db6526ee2d04991e4473174969e3795299b52f9e",
47
+ "comment": "Replacing use of functions in makeStyles with direct use of tokens."
48
+ },
49
+ {
50
+ "author": "behowell@microsoft.com",
51
+ "package": "@fluentui/react-positioning",
52
+ "commit": "2e34c026a354af1bbfe6a5ead1ade41348d5488f",
53
+ "comment": "Fix tooltip arrow's high contrast border in RTL"
54
+ },
55
+ {
56
+ "author": "olfedias@microsoft.com",
57
+ "package": "@fluentui/react-positioning",
58
+ "commit": "523b5785eafd28cf56b677af40274cefe5d42dcb",
59
+ "comment": "use Griffel packages"
60
+ },
61
+ {
62
+ "author": "lingfangao@hotmail.com",
63
+ "package": "@fluentui/react-positioning",
64
+ "commit": "a548a59bd94f9c4b656da3bdd149db7ac2de726f",
65
+ "comment": "feat: Imperative `setTarget` for `usePopper` and `positioning`"
66
+ },
67
+ {
68
+ "author": "bsunderhus@microsoft.com",
69
+ "package": "@fluentui/react-positioning",
70
+ "commit": "e382ad22539fc97bb283ca4ed856e126c7477e89",
71
+ "comment": "Adds @noflip annotation to data-popper-placement styles"
72
+ },
73
+ {
74
+ "author": "olfedias@microsoft.com",
75
+ "package": "@fluentui/react-positioning",
76
+ "commit": "967d6b74cf0507685a24e0cfaa8c7b9d52a351e1",
77
+ "comment": "update styles to not use CSS shorthands"
78
+ },
79
+ {
80
+ "author": "lingfangao@hotmail.com",
81
+ "package": "@fluentui/react-positioning",
82
+ "commit": "c00913d50e2dd15bbfbb0757cefe43b192ff1d7f",
83
+ "comment": "Bump Fluent UI packages to 9.0.0-rc"
84
+ },
85
+ {
86
+ "author": "behowell@microsoft.com",
87
+ "package": "@fluentui/react-positioning",
88
+ "commit": "09804275c7f346db54c33d4ff347bffc33676014",
89
+ "comment": "Fix popover arrow styling"
90
+ },
91
+ {
92
+ "author": "beachball",
93
+ "package": "@fluentui/react-positioning",
94
+ "comment": "Bump @fluentui/react-shared-contexts to v9.0.0-rc.1",
95
+ "commit": "e6c855f6d9019d6c73668d15fc9bc3a13291a6c8"
96
+ },
97
+ {
98
+ "author": "beachball",
99
+ "package": "@fluentui/react-positioning",
100
+ "comment": "Bump @fluentui/react-utilities to v9.0.0-rc.1",
101
+ "commit": "e6c855f6d9019d6c73668d15fc9bc3a13291a6c8"
102
+ }
103
+ ],
104
+ "none": [
105
+ {
106
+ "author": "olfedias@microsoft.com",
107
+ "package": "@fluentui/react-positioning",
108
+ "commit": "c061e98be4b4a718c72a144a1f60bb5515824612",
109
+ "comment": "remove inline-style-expand-shorthand from tsconfigs"
110
+ },
111
+ {
112
+ "author": "martinhochel@microsoft.com",
113
+ "package": "@fluentui/react-positioning",
114
+ "commit": "8dfa712156b70414205b87b5b6d099367b0c297d",
115
+ "comment": "chore: use storybook runner for all vNext packages"
116
+ }
117
+ ]
118
+ }
119
+ },
120
+ {
121
+ "date": "Thu, 25 Nov 2021 08:34:15 GMT",
122
+ "tag": "@fluentui/react-positioning_v9.0.0-beta.4",
123
+ "version": "9.0.0-beta.4",
124
+ "comments": {
125
+ "none": [
126
+ {
127
+ "author": "lingfangao@hotmail.com",
128
+ "package": "@fluentui/react-positioning",
129
+ "commit": "718e63006d8d07d24efab9c32942041963d78dc7",
130
+ "comment": "Migrate package to use solution style ts-configs"
131
+ }
132
+ ],
133
+ "prerelease": [
16
134
  {
17
135
  "author": "lingfangao@hotmail.com",
18
136
  "package": "@fluentui/react-positioning",
@@ -22,20 +140,26 @@
22
140
  {
23
141
  "author": "beachball",
24
142
  "package": "@fluentui/react-positioning",
25
- "comment": "Bump @fluentui/react-make-styles to v0.0.0-nightlyc0273fdc6920211123.1",
26
- "commit": "ecb84838dc29fe424995bfc3c2983d3cd335936e"
143
+ "comment": "Bump @fluentui/react-make-styles to v9.0.0-beta.4",
144
+ "commit": "48d236ac53a4950fabc3ddd52f91dac93ca0195b"
145
+ },
146
+ {
147
+ "author": "beachball",
148
+ "package": "@fluentui/react-positioning",
149
+ "comment": "Bump @fluentui/react-shared-contexts to v9.0.0-beta.4",
150
+ "commit": "48d236ac53a4950fabc3ddd52f91dac93ca0195b"
27
151
  },
28
152
  {
29
153
  "author": "beachball",
30
154
  "package": "@fluentui/react-positioning",
31
- "comment": "Bump @fluentui/react-shared-contexts to v0.0.0-nightlyc0273fdc6920211123.1",
32
- "commit": "ecb84838dc29fe424995bfc3c2983d3cd335936e"
155
+ "comment": "Bump @fluentui/react-utilities to v9.0.0-beta.4",
156
+ "commit": "48d236ac53a4950fabc3ddd52f91dac93ca0195b"
33
157
  },
34
158
  {
35
159
  "author": "beachball",
36
160
  "package": "@fluentui/react-positioning",
37
- "comment": "Bump @fluentui/react-utilities to v0.0.0-nightlyc0273fdc6920211123.1",
38
- "commit": "ecb84838dc29fe424995bfc3c2983d3cd335936e"
161
+ "comment": "Bump @fluentui/babel-make-styles to v9.0.0-beta.4",
162
+ "commit": "48d236ac53a4950fabc3ddd52f91dac93ca0195b"
39
163
  }
40
164
  ]
41
165
  }
package/CHANGELOG.md CHANGED
@@ -1,21 +1,51 @@
1
1
  # Change Log - @fluentui/react-positioning
2
2
 
3
- This log was last generated on Tue, 23 Nov 2021 04:19:30 GMT and should not be manually modified.
3
+ This log was last generated on Thu, 17 Feb 2022 04:12:39 GMT and should not be manually modified.
4
4
 
5
5
  <!-- Start content -->
6
6
 
7
- ## [0.0.0-nightlyc0273fdc6920211123.1](https://github.com/microsoft/fluentui/tree/@fluentui/react-positioning_v0.0.0-nightlyc0273fdc6920211123.1)
7
+ ## [0.0.0-nightlyc0e3a0a1f320220217.1](https://github.com/microsoft/fluentui/tree/@fluentui/react-positioning_v0.0.0-nightlyc0e3a0a1f320220217.1)
8
8
 
9
- Tue, 23 Nov 2021 04:19:30 GMT
10
- [Compare changes](https://github.com/microsoft/fluentui/compare/@fluentui/react-positioning_v9.0.0-beta.3..@fluentui/react-positioning_v0.0.0-nightlyc0273fdc6920211123.1)
9
+ Thu, 17 Feb 2022 04:12:39 GMT
10
+ [Compare changes](https://github.com/microsoft/fluentui/compare/@fluentui/react-positioning_v9.0.0-rc.1..@fluentui/react-positioning_v0.0.0-nightlyc0e3a0a1f320220217.1)
11
+
12
+ ### Changes
13
+
14
+ - Release nightly v9 ([commit](https://github.com/microsoft/fluentui/commit/4df2a77ff1d0255eee60fa6109174a7cb44dcbe6) by email not defined)
15
+ - Bump @fluentui/react-shared-contexts to v0.0.0-nightlyc0e3a0a1f320220217.1 ([commit](https://github.com/microsoft/fluentui/commit/4df2a77ff1d0255eee60fa6109174a7cb44dcbe6) by beachball)
16
+ - Bump @fluentui/react-utilities to v0.0.0-nightlyc0e3a0a1f320220217.1 ([commit](https://github.com/microsoft/fluentui/commit/4df2a77ff1d0255eee60fa6109174a7cb44dcbe6) by beachball)
17
+
18
+ ## [9.0.0-rc.1](https://github.com/microsoft/fluentui/tree/@fluentui/react-positioning_v9.0.0-rc.1)
19
+
20
+ Thu, 10 Feb 2022 08:50:40 GMT
21
+ [Compare changes](https://github.com/microsoft/fluentui/compare/@fluentui/react-positioning_v9.0.0-beta.4..@fluentui/react-positioning_v9.0.0-rc.1)
22
+
23
+ ### Changes
24
+
25
+ - use new types from makeStyles core ([PR #20786](https://github.com/microsoft/fluentui/pull/20786) by olfedias@microsoft.com)
26
+ - Replacing use of functions in makeStyles with direct use of tokens. ([PR #21051](https://github.com/microsoft/fluentui/pull/21051) by Humberto.Morimoto@microsoft.com)
27
+ - Fix tooltip arrow's high contrast border in RTL ([PR #21354](https://github.com/microsoft/fluentui/pull/21354) by behowell@microsoft.com)
28
+ - use Griffel packages ([PR #21421](https://github.com/microsoft/fluentui/pull/21421) by olfedias@microsoft.com)
29
+ - feat: Imperative `setTarget` for `usePopper` and `positioning` ([PR #21632](https://github.com/microsoft/fluentui/pull/21632) by lingfangao@hotmail.com)
30
+ - Adds @noflip annotation to data-popper-placement styles ([PR #20845](https://github.com/microsoft/fluentui/pull/20845) by bsunderhus@microsoft.com)
31
+ - update styles to not use CSS shorthands ([PR #20842](https://github.com/microsoft/fluentui/pull/20842) by olfedias@microsoft.com)
32
+ - Bump Fluent UI packages to 9.0.0-rc ([PR #21623](https://github.com/microsoft/fluentui/pull/21623) by lingfangao@hotmail.com)
33
+ - Fix popover arrow styling ([PR #21086](https://github.com/microsoft/fluentui/pull/21086) by behowell@microsoft.com)
34
+ - Bump @fluentui/react-shared-contexts to v9.0.0-rc.1 ([commit](https://github.com/microsoft/fluentui/commit/e6c855f6d9019d6c73668d15fc9bc3a13291a6c8) by beachball)
35
+ - Bump @fluentui/react-utilities to v9.0.0-rc.1 ([commit](https://github.com/microsoft/fluentui/commit/e6c855f6d9019d6c73668d15fc9bc3a13291a6c8) by beachball)
36
+
37
+ ## [9.0.0-beta.4](https://github.com/microsoft/fluentui/tree/@fluentui/react-positioning_v9.0.0-beta.4)
38
+
39
+ Thu, 25 Nov 2021 08:34:15 GMT
40
+ [Compare changes](https://github.com/microsoft/fluentui/compare/@fluentui/react-positioning_v9.0.0-beta.3..@fluentui/react-positioning_v9.0.0-beta.4)
11
41
 
12
42
  ### Changes
13
43
 
14
- - Release nightly v9 ([commit](https://github.com/microsoft/fluentui/commit/ecb84838dc29fe424995bfc3c2983d3cd335936e) by email not defined)
15
44
  - Add utility function to create styles for an arrow element ([PR #20541](https://github.com/microsoft/fluentui/pull/20541) by lingfangao@hotmail.com)
16
- - Bump @fluentui/react-make-styles to v0.0.0-nightlyc0273fdc6920211123.1 ([commit](https://github.com/microsoft/fluentui/commit/ecb84838dc29fe424995bfc3c2983d3cd335936e) by beachball)
17
- - Bump @fluentui/react-shared-contexts to v0.0.0-nightlyc0273fdc6920211123.1 ([commit](https://github.com/microsoft/fluentui/commit/ecb84838dc29fe424995bfc3c2983d3cd335936e) by beachball)
18
- - Bump @fluentui/react-utilities to v0.0.0-nightlyc0273fdc6920211123.1 ([commit](https://github.com/microsoft/fluentui/commit/ecb84838dc29fe424995bfc3c2983d3cd335936e) by beachball)
45
+ - Bump @fluentui/react-make-styles to v9.0.0-beta.4 ([PR #20762](https://github.com/microsoft/fluentui/pull/20762) by beachball)
46
+ - Bump @fluentui/react-shared-contexts to v9.0.0-beta.4 ([PR #20762](https://github.com/microsoft/fluentui/pull/20762) by beachball)
47
+ - Bump @fluentui/react-utilities to v9.0.0-beta.4 ([PR #20762](https://github.com/microsoft/fluentui/pull/20762) by beachball)
48
+ - Bump @fluentui/babel-make-styles to v9.0.0-beta.4 ([PR #20762](https://github.com/microsoft/fluentui/pull/20762) by beachball)
19
49
 
20
50
  ## [9.0.0-beta.3](https://github.com/microsoft/fluentui/tree/@fluentui/react-positioning_v9.0.0-beta.3)
21
51
 
@@ -1,7 +1,6 @@
1
- import type { MakeStylesStyleRule } from '@fluentui/make-styles';
1
+ import type { GriffelStyle } from '@griffel/react';
2
2
  import * as PopperJs from '@popperjs/core';
3
3
  import * as React_2 from 'react';
4
- import type { Theme } from '@fluentui/react-theme';
5
4
 
6
5
  export declare type Alignment = 'top' | 'bottom' | 'start' | 'end' | 'center';
7
6
 
@@ -9,31 +8,71 @@ export declare type AutoSize = 'height' | 'height-always' | 'width' | 'width-alw
9
8
 
10
9
  export declare type Boundary = PopperJs.Boundary | 'scrollParent' | 'window';
11
10
 
11
+ /**
12
+ * Creates CSS styles to size the arrow created by createArrowStyles to the given height.
13
+ *
14
+ * Use this when you need to create classes for several different arrow sizes. If you only need a
15
+ * constant arrow size, you can pass the `arrowHeight` param to createArrowStyles instead.
16
+ */
17
+ export declare function createArrowHeightStyles(arrowHeight: number): {
18
+ width: string;
19
+ height: string;
20
+ };
21
+
12
22
  /**
13
23
  * Helper that creates a makeStyles rule for an arrow element.
14
24
  * For runtime arrow size toggling simply create extra classnames to apply to the arrow element
15
25
  *
16
26
  * ```ts
17
27
  * makeStyles({
18
- * arrowWithSize: createArrowStyles(5),
28
+ * arrowWithSize: createArrowStyles({ arrowHeight: 6 }),
19
29
  *
20
- * arrowWithoutSize: createArrowStyles(),
21
- * mediumArrow: { aspectRatio: 1, width: '4px' }
22
- * smallArrow: { aspectRatio: 1, width: '2px' }
30
+ * arrowWithoutSize: createArrowStyles({ arrowHeight: undefined }),
31
+ * mediumArrow: createArrowHeightStyles(4),
32
+ * smallArrow: createArrowHeightStyles(2),
23
33
  * })
24
34
  * ...
25
35
  *
26
- * state.arrowWithSize.clasName = styles.arrowWithSize
27
- * state.arrowWithoutSize.className = mergeClases(
36
+ * state.arrowWithSize.className = styles.arrowWithSize;
37
+ * state.arrowWithoutSize.className = mergeClasses(
28
38
  * styles.arrowWithoutSize,
29
39
  * state.smallArrow && styles.smallArrow,
30
40
  * state.mediumArrow && styles.mediumArrow,
31
41
  * )
32
42
  * ```
33
- *
34
- * @param size - dimensions of the square arrow element in pixels.
35
43
  */
36
- export declare function createArrowStyles(size?: number): MakeStylesStyleRule<Theme>;
44
+ export declare function createArrowStyles(options: CreateArrowStylesOptions): GriffelStyle;
45
+
46
+ /**
47
+ * Options parameter for the createArrowStyles function
48
+ */
49
+ export declare type CreateArrowStylesOptions = {
50
+ /**
51
+ * The height of the arrow from the base to the tip, in px. The base width of the arrow is always twice its height.
52
+ *
53
+ * This can be undefined to leave out the arrow size styles. You must then add styles created by
54
+ * createArrowHeightStyles to set the arrow's size correctly. This can be useful if the arrow can be different sizes.
55
+ */
56
+ arrowHeight: number | undefined;
57
+ /**
58
+ * The borderWidth of the arrow. Should be the same borderWidth as the parent element.
59
+ *
60
+ * @defaultvalue 1px
61
+ */
62
+ borderWidth?: GriffelStyle['borderBottomWidth'];
63
+ /**
64
+ * The borderStyle for the arrow. Should be the same borderStyle as the parent element.
65
+ *
66
+ * @defaultvalue solid
67
+ */
68
+ borderStyle?: GriffelStyle['borderBottomStyle'];
69
+ /**
70
+ * The borderColor of the arrow. Should be the same borderColor as the parent element.
71
+ *
72
+ * @defaultvalue tokens.colorTransparentStroke
73
+ */
74
+ borderColor?: GriffelStyle['borderBottomColor'];
75
+ };
37
76
 
38
77
  /**
39
78
  * Creates a virtual element based on the position of a click event
@@ -61,42 +100,13 @@ export declare type OffsetFunctionParam = {
61
100
  placement: PopperJs.Placement;
62
101
  };
63
102
 
64
- declare interface PopperOptions extends PositioningProps {
65
- /**
66
- * If false, delays Popper's creation.
67
- * @default true
68
- */
69
- enabled?: boolean;
70
- onStateUpdate?: (state: Partial<PopperJs.State>) => void;
71
- /**
72
- * Enables the Popper box to position itself in 'fixed' mode (default value is position: 'absolute')
73
- * @default false
74
- */
75
- positionFixed?: boolean;
76
- /**
77
- * When the reference element or the viewport is outside viewport allows a popper element to be fully in viewport.
78
- * "all" enables this behavior for all axis.
79
- */
80
- unstable_disableTether?: boolean | 'all';
81
- }
82
-
83
- export declare type PopperRefHandle = {
84
- updatePosition: () => void;
85
- };
86
-
87
- export declare type PopperVirtualElement = PopperJs.VirtualElement;
88
-
89
- export declare type Position = 'above' | 'below' | 'before' | 'after';
90
-
91
- export declare interface PositioningProps {
103
+ export declare interface PopperOptions {
92
104
  /** Alignment for the component. Only has an effect if used with the @see position option */
93
105
  align?: Alignment;
94
106
  /** The element which will define the boundaries of the popper position for the flip behavior. */
95
107
  flipBoundary?: Boundary;
96
108
  /** The element which will define the boundaries of the popper position for the overflow behavior. */
97
109
  overflowBoundary?: Boundary;
98
- /** An imperative handle to Popper methods. */
99
- popperRef?: React_2.Ref<PopperRefHandle>;
100
110
  /**
101
111
  * Position for the component. Position has higher priority than align. If position is vertical ('above' | 'below')
102
112
  * and align is also vertical ('top' | 'bottom') or if both position and align are horizontal ('before' | 'after'
@@ -104,6 +114,11 @@ export declare interface PositioningProps {
104
114
  * then provided value for 'align' will be ignored and 'center' will be used instead.
105
115
  */
106
116
  position?: Position;
117
+ /**
118
+ * Enables the Popper box to position itself in 'fixed' mode (default value is position: 'absolute')
119
+ * @default false
120
+ */
121
+ positionFixed?: boolean;
107
122
  /**
108
123
  * Lets you displace a popper element from its reference element.
109
124
  * This can be useful if you need to apply some margin between them or if you need to fine tune the
@@ -123,10 +138,6 @@ export declare interface PositioningProps {
123
138
  * `height-always` applies `max-height` regardless of overflow, and 'width-always' for always applying `max-width`
124
139
  */
125
140
  autoSize?: AutoSize;
126
- /**
127
- * Manual override for popper target. Useful for scenarios where a component accepts user prop to override target
128
- */
129
- target?: HTMLElement | PopperVirtualElement | null;
130
141
  /**
131
142
  * Modifies position and alignment to cover the target
132
143
  */
@@ -136,6 +147,37 @@ export declare interface PositioningProps {
136
147
  * `position` props, regardless of the size of the component, the reference element or the viewport.
137
148
  */
138
149
  pinned?: boolean;
150
+ /**
151
+ * When the reference element or the viewport is outside viewport allows a popper element to be fully in viewport.
152
+ * "all" enables this behavior for all axis.
153
+ */
154
+ unstable_disableTether?: boolean | 'all';
155
+ }
156
+
157
+ export declare type PopperRefHandle = {
158
+ /**
159
+ * Updates the position of the popper imperatively.
160
+ * Useful when the position of the target changes from other factors than scrolling of window resize.
161
+ */
162
+ updatePosition: () => void;
163
+ /**
164
+ * Sets the target and updates positioning imperatively.
165
+ * Useful for avoiding double renders with the target option.
166
+ */
167
+ setTarget: (target: HTMLElement) => void;
168
+ };
169
+
170
+ export declare type PopperVirtualElement = PopperJs.VirtualElement;
171
+
172
+ export declare type Position = 'above' | 'below' | 'before' | 'after';
173
+
174
+ export declare interface PositioningProps extends Omit<PopperOptions, 'positionFixed' | 'unstable_disableTether'> {
175
+ /** An imperative handle to Popper methods. */
176
+ popperRef?: React_2.Ref<PopperRefHandle>;
177
+ /**
178
+ * Manual override for popper target. Useful for scenarios where a component accepts user prop to override target
179
+ */
180
+ target?: HTMLElement | PopperVirtualElement | null;
139
181
  }
140
182
 
141
183
  export declare type PositioningShorthand = PositioningProps | PositioningShorthandValue;
@@ -152,7 +194,7 @@ export declare function resolvePositioningShorthand(shorthand: PositioningShorth
152
194
  * - contains a specific to React fix related to initial positioning when containers have components with managed focus
153
195
  * to avoid focus jumps
154
196
  */
155
- export declare function usePopper(options?: PopperOptions): {
197
+ export declare function usePopper(options?: UsePopperOptions): {
156
198
  targetRef: React_2.MutableRefObject<any>;
157
199
  containerRef: React_2.MutableRefObject<any>;
158
200
  arrowRef: React_2.MutableRefObject<any>;
@@ -168,4 +210,12 @@ export declare function usePopper(options?: PopperOptions): {
168
210
  */
169
211
  export declare const usePopperMouseTarget: (initialState?: PopperJs.VirtualElement | (() => PopperJs.VirtualElement) | undefined) => readonly [PopperJs.VirtualElement | undefined, (event: React_2.MouseEvent | MouseEvent | undefined | null) => void];
170
212
 
213
+ declare interface UsePopperOptions extends PositioningProps {
214
+ /**
215
+ * If false, delays Popper's creation.
216
+ * @default true
217
+ */
218
+ enabled?: boolean;
219
+ }
220
+
171
221
  export { }
@@ -1,27 +1,64 @@
1
- import type { MakeStylesStyleRule } from '@fluentui/make-styles';
2
- import type { Theme } from '@fluentui/react-theme';
1
+ import type { GriffelStyle } from '@griffel/react';
2
+ /**
3
+ * Options parameter for the createArrowStyles function
4
+ */
5
+ export declare type CreateArrowStylesOptions = {
6
+ /**
7
+ * The height of the arrow from the base to the tip, in px. The base width of the arrow is always twice its height.
8
+ *
9
+ * This can be undefined to leave out the arrow size styles. You must then add styles created by
10
+ * createArrowHeightStyles to set the arrow's size correctly. This can be useful if the arrow can be different sizes.
11
+ */
12
+ arrowHeight: number | undefined;
13
+ /**
14
+ * The borderWidth of the arrow. Should be the same borderWidth as the parent element.
15
+ *
16
+ * @defaultvalue 1px
17
+ */
18
+ borderWidth?: GriffelStyle['borderBottomWidth'];
19
+ /**
20
+ * The borderStyle for the arrow. Should be the same borderStyle as the parent element.
21
+ *
22
+ * @defaultvalue solid
23
+ */
24
+ borderStyle?: GriffelStyle['borderBottomStyle'];
25
+ /**
26
+ * The borderColor of the arrow. Should be the same borderColor as the parent element.
27
+ *
28
+ * @defaultvalue tokens.colorTransparentStroke
29
+ */
30
+ borderColor?: GriffelStyle['borderBottomColor'];
31
+ };
3
32
  /**
4
33
  * Helper that creates a makeStyles rule for an arrow element.
5
34
  * For runtime arrow size toggling simply create extra classnames to apply to the arrow element
6
35
  *
7
36
  * ```ts
8
37
  * makeStyles({
9
- * arrowWithSize: createArrowStyles(5),
38
+ * arrowWithSize: createArrowStyles({ arrowHeight: 6 }),
10
39
  *
11
- * arrowWithoutSize: createArrowStyles(),
12
- * mediumArrow: { aspectRatio: 1, width: '4px' }
13
- * smallArrow: { aspectRatio: 1, width: '2px' }
40
+ * arrowWithoutSize: createArrowStyles({ arrowHeight: undefined }),
41
+ * mediumArrow: createArrowHeightStyles(4),
42
+ * smallArrow: createArrowHeightStyles(2),
14
43
  * })
15
44
  * ...
16
45
  *
17
- * state.arrowWithSize.clasName = styles.arrowWithSize
18
- * state.arrowWithoutSize.className = mergeClases(
46
+ * state.arrowWithSize.className = styles.arrowWithSize;
47
+ * state.arrowWithoutSize.className = mergeClasses(
19
48
  * styles.arrowWithoutSize,
20
49
  * state.smallArrow && styles.smallArrow,
21
50
  * state.mediumArrow && styles.mediumArrow,
22
51
  * )
23
52
  * ```
53
+ */
54
+ export declare function createArrowStyles(options: CreateArrowStylesOptions): GriffelStyle;
55
+ /**
56
+ * Creates CSS styles to size the arrow created by createArrowStyles to the given height.
24
57
  *
25
- * @param size - dimensions of the square arrow element in pixels.
58
+ * Use this when you need to create classes for several different arrow sizes. If you only need a
59
+ * constant arrow size, you can pass the `arrowHeight` param to createArrowStyles instead.
26
60
  */
27
- export declare function createArrowStyles(size?: number): MakeStylesStyleRule<Theme>;
61
+ export declare function createArrowHeightStyles(arrowHeight: number): {
62
+ width: string;
63
+ height: string;
64
+ };
@@ -1,75 +1,87 @@
1
+ import { shorthands } from '@griffel/react';
2
+ import { tokens } from '@fluentui/react-theme';
1
3
  /**
2
4
  * Helper that creates a makeStyles rule for an arrow element.
3
5
  * For runtime arrow size toggling simply create extra classnames to apply to the arrow element
4
6
  *
5
7
  * ```ts
6
8
  * makeStyles({
7
- * arrowWithSize: createArrowStyles(5),
9
+ * arrowWithSize: createArrowStyles({ arrowHeight: 6 }),
8
10
  *
9
- * arrowWithoutSize: createArrowStyles(),
10
- * mediumArrow: { aspectRatio: 1, width: '4px' }
11
- * smallArrow: { aspectRatio: 1, width: '2px' }
11
+ * arrowWithoutSize: createArrowStyles({ arrowHeight: undefined }),
12
+ * mediumArrow: createArrowHeightStyles(4),
13
+ * smallArrow: createArrowHeightStyles(2),
12
14
  * })
13
15
  * ...
14
16
  *
15
- * state.arrowWithSize.clasName = styles.arrowWithSize
16
- * state.arrowWithoutSize.className = mergeClases(
17
+ * state.arrowWithSize.className = styles.arrowWithSize;
18
+ * state.arrowWithoutSize.className = mergeClasses(
17
19
  * styles.arrowWithoutSize,
18
20
  * state.smallArrow && styles.smallArrow,
19
21
  * state.mediumArrow && styles.mediumArrow,
20
22
  * )
21
23
  * ```
24
+ */
25
+
26
+ export function createArrowStyles(options) {
27
+ const {
28
+ arrowHeight,
29
+ borderWidth = '1px',
30
+ borderStyle = 'solid',
31
+ borderColor = tokens.colorTransparentStroke
32
+ } = options;
33
+ return {
34
+ position: 'absolute',
35
+ backgroundColor: 'inherit',
36
+ visibility: 'hidden',
37
+ zIndex: -1,
38
+ ...(arrowHeight && createArrowHeightStyles(arrowHeight)),
39
+ ':before': {
40
+ content: '""',
41
+ visibility: 'visible',
42
+ position: 'absolute',
43
+ boxSizing: 'border-box',
44
+ width: 'inherit',
45
+ height: 'inherit',
46
+ backgroundColor: 'inherit',
47
+ ...shorthands.borderRight(`${borderWidth} /* @noflip */`, `${borderStyle} /* @noflip */`, `${borderColor} /* @noflip */`),
48
+ ...shorthands.borderBottom(borderWidth, borderStyle, borderColor),
49
+ borderBottomRightRadius: tokens.borderRadiusSmall,
50
+ transform: 'rotate(var(--angle)) translate(0, 50%) rotate(45deg)'
51
+ },
52
+ // Popper sets data-popper-placement on the root element, which is used to align the arrow
53
+ ':global([data-popper-placement^="top"])': {
54
+ bottom: `-${borderWidth}`,
55
+ '--angle': '0'
56
+ },
57
+ ':global([data-popper-placement^="right"])': {
58
+ left: `-${borderWidth} /* @noflip */`,
59
+ '--angle': '90deg'
60
+ },
61
+ ':global([data-popper-placement^="bottom"])': {
62
+ top: `-${borderWidth}`,
63
+ '--angle': '180deg'
64
+ },
65
+ ':global([data-popper-placement^="left"])': {
66
+ right: `-${borderWidth} /* @noflip */`,
67
+ '--angle': '270deg'
68
+ }
69
+ };
70
+ }
71
+ /**
72
+ * Creates CSS styles to size the arrow created by createArrowStyles to the given height.
22
73
  *
23
- * @param size - dimensions of the square arrow element in pixels.
74
+ * Use this when you need to create classes for several different arrow sizes. If you only need a
75
+ * constant arrow size, you can pass the `arrowHeight` param to createArrowStyles instead.
24
76
  */
25
- export function createArrowStyles(size) {
26
- return theme => {
27
- const arrowHCBorderStyle = `1px solid transparent`;
28
- const arrowHCBorder = {
29
- borderRight: arrowHCBorderStyle,
30
- borderBottom: arrowHCBorderStyle,
31
- };
32
- return {
33
- position: 'absolute',
34
- background: 'inherit',
35
- visibility: 'hidden',
36
- zIndex: -1,
37
- ...(size && {
38
- aspectRatio: 1,
39
- width: `${size}px`,
40
- }),
41
- ':before': {
42
- content: '""',
43
- borderRadius: '4px',
44
- position: 'absolute',
45
- width: 'inherit',
46
- height: 'inherit',
47
- background: 'inherit',
48
- visibility: 'visible',
49
- borderBottomRightRadius: theme.borderRadiusSmall,
50
- transform: 'rotate(var(--angle)) translate(0, 50%) rotate(45deg)',
51
- },
52
- ':global([data-popper-placement])': {
53
- ':before': arrowHCBorder,
54
- },
55
- // Popper sets data-popper-placement on the root element, which is used to align the arrow
56
- ':global([data-popper-placement^="top"])': {
57
- bottom: 0,
58
- '--angle': '0',
59
- },
60
- ':global([data-popper-placement^="right"])': {
61
- left: 0,
62
- '--angle': '90deg',
63
- },
64
- ':global([data-popper-placement^="bottom"])': {
65
- top: 0,
66
- '--angle': '180deg',
67
- },
68
- ':global([data-popper-placement^="left"])': {
69
- right: 0,
70
- '--angle': '270deg',
71
- },
72
- };
73
- };
77
+
78
+ export function createArrowHeightStyles(arrowHeight) {
79
+ // The arrow is a square rotated 45 degrees to have its bottom and right edges form a right triangle.
80
+ // Multiply the triangle's height by sqrt(2) to get length of its edges.
81
+ const edgeLength = `${1.414 * arrowHeight}px`;
82
+ return {
83
+ width: edgeLength,
84
+ height: edgeLength
85
+ };
74
86
  }
75
87
  //# sourceMappingURL=createArrowStyles.js.map