@planningcenter/tapestry-react 4.14.0 → 4.14.1

package/dist/utils.d.ts

@@ -1,64 +1,173 @@
 import { JSXElementConstructor, ReactElement, ReactPortal } from 'react';
 import { FocusableElement } from 'tabbable';
+/**
+ * Returns true if user platform is an iOS device
+ * https://stackoverflow.com/a/9039885/1461204
+ * @return {Boolean}
+ */
 declare const isIOS: boolean;
 declare const isSafari: () => boolean;
+/**
+ * Enables Safari-specific wheel scroll propagation at boundaries
+ */
 declare function enableSafariScrollPropagation(node: HTMLElement): () => void;
+/**
+ * Returns true if user platform supports passive events
+ * https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener#Safely_detecting_option_support
+ * @return {Boolean}
+ */
 declare let supportsPassiveEvents: boolean;
+/**
+ * Used to clone and apply props to children
+ * @param {Function} children accepts valid React children
+ * @param {Function} callback return the props that should be applied to the cloned child
+ * @return {Function} the cloned set of children
+ */
 declare function cloneChildren(children: any, callback: any): (string | number | bigint | Iterable<import("react").ReactNode> | Promise<string | number | bigint | boolean | ReactPortal | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<import("react").ReactNode>> | ReactElement<unknown, string | JSXElementConstructor<any>>)[];
+/**
+ * This is intended to be used to compose event handlers
+ * @param {Function} internal the internal event handler
+ * @param {Function} external the external event handler
+ * @return {Function} the event handler to add to an element
+ */
 declare function composeEvents(internal: any, external: any): any;
+/**
+ * Similar to composeEvents, but allows an object of events to be composed together
+ * @param {Function} internalEvents the internal event handlers
+ * @param {Function} externalEvents the external event handlers
+ * @return {Function} the event handler to add to an element
+ */
 declare function composeMultipleEvents(internalEvents: any, externalEvents: any): {};
+/**
+ * Deselects any currently selected text
+ */
 declare function deselectCurrentTextRange(): void;
+/**
+ * Get the closest focusable element
+ * @param {HTMLElement} node - the element to start searching from
+ * @return {HTMLElement} the closest element that is focusable
+ */
 declare function getClosestFocusableElement(node: any): Element;
+/**
+ * Get the closest element that scrolls
+ * @param {HTMLElement} node - the element to start searching from
+ * @return {HTMLElement} the closest parentNode that scrolls
+ */
 declare function getClosestViewport(node: any, includeHidden?: boolean): any;
+/**
+ * Determines which child elements are interactive according to:
+ * https://html.spec.whatwg.org/dev/dom.html#interactive-content
+ * @param parent The parent element used to determine which children are interactive
+ */
 declare function getInteractiveChildElements(parent: any): any[];
 declare function getRect(node: any, { clone }?: {
     clone?: boolean;
 }): any;
 declare function getScrollbarWidth(): any;
+/**
+ * Returns { previous, next } tabbable siblings
+ */
 declare function getTabbableSiblings(node: FocusableElement, _startNode?: FocusableElement): {
     next: FocusableElement;
     previous: FocusableElement;
 };
 declare function generateId(prefix: any): string;
 declare function getTextWidth(text: any, font: any): number;
+/**
+ * Inserts an item in a list at a specific index returning a new array
+ */
 declare function insertAtIndex({ list, index, value }: {
     list: any;
     index: any;
     value: any;
 }): any[];
 declare function isElementInteractive(element: any): boolean;
+/**
+ * Determines if value is an array or not
+ */
 declare function isArray(value: any): boolean;
+/**
+ * Determines if value is a function or not
+ */
 declare function isFunction(value: any): boolean;
+/**
+ * Determines if a value is present in an array by
+ * performing a shallow equal check on each item.
+ */
 declare function isValueInArray(collection: any, value: any): number;
+/**
+ * Joins React children using a separator.
+ */
 declare function joinChildren(children: any, separator?: string): string | number | bigint | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<import("react").ReactNode> | ReactPortal | Promise<string | number | bigint | boolean | ReactPortal | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<import("react").ReactNode>>;
 declare function lockScroll(node: any): () => void;
