@zag-js/popper 0.1.8 → 0.1.9

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.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2021 Chakra UI
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/dist/index.d.ts CHANGED
@@ -1,3 +1,109 @@
1
- export { getPlacement, getBasePlacement } from "./get-placement";
2
- export { getPlacementStyles } from "./get-styles";
3
- export type { Placement, PositioningOptions } from "./types";
1
+ import { Placement, Boundary, ComputePositionReturn, ComputePositionConfig, VirtualElement } from '@floating-ui/dom';
2
+ export { Placement } from '@floating-ui/dom';
3
+
4
+ declare type AutoUpdateOptions = {
5
+ ancestorScroll?: boolean;
6
+ ancestorResize?: boolean;
7
+ referenceResize?: boolean;
8
+ };
9
+
10
+ declare type PositioningOptions = {
11
+ /**
12
+ * The strategy to use for positioning
13
+ */
14
+ strategy?: "absolute" | "fixed";
15
+ /**
16
+ * The initial placement of the floating element
17
+ */
18
+ placement?: Placement;
19
+ /**
20
+ * The offset of the floating element
21
+ */
22
+ offset?: {
23
+ mainAxis?: number;
24
+ crossAxis?: number;
25
+ };
26
+ /**
27
+ * The main axis offset or gap between the reference and floating elements
28
+ */
29
+ gutter?: number;
30
+ /**
31
+ * The virtual padding around the viewport edges to check for overflow
32
+ */
33
+ overflowPadding?: number;
34
+ /**
35
+ * Whether to flip the placement
36
+ */
37
+ flip?: boolean;
38
+ /**
39
+ * Whether the floating element can overlap the reference element
40
+ * @default false
41
+ */
42
+ overlap?: boolean;
43
+ /**
44
+ * Whether to make the floating element same width as the reference element
45
+ */
46
+ sameWidth?: boolean;
47
+ /**
48
+ * Whether the popover should fit the viewport.
49
+ */
50
+ fitViewport?: boolean;
51
+ /**
52
+ * The overflow boundary of the reference element
53
+ */
54
+ boundary?: Boundary;
55
+ /**
56
+ * Options to activate auto-update listeners
57
+ */
58
+ listeners?: boolean | AutoUpdateOptions;
59
+ /**
60
+ * Function called when the placement is computed
61
+ */
62
+ onComplete?(data: ComputePositionReturn & {
63
+ compute: (config?: Omit<ComputePositionConfig, "platform">) => void;
64
+ }): void;
65
+ /**
66
+ * Function called on cleanup of all listeners
67
+ */
68
+ onCleanup?: VoidFunction;
69
+ };
70
+ declare type BasePlacement = "top" | "right" | "bottom" | "left";
71
+
72
+ declare function getPlacement(reference: HTMLElement | VirtualElement | null, floating: HTMLElement | null, opts?: PositioningOptions): (() => void) | undefined;
73
+ declare function getBasePlacement(placement: Placement): BasePlacement;
74
+
75
+ declare type Options = {
76
+ measured: boolean;
77
+ strategy?: "absolute" | "fixed";
78
+ placement?: Placement;
79
+ };
80
+ declare function getPlacementStyles(options: Options): {
81
+ arrow: {
82
+ readonly [x: string]: string | 0 | undefined;
83
+ readonly position: "absolute";
84
+ readonly width: string;
85
+ readonly height: string;
86
+ readonly opacity: 0 | undefined;
87
+ };
88
+ innerArrow: {
89
+ readonly transform: any;
90
+ readonly background: string;
91
+ readonly top: "0";
92
+ readonly left: "0";
93
+ readonly width: "100%";
94
+ readonly height: "100%";
95
+ readonly position: "absolute";
96
+ readonly zIndex: "inherit";
97
+ };
98
+ floating: {
99
+ position: "absolute" | "fixed";
100
+ readonly top?: 0 | undefined;
101
+ readonly left?: 0 | undefined;
102
+ readonly opacity?: 0 | undefined;
103
+ readonly transform?: "translate3d(0, -200%, 0)" | undefined;
104
+ readonly pointerEvents?: "none" | undefined;
105
+ readonly minWidth: "max-content";
106
+ };
107
+ };
108
+
109
+ export { PositioningOptions, getBasePlacement, getPlacement, getPlacementStyles };
package/dist/index.js CHANGED
@@ -1,25 +1,8 @@
1
1
  "use strict";
2
2
  var __defProp = Object.defineProperty;
3
- var __defProps = Object.defineProperties;
4
3
  var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
5
- var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
6
4
  var __getOwnPropNames = Object.getOwnPropertyNames;
7
- var __getOwnPropSymbols = Object.getOwnPropertySymbols;
8
5
  var __hasOwnProp = Object.prototype.hasOwnProperty;
9
- var __propIsEnum = Object.prototype.propertyIsEnumerable;
10
- var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
11
- var __spreadValues = (a, b) => {
12
- for (var prop in b || (b = {}))
13
- if (__hasOwnProp.call(b, prop))
14
- __defNormalProp(a, prop, b[prop]);
15
- if (__getOwnPropSymbols)
16
- for (var prop of __getOwnPropSymbols(b)) {
17
- if (__propIsEnum.call(b, prop))
18
- __defNormalProp(a, prop, b[prop]);
19
- }
20
- return a;
21
- };
22
- var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
23
6
  var __export = (target, all) => {
24
7
  for (var name in all)
25
8
  __defProp(target, name, { get: all[name], enumerable: true });
@@ -60,7 +43,7 @@ var import_dom = require("@floating-ui/dom");
60
43
  // ../dom/dist/index.mjs
61
44
  var runIfFn = (v, ...a) => {
62
45
  const res = typeof v === "function" ? v(...a) : v;
63
- return res != null ? res : void 0;
46
+ return res ?? void 0;
64
47
  };
65
48
  var hasProp = (obj, prop) => Object.prototype.hasOwnProperty.call(obj, prop);
66
49
  function isHTMLElement(v) {
@@ -129,12 +112,11 @@ function isEqual(rect1, rect2) {
129
112
 
130
113
  // src/auto-update.ts
131
114
  function resolveOptions(option) {
132
- var _a, _b, _c;
133
115
  const bool = isBoolean(option);
134
116
  return {
135
- ancestorResize: bool ? option : (_a = option.ancestorResize) != null ? _a : true,
136
- ancestorScroll: bool ? option : (_b = option.ancestorScroll) != null ? _b : true,
137
- referenceResize: bool ? option : (_c = option.referenceResize) != null ? _c : true
117
+ ancestorResize: bool ? option : option.ancestorResize ?? true,
118
+ ancestorScroll: bool ? option : option.ancestorScroll ?? true,
119
+ referenceResize: bool ? option : option.referenceResize ?? true
138
120
  };
139
121
  }
140
122
  function autoUpdate(reference, floating, update, options = false) {
@@ -273,11 +255,12 @@ function getPlacement(reference, floating, opts = {}) {
273
255
  if (!reference || !floating)
274
256
  return;
275
257
  const { placement, strategy } = options;
276
- (0, import_dom2.computePosition)(reference, floating, __spreadValues({
258
+ (0, import_dom2.computePosition)(reference, floating, {
277
259
  placement,
278
260
  middleware,
279
- strategy
280
- }, config)).then((data) => {
261
+ strategy,
262
+ ...config
263
+ }).then((data) => {
281
264
  var _a;
282
265
  const x = Math.round(data.x);
283
266
  const y = Math.round(data.y);
@@ -287,7 +270,7 @@ function getPlacement(reference, floating, opts = {}) {
287
270
  left: "0",
288
271
  transform: `translate3d(${x}px, ${y}px, 0)`
289
272
  });
290
- (_a = options.onComplete) == null ? void 0 : _a.call(options, __spreadProps(__spreadValues({}, data), { compute }));
273
+ (_a = options.onComplete) == null ? void 0 : _a.call(options, { ...data, compute });
291
274
  });
292
275
  }
293
276
  compute();
@@ -333,9 +316,16 @@ function getPlacementStyles(options) {
333
316
  position: "absolute",
334
317
  zIndex: "inherit"
335
318
  },
336
- floating: __spreadValues({
319
+ floating: {
337
320
  position: strategy,
338
- minWidth: "max-content"
339
- }, !measured && UNMEASURED_FLOATING_STYLE)
321
+ minWidth: "max-content",
322
+ ...!measured && UNMEASURED_FLOATING_STYLE
323
+ }
340
324
  };
341
325
  }
326
+ // Annotate the CommonJS export names for ESM import in node:
327
+ 0 && (module.exports = {
328
+ getBasePlacement,
329
+ getPlacement,
330
+ getPlacementStyles
331
+ });
package/dist/index.mjs CHANGED
@@ -1,23 +1,3 @@
1
- var __defProp = Object.defineProperty;
2
- var __defProps = Object.defineProperties;
3
- var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
4
- var __getOwnPropSymbols = Object.getOwnPropertySymbols;
5
- var __hasOwnProp = Object.prototype.hasOwnProperty;
6
- var __propIsEnum = Object.prototype.propertyIsEnumerable;
7
- var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
8
- var __spreadValues = (a, b) => {
9
- for (var prop in b || (b = {}))
10
- if (__hasOwnProp.call(b, prop))
11
- __defNormalProp(a, prop, b[prop]);
12
- if (__getOwnPropSymbols)
13
- for (var prop of __getOwnPropSymbols(b)) {
14
- if (__propIsEnum.call(b, prop))
15
- __defNormalProp(a, prop, b[prop]);
16
- }
17
- return a;
18
- };
19
- var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
20
-
21
1
  // src/get-placement.ts
22
2
  import { arrow, computePosition, flip, offset, shift, size } from "@floating-ui/dom";
23
3
 
@@ -35,7 +15,7 @@ import { getOverflowAncestors } from "@floating-ui/dom";
35
15
  // ../dom/dist/index.mjs
36
16
  var runIfFn = (v, ...a) => {
37
17
  const res = typeof v === "function" ? v(...a) : v;
38
- return res != null ? res : void 0;
18
+ return res ?? void 0;
39
19
  };
40
20
  var hasProp = (obj, prop) => Object.prototype.hasOwnProperty.call(obj, prop);
41
21
  function isHTMLElement(v) {
@@ -104,12 +84,11 @@ function isEqual(rect1, rect2) {
104
84
 
105
85
  // src/auto-update.ts
106
86
  function resolveOptions(option) {
107
- var _a, _b, _c;
108
87
  const bool = isBoolean(option);
109
88
  return {
110
- ancestorResize: bool ? option : (_a = option.ancestorResize) != null ? _a : true,
111
- ancestorScroll: bool ? option : (_b = option.ancestorScroll) != null ? _b : true,
112
- referenceResize: bool ? option : (_c = option.referenceResize) != null ? _c : true
89
+ ancestorResize: bool ? option : option.ancestorResize ?? true,
90
+ ancestorScroll: bool ? option : option.ancestorScroll ?? true,
91
+ referenceResize: bool ? option : option.referenceResize ?? true
113
92
  };
114
93
  }
115
94
  function autoUpdate(reference, floating, update, options = false) {
@@ -248,11 +227,12 @@ function getPlacement(reference, floating, opts = {}) {
248
227
  if (!reference || !floating)
249
228
  return;
250
229
  const { placement, strategy } = options;
251
- computePosition(reference, floating, __spreadValues({
230
+ computePosition(reference, floating, {
252
231
  placement,
253
232
  middleware,
254
- strategy
255
- }, config)).then((data) => {
233
+ strategy,
234
+ ...config
235
+ }).then((data) => {
256
236
  var _a;
257
237
  const x = Math.round(data.x);
258
238
  const y = Math.round(data.y);
@@ -262,7 +242,7 @@ function getPlacement(reference, floating, opts = {}) {
262
242
  left: "0",
263
243
  transform: `translate3d(${x}px, ${y}px, 0)`
264
244
  });
265
- (_a = options.onComplete) == null ? void 0 : _a.call(options, __spreadProps(__spreadValues({}, data), { compute }));
245
+ (_a = options.onComplete) == null ? void 0 : _a.call(options, { ...data, compute });
266
246
  });
267
247
  }
268
248
  compute();
@@ -308,10 +288,11 @@ function getPlacementStyles(options) {
308
288
  position: "absolute",
309
289
  zIndex: "inherit"
310
290
  },
311
- floating: __spreadValues({
291
+ floating: {
312
292
  position: strategy,
313
- minWidth: "max-content"
314
- }, !measured && UNMEASURED_FLOATING_STYLE)
293
+ minWidth: "max-content",
294
+ ...!measured && UNMEASURED_FLOATING_STYLE
295
+ }
315
296
  };
316
297
  }
317
298
  export {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@zag-js/popper",
3
- "version": "0.1.8",
3
+ "version": "0.1.9",
4
4
  "description": "Dynamic positioning logic for ui machines",
5
5
  "keywords": [
6
6
  "js",
@@ -25,17 +25,20 @@
25
25
  "url": "https://github.com/chakra-ui/zag/issues"
26
26
  },
27
27
  "dependencies": {
28
- "@floating-ui/dom": "0.5.4",
29
- "@zag-js/dom-utils": "0.1.7",
30
- "@zag-js/utils": "0.1.2"
28
+ "@floating-ui/dom": "0.5.4"
29
+ },
30
+ "devDependencies": {
31
+ "@zag-js/dom-utils": "0.1.8",
32
+ "@zag-js/utils": "0.1.3"
31
33
  },
32
34
  "scripts": {
33
- "build:fast": "zag build",
34
- "start": "zag build --watch",
35
- "build": "zag build --prod",
35
+ "build-fast": "tsup src/index.ts --format=esm,cjs",
36
+ "start": "pnpm build --watch",
37
+ "build": "tsup src/index.ts --format=esm,cjs --dts",
36
38
  "test": "jest --config ../../../jest.config.js --rootDir . --passWithNoTests",
37
39
  "lint": "eslint src --ext .ts,.tsx",
38
- "test:ci": "yarn test --ci --runInBand",
39
- "test:watch": "yarn test --watch --updateSnapshot"
40
+ "test-ci": "pnpm test --ci --runInBand",
41
+ "test-watch": "pnpm test --watch -u",
42
+ "typecheck": "tsc --noEmit"
40
43
  }
41
- }
44
+ }
@@ -1,8 +0,0 @@
1
- import type { Placement, ReferenceElement } from "@floating-ui/dom";
2
- export type { Placement };
3
- export declare type AutoUpdateOptions = {
4
- ancestorScroll?: boolean;
5
- ancestorResize?: boolean;
6
- referenceResize?: boolean;
7
- };
8
- export declare function autoUpdate(reference: ReferenceElement, floating: HTMLElement, update: () => void, options?: boolean | AutoUpdateOptions): () => void;
@@ -1,4 +0,0 @@
1
- import type { Placement, VirtualElement } from "@floating-ui/dom";
2
- import type { BasePlacement, PositioningOptions } from "./types";
3
- export declare function getPlacement(reference: HTMLElement | VirtualElement | null, floating: HTMLElement | null, opts?: PositioningOptions): () => void;
4
- export declare function getBasePlacement(placement: Placement): BasePlacement;
@@ -1,35 +0,0 @@
1
- import type { Placement } from "@floating-ui/dom";
2
- declare type Options = {
3
- measured: boolean;
4
- strategy?: "absolute" | "fixed";
5
- placement?: Placement;
6
- };
7
- export declare function getPlacementStyles(options: Options): {
8
- arrow: {
9
- readonly [x: string]: string | 0;
10
- readonly position: "absolute";
11
- readonly width: string;
12
- readonly height: string;
13
- readonly opacity: 0;
14
- };
15
- innerArrow: {
16
- readonly transform: any;
17
- readonly background: string;
18
- readonly top: "0";
19
- readonly left: "0";
20
- readonly width: "100%";
21
- readonly height: "100%";
22
- readonly position: "absolute";
23
- readonly zIndex: "inherit";
24
- };
25
- floating: {
26
- readonly position: "fixed";
27
- readonly top: 0;
28
- readonly left: 0;
29
- readonly opacity: 0;
30
- readonly transform: "translate3d(0, -200%, 0)";
31
- readonly pointerEvents: "none";
32
- readonly minWidth: "max-content";
33
- };
34
- };
35
- export {};
@@ -1,29 +0,0 @@
1
- import type { Middleware } from "@floating-ui/dom";
2
- export declare const cssVars: {
3
- arrowSize: {
4
- variable: string;
5
- reference: string;
6
- };
7
- arrowSizeHalf: {
8
- variable: string;
9
- reference: string;
10
- };
11
- arrowBg: {
12
- variable: string;
13
- reference: string;
14
- };
15
- transformOrigin: {
16
- variable: string;
17
- reference: string;
18
- };
19
- arrowOffset: {
20
- variable: string;
21
- reference: string;
22
- };
23
- };
24
- export declare const transformOrigin: Middleware;
25
- declare type ArrowOptions = {
26
- element: HTMLElement;
27
- };
28
- export declare const shiftArrow: (opts: ArrowOptions) => Middleware;
29
- export {};
package/dist/types.d.ts DELETED
@@ -1,64 +0,0 @@
1
- import type { Boundary, Placement, ComputePositionReturn, ComputePositionConfig } from "@floating-ui/dom";
2
- import type { AutoUpdateOptions } from "./auto-update";
3
- export type { Placement };
4
- export declare type PositioningOptions = {
5
- /**
6
- * The strategy to use for positioning
7
- */
8
- strategy?: "absolute" | "fixed";
9
- /**
10
- * The initial placement of the floating element
11
- */
12
- placement?: Placement;
13
- /**
14
- * The offset of the floating element
15
- */
16
- offset?: {
17
- mainAxis?: number;
18
- crossAxis?: number;
19
- };
20
- /**
21
- * The main axis offset or gap between the reference and floating elements
22
- */
23
- gutter?: number;
24
- /**
25
- * The virtual padding around the viewport edges to check for overflow
26
- */
27
- overflowPadding?: number;
28
- /**
29
- * Whether to flip the placement
30
- */
31
- flip?: boolean;
32
- /**
33
- * Whether the floating element can overlap the reference element
34
- * @default false
35
- */
36
- overlap?: boolean;
37
- /**
38
- * Whether to make the floating element same width as the reference element
39
- */
40
- sameWidth?: boolean;
41
- /**
42
- * Whether the popover should fit the viewport.
43
- */
44
- fitViewport?: boolean;
45
- /**
46
- * The overflow boundary of the reference element
47
- */
48
- boundary?: Boundary;
49
- /**
50
- * Options to activate auto-update listeners
51
- */
52
- listeners?: boolean | AutoUpdateOptions;
53
- /**
54
- * Function called when the placement is computed
55
- */
56
- onComplete?(data: ComputePositionReturn & {
57
- compute: (config?: Omit<ComputePositionConfig, "platform">) => void;
58
- }): void;
59
- /**
60
- * Function called on cleanup of all listeners
61
- */
62
- onCleanup?: VoidFunction;
63
- };
64
- export declare type BasePlacement = "top" | "right" | "bottom" | "left";