@instructure/emotion 10.26.1-snapshot-2 → 10.26.1

package/types/InstUISettingsProvider/index.d.ts

@@ -1,5 +1,7 @@
+import PropTypes from 'prop-types';
 import type { ThemeOrOverride } from '../EmotionTypes';
 import type { DeterministicIdProviderValue } from '@instructure/ui-react-utils';
+import type { AsElementType } from '@instructure/shared-types';
 type InstUIProviderProps = {
     children?: React.ReactNode;
     /**
@@ -14,21 +16,45 @@ type InstUIProviderProps = {
      * specific InstUI components. (generally this is used for deterministic id generation for [SSR](/#server-side-rendering))
      */
     instanceCounterMap?: DeterministicIdProviderValue;
+} & ({
     /**
      * The text direction to use in the descendants. If not provided, it uses the following in this priority order:
      *   - The value given in a parent `TextDirectionContext`
      *   - The `dir` prop of `document.documentElement` or its `direction` CSS prop
      *   - The default `ltr`
      */
-    dir?: 'ltr' | 'rtl';
-};
+    dir: 'ltr' | 'rtl';
+    /**
+     *  @deprecated This prop will be removed in InstUI v11
+     *
+     *  The element type to render as
+     */
+    as?: AsElementType;
+} | {
+    dir?: never;
+    /**
+     *  @deprecated This prop will be removed in InstUI v11
+     *
+     *  The element type to render as
+     */
+    as?: never;
+});
 /**
  * ---
  * category: components/utilities
  * ---
  * @module InstUISettingsProvider
  */
-declare function InstUISettingsProvider({ children, theme, dir, instanceCounterMap }: InstUIProviderProps): import("@emotion/react/jsx-runtime").JSX.Element;
+declare function InstUISettingsProvider({ children, theme, dir, instanceCounterMap, as }: InstUIProviderProps): import("@emotion/react/jsx-runtime").JSX.Element;
+declare namespace InstUISettingsProvider {
+    var propTypes: {
+        children: PropTypes.Requireable<PropTypes.ReactNodeLike>;
+        theme: PropTypes.Requireable<object>;
+        dir: PropTypes.Requireable<string>;
+        instanceCounterMap: PropTypes.Requireable<Map<unknown, unknown>>;
+        as: PropTypes.Requireable<string>;
+    };
+}
 export default InstUISettingsProvider;
 export { InstUISettingsProvider };
 //# sourceMappingURL=index.d.ts.map

package/types/InstUISettingsProvider/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/InstUISettingsProvider/index.tsx"],"names":[],"mappings":"AAgCA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AACtD,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,6BAA6B,CAAA;AAE/E,KAAK,mBAAmB,GAAG;IACzB,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAA;IAE1B;;OAEG;IACH,KAAK,CAAC,EAAE,eAAe,CAAA;IAEvB;;;;;;OAMG;IACH,kBAAkB,CAAC,EAAE,4BAA4B,CAAA;IAEjD;;;;;OAKG;IACH,GAAG,CAAC,EAAE,KAAK,GAAG,KAAK,CAAA;CACpB,CAAA;AAED;;;;;GAKG;AACH,iBAAS,sBAAsB,CAAC,EAC9B,QAAQ,EACR,KAAU,EACV,GAAG,EACH,kBAAkB,EACnB,EAAE,mBAAmB,oDAwBrB;AAED,eAAe,sBAAsB,CAAA;AACrC,OAAO,EAAE,sBAAsB,EAAE,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/InstUISettingsProvider/index.tsx"],"names":[],"mappings":"AAyBA,OAAO,SAAS,MAAM,YAAY,CAAA;AAQlC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AACtD,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,6BAA6B,CAAA;AAC/E,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAA;AAE9D,KAAK,mBAAmB,GAAG;IACzB,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAA;IAE1B;;OAEG;IACH,KAAK,CAAC,EAAE,eAAe,CAAA;IAEvB;;;;;;OAMG;IACH,kBAAkB,CAAC,EAAE,4BAA4B,CAAA;CAClD,GAAG,CACA;IACE;;;;;OAKG;IACH,GAAG,EAAE,KAAK,GAAG,KAAK,CAAA;IAClB;;;;OAIG;IACH,EAAE,CAAC,EAAE,aAAa,CAAA;CACnB,GACD;IACE,GAAG,CAAC,EAAE,KAAK,CAAA;IACX;;;;OAIG;IACH,EAAE,CAAC,EAAE,KAAK,CAAA;CACX,CACJ,CAAA;AAED;;;;;GAKG;AACH,iBAAS,sBAAsB,CAAC,EAC9B,QAAQ,EACR,KAAU,EACV,GAAG,EACH,kBAAkB,EAClB,EAAE,EACH,EAAE,mBAAmB,oDA6BrB;kBAnCQ,sBAAsB;;;;;;;;;AA+C/B,eAAe,sBAAsB,CAAA;AACrC,OAAO,EAAE,sBAAsB,EAAE,CAAA"}

