@instructure/ui-react-utils 10.26.1-snapshot-2 → 10.26.2

package/types/experimental.d.ts

@@ -0,0 +1,27 @@
+import { ComponentClass } from 'react';
+/**
+ * ---
+ * category: utilities/react
+ * ---
+ * Flag React component and component props as experimental.
+ * Warnings will display in the console when experimental components/props
+ * props are used.
+ *
+ * ```js-code
+ *  class Example extends Component {
+ *    static propTypes = {
+ *      currentProp: PropTypes.func
+ *    }
+ *  }
+ *  export default experimental(['experimentalProp'])(Example)
+ * ```
+ *
+ * @module experimental
+ * @param {array} experimentalProps (if this argument is null or undefined, the entire component is flagged)
+ * @param {string} message
+ * @return {function} React component flagged as experimental
+ */
+declare const experimental: (...args: unknown[]) => (ComposedComponent: ComponentClass<any>) => any;
+export default experimental;
+export { experimental };
+//# sourceMappingURL=experimental.d.ts.map

package/types/experimental.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"experimental.d.ts","sourceRoot":"","sources":["../src/experimental.ts"],"names":[],"mappings":"AAyBA,OAAO,EAAE,cAAc,EAAE,MAAM,OAAO,CAAA;AAEtC;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,QAAA,MAAM,YAAY,yEAqDX,CAAA;AAuBP,eAAe,YAAY,CAAA;AAC3B,OAAO,EAAE,YAAY,EAAE,CAAA"}

package/types/getElementType.d.ts

@@ -1,4 +1,4 @@
-import type { ComponentClass } from 'react';
+import { ComponentType } from 'react';
 import { AsElementType } from '@instructure/shared-types';
 /**
  * A props object that is searched for some fields to determine the
@@ -28,7 +28,7 @@ interface PropsObject {
  * @param getDefault an optional function that returns the default element type
  * @returns the element type
  */
