@tylertech/forge-core 2.0.0 → 2.1.0

package/esm/index.js

@@ -8,6 +8,7 @@ export * from './constants';
 export * from './custom-elements';
 export * from './events';
 export * from './message-list';
+export * from './resize';
 export * from './scroll';
 export * from './services';
 export * from './utils';

package/esm/resize/index.js

@@ -0,0 +1,2 @@
+export * from './resize-observer';
+export * from './resize-types';

package/esm/resize/resize-observer.js

@@ -0,0 +1,63 @@
+/**
+ * Provides a set of methods for observing and responding to resizing of elements.
+ */
+export class ForgeResizeObserver {
+    /**
+     * Initiates the observing of a specified `Element`. Calling with an already observed `Element`
+     * overwrites the exisiting observation. It is expected that the consumer will eventually
+     * {@link unobserve} the `Element` to avoid memory leaks.
+     *
+     * @param target An `Element` reference.
+     * @param callback A function that accepts a `ResizeObserverEntry` for the `Element`.
+     * @param options An options object allowing you to set options for the observation.
+     */
+    static observe(target, callback, options) {
+        var _a, _b;
+        if (ForgeResizeObserver._targets.has(target)) {
+            (_a = ForgeResizeObserver._observer) === null || _a === void 0 ? void 0 : _a.unobserve(target);
+        }
+        ForgeResizeObserver._targets.set(target, callback);
+        ForgeResizeObserver._countTargets();
+        (_b = ForgeResizeObserver._observer) === null || _b === void 0 ? void 0 : _b.observe(target, options);
+    }
+    /**
+     * Ends the observing of a specified `Element`.
+     *
+     * @param target An `Element` reference.
+     */
+    static unobserve(target) {
+        var _a;
+        ForgeResizeObserver._targets.delete(target);
+        (_a = ForgeResizeObserver._observer) === null || _a === void 0 ? void 0 : _a.unobserve(target);
+        ForgeResizeObserver._countTargets();
+    }
+    /**
+     * Creates or destroys the `ResizeObserver` based on whether targets exist.
+     */
+    static _countTargets() {
+        if (ForgeResizeObserver._observer) {
+            // If there are no targets destroy the observer
+            if (ForgeResizeObserver._targets.size < 1) {
+                ForgeResizeObserver._observer = undefined;
+            }
+        }
+        else {
+            // If there are targets create the observer
+            if (ForgeResizeObserver._targets.size) {
+                ForgeResizeObserver._observer = new ResizeObserver(ForgeResizeObserver._handleResize);
+            }
+        }
+    }
+}
+ForgeResizeObserver._targets = new Map();
+/**
+ * Runs the callback function of targets when they are resized.
+ *
+ * @param entries An array of `ResizeObserverEntry`s.
+ */
+ForgeResizeObserver._handleResize = entries => {
+    entries.forEach(entry => {
+        var _a;
+        (_a = ForgeResizeObserver._targets.get(entry.target)) === null || _a === void 0 ? void 0 : _a(entry);
+    });
+};

package/esm/resize/resize-types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tylertech/forge-core",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "A library of core web utilities that support Forge Web Component libraries.",
   "author": "Tyler Technologies, Inc.",
   "license": "Apache-2.0",

package/typings/index.d.ts

@@ -8,6 +8,7 @@ export * from './constants';
 export * from './custom-elements';
 export * from './events';
 export * from './message-list';
+export * from './resize';
 export * from './scroll';
 export * from './services';
 export * from './utils';

package/typings/resize/index.d.ts

@@ -0,0 +1,2 @@
+export * from './resize-observer';
+export * from './resize-types';

package/typings/resize/resize-observer.d.ts

@@ -0,0 +1,34 @@
+import { ForgeResizeObserverCallback, IResizeObserverOptions } from './resize-types';
+/**
+ * Provides a set of methods for observing and responding to resizing of elements.
+ */
+export declare abstract class ForgeResizeObserver {
+    private static _observer?;
+    private static _targets;
+    /**
+     * Initiates the observing of a specified `Element`. Calling with an already observed `Element`
+     * overwrites the exisiting observation. It is expected that the consumer will eventually
+     * {@link unobserve} the `Element` to avoid memory leaks.
+     *
+     * @param target An `Element` reference.
+     * @param callback A function that accepts a `ResizeObserverEntry` for the `Element`.
+     * @param options An options object allowing you to set options for the observation.
+     */
+    static observe(target: Element, callback: ForgeResizeObserverCallback, options?: IResizeObserverOptions): void;
+    /**
+     * Ends the observing of a specified `Element`.
+     *
+     * @param target An `Element` reference.
+     */
+    static unobserve(target: Element): void;
+    /**
+     * Creates or destroys the `ResizeObserver` based on whether targets exist.
+     */
+    private static _countTargets;
+    /**
+     * Runs the callback function of targets when they are resized.
+     *
+     * @param entries An array of `ResizeObserverEntry`s.
+     */
+    private static _handleResize;
+}

package/typings/resize/resize-types.d.ts

@@ -0,0 +1,4 @@
+export declare type ForgeResizeObserverCallback = (entry: ResizeObserverEntry) => unknown;
+export interface IResizeObserverOptions {
+    box: 'content-box' | 'border-box' | 'device-pixel-content-box';
+}