@workday/canvas-kit-docs 10.1.3 → 10.2.0-628-next.0

package/dist/es6/lib/docs.js

@@ -248471,6 +248471,359 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
       }
     }
   },
+  {
+    "name": "calc",
+    "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/calc.ts",
+    "description": "",
+    "declarations": [
+      {
+        "name": "calc",
+        "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/calc.ts"
+      }
+    ],
+    "tags": {},
+    "type": {
+      "kind": "object",
+      "properties": [
+        {
+          "kind": "property",
+          "name": "add",
+          "type": {
+            "kind": "function",
+            "parameters": [
+              {
+                "kind": "parameter",
+                "name": "augend",
+                "type": {
+                  "kind": "primitive",
+                  "value": "string"
+                },
+                "required": true,
+                "rest": false,
+                "description": "The base value. E.g. '1rem' or '--cnvs-sys-space-x4'",
+                "declarations": [
+                  {
+                    "name": "augend",
+                    "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/calc.ts"
+                  }
+                ],
+                "tags": {
+                  "param": "augend The base value. E.g. '1rem' or '--cnvs-sys-space-x4'"
+                }
+              },
+              {
+                "kind": "parameter",
+                "name": "addend",
+                "type": {
+                  "kind": "primitive",
+                  "value": "string"
+                },
+                "required": true,
+                "rest": false,
+                "description": "The value being added to the base. E.g. '1rem' or '--cnvs-sys-space-x4'",
+                "declarations": [
+                  {
+                    "name": "addend",
+                    "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/calc.ts"
+                  }
+                ],
+                "tags": {
+                  "param": "addend The value being added to the base. E.g. '1rem' or '--cnvs-sys-space-x4'"
+                }
+              }
+            ],
+            "members": [],
+            "returnType": {
+              "kind": "primitive",
+              "value": "string"
+            }
+          },
+          "description": "",
+          "declarations": [
+            {
+              "name": "add",
+              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/calc.ts"
+            }
+          ],
+          "tags": {}
+        },
+        {
+          "kind": "property",
+          "name": "divide",
+          "type": {
+            "kind": "function",
+            "parameters": [
+              {
+                "kind": "parameter",
+                "name": "dividend",
+                "type": {
+                  "kind": "primitive",
+                  "value": "string"
+                },
+                "required": true,
+                "rest": false,
+                "description": "The base value being divided.  E.g. '1rem' or '--cnvs-sys-space-x1'",
+                "declarations": [
+                  {
+                    "name": "dividend",
+                    "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/calc.ts"
+                  }
+                ],
+                "tags": {
+                  "param": "dividend The base value being divided.  E.g. '1rem' or '--cnvs-sys-space-x1'"
+                }
+              },
+              {
+                "kind": "parameter",
+                "name": "divisor",
+                "defaultValue": {
+                  "kind": "number",
+                  "value": 1
+                },
+                "type": {
+                  "kind": "union",
+                  "value": [
+                    {
+                      "kind": "primitive",
+                      "value": "string"
+                    },
+                    {
+                      "kind": "primitive",
+                      "value": "number"
+                    }
+                  ]
+                },
+                "required": false,
+                "rest": false,
+                "description": "The divisor of the base value. E.g. 2 or '--cnvs-sys-space-x1'",
+                "declarations": [
+                  {
+                    "name": "divisor",
+                    "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/calc.ts"
+                  }
+                ],
+                "tags": {
+                  "param": "divisor The divisor of the base value. E.g. 2 or '--cnvs-sys-space-x1'"
+                }
+              }
+            ],
+            "members": [],
+            "returnType": {
+              "kind": "primitive",
+              "value": "string"
+            }
+          },
+          "description": "",
+          "declarations": [
+            {
+              "name": "divide",
+              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/calc.ts"
+            }
+          ],
+          "tags": {}
+        },
+        {
+          "kind": "property",
+          "name": "multiply",
+          "type": {
+            "kind": "function",
+            "parameters": [
+              {
+                "kind": "parameter",
+                "name": "multiplicand",
+                "type": {
+                  "kind": "primitive",
+                  "value": "string"
+                },
+                "required": true,
+                "rest": false,
+                "description": "The base value being multiplied. E.g. '1rem' or '--cnvs-sys-space-x1'",
+                "declarations": [
+                  {
+                    "name": "multiplicand",
+                    "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/calc.ts"
+                  }
+                ],
+                "tags": {
+                  "param": "multiplicand The base value being multiplied. E.g. '1rem' or '--cnvs-sys-space-x1'"
+                }
+              },
+              {
+                "kind": "parameter",
+                "name": "multiplier",
+                "defaultValue": {
+                  "kind": "number",
+                  "value": 1
+                },
+                "type": {
+                  "kind": "union",
+                  "value": [
+                    {
+                      "kind": "primitive",
+                      "value": "string"
+                    },
+                    {
+                      "kind": "primitive",
+                      "value": "number"
+                    }
+                  ]
+                },
+                "required": false,
+                "rest": false,
+                "description": "The value being multiplied to the base. E.g. 2 or '--cnvs-sys-space-x1'",
+                "declarations": [
+                  {
+                    "name": "multiplier",
+                    "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/calc.ts"
+                  }
+                ],
+                "tags": {
+                  "param": "multiplier The value being multiplied to the base. E.g. 2 or '--cnvs-sys-space-x1'"
+                }
+              }
+            ],
+            "members": [],
+            "returnType": {
+              "kind": "primitive",
+              "value": "string"
+            }
+          },
+          "description": "",
+          "declarations": [
+            {
+              "name": "multiply",
+              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/calc.ts"
+            }
+          ],
+          "tags": {}
+        },
+        {
+          "kind": "property",
+          "name": "negate",
+          "type": {
+            "kind": "function",
+            "parameters": [
+              {
+                "kind": "parameter",
+                "name": "value",
+                "type": {
+                  "kind": "primitive",
+                  "value": "string"
+                },
+                "required": true,
+                "rest": false,
+                "description": "The value being negated. E.g. '--cnvs-sys-space-x1' or '1rem'",
+                "declarations": [
+                  {
+                    "name": "value",
+                    "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/calc.ts"
+                  }
+                ],
+                "tags": {
+                  "param": "value The value being negated. E.g. '--cnvs-sys-space-x1' or '1rem'"
+                }
+              },
+              {
+                "kind": "parameter",
+                "name": "fallback",
+                "type": {
+                  "kind": "primitive",
+                  "value": "string"
+                },
+                "required": false,
+                "rest": false,
+                "description": "An optional fallback value for a CSS variable. E.g. '1rem'",
+                "declarations": [
+                  {
+                    "name": "fallback",
+                    "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/calc.ts"
+                  }
+                ],
+                "tags": {
+                  "param": "fallback An optional fallback value for a CSS variable. E.g. '1rem'"
+                }
+              }
+            ],
+            "members": [],
+            "returnType": {
+              "kind": "primitive",
+              "value": "string"
+            }
+          },
+          "description": "",
+          "declarations": [
+            {
+              "name": "negate",
+              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/calc.ts"
+            }
+          ],
+          "tags": {}
+        },
+        {
+          "kind": "property",
+          "name": "subtract",
+          "type": {
+            "kind": "function",
+            "parameters": [
+              {
+                "kind": "parameter",
+                "name": "minuend",
+                "type": {
+                  "kind": "primitive",
+                  "value": "string"
+                },
+                "required": true,
+                "rest": false,
+                "description": "The base value. E.g. '1rem' or '--cnvs-sys-space-x4'",
+                "declarations": [
+                  {
+                    "name": "minuend",
+                    "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/calc.ts"
+                  }
+                ],
+                "tags": {
+                  "param": "minuend The base value. E.g. '1rem' or '--cnvs-sys-space-x4'"
+                }
+              },
+              {
+                "kind": "parameter",
+                "name": "subtrahend",
+                "type": {
+                  "kind": "primitive",
+                  "value": "string"
+                },
+                "required": true,
+                "rest": false,
+                "description": "The value being subtracted from the base. E.g. '1rem' or '--cnvs-sys-space-x4'",
+                "declarations": [
+                  {
+                    "name": "subtrahend",
+                    "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/calc.ts"
+                  }
+                ],
+                "tags": {
+                  "param": "subtrahend The value being subtracted from the base. E.g. '1rem' or '--cnvs-sys-space-x4'"
+                }
+              }
+            ],
+            "members": [],
+            "returnType": {
+              "kind": "primitive",
+              "value": "string"
+            }
+          },
+          "description": "",
+          "declarations": [
+            {
+              "name": "subtract",
+              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/calc.ts"
+            }
+          ],
+          "tags": {}
+        }
+      ]
+    }
+  },
   {
     "name": "createStylesCache",
     "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/cs.ts",
@@ -251018,6 +251371,70 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
       }
     }
   },
