@instructure/ui-dom-utils 8.56.0 → 9.0.1-snapshot-0

package/types/index.d.ts

@@ -2,11 +2,9 @@ export { addEventListener } from './addEventListener';
 export { addInputModeListener } from './addInputModeListener';
 export { addPositionChangeListener } from './addPositionChangeListener';
 export type { PositionChangeListenerType } from './addPositionChangeListener';
-export { addResizeListener } from './addResizeListener';
 export { canUseDOM } from './canUseDOM';
 export { contains } from './contains';
 export { containsActiveElement } from './containsActiveElement';
-export { elementMatches } from './elementMatches';
 export { findDOMNode } from './findDOMNode';
 export { findFocusable } from './findFocusable';
 export { findTabbable } from './findTabbable';

package/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAyBA,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AACrD,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AAC7D,OAAO,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAA;AACvE,YAAY,EAAE,0BAA0B,EAAE,MAAM,6BAA6B,CAAA;AAC7E,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAA;AACvD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AACrC,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAA;AAC/D,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAC7C,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AACrD,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAA;AAC/D,YAAY,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAA;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAC7C,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AACrD,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AACrD,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAA;AACzD,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAA;AAC/D,YAAY,EAAE,yBAAyB,EAAE,MAAM,yBAAyB,CAAA;AACxE,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAA;AACzD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAyBA,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AACrD,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AAC7D,OAAO,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAA;AACvE,YAAY,EAAE,0BAA0B,EAAE,MAAM,6BAA6B,CAAA;AAC7E,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AACrC,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAA;AAC/D,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAC7C,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AACrD,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAA;AAC/D,YAAY,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAA;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAC7C,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AACrD,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AACrD,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAA;AACzD,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAA;AAC/D,YAAY,EAAE,yBAAyB,EAAE,MAAM,yBAAyB,CAAA;AACxE,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAA;AACzD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA"}

package/es/__new-tests__/addResizeListener.test.js

@@ -1,64 +0,0 @@
-var _div;
-/*
- * The MIT License (MIT)
- *
- * Copyright (c) 2015 - present Instructure, Inc.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-import React from 'react';
-import { render, waitFor } from '@testing-library/react';
-import '@testing-library/jest-dom';
-import { addResizeListener } from '../addResizeListener';
-const mockRect = {
-  top: 0,
-  left: 0,
-  right: 0,
-  bottom: 0,
-  width: 0,
-  height: 0,
-  x: 0,
-  y: 0,
-  toJSON: jest.fn()
-};
-describe('addResizeListener', () => {
-  it('should provide a remove method', async () => {
-    const callback = jest.fn();
-    Element.prototype.getBoundingClientRect = jest.fn(() => mockRect);
-    const _render = render(_div || (_div = /*#__PURE__*/React.createElement("div", null))),
-      container = _render.container;
-    const node = container.firstChild;
-    const listener = addResizeListener(node, callback);
-
-    // Manually trigger a size change (since JSDOM won't)
-    Element.prototype.getBoundingClientRect = jest.fn(() => {
-      return {
-        ...mockRect,
-        width: 200
-      };
-    });
-    await waitFor(() => {
-      expect(callback).toHaveBeenCalledTimes(1);
-      expect(typeof listener.remove).toBe('function');
-    });
-    listener.remove();
-    jest.restoreAllMocks();
-  });
-});

package/es/addResizeListener.js