+/**
+ * No op function used to stub function props
+ */
 declare function noop(): any;
+/**
+ * Pad a number with 0's
+ */
 declare function padNumber(number: number | string, size: number): string;
+/**
+ * Listen for window visibility and focus/blur changes
+ */
 declare function pageViewChange(callback: any): () => void;
+/**
+ * Create a range of numbers
+ */
 declare function range(start: any, stop: any): any[];
+/**
+ * Removes an item in a list at a specific index returning a new array
+ */
 declare function removeAtIndex({ list, index }: {
     list: any;
     index: any;
 }): any[];
+/**
+ * Helps with rendering a nested group of data that needs an ordered index.
+ */
 declare function renderIndexedGroup({ group, renderGroup, renderEmpty, }: {
     group: any;
     renderGroup: any;
     renderEmpty?: string;
 }): any;
+/**
+ * Reorder a result in an array by its index
+ */
 declare function reorderArray<L extends any[]>({ list, startIndex, endIndex, }: {
     endIndex: number;
     list: L;
     startIndex: number;
 }): any[];
+/**
+ * Shallow compare two items
+ */
 declare function shallowEqual(a: any, b: any): boolean;
+/**
+ * Selects the full text range including number inputs
+ */
 declare function selectFullTextRange(node: any): void;
+/**
+ * Stop an event from propagating
+ */
 declare function stopImmediatePropagation(e: any): void;
+/**
+ * Adds event.stopPropagation() to a component's onClick event.
+ * Used to prevent element's onClick from bubbling up the tree.
+ */
 declare function stopPropagationClick(onClick: any): (event: any) => void;
 declare function trapFocus(node: any): () => void;
 declare function createCSSProperty(key: any, value: any): string;
 declare function getCSSProperty(key: any, value: any): string;
 declare function objectToCSSProperties(themeKey: any, props: any): {};
 declare function callRef(ref: any, node: any): void;
+/**
+ * Merges sets of props together:
+ *  - duplicate `className` props get concatenated
+ *  - duplicate `style` props get shallow merged (later props have precedence for conflicting rules)
+ *  - duplicate refs or functions (to be used for event handlers) get called in order from left to right
+ * @param propGroup Sets of props to merge together. Later props have precedence.
+ */
 declare function mergeProps(...propGroup: any[]): any;
 export { callRef, cloneChildren, composeEvents, composeMultipleEvents, createCSSProperty, deselectCurrentTextRange, enableSafariScrollPropagation, generateId, getClosestFocusableElement, getClosestViewport, getCSSProperty, getInteractiveChildElements, getRect, getScrollbarWidth, getTabbableSiblings, getTextWidth, insertAtIndex, isArray, isElementInteractive, isFunction, isIOS, isSafari, isValueInArray, joinChildren, lockScroll, mergeProps, noop, objectToCSSProperties, padNumber, pageViewChange, range, removeAtIndex, renderIndexedGroup, reorderArray, selectFullTextRange, shallowEqual, stopImmediatePropagation, stopPropagationClick, supportsPassiveEvents, trapFocus, };
 //# sourceMappingURL=utils.d.ts.map