+  {
+    "name": "px2rem",
+    "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/px2rem.ts",
+    "description": "Function that converts a `px` value (number) to `rem` (string).",
+    "declarations": [
+      {
+        "name": "px2rem",
+        "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/px2rem.ts"
+      }
+    ],
+    "tags": {
+      "example": "```ts\nmargin: px2rem(2);\n// returns '0.125rem'\n```"
+    },
+    "type": {
+      "kind": "function",
+      "parameters": [
+        {
+          "kind": "parameter",
+          "name": "px",
+          "type": {
+            "kind": "primitive",
+            "value": "number"
+          },
+          "required": true,
+          "rest": false,
+          "description": "",
+          "declarations": [
+            {
+              "name": "px",
+              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/px2rem.ts"
+            }
+          ],
+          "tags": {}
+        },
+        {
+          "kind": "parameter",
+          "name": "base",
+          "defaultValue": {
+            "kind": "number",
+            "value": 16
+          },
+          "type": {
+            "kind": "primitive",
+            "value": "number"
+          },
+          "required": false,
+          "rest": false,
+          "description": "",
+          "declarations": [
+            {
+              "name": "base",
+              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/px2rem.ts"
+            }
+          ],
+          "tags": {}
+        }
+      ],
+      "members": [],
+      "returnType": {
+        "kind": "primitive",
+        "value": "string"
+      }
+    }
+  },
   {
     "name": "slugify",
     "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/slugify.ts",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@workday/canvas-kit-docs",
-  "version": "10.1.3",
+  "version": "10.2.0-628-next.0",
   "description": "Documentation components of Canvas Kit components",
   "author": "Workday, Inc. (https://www.workday.com)",
   "license": "Apache-2.0",
@@ -44,10 +44,10 @@
   "dependencies": {
     "@emotion/styled": "^11.6.0",
     "@storybook/csf": "0.0.1",
-    "@workday/canvas-kit-labs-react": "^10.1.3",
-    "@workday/canvas-kit-preview-react": "^10.1.3",
-    "@workday/canvas-kit-react": "^10.1.3",
-    "@workday/canvas-kit-styling": "^10.1.3",
+    "@workday/canvas-kit-labs-react": "^10.2.0-628-next.0",
+    "@workday/canvas-kit-preview-react": "^10.2.0-628-next.0",
+    "@workday/canvas-kit-react": "^10.2.0-628-next.0",
+    "@workday/canvas-kit-styling": "^10.2.0-628-next.0",
     "@workday/canvas-system-icons-web": "^3.0.0",
     "@workday/canvas-tokens-web": "^1.0.0",
     "markdown-to-jsx": "^6.10.3",
@@ -59,5 +59,5 @@
     "mkdirp": "^1.0.3",
     "typescript": "4.2"
   },
-  "gitHead": "2936b4918f4df739c86417d45700bbde98130fe9"
+  "gitHead": "e87d2573a126d186bd1e45e3eedef40a9e0dcc4f"
 }