@workday/canvas-kit-react 9.0.0-alpha.368-next.6 → 9.0.0-alpha.382-next.2

package/dist/commonjs/common/lib/theming/breakpoints.js

@@ -40,7 +40,7 @@ exports.breakpoints = {
     l: 1024,
     xl: 1440,
 };
-var step = 0.5;
+const step = 0.5;
 /**
  * ### Up
  *
@@ -65,8 +65,8 @@ var step = 0.5;
  * ```
  */
 function up(key) {
-    var value = typeof exports.breakpoints[key] === 'number' ? exports.breakpoints[key] : key;
-    return "@media (min-width: " + value + "px)";
+    const value = typeof exports.breakpoints[key] === 'number' ? exports.breakpoints[key] : key;
+    return `@media (min-width: ${value}px)`;
 }
 exports.up = up;
 /**
@@ -115,14 +115,14 @@ exports.up = up;
  * ```
  */
 function down(endKey) {
-    var endIndex = exports.breakpointKeys.indexOf(endKey) + 1;
-    var upperbound = exports.breakpoints[exports.breakpointKeys[endIndex]];
+    const endIndex = exports.breakpointKeys.indexOf(endKey) + 1;
+    const upperbound = exports.breakpoints[exports.breakpointKeys[endIndex]];
     if (endIndex === exports.breakpointKeys.length) {
         // xl down applies to all sizes
         return up(BreakpointKey.zero);
     }
-    var value = typeof upperbound === 'number' && endIndex > 0 ? upperbound : 0;
-    return "@media (max-width: " + (value - step) + "px)";
+    const value = typeof upperbound === 'number' && endIndex > 0 ? upperbound : 0;
+    return `@media (max-width: ${value - step}px)`;
 }
 exports.down = down;
 /**
@@ -172,12 +172,12 @@ exports.down = down;
  * ```
  */
 function between(start, end) {
-    var endIndex = exports.breakpointKeys.indexOf(end) + 1;
+    const endIndex = exports.breakpointKeys.indexOf(end) + 1;
     if (endIndex === exports.breakpointKeys.length) {
         return up(start);
     }
-    return ("@media (min-width: " + exports.breakpoints[start] + "px) and " +
-        ("(max-width: " + (exports.breakpoints[exports.breakpointKeys[endIndex]] - step) + "px)"));
+    return (`@media (min-width: ${exports.breakpoints[start]}px) and ` +
+        `(max-width: ${exports.breakpoints[exports.breakpointKeys[endIndex]] - step}px)`);
 }
 exports.between = between;
 /**

package/dist/commonjs/common/lib/theming/createCanvasTheme.js

@@ -1,110 +1,81 @@
 "use strict";
-var __assign = (this && this.__assign) || function () {
-    __assign = Object.assign || function(t) {
-        for (var s, i = 1, n = arguments.length; i < n; i++) {
-            s = arguments[i];
-            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
-                t[p] = s[p];
-        }
-        return t;
-    };
-    return __assign.apply(this, arguments);
-};
-var __rest = (this && this.__rest) || function (s, e) {
-    var t = {};
-    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
-        t[p] = s[p];
-    if (s != null && typeof Object.getOwnPropertySymbols === "function")
-        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
-            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
-                t[p[i]] = s[p[i]];
-        }
-    return t;
-};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createCanvasTheme = exports.shiftColor = void 0;
-var chroma_js_1 = __importDefault(require("chroma-js"));
-var canvas_colors_web_1 = __importDefault(require("@workday/canvas-colors-web"));
-var theme_1 = require("./theme");
-var types_1 = require("./types");
-var utils_1 = require("../utils");
+const chroma_js_1 = __importDefault(require("chroma-js"));
+const canvas_colors_web_1 = __importDefault(require("@workday/canvas-colors-web"));
+const theme_1 = require("./theme");
+const types_1 = require("./types");
+const utils_1 = require("../utils");
 // Should these be exported?
-var deepMerge_1 = require("../utils/deepMerge");
-var memoize_1 = require("../utils/memoize");
-exports.shiftColor = memoize_1.memoize(function (hexColor, amount) {
-    if (amount === void 0) { amount = 100; }
-    var canvasColor = Object.keys(canvas_colors_web_1.default).find(function (color) { return canvas_colors_web_1.default[color] === hexColor; });
+const deepMerge_1 = require("../utils/deepMerge");
+const memoize_1 = require("../utils/memoize");
+exports.shiftColor = memoize_1.memoize((hexColor, amount = 100) => {
+    const canvasColor = Object.keys(canvas_colors_web_1.default).find(color => canvas_colors_web_1.default[color] === hexColor);
     if (canvasColor) {
-        var colorRegex = /([a-zAz]*)(\d{3})/g;
-        var match = colorRegex.exec(canvasColor);
+        const colorRegex = /([a-zAz]*)(\d{3})/g;
+        const match = colorRegex.exec(canvasColor);
         if (match) {
-            var baseColor = match[1];
-            var shadeNumber = parseInt(match[2], 10);
-            var newShade = shadeNumber + amount;
+            const baseColor = match[1];
+            const shadeNumber = parseInt(match[2], 10);
+            const newShade = shadeNumber + amount;
             if (newShade >= 100 && newShade <= 600) {
                 return canvas_colors_web_1.default[(baseColor + newShade)];
             }
         }
     }
     try {
-        var newColor = amount > 0
+        const newColor = amount > 0
             ? chroma_js_1.default(hexColor).darken(amount / 100)
             : chroma_js_1.default(hexColor).brighten(-amount / 100);
         return newColor.hex();
     }
     catch (e) {
-        console.warn("Invalid color '" + hexColor + "' used in theme");
+        console.warn(`Invalid color '${hexColor}' used in theme`);
         return hexColor;
     }
-}, function (color, value) { return color + "." + value; });
+}, (color, value) => `${color}.${value}`);
 function fillPalette(defaultPalette, palette) {
     if (!palette) {
         return {};
     }
-    var main = palette.main || defaultPalette.main;
-    var dark = palette.dark || (palette.main && exports.shiftColor(palette.main, 100)) || defaultPalette.dark;
-    var darkest = palette.darkest || (palette.main && exports.shiftColor(palette.main, 200)) || defaultPalette.darkest;
-    var light = palette.light || (palette.main && exports.shiftColor(palette.main, -100)) || defaultPalette.light;
-    var lightest = palette.lightest || (palette.main && exports.shiftColor(palette.main, -200)) || defaultPalette.lightest;
-    var contrast = palette.contrast || utils_1.pickForegroundColor(main) || defaultPalette.contrast;
+    const main = palette.main || defaultPalette.main;
+    const dark = palette.dark || (palette.main && exports.shiftColor(palette.main, 100)) || defaultPalette.dark;
+    const darkest = palette.darkest || (palette.main && exports.shiftColor(palette.main, 200)) || defaultPalette.darkest;
+    const light = palette.light || (palette.main && exports.shiftColor(palette.main, -100)) || defaultPalette.light;
+    const lightest = palette.lightest || (palette.main && exports.shiftColor(palette.main, -200)) || defaultPalette.lightest;
+    const contrast = palette.contrast || utils_1.pickForegroundColor(main) || defaultPalette.contrast;
     return {
-        lightest: lightest,
-        light: light,
-        main: main,
-        dark: dark,
-        darkest: darkest,
-        contrast: contrast,
+        lightest,
+        light,
+        main,
+        dark,
+        darkest,
+        contrast,
     };
 }
 function calculateCanvasTheme(partialTheme) {
-    var _a = partialTheme.palette, palette = _a === void 0 ? {} : _a, _b = partialTheme.breakpoints, breakpoints = _b === void 0 ? {} : _b, direction = partialTheme.direction, extraFields = __rest(partialTheme, ["palette", "breakpoints", "direction"]);
-    var _c = palette, primary = _c.primary, alert = _c.alert, error = _c.error, success = _c.success, neutral = _c.neutral, _d = _c.common, common = _d === void 0 ? {} : _d;
-    var mergeable = {
+    const { palette = {}, breakpoints = {}, direction, ...extraFields } = partialTheme;
+    const { primary, alert, error, success, neutral, common = {} } = palette;
+    const mergeable = {
         palette: {
-            common: common,
+            common,
             primary: fillPalette(theme_1.defaultCanvasTheme.palette.primary, primary),
             alert: fillPalette(theme_1.defaultCanvasTheme.palette.alert, alert),
             error: fillPalette(theme_1.defaultCanvasTheme.palette.error, error),
             success: fillPalette(theme_1.defaultCanvasTheme.palette.success, success),
             neutral: fillPalette(theme_1.defaultCanvasTheme.palette.neutral, neutral),
         },
-        breakpoints: breakpoints,
+        breakpoints,
         direction: direction === types_1.ContentDirection.RTL ? direction : types_1.ContentDirection.LTR,
     };
-    return deepMerge_1.deepMerge(deepMerge_1.deepMerge({}, theme_1.defaultCanvasTheme), __assign(__assign({}, mergeable), extraFields));
+    return deepMerge_1.deepMerge(deepMerge_1.deepMerge({}, theme_1.defaultCanvasTheme), { ...mergeable, ...extraFields });
 }
 /**
  * Creates a full {@link CanvasTheme} from any partial theme by deeply merging with the
  * `defaultCanvasTheme` object. The function is memoized, but it is best to run this function
  * only once and save the result.
  */
