@workday/canvas-kit-docs 9.0.0-alpha.348-next.3 → 9.0.0-alpha.352-next.0

package/dist/es6/lib/docs.js

@@ -93856,47 +93856,6 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
       }
     }
   },
-  {
-    "name": "memoizedFocusRing",
-    "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/styles/focusRing.ts",
-    "description": "",
-    "declarations": [
-      {
-        "name": "memoizedFocusRing",
-        "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/styles/focusRing.ts"
-      }
-    ],
-    "tags": {},
-    "type": {
-      "kind": "intersection",
-      "value": [
-        {
-          "kind": "parenthesis",
-          "value": {
-            "kind": "function",
-            "parameters": [
-              {
-                "kind": "unknown",
-                "value": "unknown",
-                "text": "???"
-              }
-            ],
-            "members": [],
-            "returnType": {
-              "kind": "external",
-              "name": "CSSObject",
-              "url": "https://emotion.sh/docs/object-styles"
-            }
-          }
-        },
-        {
-          "kind": "symbol",
-          "name": "MemoizedFunction",
-          "value": "any"
-        }
-      ]
-    }
-  },
   {
     "name": "focusRing",
     "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/styles/focusRing.ts",
@@ -94033,23 +93992,6 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
                   }
                 ],
                 "tags": {}
-              },
-              {
-                "kind": "property",
-                "name": "memoize",
-                "required": false,
-                "type": {
-                  "kind": "primitive",
-                  "value": "boolean"
-                },
-                "description": "",
-                "declarations": [
-                  {
-                    "name": "memoize",
-                    "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/styles/focusRing.ts"
-                  }
-                ],
-                "tags": {}
               }
             ]
           },
@@ -94652,41 +94594,6 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
       }
     }
   },
-  {
-    "name": "ColorDirection",
-    "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/createCanvasTheme.ts",
-    "description": "",
-    "declarations": [
-      {
-        "name": "ColorDirection",
-        "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/createCanvasTheme.ts"
-      }
-    ],
-    "tags": {},
-    "type": {
-      "kind": "object",
-      "typeParameters": [],
-      "properties": [
-        {
-          "kind": "property",
-          "name": "Darken",
-          "type": {
-            "kind": "number",
-            "value": 0
-          }
-        },
-        {
-          "kind": "property",
-          "name": "Brighten",
-          "type": {
-            "kind": "number",
-            "value": 1
-          }
-        }
-      ],
-      "callSignatures": []
-    }
-  },
   {
     "name": "shiftColor",
     "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/createCanvasTheme.ts",
@@ -94721,18 +94628,21 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
         },
         {
           "kind": "parameter",
-          "name": "direction",
+          "name": "amount",
+          "defaultValue": {
+            "kind": "number",
+            "value": 100
+          },
           "type": {
-            "kind": "symbol",
-            "name": "ColorDirection",
-            "value": "ColorDirection"
+            "kind": "primitive",
+            "value": "any"
           },
-          "required": true,
+          "required": false,
           "rest": false,
           "description": "",
           "declarations": [
             {
-              "name": "direction",
+              "name": "amount",
               "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/createCanvasTheme.ts"
             }
           ],
@@ -94749,7 +94659,7 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
   {
     "name": "createCanvasTheme",
     "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/createCanvasTheme.ts",
-    "description": "",
+    "description": "Creates a full {@link CanvasTheme} from any partial theme by deeply merging with the\n`defaultCanvasTheme` object. The function is memoized, but it is best to run this function\nonly once and save the result.",
     "declarations": [
       {
         "name": "createCanvasTheme",
@@ -94758,47 +94668,34 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
     ],
     "tags": {},
     "type": {
-      "kind": "intersection",
-      "value": [
+      "kind": "function",
+      "parameters": [
         {
-          "kind": "parenthesis",
-          "value": {
-            "kind": "function",
-            "parameters": [
-              {
-                "kind": "parameter",
-                "name": "partialTheme",
-                "type": {
-                  "kind": "symbol",
-                  "name": "PartialCanvasTheme",
-                  "value": "RecursivePartial<CanvasTheme>"
-                },
-                "required": true,
-                "rest": false,
-                "description": "",
-                "declarations": [
-                  {
-                    "name": "partialTheme",
-                    "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/createCanvasTheme.ts"
-                  }
-                ],
-                "tags": {}
-              }
-            ],
-            "members": [],
-            "returnType": {
-              "kind": "symbol",
-              "name": "CanvasTheme",
-              "value": "any"
+          "kind": "parameter",
+          "name": "partialTheme",
+          "type": {
+            "kind": "symbol",
+            "name": "PartialCanvasTheme",
+            "value": "RecursivePartial<CanvasTheme>"
+          },
+          "required": true,
+          "rest": false,
+          "description": "",
+          "declarations": [
+            {
+              "name": "partialTheme",
+              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/createCanvasTheme.ts"
             }
-          }
-        },
-        {
-          "kind": "symbol",
-          "name": "MemoizedFunction",
-          "value": "any"
+          ],
+          "tags": {}
         }
-      ]
+      ],
+      "members": [],
+      "returnType": {
+        "kind": "symbol",
+        "name": "CanvasTheme",
+        "value": "CanvasTheme"
+      }
     }
   },
   {
@@ -94894,6 +94791,33 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
       }
     }
   },
+  {
+    "name": "RecursivePartial",
+    "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/getObjectProxy.ts",
+    "description": "For custom themes that do not overwrite every default.",
+    "declarations": [
+      {
+        "name": "RecursivePartial",
+        "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/getObjectProxy.ts"
+      }
+    ],
+    "tags": {},
+    "type": {
+      "kind": "type",
+      "typeParameters": [
+        {
+          "kind": "typeParameter",
+          "name": "T",
+          "required": true
+        }
+      ],
+      "value": {
+        "kind": "unknown",
+        "value": "unknown",
+        "text": "{\n  [P in keyof T]?: RecursivePartial<T[P]>;\n}"
+      }
+    }
+  },
   {
     "name": "getObjectProxy",
     "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/getObjectProxy.ts",
@@ -94905,7 +94829,7 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
       }
     ],
     "tags": {
-      "param": "target Any custom theme object\nfallback A fallback theme object"
+      "param": "target A partial object with up to the same shape as the `fallback` object\nfallback A fallback object. If a property to be accessed from the proxy is not available on the target object, the fallback object will be used"
     },
     "type": {
       "kind": "function",
@@ -94925,12 +94849,28 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
           "kind": "parameter",
           "name": "target",
           "type": {
-            "kind": "primitive",
-            "value": "unknown"
+            "kind": "union",
+            "value": [
+              {
+                "kind": "symbol",
+                "name": "RecursivePartial",
+                "typeParameters": [
+                  {
+                    "kind": "generic",
+                    "name": "T"
+                  }
+                ],
+                "value": "RecursivePartial<T>"
+              },
+              {
+                "kind": "primitive",
+                "value": "undefined"
+              }
+            ]
           },
-          "required": true,
+          "required": false,
           "rest": false,
-          "description": "Any custom theme object",
+          "description": "A partial object with up to the same shape as the `fallback` object",
           "declarations": [
             {
               "name": "target",
@@ -94938,7 +94878,7 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
             }
           ],
           "tags": {
-            "param": "target Any custom theme object"
+            "param": "target A partial object with up to the same shape as the `fallback` object"
           }
         },
         {
@@ -94950,7 +94890,7 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
           },
           "required": true,
           "rest": false,