-declare function getElementType<T extends PropsObject>(Component: ComponentClass<T>, props: T, getDefault?: () => AsElementType<T>): "symbol" | "object" | import("react").FunctionComponent<any> | "style" | "map" | "filter" | "a" | "abbr" | "address" | "area" | "article" | "aside" | "audio" | "b" | "base" | "bdi" | "bdo" | "big" | "blockquote" | "body" | "br" | "button" | "canvas" | "caption" | "center" | "cite" | "code" | "col" | "colgroup" | "data" | "datalist" | "dd" | "del" | "details" | "dfn" | "dialog" | "div" | "dl" | "dt" | "em" | "embed" | "fieldset" | "figcaption" | "figure" | "footer" | "form" | "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "head" | "header" | "hgroup" | "hr" | "html" | "i" | "iframe" | "img" | "input" | "ins" | "kbd" | "keygen" | "label" | "legend" | "li" | "link" | "main" | "mark" | "menu" | "menuitem" | "meta" | "meter" | "nav" | "noindex" | "noscript" | "ol" | "optgroup" | "option" | "output" | "p" | "param" | "picture" | "pre" | "progress" | "q" | "rp" | "rt" | "ruby" | "s" | "samp" | "search" | "slot" | "script" | "section" | "select" | "small" | "source" | "span" | "strong" | "sub" | "summary" | "sup" | "table" | "template" | "tbody" | "td" | "textarea" | "tfoot" | "th" | "thead" | "time" | "title" | "tr" | "track" | "u" | "ul" | "var" | "video" | "wbr" | "webview" | "svg" | "animate" | "animateMotion" | "animateTransform" | "circle" | "clipPath" | "defs" | "desc" | "ellipse" | "feBlend" | "feColorMatrix" | "feComponentTransfer" | "feComposite" | "feConvolveMatrix" | "feDiffuseLighting" | "feDisplacementMap" | "feDistantLight" | "feDropShadow" | "feFlood" | "feFuncA" | "feFuncB" | "feFuncG" | "feFuncR" | "feGaussianBlur" | "feImage" | "feMerge" | "feMergeNode" | "feMorphology" | "feOffset" | "fePointLight" | "feSpecularLighting" | "feSpotLight" | "feTile" | "feTurbulence" | "foreignObject" | "g" | "image" | "line" | "linearGradient" | "marker" | "mask" | "metadata" | "mpath" | "path" | "pattern" | "polygon" | "polyline" | "radialGradient" | "rect" | "set" | "stop" | "switch" | "text" | "textPath" | "tspan" | "use" | "view" | ComponentClass<any, any> | ComponentClass<T, any> | import("react").FunctionComponent<T> | NonNullable<T["as"]>;
+declare function getElementType<T extends PropsObject>(Component: Omit<ComponentType<T>, 'propTypes'>, props: T, getDefault?: () => AsElementType<T>): "symbol" | "object" | "a" | "abbr" | "address" | "area" | "article" | "aside" | "audio" | "b" | "base" | "bdi" | "bdo" | "big" | "blockquote" | "body" | "br" | "button" | "canvas" | "caption" | "center" | "cite" | "code" | "col" | "colgroup" | "data" | "datalist" | "dd" | "del" | "details" | "dfn" | "dialog" | "div" | "dl" | "dt" | "em" | "embed" | "fieldset" | "figcaption" | "figure" | "footer" | "form" | "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "head" | "header" | "hgroup" | "hr" | "html" | "i" | "iframe" | "img" | "input" | "ins" | "kbd" | "keygen" | "label" | "legend" | "li" | "link" | "main" | "map" | "mark" | "menu" | "menuitem" | "meta" | "meter" | "nav" | "noscript" | "ol" | "optgroup" | "option" | "output" | "p" | "param" | "picture" | "pre" | "progress" | "q" | "rp" | "rt" | "ruby" | "s" | "samp" | "search" | "slot" | "script" | "section" | "select" | "small" | "source" | "span" | "strong" | "style" | "sub" | "summary" | "sup" | "table" | "template" | "tbody" | "td" | "textarea" | "tfoot" | "th" | "thead" | "time" | "title" | "tr" | "track" | "u" | "ul" | "var" | "video" | "wbr" | "webview" | "animate" | "circle" | "clipPath" | "defs" | "desc" | "ellipse" | "feBlend" | "feColorMatrix" | "feComponentTransfer" | "feComposite" | "feConvolveMatrix" | "feDiffuseLighting" | "feDisplacementMap" | "feDistantLight" | "feDropShadow" | "feFlood" | "feFuncA" | "feFuncB" | "feFuncG" | "feFuncR" | "feGaussianBlur" | "feImage" | "feMerge" | "feMergeNode" | "feMorphology" | "feOffset" | "fePointLight" | "feSpecularLighting" | "feSpotLight" | "feTile" | "feTurbulence" | "filter" | "foreignObject" | "g" | "image" | "line" | "linearGradient" | "marker" | "mask" | "metadata" | "path" | "pattern" | "polygon" | "polyline" | "radialGradient" | "rect" | "stop" | "svg" | "switch" | "text" | "textPath" | "tspan" | "use" | "view" | import("react").FunctionComponent<any> | "noindex" | "animateMotion" | "animateTransform" | "mpath" | import("react").ComponentClass<any, any> | import("react").ComponentClass<T, any> | import("react").FunctionComponent<T> | NonNullable<T["as"]>;
 export default getElementType;
 export { getElementType };
 //# sourceMappingURL=getElementType.d.ts.map