@@ -1,93 +0,0 @@
-/*
- * The MIT License (MIT)
- *
- * Copyright (c) 2015 - present Instructure, Inc.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-import { findDOMNode } from './findDOMNode';
-import { getBoundingClientRect } from './getBoundingClientRect';
-import { requestAnimationFrame } from './requestAnimationFrame';
-/**
- * ---
- * category: utilities/DOM
- * ---
- * ### This utility is deprecated since version __8.0__ and will be permanently deleted in version 9.0.
- * *Please use the native [DOM ResizeObserver API](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver) instead of this.*
- *
- *
- * Example usage of the `ResizeObserver`:
- * ```js-code
- *  const observer = new ResizeObserver((entries) => {
- *   for (let entry of entries) {
- *     const size = {
- *       width: entry.contentRect.width
- *     }
- *
- *     if (size.width !== origSize.width) {
- *       // call your handler function here
- *        this._debounced(size)
- *     }
- *    }
- *  })
- *
- *   observer.observe(content)
- * ```
- *
- * Adds a listener to an element and calls a specified handler function whenever the size changes.
- * @deprecated since version 8.0
- * @module
- *
- *
- * @param { Node | Window | React.ReactElement | React.Component | function } el - component or DOM node
- * @param {function} handler - function to run when resize occurs
- * @param dimensions
- * @returns {function} remove - cancel the listener and no longer execute the handler function
- */
-function addResizeListener(el, handler, dimensions = ['width']) {
-  const node = findDOMNode(el);
-  let origSize = getBoundingClientRect(node);
-  let cancelled = false;
-  let raf;
-  const checkDimensions = () => {
-    if (cancelled) {
-      return;
-    }
-    const boundingRect = getBoundingClientRect(node);
-    const size = {
-      width: boundingRect.width,
-      height: boundingRect.height
-    };
-    if (dimensions.some(dim => size[dim] != origSize[dim]) && typeof handler === 'function') {
-      handler(size);
-    }
-    origSize = size;
-    raf = requestAnimationFrame(checkDimensions);
-  };
-  checkDimensions();
-  return {
-    remove() {
-      cancelled = true;
-      raf.cancel();
-    }
-  };
-}
-export default addResizeListener;
-export { addResizeListener };

package/es/elementMatches.js

@@ -1,46 +0,0 @@
-/*
- * The MIT License (MIT)
- *
- * Copyright (c) 2015 - present Instructure, Inc.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-import { findDOMNode } from './findDOMNode';
-/**
- * ---
- * category: utilities/DOM
- * ---
- *
- * Polyfill for Element.matches (https://developer.mozilla.org/en-US/docs/Web/API/Element/matches)
- * DEPRECATED This polyfill is only needed for old browsers and will be removed in InstUI v9
- * @module elementMatches
- * @param el - component or DOM node
- * @param selectorString - a string representing the selector to test
- * @returns if the element would be selected by the specified selector string
- */
-function elementMatches(el, selectorString) {
-  const node = el && findDOMNode(el);
-  if (!node) return false;
-  // this cast is in a separate line to circumvent a react-docgen bug
-  const elem = node;
-  return elem.matches(selectorString);
-}
-export default elementMatches;
-export { elementMatches };

package/lib/__new-tests__/addResizeListener.test.js

@@ -1,66 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
-var _react = _interopRequireDefault(require("react"));
-var _react2 = require("@testing-library/react");
-require("@testing-library/jest-dom");
-var _addResizeListener = require("../addResizeListener");
-var _div;
-/*
- * The MIT License (MIT)
- *
- * Copyright (c) 2015 - present Instructure, Inc.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-const mockRect = {
-  top: 0,
-  left: 0,
-  right: 0,
-  bottom: 0,
-  width: 0,
-  height: 0,
-  x: 0,
-  y: 0,
-  toJSON: jest.fn()
-};
-describe('addResizeListener', () => {
-  it('should provide a remove method', async () => {
-    const callback = jest.fn();
-    Element.prototype.getBoundingClientRect = jest.fn(() => mockRect);
-    const _render = (0, _react2.render)(_div || (_div = /*#__PURE__*/_react.default.createElement("div", null))),
-      container = _render.container;
-    const node = container.firstChild;
-    const listener = (0, _addResizeListener.addResizeListener)(node, callback);
-
-    // Manually trigger a size change (since JSDOM won't)
-    Element.prototype.getBoundingClientRect = jest.fn(() => {
-      return {
-        ...mockRect,
-        width: 200
-      };
-    });
-    await (0, _react2.waitFor)(() => {
-      expect(callback).toHaveBeenCalledTimes(1);
-      expect(typeof listener.remove).toBe('function');
-    });
-    listener.remove();
-    jest.restoreAllMocks();
-  });
-});

package/lib/addResizeListener.js