-          "description": "A fallback theme object",
+          "description": "A fallback object. If a property to be accessed from the proxy is not available on the target object, the fallback object will be used",
           "declarations": [
             {
               "name": "fallback",
@@ -94958,7 +94898,7 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
             }
           ],
           "tags": {
-            "param": "fallback A fallback theme object"
+            "param": "fallback A fallback object. If a property to be accessed from the proxy is not available on the target object, the fallback object will be used"
           }
         }
       ],
@@ -102791,6 +102731,85 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
       }
     }
   },
+  {
+    "name": "deepMerge",
+    "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/deepMerge.ts",
+    "description": "",
+    "declarations": [
+      {
+        "name": "deepMerge",
+        "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/deepMerge.ts"
+      }
+    ],
+    "tags": {},
+    "type": {
+      "kind": "function",
+      "typeParameters": [
+        {
+          "kind": "typeParameter",
+          "name": "T",
+          "required": true
+        },
+        {
+          "kind": "typeParameter",
+          "name": "S",
+          "required": true
+        }
+      ],
+      "parameters": [
+        {
+          "kind": "parameter",
+          "name": "target",
+          "type": {
+            "kind": "generic",
+            "name": "T"
+          },
+          "required": true,
+          "rest": false,
+          "description": "",
+          "declarations": [
+            {
+              "name": "target",
+              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/deepMerge.ts"
+            }
+          ],
+          "tags": {}
+        },
+        {
+          "kind": "parameter",
+          "name": "source",
+          "type": {
+            "kind": "generic",
+            "name": "S"
+          },
+          "required": true,
+          "rest": false,
+          "description": "",
+          "declarations": [
+            {
+              "name": "source",
+              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/deepMerge.ts"
+            }
+          ],
+          "tags": {}
+        }
+      ],
+      "members": [],
+      "returnType": {
+        "kind": "intersection",
+        "value": [
+          {
+            "kind": "generic",
+            "name": "T"
+          },
+          {
+            "kind": "generic",
+            "name": "S"
+          }
+        ]
+      }
+    }
+  },
   {
     "name": "isFocusable",
     "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/elements.ts",
@@ -103176,6 +103195,130 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
       }
     }
   },