package/types/getElementType.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getElementType.d.ts","sourceRoot":"","sources":["../src/getElementType.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,OAAO,CAAA;AAE3C,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAA;AAEzD;;;GAGG;AACH,UAAU,WAAW;IACnB,EAAE,CAAC,EAAE,aAAa,CAAA;IAClB,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,OAAO,CAAC,EAAE,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,KAAK,GAAG,CAAC,GAAG,IAAI,CAAA;CACzC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,iBAAS,cAAc,CAAC,CAAC,SAAS,WAAW,EAC3C,SAAS,EAAE,cAAc,CAAC,CAAC,CAAC,EAC5B,KAAK,EAAE,CAAC,EACR,UAAU,CAAC,EAAE,MAAM,aAAa,CAAC,CAAC,CAAC,yhEAuBpC;AAED,eAAe,cAAc,CAAA;AAC7B,OAAO,EAAE,cAAc,EAAE,CAAA"}
+{"version":3,"file":"getElementType.d.ts","sourceRoot":"","sources":["../src/getElementType.ts"],"names":[],"mappings":"AAwBA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAA;AAErC,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAA;AAEzD;;;GAGG;AACH,UAAU,WAAW;IACnB,EAAE,CAAC,EAAE,aAAa,CAAA;IAClB,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,OAAO,CAAC,EAAE,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,KAAK,GAAG,CAAC,GAAG,IAAI,CAAA;CACzC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,iBAAS,cAAc,CAAC,CAAC,SAAS,WAAW,EAC3C,SAAS,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,WAAW,CAAC,EAC9C,KAAK,EAAE,CAAC,EACR,UAAU,CAAC,EAAE,MAAM,aAAa,CAAC,CAAC,CAAC,ijEAuBpC;AAED,eAAe,cAAc,CAAA;AAC7B,OAAO,EAAE,cAAc,EAAE,CAAA"}

package/types/hack.d.ts

@@ -0,0 +1,47 @@
+/**
+ * ---
+ * category: utilities/react
+ * ---
+ * Flag React component props as hack props.
+ * Warnings will display in the console when hack props are used.
+ *
+ * ```js-code
+ *  class Example extends Component {
+ *    static propTypes = {
+ *      currentProp: PropTypes.func
+ *    }
+ *  }
+ *  export default hack(['hackProp'])(Example)
+ * ```
+ *
+ * @module hack
+ * @param {array} hackProps
+ * @param {string} message
+ * @return {function} React component flagged as having hack props
+ */
+declare const hack: (...args: unknown[]) => (ComposedComponent: import("react").ComponentClass<any>) => any;
+export default hack;
+export { 
+/**
+ * ---
+ * category: utilities/react
+ * ---
+ * Flag React component props as hack props.
+ * Warnings will display in the console when hack props are used.
+ *
+ * ```js
+ *  class Example extends Component {
+ *    static propTypes = {
+ *      currentProp: PropTypes.func
+ *    }
+ *  }
+ *  export default hack(['hackProp'])(Example)
+ * ```
+ *
+ * @module hack
+ * @param {array} hackProps
+ * @param {string} message
+ * @return {function} React component flagged as having hack props
+ */
+hack };
+//# sourceMappingURL=hack.d.ts.map

package/types/hack.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hack.d.ts","sourceRoot":"","sources":["../src/hack.ts"],"names":[],"mappings":"AA2BA;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,QAAA,MAAM,IAAI,yFAuCF,CAAA;AAgBR,eAAe,IAAI,CAAA;AACnB,OAAO;AACL;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,IAAI,EACL,CAAA"}

package/types/index.d.ts

@@ -1,5 +1,8 @@
 export { callRenderProp } from './callRenderProp';
+export { deprecated } from './deprecated';
 export { ensureSingleChild } from './ensureSingleChild';
+export { experimental } from './experimental';
+export { hack } from './hack';
 export { getDisplayName } from './getDisplayName';
 export { getElementType } from './getElementType';
 export { getInteraction } from './getInteraction';

package/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAyBA,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AACjD,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAA;AACvD,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AACjD,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AACjD,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AACjD,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAA;AAC3D,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AACrD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AACrD,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAA;AAC/D,OAAO,EACL,sBAAsB,EACtB,8BAA8B,EAC9B,mBAAmB,EACpB,MAAM,0BAA0B,CAAA;AAEjC,YAAY,EAAE,qBAAqB,EAAE,MAAM,kBAAkB,CAAA;AAC7D,YAAY,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAA;AACvD,YAAY,EACV,4BAA4B,EAC5B,wBAAwB,EACzB,MAAM,0BAA0B,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAyBA,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AACjD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AACzC,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAA;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAC7C,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAA;AAC7B,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AACjD,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AACjD,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AACjD,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAA;AAC3D,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AACrD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AACrD,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAA;AAC/D,OAAO,EACL,sBAAsB,EACtB,8BAA8B,EAC9B,mBAAmB,EACpB,MAAM,0BAA0B,CAAA;AACjC,YAAY,EAAE,qBAAqB,EAAE,MAAM,kBAAkB,CAAA;AAC7D,YAAY,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAA;AACvD,YAAY,EACV,4BAA4B,EAC5B,wBAAwB,EACzB,MAAM,0BAA0B,CAAA"}