package/types/getTheme.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getTheme.d.ts","sourceRoot":"","sources":["../src/getTheme.ts"],"names":[],"mappings":"AA0BA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAA;AAE1D,OAAO,KAAK,EAEV,eAAe,EAEhB,MAAM,gBAAgB,CAAA;AAEvB;;;;;;;;;;;;;;;GAeG;AACH,QAAA,MAAM,QAAQ,GACX,iBAAiB,eAAe,MAChC,gBAAsB,SAAS,oCAoD/B,CAAA;AAEH,eAAe,QAAQ,CAAA;AACvB,OAAO,EAAE,QAAQ,EAAE,CAAA"}
+{"version":3,"file":"getTheme.d.ts","sourceRoot":"","sources":["../src/getTheme.ts"],"names":[],"mappings":"AA2BA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAA;AAE1D,OAAO,KAAK,EAEV,eAAe,EAEhB,MAAM,gBAAgB,CAAA;AAEvB;;;;;;;;;;;;;;;GAeG;AACH,QAAA,MAAM,QAAQ,GACX,iBAAiB,eAAe,MAChC,gBAAsB,SAAS,oCAsD/B,CAAA;AAEH,eAAe,QAAQ,CAAA;AACvB,OAAO,EAAE,QAAQ,EAAE,CAAA"}

package/types/index.d.ts

@@ -1,7 +1,7 @@
 export * from '@emotion/react';
 export { InstUISettingsProvider } from './InstUISettingsProvider';
 export { withStyle } from './withStyle';
-export { ThemeablePropValues, makeThemeVars, getShorthandPropValue, mirrorShorthandCorners, mirrorShorthandEdges, mapSpacingToShorthand } from './styleUtils';
+export { ThemeablePropValues, ThemeablePropTypes, makeThemeVars, getShorthandPropValue, mirrorShorthandCorners, mirrorShorthandEdges, mapSpacingToShorthand } from './styleUtils';
 export { useStyle } from './useStyle';
 export type { ComponentStyle, StyleObject, Overrides } from './EmotionTypes';
 export type { WithStyleProps } from './withStyle';