+  {
+    "name": "memoize",
+    "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/memoize.ts",
+    "description": "Simple memoize function. It takes a function and a resolver function to generate a\ncache key",
+    "declarations": [
+      {
+        "name": "memoize",
+        "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/memoize.ts"
+      }
+    ],
+    "tags": {},
+    "type": {
+      "kind": "function",
+      "typeParameters": [
+        {
+          "kind": "typeParameter",
+          "name": "T",
+          "constraint": {
+            "kind": "function",
+            "parameters": [
+              {
+                "kind": "parameter",
+                "name": "args",
+                "type": {
+                  "kind": "primitive",
+                  "value": "any"
+                },
+                "required": true,
+                "rest": true,
+                "description": "",
+                "declarations": [
+                  {
+                    "name": "args",
+                    "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/memoize.ts"
+                  }
+                ],
+                "tags": {}
+              }
+            ],
+            "members": [],
+            "returnType": {
+              "kind": "primitive",
+              "value": "any"
+            }
+          },
+          "required": true
+        }
+      ],
+      "parameters": [
+        {
+          "kind": "parameter",
+          "name": "func",
+          "type": {
+            "kind": "generic",
+            "name": "T"
+          },
+          "required": true,
+          "rest": false,
+          "description": "",
+          "declarations": [
+            {
+              "name": "func",
+              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/memoize.ts"
+            }
+          ],
+          "tags": {}
+        },
+        {
+          "kind": "parameter",
+          "name": "resolver",
+          "type": {
+            "kind": "function",
+            "parameters": [
+              {
+                "kind": "parameter",
+                "name": "args",
+                "type": {
+                  "kind": "symbol",
+                  "name": "Parameters",
+                  "typeParameters": [
+                    {
+                      "kind": "generic",
+                      "name": "T"
+                    }
+                  ],
+                  "value": "Parameters<T>"
+                },
+                "required": true,
+                "rest": true,
+                "description": "",
+                "declarations": [
+                  {
+                    "name": "args",
+                    "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/memoize.ts"
+                  }
+                ],
+                "tags": {}
+              }
+            ],
+            "members": [],
+            "returnType": {
+              "kind": "primitive",
+              "value": "string"
+            }
+          },
+          "required": true,
+          "rest": false,
+          "description": "",
+          "declarations": [
+            {
+              "name": "resolver",
+              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/memoize.ts"
+            }
+          ],
+          "tags": {}
+        }
+      ],
+      "members": [],
+      "returnType": {
+        "kind": "generic",
+        "name": "T"
+      }
+    }
+  },
   {
     "name": "mergeCallback",
     "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/mergeCallback.ts",

package/dist/mdx/9.0-UPGRADE-GUIDE.mdx

@@ -10,6 +10,8 @@ any questions.
   - [Layout and Column](#layout-and-column) - [Stack](#stack-hstack-vstack)
 - [Component Updates](#component-updates)
   - [Buttons](#buttons)
+- [Utility Updates](#utility-updates)
+  - [focusRing](#focusring)
 
 ## Codemod
 
@@ -105,4 +107,12 @@ This change affects all of our `buttons` including:
 `PrimaryButton, SecondaryButton, TertiaryButton, ToolbarButton`.
 
 If you still wish for a specific `button` within a `form` to submit, just add the attribute
-`type="submit"`.
+`type="submit"`.
+
+## Utility Updates
+
+### focusRing
+
+We're removing memoization from focus ring. The `memoize` argument passed to `focusRing` is no
+longer valid and we've removed the exported `memoizedFocusRing`. There is no codemod for this
+change. We couldn't find any example of `memoize` or `memoizedFocusRing` being used.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@workday/canvas-kit-docs",
-  "version": "9.0.0-alpha.348-next.3+62cb7fef",
+  "version": "9.0.0-alpha.352-next.0+22b093b2",
   "description": "Documentation components of Canvas Kit components",
   "author": "Workday, Inc. (https://www.workday.com)",
   "license": "Apache-2.0",
@@ -44,9 +44,9 @@
   "dependencies": {
     "@emotion/styled": "^11.6.0",
     "@storybook/csf": "0.0.1",
-    "@workday/canvas-kit-labs-react": "^9.0.0-alpha.348-next.3+62cb7fef",
-    "@workday/canvas-kit-preview-react": "^9.0.0-alpha.348-next.3+62cb7fef",
-    "@workday/canvas-kit-react": "^9.0.0-alpha.348-next.3+62cb7fef",
+    "@workday/canvas-kit-labs-react": "^9.0.0-alpha.352-next.0+22b093b2",
+    "@workday/canvas-kit-preview-react": "^9.0.0-alpha.352-next.0+22b093b2",
+    "@workday/canvas-kit-react": "^9.0.0-alpha.352-next.0+22b093b2",
     "@workday/canvas-system-icons-web": "^3.0.0",
     "markdown-to-jsx": "^6.10.3",
     "ts-node": "^10.9.1"
@@ -57,5 +57,5 @@
     "mkdirp": "^1.0.3",
     "typescript": "4.2"
   },
-  "gitHead": "62cb7fefb41fcc2ba937163d06d22deb7bf77203"
+  "gitHead": "22b093b2d82ae29c9f2083034010d99b171b97c5"
 }