@@ -1,99 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.addResizeListener = addResizeListener;
-exports.default = void 0;
-var _findDOMNode = require("./findDOMNode");
-var _getBoundingClientRect = require("./getBoundingClientRect");
-var _requestAnimationFrame = require("./requestAnimationFrame");
-/*
- * The MIT License (MIT)
- *
- * Copyright (c) 2015 - present Instructure, Inc.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-/**
- * ---
- * category: utilities/DOM
- * ---
- * ### This utility is deprecated since version __8.0__ and will be permanently deleted in version 9.0.
- * *Please use the native [DOM ResizeObserver API](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver) instead of this.*
- *
- *
- * Example usage of the `ResizeObserver`:
- * ```js-code
- *  const observer = new ResizeObserver((entries) => {
- *   for (let entry of entries) {
- *     const size = {
- *       width: entry.contentRect.width
- *     }
- *
- *     if (size.width !== origSize.width) {
- *       // call your handler function here
- *        this._debounced(size)
- *     }
- *    }
- *  })
- *
- *   observer.observe(content)
- * ```
- *
- * Adds a listener to an element and calls a specified handler function whenever the size changes.
- * @deprecated since version 8.0
- * @module
- *
- *
- * @param { Node | Window | React.ReactElement | React.Component | function } el - component or DOM node
- * @param {function} handler - function to run when resize occurs
- * @param dimensions
- * @returns {function} remove - cancel the listener and no longer execute the handler function
- */
-function addResizeListener(el, handler, dimensions = ['width']) {
-  const node = (0, _findDOMNode.findDOMNode)(el);
-  let origSize = (0, _getBoundingClientRect.getBoundingClientRect)(node);
-  let cancelled = false;
-  let raf;
-  const checkDimensions = () => {
-    if (cancelled) {
-      return;
-    }
-    const boundingRect = (0, _getBoundingClientRect.getBoundingClientRect)(node);
-    const size = {
-      width: boundingRect.width,
-      height: boundingRect.height
-    };
-    if (dimensions.some(dim => size[dim] != origSize[dim]) && typeof handler === 'function') {
-      handler(size);
-    }
-    origSize = size;
-    raf = (0, _requestAnimationFrame.requestAnimationFrame)(checkDimensions);
-  };
-  checkDimensions();
-  return {
-    remove() {
-      cancelled = true;
-      raf.cancel();
-    }
-  };
-}
-var _default = exports.default = addResizeListener;

package/lib/elementMatches.js

@@ -1,52 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-exports.elementMatches = elementMatches;
-var _findDOMNode = require("./findDOMNode");
-/*
- * The MIT License (MIT)
- *
- * Copyright (c) 2015 - present Instructure, Inc.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-/**
- * ---
- * category: utilities/DOM
- * ---
- *
- * Polyfill for Element.matches (https://developer.mozilla.org/en-US/docs/Web/API/Element/matches)
- * DEPRECATED This polyfill is only needed for old browsers and will be removed in InstUI v9
- * @module elementMatches
- * @param el - component or DOM node
- * @param selectorString - a string representing the selector to test
- * @returns if the element would be selected by the specified selector string
- */
-function elementMatches(el, selectorString) {
-  const node = el && (0, _findDOMNode.findDOMNode)(el);
-  if (!node) return false;
-  // this cast is in a separate line to circumvent a react-docgen bug
-  const elem = node;
-  return elem.matches(selectorString);
-}
-var _default = exports.default = elementMatches;

package/src/__new-tests__/addResizeListener.test.tsx