package/dist/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AACA,OAAO,EAIL,qBAAqB,EACrB,YAAY,EACZ,WAAW,EACZ,MAAM,OAAO,CAAA;AACd,OAAO,EAAE,gBAAgB,EAAY,MAAM,UAAU,CAAA;AAOrD,QAAA,MAAM,KAAK,SAGA,CAAA;AAIX,QAAA,MAAM,QAAQ,eAMb,CAAA;AAKD,iBAAS,6BAA6B,CAAC,IAAI,EAAE,WAAW,cA8BvD;AAOD,QAAA,IAAI,qBAAqB,SAAQ,CAAA;AAsBjC,iBAAS,aAAa,CAAC,QAAQ,KAAA,EAAE,QAAQ,KAAA,kSAsBxC;AAQD,iBAAS,aAAa,CAAC,QAAQ,KAAA,EAAE,QAAQ,KAAA,OAOxC;AAQD,iBAAS,qBAAqB,CAAC,cAAc,KAAA,EAAE,cAAc,KAAA,MAc5D;AAKD,iBAAS,wBAAwB,SAEhC;AAOD,iBAAS,0BAA0B,CAAC,IAAI,KAAA,WAUvC;AAOD,iBAAS,kBAAkB,CAAC,IAAI,KAAA,EAAE,aAAa,GAAE,OAAe,OAe/D;AAOD,iBAAS,2BAA2B,CAAC,MAAM,KAAA,SAQ1C;AAoBD,iBAAS,OAAO,CAAC,IAAI,KAAA,EAAE,EAAE,KAAK,EAAE,GAAE;IAAE,KAAK,CAAC,EAAE,OAAO,CAAA;CAAqB,OAcvE;AAMD,iBAAS,iBAAiB,QAkBzB;AAKD,iBAAS,mBAAmB,CAC1B,IAAI,EAAE,gBAAgB,EACtB,UAAU,CAAC,EAAE,gBAAgB;;;EAc9B;AAOD,iBAAS,UAAU,CAAC,MAAM,KAAA,UAEzB;AAoBD,iBAAS,YAAY,CAAC,IAAI,KAAA,EAAE,IAAI,KAAA,UAiB/B;AAKD,iBAAS,aAAa,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE;;;;CAAA,SAI5C;AAiCD,iBAAS,oBAAoB,CAAC,OAAO,KAAA,WAiBpC;AAKD,iBAAS,OAAO,CAAC,KAAK,KAAA,WAErB;AAKD,iBAAS,UAAU,CAAC,KAAK,KAAA,WAExB;AAMD,iBAAS,cAAc,CAAC,UAAU,KAAA,EAAE,KAAK,KAAA,UAIxC;AAKD,iBAAS,YAAY,CAAC,QAAQ,KAAA,EAAE,SAAS,SAAO,4SAmC/C;AAWD,iBAAS,UAAU,CAAC,IAAI,KAAA,cAmGvB;AAKD,iBAAS,IAAI,QAEZ;AAKD,iBAAS,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,IAAI,EAAE,MAAM,UAEvD;AAKD,iBAAS,cAAc,CAAC,QAAQ,KAAA,cAgB/B;AAKD,iBAAS,KAAK,CAAC,KAAK,KAAA,EAAE,IAAI,KAAA,SAMzB;AAKD,iBAAS,aAAa,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE;;;CAAA,SAIrC;AAKD,iBAAS,kBAAkB,CAAC,EAC1B,KAAK,EACL,WAAW,EACX,WAA8B,GAC/B;;;;CAAA,OAYA;AAKD,iBAAS,YAAY,CAAC,CAAC,SAAS,GAAG,EAAE,EAAE,EACrC,IAAI,EACJ,UAAU,EACV,QAAQ,GACT,EAAE;IACD,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,CAAC,CAAA;IACP,UAAU,EAAE,MAAM,CAAA;CACnB,SAKA;AAKD,iBAAS,YAAY,CAAC,CAAC,KAAA,EAAE,CAAC,KAAA,WAEzB;AAKD,iBAAS,mBAAmB,CAAC,IAAI,KAAA,QAMhC;AAKD,iBAAS,wBAAwB,CAAC,CAAC,KAAA,QAElC;AAMD,iBAAS,oBAAoB,CAAC,OAAO,KAAA,wBAOpC;AAQD,iBAAS,SAAS,CAAC,IAAI,KAAA,cA8CtB;AAOD,iBAAS,iBAAiB,CAAC,GAAG,KAAA,EAAE,KAAK,KAAA,UAKpC;AAED,iBAAS,cAAc,CAAC,GAAG,KAAA,EAAE,KAAK,KAAA,UAIjC;AAED,iBAAS,qBAAqB,CAAC,QAAQ,KAAA,EAAE,KAAK,KAAA,MAY7C;AAED,iBAAS,OAAO,CAAC,GAAG,KAAA,EAAE,IAAI,KAAA,QAQzB;AA0CD,iBAAS,UAAU,CAAC,GAAG,SAAS,OAAA,OAU/B;AAED,OAAO,EACL,OAAO,EACP,aAAa,EACb,aAAa,EACb,qBAAqB,EACrB,iBAAiB,EACjB,wBAAwB,EACxB,6BAA6B,EAC7B,UAAU,EACV,0BAA0B,EAC1B,kBAAkB,EAClB,cAAc,EACd,2BAA2B,EAC3B,OAAO,EACP,iBAAiB,EACjB,mBAAmB,EACnB,YAAY,EACZ,aAAa,EACb,OAAO,EACP,oBAAoB,EACpB,UAAU,EACV,KAAK,EACL,QAAQ,EACR,cAAc,EACd,YAAY,EACZ,UAAU,EACV,UAAU,EACV,IAAI,EACJ,qBAAqB,EACrB,SAAS,EACT,cAAc,EACd,KAAK,EACL,aAAa,EACb,kBAAkB,EAClB,YAAY,EACZ,mBAAmB,EACnB,YAAY,EACZ,wBAAwB,EACxB,oBAAoB,EACpB,qBAAqB,EACrB,SAAS,GACV,CAAA"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AACA,OAAO,EAIL,qBAAqB,EACrB,YAAY,EACZ,WAAW,EACZ,MAAM,OAAO,CAAA;AACd,OAAO,EAAE,gBAAgB,EAAY,MAAM,UAAU,CAAA;AAErD;;;;GAIG;AACH,QAAA,MAAM,KAAK,SAGA,CAAA;AAIX,QAAA,MAAM,QAAQ,eAMb,CAAA;AAED;;GAEG;AACH,iBAAS,6BAA6B,CAAC,IAAI,EAAE,WAAW,cA8BvD;AAED;;;;GAIG;AACH,QAAA,IAAI,qBAAqB,SAAQ,CAAA;AAgBjC;;;;;GAKG;AACH,iBAAS,aAAa,CAAC,QAAQ,KAAA,EAAE,QAAQ,KAAA,kSAsBxC;AAED;;;;;GAKG;AACH,iBAAS,aAAa,CAAC,QAAQ,KAAA,EAAE,QAAQ,KAAA,OAOxC;AAED;;;;;GAKG;AACH,iBAAS,qBAAqB,CAAC,cAAc,KAAA,EAAE,cAAc,KAAA,MAc5D;AAED;;GAEG;AACH,iBAAS,wBAAwB,SAEhC;AAED;;;;GAIG;AACH,iBAAS,0BAA0B,CAAC,IAAI,KAAA,WAUvC;AAED;;;;GAIG;AACH,iBAAS,kBAAkB,CAAC,IAAI,KAAA,EAAE,aAAa,GAAE,OAAe,OAe/D;AAED;;;;GAIG;AACH,iBAAS,2BAA2B,CAAC,MAAM,KAAA,SAQ1C;AAoBD,iBAAS,OAAO,CAAC,IAAI,KAAA,EAAE,EAAE,KAAK,EAAE,GAAE;IAAE,KAAK,CAAC,EAAE,OAAO,CAAA;CAAqB,OAcvE;AAMD,iBAAS,iBAAiB,QAkBzB;AAED;;GAEG;AACH,iBAAS,mBAAmB,CAC1B,IAAI,EAAE,gBAAgB,EACtB,UAAU,CAAC,EAAE,gBAAgB;;;EAc9B;AAOD,iBAAS,UAAU,CAAC,MAAM,KAAA,UAEzB;AAoBD,iBAAS,YAAY,CAAC,IAAI,KAAA,EAAE,IAAI,KAAA,UAiB/B;AAED;;GAEG;AACH,iBAAS,aAAa,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE;;;;CAAA,SAI5C;AAiCD,iBAAS,oBAAoB,CAAC,OAAO,KAAA,WAiBpC;AAED;;GAEG;AACH,iBAAS,OAAO,CAAC,KAAK,KAAA,WAErB;AAED;;GAEG;AACH,iBAAS,UAAU,CAAC,KAAK,KAAA,WAExB;AAED;;;GAGG;AACH,iBAAS,cAAc,CAAC,UAAU,KAAA,EAAE,KAAK,KAAA,UAIxC;AAED;;GAEG;AACH,iBAAS,YAAY,CAAC,QAAQ,KAAA,EAAE,SAAS,SAAO,4SAmC/C;AAWD,iBAAS,UAAU,CAAC,IAAI,KAAA,cAmGvB;AAED;;GAEG;AACH,iBAAS,IAAI,QAEZ;AAED;;GAEG;AACH,iBAAS,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,IAAI,EAAE,MAAM,UAEvD;AAED;;GAEG;AACH,iBAAS,cAAc,CAAC,QAAQ,KAAA,cAgB/B;AAED;;GAEG;AACH,iBAAS,KAAK,CAAC,KAAK,KAAA,EAAE,IAAI,KAAA,SAMzB;AAED;;GAEG;AACH,iBAAS,aAAa,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE;;;CAAA,SAIrC;AAED;;GAEG;AACH,iBAAS,kBAAkB,CAAC,EAC1B,KAAK,EACL,WAAW,EACX,WAA8B,GAC/B;;;;CAAA,OAYA;AAED;;GAEG;AACH,iBAAS,YAAY,CAAC,CAAC,SAAS,GAAG,EAAE,EAAE,EACrC,IAAI,EACJ,UAAU,EACV,QAAQ,GACT,EAAE;IACD,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,CAAC,CAAA;IACP,UAAU,EAAE,MAAM,CAAA;CACnB,SAKA;AAED;;GAEG;AACH,iBAAS,YAAY,CAAC,CAAC,KAAA,EAAE,CAAC,KAAA,WAEzB;AAED;;GAEG;AACH,iBAAS,mBAAmB,CAAC,IAAI,KAAA,QAMhC;AAED;;GAEG;AACH,iBAAS,wBAAwB,CAAC,CAAC,KAAA,QAElC;AAED;;;GAGG;AACH,iBAAS,oBAAoB,CAAC,OAAO,KAAA,wBAOpC;AAQD,iBAAS,SAAS,CAAC,IAAI,KAAA,cA8CtB;AAOD,iBAAS,iBAAiB,CAAC,GAAG,KAAA,EAAE,KAAK,KAAA,UAKpC;AAED,iBAAS,cAAc,CAAC,GAAG,KAAA,EAAE,KAAK,KAAA,UAIjC;AAED,iBAAS,qBAAqB,CAAC,QAAQ,KAAA,EAAE,KAAK,KAAA,MAY7C;AAED,iBAAS,OAAO,CAAC,GAAG,KAAA,EAAE,IAAI,KAAA,QAQzB;AAmCD;;;;;;GAMG;AACH,iBAAS,UAAU,CAAC,GAAG,SAAS,OAAA,OAU/B;AAED,OAAO,EACL,OAAO,EACP,aAAa,EACb,aAAa,EACb,qBAAqB,EACrB,iBAAiB,EACjB,wBAAwB,EACxB,6BAA6B,EAC7B,UAAU,EACV,0BAA0B,EAC1B,kBAAkB,EAClB,cAAc,EACd,2BAA2B,EAC3B,OAAO,EACP,iBAAiB,EACjB,mBAAmB,EACnB,YAAY,EACZ,aAAa,EACb,OAAO,EACP,oBAAoB,EACpB,UAAU,EACV,KAAK,EACL,QAAQ,EACR,cAAc,EACd,YAAY,EACZ,UAAU,EACV,UAAU,EACV,IAAI,EACJ,qBAAqB,EACrB,SAAS,EACT,cAAc,EACd,KAAK,EACL,aAAa,EACb,kBAAkB,EAClB,YAAY,EACZ,mBAAmB,EACnB,YAAY,EACZ,wBAAwB,EACxB,oBAAoB,EACpB,qBAAqB,EACrB,SAAS,GACV,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@planningcenter/tapestry-react",
-  "version": "4.14.0",
+  "version": "4.14.1",
   "description": "A collection of flexible React components to help you build resilient, accessible user interfaces quickly and effectively.",
   "author": "Front End Systems Engineering <frontend@pco.bz>",
   "main": "./dist/index.js",