package/types/safeCloneElement.d.ts

@@ -13,7 +13,7 @@ type GetProps<E extends ReactElement = ReactElement> = E extends FunctionCompone
  * @param props Props of the element
  * @param children
  */
-declare function safeCloneElement<E extends ReactElement<any> = ReactElement, P extends GetProps<E> = GetProps<E>>(element: {
+declare function safeCloneElement<E extends ReactElement = ReactElement, P extends GetProps<E> = GetProps<E>>(element: {
     ref?: any;
 } & E, props: {
     style?: any;

package/types/safeCloneElement.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"safeCloneElement.d.ts","sourceRoot":"","sources":["../src/safeCloneElement.ts"],"names":[],"mappings":"AAwBA,OAAO,EACL,UAAU,EACV,wBAAwB,EACxB,gBAAgB,EAChB,YAAY,EACZ,SAAS,EACT,UAAU,EAGX,MAAM,OAAO,CAAA;AAKd,KAAK,QAAQ,CAAC,CAAC,SAAS,YAAY,GAAG,YAAY,IAAI,CAAC,SACpD,wBAAwB,CAAC,MAAM,CAAC,CAAC,GACjC,gBAAgB,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC,GAC9B,UAAU,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC,GACxB,CAAC,GAAG;IAAE,GAAG,CAAC,EAAE,GAAG,CAAA;CAAE,GACjB,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG;IAAE,GAAG,CAAC,EAAE,GAAG,CAAA;CAAE,CAAA;AAEvC;;;;;;;;GAQG;AACH,iBAAS,gBAAgB,CACvB,CAAC,SAAS,YAAY,CAAC,GAAG,CAAC,GAAG,YAAY,EAC1C,CAAC,SAAS,QAAQ,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,EAEnC,OAAO,EAAE;IAAE,GAAG,CAAC,EAAE,GAAG,CAAA;CAAE,GAAG,CAAC,EAC1B,KAAK,EAAE;IAAE,KAAK,CAAC,EAAE,GAAG,CAAA;CAAE,GAAG,OAAO,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,EACzD,GAAG,QAAQ,EAAE,SAAS,EAAE,KAyEzB;AAED,eAAe,gBAAgB,CAAA;AAC/B,OAAO,EAAE,gBAAgB,EAAE,CAAA"}
+{"version":3,"file":"safeCloneElement.d.ts","sourceRoot":"","sources":["../src/safeCloneElement.ts"],"names":[],"mappings":"AAwBA,OAAO,EACL,UAAU,EACV,wBAAwB,EACxB,gBAAgB,EAChB,YAAY,EACZ,SAAS,EACT,UAAU,EAGX,MAAM,OAAO,CAAA;AAKd,KAAK,QAAQ,CAAC,CAAC,SAAS,YAAY,GAAG,YAAY,IAAI,CAAC,SACpD,wBAAwB,CAAC,MAAM,CAAC,CAAC,GACjC,gBAAgB,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC,GAC9B,UAAU,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC,GACxB,CAAC,GAAG;IAAE,GAAG,CAAC,EAAE,GAAG,CAAA;CAAE,GACjB,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG;IAAE,GAAG,CAAC,EAAE,GAAG,CAAA;CAAE,CAAA;AAEvC;;;;;;;;GAQG;AACH,iBAAS,gBAAgB,CACvB,CAAC,SAAS,YAAY,GAAG,YAAY,EACrC,CAAC,SAAS,QAAQ,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,EAEnC,OAAO,EAAE;IAAE,GAAG,CAAC,EAAE,GAAG,CAAA;CAAE,GAAG,CAAC,EAC1B,KAAK,EAAE;IAAE,KAAK,CAAC,EAAE,GAAG,CAAA;CAAE,GAAG,OAAO,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,EACzD,GAAG,QAAQ,EAAE,SAAS,EAAE,KA0EzB;AAED,eAAe,gBAAgB,CAAA;AAC/B,OAAO,EAAE,gBAAgB,EAAE,CAAA"}