-exports.createCanvasTheme = memoize_1.memoize(calculateCanvasTheme, function () {
-    var args = [];
-    for (var _i = 0; _i < arguments.length; _i++) {
-        args[_i] = arguments[_i];
-    }
-    return JSON.stringify(args);
-});
+exports.createCanvasTheme = memoize_1.memoize(calculateCanvasTheme, (...args) => JSON.stringify(args));

package/dist/commonjs/common/lib/theming/getObjectProxy.js

@@ -11,17 +11,17 @@ exports.getObjectProxy = void 0;
 function getObjectProxy(target, fallback) {
     if (target) {
         return new Proxy(target, {
-            get: function (target, prop, receiver) {
+            get(target, prop, receiver) {
                 if (typeof fallback[prop] === 'object') {
                     return getObjectProxy(target[prop], fallback[prop]);
                 }
-                var targetProp = target[prop];
+                const targetProp = target[prop];
                 if (targetProp !== undefined) {
                     return targetProp;
                 }
                 return Reflect.get(fallback, prop, receiver);
             },
-            ownKeys: function () {
+            ownKeys() {
                 return Reflect.ownKeys(fallback);
             },
         });

package/dist/commonjs/common/lib/theming/index.d.ts

@@ -4,7 +4,7 @@ export * from './types';
 export { default as styled, StyleRewriteFn } from './styled';
 export * from './theme';
 export * from './useTheme';
+export * from './useThemedRing';
 export * from './useIsRTL';
-export * from './getCanvasTheme';
 export * from './getObjectProxy';
 //# sourceMappingURL=index.d.ts.map

package/dist/commonjs/common/lib/theming/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../common/lib/theming/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAC,iBAAiB,EAAC,MAAM,qBAAqB,CAAC;AACtD,cAAc,SAAS,CAAC;AACxB,OAAO,EAAC,OAAO,IAAI,MAAM,EAAE,cAAc,EAAC,MAAM,UAAU,CAAC;AAC3D,cAAc,SAAS,CAAC;AACxB,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../common/lib/theming/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAC,iBAAiB,EAAC,MAAM,qBAAqB,CAAC;AACtD,cAAc,SAAS,CAAC;AACxB,OAAO,EAAC,OAAO,IAAI,MAAM,EAAE,cAAc,EAAC,MAAM,UAAU,CAAC;AAC3D,cAAc,SAAS,CAAC;AACxB,cAAc,YAAY,CAAC;AAC3B,cAAc,iBAAiB,CAAC;AAChC,cAAc,YAAY,CAAC;AAC3B,cAAc,kBAAkB,CAAC"}

package/dist/commonjs/common/lib/theming/index.js

@@ -22,6 +22,6 @@ var styled_1 = require("./styled");
 Object.defineProperty(exports, "styled", { enumerable: true, get: function () { return __importDefault(styled_1).default; } });
 __exportStar(require("./theme"), exports);
 __exportStar(require("./useTheme"), exports);
+__exportStar(require("./useThemedRing"), exports);
 __exportStar(require("./useIsRTL"), exports);
-__exportStar(require("./getCanvasTheme"), exports);
 __exportStar(require("./getObjectProxy"), exports);

package/dist/commonjs/common/lib/theming/styled.js

@@ -3,21 +3,17 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-var styled_1 = __importDefault(require("@emotion/styled"));
-var index_1 = require("./index");
-var rtl_css_js_1 = __importDefault(require("rtl-css-js"));
-var noop = function (styles) { return styles; };
+const styled_1 = __importDefault(require("@emotion/styled"));
+const index_1 = require("./index");
+const rtl_css_js_1 = __importDefault(require("rtl-css-js"));
+const noop = (styles) => styles;
 function styled(node) {
-    return function () {
-        var args = [];
-        for (var _i = 0; _i < arguments.length; _i++) {
-            args[_i] = arguments[_i];
-        }
-        var newArgs = args.map(function (interpolation) { return function (props) {
+    return (...args) => {
+        const newArgs = args.map(interpolation => (props) => {
             props.theme = index_1.useTheme(props.theme);
-            var direction = props.theme.canvas.direction;
-            var maybeFlip = direction === index_1.ContentDirection.RTL ? rtl_css_js_1.default : noop;
-            var maybeConvert = props.theme._styleRewriteFn || noop;
+            const direction = props.theme.canvas.direction;
+            const maybeFlip = direction === index_1.ContentDirection.RTL ? rtl_css_js_1.default : noop;
+            const maybeConvert = props.theme._styleRewriteFn || noop;
             try {
                 if (typeof interpolation === 'function') {
                     return maybeFlip(maybeConvert(interpolation(props)));
@@ -27,7 +23,7 @@ function styled(node) {
             catch (e) {
                 return maybeConvert(interpolation);
             }
-        }; });
+        });
         return styled_1.default(node)(newArgs);
     };
 }

package/dist/commonjs/common/lib/theming/theme.js

@@ -4,9 +4,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.defaultCanvasTheme = void 0;
-var canvas_colors_web_1 = __importDefault(require("@workday/canvas-colors-web"));
-var types_1 = require("./types");
-var breakpoints_1 = require("./breakpoints");
+const canvas_colors_web_1 = __importDefault(require("@workday/canvas-colors-web"));
+const types_1 = require("./types");
+const breakpoints_1 = require("./breakpoints");
 exports.defaultCanvasTheme = {
     palette: {
         primary: {

package/dist/commonjs/common/lib/theming/useIsRTL.js

@@ -20,9 +20,9 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.useIsRTL = void 0;
-var React = __importStar(require("react"));
-var react_1 = require("@emotion/react");
-var types_1 = require("./types");
+const React = __importStar(require("react"));
+const react_1 = require("@emotion/react");
+const types_1 = require("./types");
 function useDefaultTheme(theme, config, fn) {
     return theme || fn(config);
 }
@@ -32,8 +32,8 @@ function useDefaultTheme(theme, config, fn) {
  * @example
  * const isRTL = useIsRTL();
  */
-var useIsRTL = function (partialTheme) {
-    var theme = useDefaultTheme(partialTheme, react_1.ThemeContext, React.useContext);
+const useIsRTL = (partialTheme) => {
+    const theme = useDefaultTheme(partialTheme, react_1.ThemeContext, React.useContext);
     return (theme && theme.canvas && theme.canvas.direction) === types_1.ContentDirection.RTL;
 };
 exports.useIsRTL = useIsRTL;

package/dist/commonjs/common/lib/theming/useTheme.d.ts

@@ -1,11 +1,47 @@
 import { EmotionCanvasTheme, PartialEmotionCanvasTheme } from './index';
 /**
- * Hook function to get the correct theme object.
- * @param {Object=} theme - The theme object returned from the emotion ThemeContext
- * (through ThemeProvider). The Canvas Kit theme is namespaced within this variable under the `canvas` key.
+ * Function to get the correct theme object for `styled` and class components
+ * or to be used outside component.
+ * @param {Object=} theme - The theme object with the Canvas Kit theme.
+ * It should be namespaced within this variable under the `canvas` key.
+ * Value of `canvas` property is any partial or full theme object to overwtite default theme.
  *
- * NOTE: If you are using a class component, you MUST pass the theme.
- * If not passed, the function will try to pull the theme from ThemeContext.
+ * @returns An object containing updated or default Canvas Kit theme under `canvas` key.
+ *
+ * The passed partial theme object will be merged with the default Canvas theme
+ * (using memoized createCanvasTheme()) to establish any missing fields that have
+ * not been defined by the consumer's theme object.
+ *
+ * If theme is not passed, the function will try to retrieve it from the window object.
+ * If window theme is not found, it will return the default Canvas theme.
+ *
+ * @example
+ * import {getTheme} from '@workday/canvas-kit-react/common';
+ *
+ * const theme = getTheme();
+ * const {up, down} = theme.canvas.breakpoints;
+ * const small = down('m'); // Returns '@media (max-width: 768px)'
+ * const medium = up('m'); // Returns '@media (min-width: 768px)'
+ *
+ * const styles = {
+ *  [small]: {
+ *    margin: space.m
+ *  },
+ *  [medium]: {
+ *    margin: space.l
+ *  }
+ * }
+ */
+export declare function getTheme(theme?: PartialEmotionCanvasTheme): EmotionCanvasTheme;
+/**
+ * Hook function to get the correct theme object for functional components.
+ * @param {Object=} theme - The theme object with the Canvas Kit theme.
+ * It should be namespaced within this variable under the `canvas` key.
+ * Value of `canvas` property is any partial or full theme object to overwtite default theme.
+ *
+ * @returns An object containing updated or default Canvas Kit theme under `canvas` key.
+ *
+ * NOTE: If theme is not passed, the function will try to pull the theme from ThemeContext.
  * If that does not work, it will try to retrieve it from the window object.
  * As a last resort, it will return the default Canvas theme.
  *
@@ -16,6 +52,14 @@ import { EmotionCanvasTheme, PartialEmotionCanvasTheme } from './index';
  * Providing the default theme here is currently a work around for when no
  * ThemeProvider or context exists.
  * Tracked on https://github.com/emotion-js/emotion/issues/1193.
+ *
+ * @example
+ * export const ErrorMessage = () => {
+ *  const theme = useTheme();
+ *  return (
+ *    <Subtext size="large" color={theme.canvas.palette.error.main}>
+ *  );
+ * }
  */
 export declare function useTheme(theme?: PartialEmotionCanvasTheme): EmotionCanvasTheme;
 //# sourceMappingURL=useTheme.d.ts.map

package/dist/commonjs/common/lib/theming/useTheme.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useTheme.d.ts","sourceRoot":"","sources":["../../../../../common/lib/theming/useTheme.ts"],"names":[],"mappings":"AACA,OAAO,EAGL,kBAAkB,EAClB,yBAAyB,EAC1B,MAAM,SAAS,CAAC;AAOjB;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,QAAQ,CAAC,KAAK,CAAC,EAAE,yBAAyB,GAAG,kBAAkB,CAqB9E"}
+{"version":3,"file":"useTheme.d.ts","sourceRoot":"","sources":["../../../../../common/lib/theming/useTheme.ts"],"names":[],"mappings":"AAIA,OAAO,EAGL,kBAAkB,EAClB,yBAAyB,EAC1B,MAAM,SAAS,CAAC;AAOjB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,wBAAgB,QAAQ,CAAC,KAAK,CAAC,EAAE,yBAAyB,GAAG,kBAAkB,CAY9E;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,QAAQ,CAAC,KAAK,CAAC,EAAE,yBAAyB,GAAG,kBAAkB,CAkB9E"}

package/dist/commonjs/common/lib/theming/useTheme.js

@@ -1,27 +1,68 @@
 "use strict";
-var __assign = (this && this.__assign) || function () {
-    __assign = Object.assign || function(t) {
-        for (var s, i = 1, n = arguments.length; i < n; i++) {
-            s = arguments[i];
-            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
-                t[p] = s[p];
-        }
-        return t;
-    };
-    return __assign.apply(this, arguments);
-};
+// refactor for v5
+/// <reference types="@types/node" />
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.useTheme = void 0;
-var react_1 = require("@emotion/react");
-var index_1 = require("./index");
-var getFilledTheme = function (theme) { return (__assign(__assign({}, theme), { canvas: index_1.createCanvasTheme(theme.canvas) })); };
+exports.useTheme = exports.getTheme = void 0;
+const react_1 = require("@emotion/react");
+const index_1 = require("./index");
+const getFilledTheme = (theme) => ({
+    ...theme,
+    canvas: index_1.createCanvasTheme(theme.canvas),
+});
+/**
+ * Function to get the correct theme object for `styled` and class components
+ * or to be used outside component.
+ * @param {Object=} theme - The theme object with the Canvas Kit theme.
+ * It should be namespaced within this variable under the `canvas` key.
+ * Value of `canvas` property is any partial or full theme object to overwtite default theme.
+ *
+ * @returns An object containing updated or default Canvas Kit theme under `canvas` key.
+ *
+ * The passed partial theme object will be merged with the default Canvas theme
+ * (using memoized createCanvasTheme()) to establish any missing fields that have
+ * not been defined by the consumer's theme object.
+ *
+ * If theme is not passed, the function will try to retrieve it from the window object.
+ * If window theme is not found, it will return the default Canvas theme.
+ *
+ * @example
+ * import {getTheme} from '@workday/canvas-kit-react/common';
+ *
+ * const theme = getTheme();
+ * const {up, down} = theme.canvas.breakpoints;
+ * const small = down('m'); // Returns '@media (max-width: 768px)'
+ * const medium = up('m'); // Returns '@media (min-width: 768px)'
+ *
+ * const styles = {
+ *  [small]: {
+ *    margin: space.m
+ *  },
+ *  [medium]: {
+ *    margin: space.l
+ *  }
+ * }
+ */
+function getTheme(theme) {
+    var _a, _b, _c;
+    if (theme === null || theme === void 0 ? void 0 : theme.canvas) {
+        return getFilledTheme(theme);
+    }
+    const windowTheme = typeof window !== 'undefined' && ((_c = (_b = (_a = window) === null || _a === void 0 ? void 0 : _a.workday) === null || _b === void 0 ? void 0 : _b.canvas) === null || _c === void 0 ? void 0 : _c.theme);
+    if (windowTheme) {
+        return getFilledTheme({ canvas: windowTheme });
+    }
+    return { canvas: index_1.defaultCanvasTheme };
+}
+exports.getTheme = getTheme;
 /**
- * Hook function to get the correct theme object.
- * @param {Object=} theme - The theme object returned from the emotion ThemeContext
- * (through ThemeProvider). The Canvas Kit theme is namespaced within this variable under the `canvas` key.
+ * Hook function to get the correct theme object for functional components.
+ * @param {Object=} theme - The theme object with the Canvas Kit theme.
+ * It should be namespaced within this variable under the `canvas` key.
+ * Value of `canvas` property is any partial or full theme object to overwtite default theme.
  *
- * NOTE: If you are using a class component, you MUST pass the theme.
- * If not passed, the function will try to pull the theme from ThemeContext.
+ * @returns An object containing updated or default Canvas Kit theme under `canvas` key.
+ *
+ * NOTE: If theme is not passed, the function will try to pull the theme from ThemeContext.
  * If that does not work, it will try to retrieve it from the window object.
  * As a last resort, it will return the default Canvas theme.
  *
@@ -32,26 +73,30 @@ var getFilledTheme = function (theme) { return (__assign(__assign({}, theme), {
  * Providing the default theme here is currently a work around for when no
  * ThemeProvider or context exists.
  * Tracked on https://github.com/emotion-js/emotion/issues/1193.
+ *
+ * @example
+ * export const ErrorMessage = () => {
+ *  const theme = useTheme();
+ *  return (
+ *    <Subtext size="large" color={theme.canvas.palette.error.main}>
+ *  );
+ * }
  */
 function useTheme(theme) {
-    var _a, _b, _c;
-    if (theme && theme.canvas) {
-        return getFilledTheme(theme);
-    }
-    try {
-        // eslint-disable-next-line react-hooks/rules-of-hooks
-        var contextTheme = react_1.useTheme();
-        if (contextTheme && contextTheme.canvas) {
-            return getFilledTheme(contextTheme);
+    if (!theme) {
+        try {
+            // eslint-disable-next-line react-hooks/rules-of-hooks
+            const contextTheme = react_1.useTheme();
+            if (contextTheme === null || contextTheme === void 0 ? void 0 : contextTheme.canvas) {
+                return getFilledTheme(contextTheme);
+            }
+        }
+        catch (e) {
+            if (process && process.env.NODE_ENV === 'development') {
+                console.warn('useTheme: Context not supported or invalid. Please consider using `getTheme` function instead for `styled` or class components.');
+            }
         }
     }
-    catch (e) {
-        // Context not supported or invalid (probably called from within a class component)
-    }
-    var windowTheme = typeof window !== 'undefined' && ((_c = (_b = (_a = window) === null || _a === void 0 ? void 0 : _a.workday) === null || _b === void 0 ? void 0 : _b.canvas) === null || _c === void 0 ? void 0 : _c.theme);
-    if (windowTheme) {
-        return getFilledTheme({ canvas: windowTheme });
-    }
-    return { canvas: index_1.defaultCanvasTheme };
+    return getTheme(theme);
 }
 exports.useTheme = useTheme;

package/dist/commonjs/common/lib/theming/useThemedRing.d.ts

@@ -0,0 +1,43 @@
+import { EmotionCanvasTheme } from '@workday/canvas-kit-react/common';
+import { CSSProperties } from '@workday/canvas-kit-react/tokens';
+declare type paletteSelection = Exclude<keyof EmotionCanvasTheme['canvas']['palette'], 'common'>;
+interface ContrastColors {
+    outer?: string;
+    inner?: string;
+}
+export declare function getPaletteColorsForFocusRing(type: paletteSelection, theme: EmotionCanvasTheme): ContrastColors;
+/**
+ * This is a way to automatically add themed colors to your input and is helpful when showing alerts, success or errors to users.
+ * It supports `error`, `alert`, and `success` states. It will try and use the corresponding
+ * `main` colors from your `CanvasThemePalette` unless they do not meet accessibility contrast, in
+ * which case the outer ring will use the `darkest` color. This hook will also show a `focusOutline`
+ * ring when the input is focused. Note: You should not rely on these colors alone to differentiate
+ * alerts, but use them in combination with icons or hint text.
+ * ```tsx
+ * // Add here jsx pragma to use css
+ * import {jsx} from '@emotion/core';
+ * import React from 'react';
+ * import {TextInput} from '@workday/canvas-kit-preview-react/text-input';
+ * import {useThemedRing} from '@workday/canvas-kit-react/common';
+ *
+ * export const MyInput = ({handleChange}) => {
+ *  const [value, setValue] = React.useState('invalid@email');
+ *  const handleChange = (event: React.ChangeEvent<HTMLInputElement>) => {
+ *    setValue(event.target.value);
+ *  };
+ *
+ *  const alertStyles = useThemedRing('alert');
+ *
+ *  return (
+ *    <TextInput>
+ *     <TextInput.Label>Email</TextInput.Label>
+ *      <TextInput.Field css={alertStyles} onChange={handleChange} value={value} />
+ *      <TextInput.Hint>Please enter a valid email.</TextInput.Hint>
+ *    </TextInput>
+ *  );
+ * };
+ *```
+ */
+export declare const useThemedRing: (type: paletteSelection) => CSSProperties;
+export {};
+//# sourceMappingURL=useThemedRing.d.ts.map

package/dist/commonjs/common/lib/theming/useThemedRing.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useThemedRing.d.ts","sourceRoot":"","sources":["../../../../../common/lib/theming/useThemedRing.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqB,kBAAkB,EAAW,MAAM,kCAAkC,CAAC;AAClG,OAAO,EAAS,aAAa,EAA4B,MAAM,kCAAkC,CAAC;AAIlG,aAAK,gBAAgB,GAAG,OAAO,CAAC,MAAM,kBAAkB,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,EAAE,QAAQ,CAAC,CAAC;AACzF,UAAU,cAAc;IACtB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAoBD,wBAAgB,4BAA4B,CAC1C,IAAI,EAAE,gBAAgB,EACtB,KAAK,EAAE,kBAAkB,GACxB,cAAc,CAsBhB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,eAAO,MAAM,aAAa,SAAU,gBAAgB,KAAG,aAyBtD,CAAC"}