package/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAyBA,cAAc,gBAAgB,CAAA;AAE9B,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAA;AACjE,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,EACL,mBAAmB,EACnB,aAAa,EACb,qBAAqB,EACrB,sBAAsB,EACtB,oBAAoB,EACpB,qBAAqB,EACtB,MAAM,cAAc,CAAA;AAErB,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AAErC,YAAY,EAAE,cAAc,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC5E,YAAY,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AACjD,YAAY,EACV,aAAa,EACb,OAAO,EACP,MAAM,EACN,QAAQ,EACR,UAAU,EACV,iBAAiB,EACjB,WAAW,EACX,iBAAiB,EACjB,WAAW,EACZ,MAAM,cAAc,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAyBA,cAAc,gBAAgB,CAAA;AAE9B,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAA;AACjE,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,EACL,mBAAmB,EACnB,kBAAkB,EAClB,aAAa,EACb,qBAAqB,EACrB,sBAAsB,EACtB,oBAAoB,EACpB,qBAAqB,EACtB,MAAM,cAAc,CAAA;AAErB,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AAErC,YAAY,EAAE,cAAc,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC5E,YAAY,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AACjD,YAAY,EACV,aAAa,EACb,OAAO,EACP,MAAM,EACN,QAAQ,EACR,UAAU,EACV,iBAAiB,EACjB,WAAW,EACX,iBAAiB,EACjB,WAAW,EACZ,MAAM,cAAc,CAAA"}

package/types/styleUtils/ThemeablePropTypes.d.ts

@@ -0,0 +1,22 @@
+import PropTypes from 'prop-types';
+import type { BorderRadiiValues, BorderRadii, BorderWidthValues, BorderWidth, SpacingValues } from './ThemeablePropValues';
+/**
+ * ---
+ * category: utilities/themes
+ * ---
+ * Custom prop types for themeable React components.
+ * @module ThemeablePropTypes
+ */
+declare const ThemeablePropTypes: {
+    shadow: PropTypes.Requireable<"resting" | "above" | "topmost" | "none">;
+    stacking: PropTypes.Requireable<"resting" | "above" | "topmost" | "below" | "deepest">;
+    borderWidth: PropTypes.Validator<BorderWidth>;
+    borderRadius: PropTypes.Validator<string>;
+    background: PropTypes.Requireable<"default" | "inverse" | "transparent">;
+    size: PropTypes.Requireable<"small" | "medium" | "large" | "x-small" | "x-large">;
+};
+type ValueKeys = BorderWidthValues[] | BorderRadiiValues[] | SpacingValues[] | string[];
+declare function shorthandPropType<V extends ValueKeys>(validValues: V): PropTypes.Validator<V extends BorderWidthValues[] ? BorderWidth : V extends BorderRadiiValues[] ? BorderRadii : string[]>;
+export default ThemeablePropTypes;
+export { ThemeablePropTypes, shorthandPropType };
+//# sourceMappingURL=ThemeablePropTypes.d.ts.map

package/types/styleUtils/ThemeablePropTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ThemeablePropTypes.d.ts","sourceRoot":"","sources":["../../src/styleUtils/ThemeablePropTypes.ts"],"names":[],"mappings":"AAwBA,OAAO,SAAS,MAAM,YAAY,CAAA;AAGlC,OAAO,KAAK,EACV,iBAAiB,EACjB,WAAW,EACX,iBAAiB,EACjB,WAAW,EACX,aAAa,EACd,MAAM,uBAAuB,CAAA;AAW9B;;;;;;GAMG;AACH,QAAA,MAAM,kBAAkB;;;;;;;CAOvB,CAAA;AAED,KAAK,SAAS,GACV,iBAAiB,EAAE,GACnB,iBAAiB,EAAE,GACnB,aAAa,EAAE,GACf,MAAM,EAAE,CAAA;AAEZ,iBAAS,iBAAiB,CAAC,CAAC,SAAS,SAAS,EAC5C,WAAW,EAAE,CAAC,GACb,SAAS,CAAC,SAAS,CACpB,CAAC,SAAS,iBAAiB,EAAE,GACzB,WAAW,GACX,CAAC,SAAS,iBAAiB,EAAE,GAC7B,WAAW,GACX,MAAM,EAAE,CACb,CA2CA;AAED,eAAe,kBAAkB,CAAA;AACjC,OAAO,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,CAAA"}

package/types/styleUtils/index.d.ts

@@ -1,4 +1,5 @@
 export { ThemeablePropValues } from './ThemeablePropValues';