@@ -1,65 +0,0 @@
-/*
- * The MIT License (MIT)
- *
- * Copyright (c) 2015 - present Instructure, Inc.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-import React from 'react'
-import { render, waitFor } from '@testing-library/react'
-import '@testing-library/jest-dom'
-import { addResizeListener } from '../addResizeListener'
-
-const mockRect = {
-  top: 0,
-  left: 0,
-  right: 0,
-  bottom: 0,
-  width: 0,
-  height: 0,
-  x: 0,
-  y: 0,
-  toJSON: jest.fn()
-}
-
-describe('addResizeListener', () => {
-  it('should provide a remove method', async () => {
-    const callback = jest.fn()
-    Element.prototype.getBoundingClientRect = jest.fn(() => mockRect as DOMRect)
-
-    const { container } = render(<div />)
-    const node = container.firstChild as HTMLDivElement
-
-    const listener = addResizeListener(node, callback)
-
-    // Manually trigger a size change (since JSDOM won't)
-    Element.prototype.getBoundingClientRect = jest.fn(() => {
-      return { ...mockRect, width: 200 } as DOMRect
-    })
-
-    await waitFor(() => {
-      expect(callback).toHaveBeenCalledTimes(1)
-      expect(typeof listener.remove).toBe('function')
-    })
-
-    listener.remove()
-    jest.restoreAllMocks()
-  })
-})

package/src/addResizeListener.ts

@@ -1,116 +0,0 @@
-/*
- * The MIT License (MIT)
- *
- * Copyright (c) 2015 - present Instructure, Inc.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-import { findDOMNode } from './findDOMNode'
-import { getBoundingClientRect, RectType } from './getBoundingClientRect'
-import {
-  requestAnimationFrame,
-  RequestAnimationFrameType
-} from './requestAnimationFrame'
-import { UIElement } from '@instructure/shared-types'
-
-type ResizeListenerType = { remove: () => void }
-type DimensionTypes = 'width' | 'height'
-
-/**
- * ---
- * category: utilities/DOM
- * ---
- * ### This utility is deprecated since version __8.0__ and will be permanently deleted in version 9.0.
- * *Please use the native [DOM ResizeObserver API](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver) instead of this.*
- *
- *
- * Example usage of the `ResizeObserver`:
- * ```js-code
- *  const observer = new ResizeObserver((entries) => {
- *   for (let entry of entries) {
- *     const size = {
- *       width: entry.contentRect.width
- *     }
- *
- *     if (size.width !== origSize.width) {
- *       // call your handler function here
- *        this._debounced(size)
- *     }
- *    }
- *  })
- *
- *   observer.observe(content)
- * ```
- *
- * Adds a listener to an element and calls a specified handler function whenever the size changes.
- * @deprecated since version 8.0
- * @module
- *
- *
- * @param { Node | Window | React.ReactElement | React.Component | function } el - component or DOM node
- * @param {function} handler - function to run when resize occurs
- * @param dimensions
- * @returns {function} remove - cancel the listener and no longer execute the handler function
- */
-function addResizeListener(
-  el: UIElement,
-  handler: (dimensions: Record<DimensionTypes, number>) => any,
-  dimensions: DimensionTypes[] = ['width']
-): ResizeListenerType {
-  const node = findDOMNode(el)
-  let origSize: Partial<RectType> = getBoundingClientRect(node)
-  let cancelled = false
-  let raf: RequestAnimationFrameType
-
-  const checkDimensions = () => {
-    if (cancelled) {
-      return
-    }
-
-    const boundingRect = getBoundingClientRect(node)
-    const size: Record<DimensionTypes, number> = {
-      width: boundingRect.width,
-      height: boundingRect.height
-    }
-
-    if (
-      dimensions.some((dim) => size[dim] != origSize[dim]) &&
-      typeof handler === 'function'
-    ) {
-      handler(size)
-    }
-
-    origSize = size
-
-    raf = requestAnimationFrame(checkDimensions)
-  }
-
-  checkDimensions()
-
-  return {
-    remove() {
-      cancelled = true
-      raf.cancel()
-    }
-  }
-}
-
-export default addResizeListener
-export { addResizeListener }

package/src/elementMatches.ts

@@ -1,49 +0,0 @@
-/*
- * The MIT License (MIT)
- *
- * Copyright (c) 2015 - present Instructure, Inc.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-import { findDOMNode } from './findDOMNode'
-import type { UIElement } from '@instructure/shared-types'
-
-/**
- * ---
- * category: utilities/DOM
- * ---
- *
- * Polyfill for Element.matches (https://developer.mozilla.org/en-US/docs/Web/API/Element/matches)
- * DEPRECATED This polyfill is only needed for old browsers and will be removed in InstUI v9
- * @module elementMatches
- * @param el - component or DOM node
- * @param selectorString - a string representing the selector to test
- * @returns if the element would be selected by the specified selector string
- */
-function elementMatches(el: UIElement, selectorString: string) {
-  const node = el && findDOMNode(el)
-  if (!node) return false
-  // this cast is in a separate line to circumvent a react-docgen bug
-  const elem: Element = node as Element
-  return elem.matches(selectorString)
-}
-
-export default elementMatches
-export { elementMatches }

package/types/__new-tests__/addResizeListener.test.d.ts

@@ -1,2 +0,0 @@
-import '@testing-library/jest-dom';
-//# sourceMappingURL=addResizeListener.test.d.ts.map

package/types/__new-tests__/addResizeListener.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"addResizeListener.test.d.ts","sourceRoot":"","sources":["../../src/__new-tests__/addResizeListener.test.tsx"],"names":[],"mappings":"AA0BA,OAAO,2BAA2B,CAAA"}