@mui/utils 6.0.0-alpha.8 → 6.0.0-beta.0

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 (42) hide show
  1. package/CHANGELOG.md +407 -3
  2. package/deepmerge/deepmerge.js +2 -4
  3. package/getDisplayName/getDisplayName.d.ts +1 -1
  4. package/getDisplayName/getDisplayName.js +1 -1
  5. package/index.d.ts +1 -2
  6. package/index.js +2 -3
  7. package/isFocusVisible/index.d.ts +1 -0
  8. package/isFocusVisible/index.js +1 -0
  9. package/isFocusVisible/isFocusVisible.d.ts +4 -0
  10. package/isFocusVisible/isFocusVisible.js +15 -0
  11. package/{scrollLeft → isFocusVisible}/package.json +1 -1
  12. package/modern/deepmerge/deepmerge.js +2 -4
  13. package/modern/getDisplayName/getDisplayName.js +1 -1
  14. package/modern/index.js +2 -3
  15. package/modern/isFocusVisible/index.js +1 -0
  16. package/modern/isFocusVisible/isFocusVisible.js +15 -0
  17. package/modern/useControlled/useControlled.js +3 -1
  18. package/node/deepmerge/deepmerge.js +2 -4
  19. package/node/getDisplayName/getDisplayName.js +1 -1
  20. package/node/index.js +7 -22
  21. package/node/isFocusVisible/index.js +13 -0
  22. package/node/isFocusVisible/isFocusVisible.js +21 -0
  23. package/node/useControlled/useControlled.js +3 -1
  24. package/package.json +3 -3
  25. package/useControlled/useControlled.js +3 -1
  26. package/modern/scrollLeft/index.js +0 -1
  27. package/modern/scrollLeft/scrollLeft.js +0 -70
  28. package/modern/useIsFocusVisible/index.js +0 -2
  29. package/modern/useIsFocusVisible/useIsFocusVisible.js +0 -163
  30. package/node/scrollLeft/index.js +0 -16
  31. package/node/scrollLeft/scrollLeft.js +0 -77
  32. package/node/useIsFocusVisible/index.js +0 -26
  33. package/node/useIsFocusVisible/useIsFocusVisible.js +0 -171
  34. package/scrollLeft/index.d.ts +0 -1
  35. package/scrollLeft/index.js +0 -1
  36. package/scrollLeft/scrollLeft.d.ts +0 -2
  37. package/scrollLeft/scrollLeft.js +0 -70
  38. package/useIsFocusVisible/index.d.ts +0 -2
  39. package/useIsFocusVisible/index.js +0 -2
  40. package/useIsFocusVisible/package.json +0 -6
  41. package/useIsFocusVisible/useIsFocusVisible.d.ts +0 -9
  42. package/useIsFocusVisible/useIsFocusVisible.js +0 -163