+export { ThemeablePropTypes } from './ThemeablePropTypes';
 export { makeThemeVars } from './makeThemeVars';
 export { getShorthandPropValue } from './getShorthandPropValue';
 export { mirrorShorthandCorners } from './mirrorShorthandCorners';

package/types/styleUtils/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/styleUtils/index.ts"],"names":[],"mappings":"AAwBA,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAA;AAC3D,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAA;AAC/D,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAA;AACjE,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AAC7D,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAA;AAE/D,YAAY,EACV,aAAa,EACb,OAAO,EACP,MAAM,EACN,QAAQ,EACR,UAAU,EACV,iBAAiB,EACjB,WAAW,EACX,iBAAiB,EACjB,WAAW,EACZ,MAAM,uBAAuB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/styleUtils/index.ts"],"names":[],"mappings":"AAwBA,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAA;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAA;AACzD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAA;AAC/D,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAA;AACjE,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AAC7D,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAA;AAE/D,YAAY,EACV,aAAa,EACb,OAAO,EACP,MAAM,EACN,QAAQ,EACR,UAAU,EACV,iBAAiB,EACjB,WAAW,EACX,iBAAiB,EACjB,WAAW,EACZ,MAAM,uBAAuB,CAAA"}

package/types/useTheme.d.ts

@@ -4,7 +4,8 @@ import type { BaseThemeOrOverride } from './EmotionTypes';
  * private: true
  * ---
  * A hook that will return the currently applied theme object from the nearest Context.
- * If there is no theme provided to the Context, it will return the default `canvas` theme.
+ * If there is no Context, then it tries to get the current theme from the global ThemeRegistry.
+ * If there is no theme provided to the Context and ThemeRegistry it will return the default `canvas` theme.
  * @returns The theme object
  */
 declare const useTheme: () => BaseThemeOrOverride;

package/types/useTheme.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useTheme.d.ts","sourceRoot":"","sources":["../src/useTheme.ts"],"names":[],"mappings":"AA4BA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAA;AAEzD;;;;;;;GAOG;AACH,QAAA,MAAM,QAAQ,2BAYb,CAAA;AAED,eAAe,QAAQ,CAAA;AACvB,OAAO,EAAE,QAAQ,EAAE,CAAA"}
+{"version":3,"file":"useTheme.d.ts","sourceRoot":"","sources":["../src/useTheme.ts"],"names":[],"mappings":"AA6BA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAA;AAEzD;;;;;;;;GAQG;AACH,QAAA,MAAM,QAAQ,2BAkBb,CAAA;AAED,eAAe,QAAQ,CAAA;AACvB,OAAO,EAAE,QAAQ,EAAE,CAAA"}

package/types/withStyle.d.ts

@@ -36,7 +36,7 @@ type WithStyleProps<Theme extends ComponentTheme | null = ComponentTheme, Style
  * [InstUISettingsProvider](#InstUISettingsProvider) component, and/or set
  * explicitly via its `themeOverride` prop.
  *
- * InstUISettingsProvider provides a theme object (e.g. the [canvas theme](/#canvas)).
+ * InstUISettingsProvider provides a theme object with global theme variables (e.g. the [canvas theme](/#canvas)).
  * These variables are mapped to the component's own variables in `theme.js` (see [theming](#theming-basics) for more info).
  *
  * With the `themeOverride` prop you can directly set/override the component theme variables declared in theme.js. It accepts an object or a function. The function has the component's theme and the currently active main theme as its parameter.

package/types/withStyle.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"withStyle.d.ts","sourceRoot":"","sources":["../src/withStyle.tsx"],"names":[],"mappings":"AAwCA,OAAO,KAAK,EACV,SAAS,EACT,cAAc,EAEf,MAAM,2BAA2B,CAAA;AAClC,OAAO,KAAK,EACV,cAAc,EAKf,MAAM,gBAAgB,CAAA;AAYvB,KAAK,qBAAqB,CACxB,KAAK,SAAS,cAAc,GAAG,IAAI,GAAG,cAAc,IAClD,KAAK,SAAS,IAAI,GAClB,MAAM,GACN;IACE,MAAM,CAAC,EAAE,KAAK,CAAA;IACd,UAAU,CAAC,EAAE,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,IAAI,CAAA;CAC3D,CAAA;AAEL,KAAK,iBAAiB,CAAC,KAAK,SAAS,cAAc,GAAG,IAAI,GAAG,cAAc,IAAI;IAC7E,aAAa,CAAC,EACV,OAAO,CAAC,KAAK,CAAC,GACd,CAAC,CAAC,cAAc,EAAE,KAAK,EAAE,YAAY,EAAE,SAAS,KAAK,OAAO,CAAC,KAAK,CAAC,CAAC,CAAA;CACzE,CAAA;AAED,KAAK,cAAc,CACjB,KAAK,SAAS,cAAc,GAAG,IAAI,GAAG,cAAc,EACpD,KAAK,SAAS,cAAc,GAAG,IAAI,GAAG,cAAc,IAClD,KAAK,SAAS,IAAI,GAClB,qBAAqB,CAAC,KAAK,CAAC,GAC5B,qBAAqB,CAAC,KAAK,CAAC,GAAG,iBAAiB,CAAC,KAAK,CAAC,CAAA;AAO3D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0EG;AACH,QAAA,MAAM,SAAS,yFA8Gd,CAAA;AAED,eAAe,SAAS,CAAA;AACxB,OAAO,EAAE,SAAS,EAAE,CAAA;AACpB,YAAY,EAAE,cAAc,EAAE,CAAA"}
+{"version":3,"file":"withStyle.d.ts","sourceRoot":"","sources":["../src/withStyle.tsx"],"names":[],"mappings":"AAwCA,OAAO,KAAK,EACV,SAAS,EACT,cAAc,EAEf,MAAM,2BAA2B,CAAA;AAClC,OAAO,KAAK,EACV,cAAc,EAKf,MAAM,gBAAgB,CAAA;AAYvB,KAAK,qBAAqB,CACxB,KAAK,SAAS,cAAc,GAAG,IAAI,GAAG,cAAc,IAClD,KAAK,SAAS,IAAI,GAClB,MAAM,GACN;IACE,MAAM,CAAC,EAAE,KAAK,CAAA;IACd,UAAU,CAAC,EAAE,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,IAAI,CAAA;CAC3D,CAAA;AAEL,KAAK,iBAAiB,CAAC,KAAK,SAAS,cAAc,GAAG,IAAI,GAAG,cAAc,IAAI;IAC7E,aAAa,CAAC,EACV,OAAO,CAAC,KAAK,CAAC,GACd,CAAC,CAAC,cAAc,EAAE,KAAK,EAAE,YAAY,EAAE,SAAS,KAAK,OAAO,CAAC,KAAK,CAAC,CAAC,CAAA;CACzE,CAAA;AAED,KAAK,cAAc,CACjB,KAAK,SAAS,cAAc,GAAG,IAAI,GAAG,cAAc,EACpD,KAAK,SAAS,cAAc,GAAG,IAAI,GAAG,cAAc,IAClD,KAAK,SAAS,IAAI,GAClB,qBAAqB,CAAC,KAAK,CAAC,GAC5B,qBAAqB,CAAC,KAAK,CAAC,GAAG,iBAAiB,CAAC,KAAK,CAAC,CAAA;AAO3D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0EG;AACH,QAAA,MAAM,SAAS,yFAkHd,CAAA;AAED,eAAe,SAAS,CAAA;AACxB,OAAO,EAAE,SAAS,EAAE,CAAA;AACpB,YAAY,EAAE,cAAc,EAAE,CAAA"}