package/node/index.js CHANGED
@@ -1,5 +1,5 @@
1
1
  /**
2
- * @mui/utils v6.0.0-alpha.8
2
+ * @mui/utils v6.0.0-beta.0
3
3
  *
4
4
  * @license MIT
5
5
  * This source code is licensed under the MIT license found in the
@@ -42,10 +42,8 @@ var _exportNames = {
42
42
  unstable_useTimeout: true,
43
43
  unstable_Timeout: true,
44
44
  unstable_useOnMount: true,
45
- unstable_useIsFocusVisible: true,
45
+ unstable_isFocusVisible: true,
46
46
  unstable_getScrollbarSize: true,
47
- unstable_detectScrollType: true,
48
- unstable_getNormalizedScrollLeft: true,
49
47
  usePreviousProps: true,
50
48
  getValidReactChildren: true,
51
49
  visuallyHidden: true,
@@ -190,12 +188,6 @@ Object.defineProperty(exports, "unstable_deprecatedPropType", {
190
188
  return _deprecatedPropType.default;
191
189
  }
192
190
  });
193
- Object.defineProperty(exports, "unstable_detectScrollType", {
194
- enumerable: true,
195
- get: function () {
196
- return _scrollLeft.detectScrollType;
197
- }
198
- });
199
191
  Object.defineProperty(exports, "unstable_generateUtilityClass", {
200
192
  enumerable: true,
201
193
  get: function () {
@@ -208,16 +200,16 @@ Object.defineProperty(exports, "unstable_generateUtilityClasses", {
208
200
  return _generateUtilityClasses.default;
209
201
  }
210
202
  });
211
- Object.defineProperty(exports, "unstable_getNormalizedScrollLeft", {
203
+ Object.defineProperty(exports, "unstable_getScrollbarSize", {
212
204
  enumerable: true,
213
205
  get: function () {
214
- return _scrollLeft.getNormalizedScrollLeft;
206
+ return _getScrollbarSize.default;
215
207
  }
216
208
  });
217
- Object.defineProperty(exports, "unstable_getScrollbarSize", {
209
+ Object.defineProperty(exports, "unstable_isFocusVisible", {
218
210
  enumerable: true,
219
211
  get: function () {
220
- return _getScrollbarSize.default;
212
+ return _isFocusVisible.default;
221
213
  }
222
214
  });
223
215
  Object.defineProperty(exports, "unstable_isGlobalState", {
@@ -292,12 +284,6 @@ Object.defineProperty(exports, "unstable_useId", {
292
284
  return _useId.default;
293
285
  }
294
286
  });
295
- Object.defineProperty(exports, "unstable_useIsFocusVisible", {
296
- enumerable: true,
297
- get: function () {
298
- return _useIsFocusVisible.default;
299
- }
300
- });
301
287
  Object.defineProperty(exports, "unstable_useLazyRef", {
302
288
  enumerable: true,
303
289
  get: function () {
@@ -356,9 +342,8 @@ var _useForkRef = _interopRequireDefault(require("./useForkRef"));
356
342
  var _useLazyRef = _interopRequireDefault(require("./useLazyRef"));
357
343
  var _useTimeout = _interopRequireWildcard(require("./useTimeout"));
358
344
  var _useOnMount = _interopRequireDefault(require("./useOnMount"));
359
- var _useIsFocusVisible = _interopRequireDefault(require("./useIsFocusVisible"));
345
+ var _isFocusVisible = _interopRequireDefault(require("./isFocusVisible"));
360
346
  var _getScrollbarSize = _interopRequireDefault(require("./getScrollbarSize"));
361
- var _scrollLeft = require("./scrollLeft");
362
347
  var _usePreviousProps = _interopRequireDefault(require("./usePreviousProps"));
363
348
  var _getValidReactChildren = _interopRequireDefault(require("./getValidReactChildren"));
364
349
  var _visuallyHidden = _interopRequireDefault(require("./visuallyHidden"));
@@ -0,0 +1,13 @@
1
+ "use strict";
2
+
3
+ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
4
+ Object.defineProperty(exports, "__esModule", {
5
+ value: true
6
+ });
7
+ Object.defineProperty(exports, "default", {
8
+ enumerable: true,
9
+ get: function () {
10
+ return _isFocusVisible.default;
11
+ }
12
+ });
13
+ var _isFocusVisible = _interopRequireDefault(require("./isFocusVisible"));
@@ -0,0 +1,21 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports.default = isFocusVisible;
7
+ /**
8
+ * Returns a boolean indicating if the event's target has :focus-visible
9
+ */
10
+ function isFocusVisible(element) {
11
+ try {
12
+ return element.matches(':focus-visible');
13
+ } catch (error) {
14
+ // Do not warn on jsdom tests, otherwise all tests that rely on focus have to be skipped
15
+ // Tests that rely on `:focus-visible` will still have to be skipped in jsdom
16
+ if (process.env.NODE_ENV !== 'production' && !/jsdom/.test(window.navigator.userAgent)) {
17
+ console.warn(['MUI: The `:focus-visible` pseudo class is not supported in this browser.', 'Some components rely on this feature to work properly.'].join('\n'));
18
+ }
19
+ }
20
+ return false;
21
+ }
@@ -31,7 +31,9 @@ function useControlled({
31
31
  current: defaultValue
32
32
  } = React.useRef(defaultProp);
33
33
  React.useEffect(() => {
34
- if (!isControlled && defaultValue !== defaultProp) {
34
+ // Object.is() is not equivalent to the === operator.
35
+ // See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/is for more details.
36
+ if (!isControlled && !Object.is(defaultValue, defaultProp)) {
35
37
  console.error([`MUI: A component is changing the default ${state} state of an uncontrolled ${name} after being initialized. ` + `To suppress this warning opt to use a controlled ${name}.`].join('\n'));
36
38
  }
37
39
  }, [JSON.stringify(defaultProp)]);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mui/utils",
3
- "version": "6.0.0-alpha.8",
3
+ "version": "6.0.0-beta.0",
4
4
  "private": false,
5
5
  "author": "MUI Team",
6
6
  "description": "Utility functions for React components.",
@@ -26,10 +26,10 @@
26
26
  "url": "https://opencollective.com/mui-org"
27
27
  },
28
28
  "dependencies": {
29
- "@babel/runtime": "^7.24.5",
29
+ "@babel/runtime": "^7.24.7",
30
30
  "@types/prop-types": "^15.7.12",
31
31
  "prop-types": "^15.8.1",
32
- "react-is": "^18.2.0"
32
+ "react-is": "^18.3.1"
33
33
  },
34
34
  "peerDependencies": {
35
35
  "@types/react": "^17.0.0 || ^18.0.0",
@@ -24,7 +24,9 @@ export default function useControlled({
24
24
  current: defaultValue
25
25
  } = React.useRef(defaultProp);
26
26
  React.useEffect(() => {
27
- if (!isControlled && defaultValue !== defaultProp) {
27
+ // Object.is() is not equivalent to the === operator.
28
+ // See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/is for more details.
29
+ if (!isControlled && !Object.is(defaultValue, defaultProp)) {
28
30
  console.error([`MUI: A component is changing the default ${state} state of an uncontrolled ${name} after being initialized. ` + `To suppress this warning opt to use a controlled ${name}.`].join('\n'));
29
31
  }
30
32
  }, [JSON.stringify(defaultProp)]);
@@ -1 +0,0 @@
1
- export * from './scrollLeft';
@@ -1,70 +0,0 @@
1
- // Source from https://github.com/alitaheri/normalize-scroll-left
2
- let cachedType;
3
-
4
- /**
5
- * Based on the jquery plugin https://github.com/othree/jquery.rtl-scroll-type
6
- *
7
- * Types of scrollLeft, assuming scrollWidth=100 and direction is rtl.
8
- *
9
- * Type | <- Most Left | Most Right -> | Initial
10
- * ---------------- | ------------ | ------------- | -------
11
- * default | 0 | 100 | 100
12
- * negative (spec*) | -100 | 0 | 0
13
- * reverse | 100 | 0 | 0
14
- *
15
- * Edge 85: default
16
- * Safari 14: negative
17
- * Chrome 85: negative
18
- * Firefox 81: negative
19
- * IE11: reverse
20
- *
21
- * spec* https://drafts.csswg.org/cssom-view/#dom-window-scroll
22
- */
23
- export function detectScrollType() {
24
- if (cachedType) {
25
- return cachedType;
26
- }
27
- const dummy = document.createElement('div');
28
- const container = document.createElement('div');
29
- container.style.width = '10px';
30
- container.style.height = '1px';
31
- dummy.appendChild(container);
32
- dummy.dir = 'rtl';
33
- dummy.style.fontSize = '14px';
34
- dummy.style.width = '4px';
35
- dummy.style.height = '1px';
36
- dummy.style.position = 'absolute';
37
- dummy.style.top = '-1000px';
38
- dummy.style.overflow = 'scroll';
39
- document.body.appendChild(dummy);
40
- cachedType = 'reverse';
41
- if (dummy.scrollLeft > 0) {
42
- cachedType = 'default';
43
- } else {
44
- dummy.scrollLeft = 1;
45
- if (dummy.scrollLeft === 0) {
46
- cachedType = 'negative';
47
- }
48
- }
49
- document.body.removeChild(dummy);
50
- return cachedType;
51
- }
52
-
53
- // Based on https://stackoverflow.com/a/24394376
54
- export function getNormalizedScrollLeft(element, direction) {
55
- const scrollLeft = element.scrollLeft;
56
-
57
- // Perform the calculations only when direction is rtl to avoid messing up the ltr behavior
58
- if (direction !== 'rtl') {
59
- return scrollLeft;
60
- }
61
- const type = detectScrollType();
62
- switch (type) {
63
- case 'negative':
64
- return element.scrollWidth - element.clientWidth + scrollLeft;
65
- case 'reverse':
66
- return element.scrollWidth - element.clientWidth - scrollLeft;
67
- default:
68
- return scrollLeft;
69
- }
70
- }
@@ -1,2 +0,0 @@
1
- export { default } from './useIsFocusVisible';
2
- export * from './useIsFocusVisible';
@@ -1,163 +0,0 @@
1
- 'use client';
2
-
3
- // based on https://github.com/WICG/focus-visible/blob/v4.1.5/src/focus-visible.js
4
- import * as React from 'react';
5
- import { Timeout } from '../useTimeout/useTimeout';
6
- let hadKeyboardEvent = true;
7
- let hadFocusVisibleRecently = false;
8
- const hadFocusVisibleRecentlyTimeout = new Timeout();
9
- const inputTypesWhitelist = {
10
- text: true,
11
- search: true,
12
- url: true,
13
- tel: true,
14
- email: true,
15
- password: true,
16
- number: true,
17
- date: true,
18
- month: true,
19
- week: true,
20
- time: true,
21
- datetime: true,
22
- 'datetime-local': true
23
- };
24
-
25
- /**
26
- * Computes whether the given element should automatically trigger the
27
- * `focus-visible` class being added, i.e. whether it should always match
28
- * `:focus-visible` when focused.
29
- * @param {Element} node
30
- * @returns {boolean}
31
- */
32
- function focusTriggersKeyboardModality(node) {
33
- const {
34
- type,
35
- tagName
36
- } = node;
37
- if (tagName === 'INPUT' && inputTypesWhitelist[type] && !node.readOnly) {
38
- return true;
39
- }
40
- if (tagName === 'TEXTAREA' && !node.readOnly) {
41
- return true;
42
- }
43
- if (node.isContentEditable) {
44
- return true;
45
- }
46
- return false;
47
- }
48
-
49
- /**
50
- * Keep track of our keyboard modality state with `hadKeyboardEvent`.
51
- * If the most recent user interaction was via the keyboard;
52
- * and the key press did not include a meta, alt/option, or control key;
53
- * then the modality is keyboard. Otherwise, the modality is not keyboard.
54
- * @param {KeyboardEvent} event
55
- */
56
- function handleKeyDown(event) {
57
- if (event.metaKey || event.altKey || event.ctrlKey) {
58
- return;
59
- }
60
- hadKeyboardEvent = true;
61
- }
62
-
63
- /**
64
- * If at any point a user clicks with a pointing device, ensure that we change
65
- * the modality away from keyboard.
66
- * This avoids the situation where a user presses a key on an already focused
67
- * element, and then clicks on a different element, focusing it with a
68
- * pointing device, while we still think we're in keyboard modality.
69
- */
70
- function handlePointerDown() {
71
- hadKeyboardEvent = false;
72
- }
73
- function handleVisibilityChange() {
74
- if (this.visibilityState === 'hidden') {
75
- // If the tab becomes active again, the browser will handle calling focus
76
- // on the element (Safari actually calls it twice).
77
- // If this tab change caused a blur on an element with focus-visible,
78
- // re-apply the class when the user switches back to the tab.
79
- if (hadFocusVisibleRecently) {
80
- hadKeyboardEvent = true;
81
- }
82
- }
83
- }
84
- function prepare(doc) {
85
- doc.addEventListener('keydown', handleKeyDown, true);
86
- doc.addEventListener('mousedown', handlePointerDown, true);
87
- doc.addEventListener('pointerdown', handlePointerDown, true);
88
- doc.addEventListener('touchstart', handlePointerDown, true);
89
- doc.addEventListener('visibilitychange', handleVisibilityChange, true);
90
- }
91
- export function teardown(doc) {
92
- doc.removeEventListener('keydown', handleKeyDown, true);
93
- doc.removeEventListener('mousedown', handlePointerDown, true);
94
- doc.removeEventListener('pointerdown', handlePointerDown, true);
95
- doc.removeEventListener('touchstart', handlePointerDown, true);
96
- doc.removeEventListener('visibilitychange', handleVisibilityChange, true);
97
- }
98
- function isFocusVisible(event) {
99
- const {
100
- target
101
- } = event;
102
- try {
103
- return target.matches(':focus-visible');
104
- } catch (error) {
105
- // Browsers not implementing :focus-visible will throw a SyntaxError.
106
- // We use our own heuristic for those browsers.
107
- // Rethrow might be better if it's not the expected error but do we really
108
- // want to crash if focus-visible malfunctioned?
109
- }
110
-
111
- // No need for validFocusTarget check. The user does that by attaching it to
112
- // focusable events only.
113
- return hadKeyboardEvent || focusTriggersKeyboardModality(target);
114
- }
115
- export default function useIsFocusVisible() {
116
- const ref = React.useCallback(node => {
117
- if (node != null) {
118
- prepare(node.ownerDocument);
119
- }
120
- }, []);
121
- const isFocusVisibleRef = React.useRef(false);
122
-
123
- /**
124
- * Should be called if a blur event is fired
125
- */
126
- function handleBlurVisible() {
127
- // checking against potential state variable does not suffice if we focus and blur synchronously.
128
- // React wouldn't have time to trigger a re-render so `focusVisible` would be stale.
129
- // Ideally we would adjust `isFocusVisible(event)` to look at `relatedTarget` for blur events.
130
- // This doesn't work in IE11 due to https://github.com/facebook/react/issues/3751
131
- // TODO: check again if React releases their internal changes to focus event handling (https://github.com/facebook/react/pull/19186).
132
- if (isFocusVisibleRef.current) {
133
- // To detect a tab/window switch, we look for a blur event followed
134
- // rapidly by a visibility change.
135
- // If we don't see a visibility change within 100ms, it's probably a
136
- // regular focus change.
137
- hadFocusVisibleRecently = true;
138
- hadFocusVisibleRecentlyTimeout.start(100, () => {
139
- hadFocusVisibleRecently = false;
140
- });
141
- isFocusVisibleRef.current = false;
142
- return true;
143
- }
144
- return false;
145
- }
146
-
147
- /**
148
- * Should be called if a blur event is fired
149
- */
150
- function handleFocusVisible(event) {
151
- if (isFocusVisible(event)) {
152
- isFocusVisibleRef.current = true;
153
- return true;
154
- }
155
- return false;
156
- }
157
- return {
158
- isFocusVisibleRef,
159
- onFocus: handleFocusVisible,
160
- onBlur: handleBlurVisible,
161
- ref
162
- };
163
- }
@@ -1,16 +0,0 @@
1
- "use strict";
2
-
3
- Object.defineProperty(exports, "__esModule", {
4
- value: true
5
- });
6
- var _scrollLeft = require("./scrollLeft");
7
- Object.keys(_scrollLeft).forEach(function (key) {
8
- if (key === "default" || key === "__esModule") return;
9
- if (key in exports && exports[key] === _scrollLeft[key]) return;
10
- Object.defineProperty(exports, key, {
11
- enumerable: true,
12
- get: function () {
13
- return _scrollLeft[key];
14
- }
15
- });
16
- });
@@ -1,77 +0,0 @@
1
- "use strict";
2
-
3
- Object.defineProperty(exports, "__esModule", {
4
- value: true
5
- });
6
- exports.detectScrollType = detectScrollType;
7
- exports.getNormalizedScrollLeft = getNormalizedScrollLeft;
8
- // Source from https://github.com/alitaheri/normalize-scroll-left
9
- let cachedType;
10
-
11
- /**
12
- * Based on the jquery plugin https://github.com/othree/jquery.rtl-scroll-type
13
- *
14
- * Types of scrollLeft, assuming scrollWidth=100 and direction is rtl.
15
- *
16
- * Type | <- Most Left | Most Right -> | Initial
17
- * ---------------- | ------------ | ------------- | -------
18
- * default | 0 | 100 | 100
19
- * negative (spec*) | -100 | 0 | 0
20
- * reverse | 100 | 0 | 0
21
- *
22
- * Edge 85: default
23
- * Safari 14: negative
24
- * Chrome 85: negative
25
- * Firefox 81: negative
26
- * IE11: reverse
27
- *
28
- * spec* https://drafts.csswg.org/cssom-view/#dom-window-scroll
29
- */
30
- function detectScrollType() {
31
- if (cachedType) {
32
- return cachedType;
33
- }
34
- const dummy = document.createElement('div');
35
- const container = document.createElement('div');
36
- container.style.width = '10px';
37
- container.style.height = '1px';
38
- dummy.appendChild(container);
39
- dummy.dir = 'rtl';
40
- dummy.style.fontSize = '14px';
41
- dummy.style.width = '4px';
42
- dummy.style.height = '1px';
43
- dummy.style.position = 'absolute';
44
- dummy.style.top = '-1000px';
45
- dummy.style.overflow = 'scroll';
46
- document.body.appendChild(dummy);
47
- cachedType = 'reverse';
48
- if (dummy.scrollLeft > 0) {
49
- cachedType = 'default';
50
- } else {
51
- dummy.scrollLeft = 1;
52
- if (dummy.scrollLeft === 0) {
53
- cachedType = 'negative';
54
- }
55
- }
56
- document.body.removeChild(dummy);
57
- return cachedType;
58
- }
59
-
60
- // Based on https://stackoverflow.com/a/24394376
61
- function getNormalizedScrollLeft(element, direction) {
62
- const scrollLeft = element.scrollLeft;
63
-
64
- // Perform the calculations only when direction is rtl to avoid messing up the ltr behavior
65
- if (direction !== 'rtl') {
66
- return scrollLeft;
67
- }
68
- const type = detectScrollType();
69
- switch (type) {
70
- case 'negative':
71
- return element.scrollWidth - element.clientWidth + scrollLeft;
72
- case 'reverse':
73
- return element.scrollWidth - element.clientWidth - scrollLeft;
74
- default:
75
- return scrollLeft;
76
- }
77
- }
@@ -1,26 +0,0 @@
1
- "use strict";
2
-
3
- Object.defineProperty(exports, "__esModule", {
4
- value: true
5
- });
6
- var _exportNames = {};
7
- Object.defineProperty(exports, "default", {
8
- enumerable: true,
9
- get: function () {
10
- return _useIsFocusVisible.default;
11
- }
12
- });
13
- var _useIsFocusVisible = _interopRequireWildcard(require("./useIsFocusVisible"));
14
- Object.keys(_useIsFocusVisible).forEach(function (key) {
15
- if (key === "default" || key === "__esModule") return;
16
- if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
17
- if (key in exports && exports[key] === _useIsFocusVisible[key]) return;
18
- Object.defineProperty(exports, key, {
19
- enumerable: true,
20
- get: function () {
21
- return _useIsFocusVisible[key];
22
- }
23
- });
24
- });
25
- function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
26
- function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }