@workday/canvas-kit-docs 14.0.0-alpha.1135-next.0 → 14.0.0-alpha.1144-next.0

package/dist/es6/lib/docs.js

@@ -216353,7 +216353,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
       }
     ],
     "tags": {
-      "deprecated": "Interface `AccentIconStyles` will be removed in a future version. All props will be moved inside `AccentIconProps`. Consider to use the new tokens set to set `color` prop: `color={base.blueberry500}`."
+      "deprecated": "Interface `AccentIconStyles` will be removed in a future version. All props will be moved inside `AccentIconProps`. Consider use the new tokens set to set `color` prop: `color={system.color.bg.primary.strong}`."
     },
     "type": {
       "kind": "object",
@@ -216374,7 +216374,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
             }
           ],
           "tags": {
-            "default": "base.blueberry500"
+            "default": "system.color.bg.primary.strong"
           }
         },
         {
@@ -216385,7 +216385,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
             "kind": "primitive",
             "value": "boolean"
           },
-          "description": "If true, set the background fill of the AccentIcon to `transparent`.\nIf false, set the background fill of the AccentIcon to `base.frenchVanilla100`.",
+          "description": "If true, set the background fill of the AccentIcon to `transparent`.\nIf false, set the background fill of the AccentIcon to `system.color.bg.alt.soft`.",
           "declarations": [
             {
               "name": "transparent",
@@ -217221,12 +217221,12 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
             }
           ],
           "tags": {
-            "default": "base.blueberry500"
+            "default": "system.color.bg.primary.strong"
           },
           "defaultValue": {
             "kind": "symbol",
-            "name": "base.blueberry500",
-            "value": "base.blueberry500"
+            "name": "system.color.bg.primary.strong",
+            "value": "system.color.bg.primary.strong"
           }
         },
         {
@@ -217237,7 +217237,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
             "kind": "primitive",
             "value": "boolean"
           },
-          "description": "If true, set the background fill of the AccentIcon to `transparent`.\nIf false, set the background fill of the AccentIcon to `base.frenchVanilla100`.",
+          "description": "If true, set the background fill of the AccentIcon to `transparent`.\nIf false, set the background fill of the AccentIcon to `system.color.bg.alt.soft`.",
           "declarations": [
             {
               "name": "transparent",
@@ -222493,6 +222493,695 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
       "name": "SystemIconCircle"
     }
   },
+  {
+    "name": "systemIconCircleStencil",
+    "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/icon/lib/SystemIconCircle.tsx",
+    "description": "",
+    "declarations": [
+      {
+        "name": "systemIconCircleStencil",
+        "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/icon/lib/SystemIconCircle.tsx"
+      }
+    ],
+    "tags": {},
+    "type": {
+      "kind": "function",
+      "parameters": [
+        {
+          "kind": "parameter",
+          "name": "options",
+          "type": {
+            "kind": "conditional",
+            "check": {
+              "kind": "tuple",
+              "value": [
+                {
+                  "kind": "symbol",
+                  "name": "E",
+                  "value": "E"
+                }
+              ]
+            },
+            "extends": {
+              "kind": "tuple",
+              "value": [
+                {
+                  "kind": "primitive",
+                  "value": "never"
+                }
+              ]
+            },
+            "trueType": {
+              "kind": "intersection",
+              "value": [
+                {
+                  "kind": "symbol",
+                  "name": "ModifierValuesStencil",
+                  "typeParameters": [
+                    {
+                      "kind": "symbol",
+                      "name": "M",
+                      "value": "M"
+                    },
+                    {
+                      "kind": "symbol",
+                      "name": "V",
+                      "value": "V"
+                    }
+                  ],
+                  "value": "ModifierValuesStencil<M, V>"
+                },
+                {
+                  "kind": "symbol",
+                  "name": "VariableValuesStencil",
+                  "typeParameters": [
+                    {
+                      "kind": "symbol",
+                      "name": "V",
+                      "value": "V"
+                    }
+                  ],
+                  "value": "VariableValuesStencil<V>"
+                }
+              ]
+            },
+            "falseType": {
+              "kind": "conditional",
+              "check": {
+                "kind": "symbol",
+                "name": "E",
+                "value": "E"
+              },
+              "extends": {
+                "kind": "symbol",
+                "name": "BaseStencil",
+                "typeParameters": [
+                  {
+                    "kind": "infer",
+                    "value": {
+                      "kind": "typeParameter",
+                      "name": "ME",
+                      "required": true
+                    }
+                  },
+                  {
+                    "kind": "primitive",
+                    "value": "any"
+                  },
+                  {
+                    "kind": "infer",
+                    "value": {
+                      "kind": "typeParameter",
+                      "name": "VE",
+                      "required": true
+                    }
+                  },
+                  {
+                    "kind": "primitive",
+                    "value": "any"
+                  },
+                  {
+                    "kind": "primitive",
+                    "value": "any"
+                  }
+                ],
+                "value": "BaseStencil<M, P, V, E, ID>"
+              },
+              "trueType": {
+                "kind": "intersection",
+                "value": [
+                  {
+                    "kind": "symbol",
+                    "name": "ModifierValuesStencil",
+                    "typeParameters": [
+                      {
+                        "kind": "intersection",
+                        "value": [
+                          {
+                            "kind": "symbol",
+                            "name": "ME",
+                            "value": "ME"
+                          },
+                          {
+                            "kind": "symbol",
+                            "name": "M",
+                            "value": "M"
+                          }
+                        ]
+                      }
+                    ],
+                    "value": "ModifierValuesStencil<M, V>"
+                  },
+                  {
+                    "kind": "symbol",
+                    "name": "VariableValuesStencil",
+                    "typeParameters": [
+                      {
+                        "kind": "intersection",
+                        "value": [
+                          {
+                            "kind": "symbol",
+                            "name": "VE",
+                            "value": "VE"
+                          },
+                          {
+                            "kind": "symbol",
+                            "name": "V",
+                            "value": "V"
+                          }
+                        ]
+                      }
+                    ],
+                    "value": "VariableValuesStencil<V>"
+                  }
+                ]
+              },
+              "falseType": {
+                "kind": "primitive",
+                "value": "never"
+              }
+            }
+          },
+          "required": false,
+          "rest": false,
+          "description": "",
+          "declarations": [
+            {
+              "name": "options",
+              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
+            }
+          ],
+          "tags": {}
+        }
+      ],
+      "members": [
+        {
+          "kind": "property",
+          "name": "parts",
+          "required": true,
+          "type": {
+            "kind": "conditional",
+            "check": {
+              "kind": "tuple",
+              "value": [
+                {
+                  "kind": "symbol",
+                  "name": "E",
+                  "value": "E"
+                }
+              ]
+            },
+            "extends": {
+              "kind": "tuple",
+              "value": [
+                {
+                  "kind": "symbol",
+                  "name": "BaseStencil",
+                  "typeParameters": [
+                    {
+                      "kind": "primitive",
+                      "value": "any"
+                    },
+                    {
+                      "kind": "infer",
+                      "value": {
+                        "kind": "typeParameter",
+                        "name": "PE",
+                        "required": true
+                      }
+                    },
+                    {
+                      "kind": "primitive",
+                      "value": "any"
+                    },
+                    {
+                      "kind": "primitive",
+                      "value": "any"
+                    },
+                    {
+                      "kind": "primitive",
+                      "value": "any"
+                    }
+                  ],
+                  "value": "BaseStencil<M, P, V, E, ID>"
+                }
+              ]
+            },
+            "trueType": {
+              "kind": "symbol",
+              "name": "StencilPartProps",
+              "typeParameters": [
+                {
+                  "kind": "intersection",
+                  "value": [
+                    {
+                      "kind": "symbol",
+                      "name": "PE",
+                      "value": "PE"
+                    },
+                    {
+                      "kind": "symbol",
+                      "name": "P",
+                      "value": "P"
+                    }
+                  ]
+                }
+              ],
+              "value": "StencilPartProps<T>"
+            },
+            "falseType": {
+              "kind": "symbol",
+              "name": "StencilPartProps",
+              "typeParameters": [
+                {
+                  "kind": "symbol",
+                  "name": "P",
+                  "value": "P"
+                }
+              ],
+              "value": "StencilPartProps<T>"
+            }
+          },
+          "description": "",
+          "declarations": [
+            {
+              "name": "parts",
+              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
+            }
+          ],
+          "tags": {}
+        },
+        {
+          "kind": "property",
+          "name": "vars",
+          "required": true,
+          "type": {
+            "kind": "symbol",
+            "name": "StencilDefaultVars",
+            "typeParameters": [
+              {
+                "kind": "symbol",
+                "name": "V",
+                "value": "V"
+              },
+              {
+                "kind": "symbol",
+                "name": "E",
+                "value": "E"
+              },
+              {
+                "kind": "symbol",
+                "name": "ID",
+                "value": "ID"
+              }
+            ],
+            "value": "StencilDefaultVars<V, E, ID>"
+          },
+          "description": "",
+          "declarations": [
+            {
+              "name": "vars",
+              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
+            }
+          ],
+          "tags": {}
+        },
+        {
+          "kind": "property",
+          "name": "base",
+          "required": true,
+          "type": {
+            "kind": "primitive",
+            "value": "string"
+          },
+          "description": "",
+          "declarations": [
+            {
+              "name": "base",
+              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
+            }
+          ],
+          "tags": {}
+        },
+        {
+          "kind": "property",
+          "name": "modifiers",
+          "required": true,
+          "type": {
+            "kind": "conditional",
+            "check": {
+              "kind": "tuple",
+              "value": [
+                {
+                  "kind": "symbol",
+                  "name": "E",
+                  "value": "E"
+                }
+              ]
+            },
+            "extends": {
+              "kind": "tuple",
+              "value": [
+                {
+                  "kind": "symbol",
+                  "name": "BaseStencil",
+                  "typeParameters": [
+                    {
+                      "kind": "infer",
+                      "value": {
+                        "kind": "typeParameter",
+                        "name": "ME",
+                        "required": true
+                      }
+                    },
+                    {
+                      "kind": "primitive",
+                      "value": "any"
+                    },
+                    {
+                      "kind": "infer",
+                      "value": {
+                        "kind": "typeParameter",
+                        "name": "VE",
+                        "required": true
+                      }
+                    },
+                    {
+                      "kind": "primitive",
+                      "value": "any"
+                    },
+                    {
+                      "kind": "primitive",
+                      "value": "any"
+                    }
+                  ],
+                  "value": "BaseStencil<M, P, V, E, ID>"
+                }
+              ]
+            },
+            "trueType": {
+              "kind": "symbol",
+              "name": "StencilModifierReturn",
+              "typeParameters": [
+                {
+                  "kind": "intersection",
+                  "value": [
+                    {
+                      "kind": "symbol",
+                      "name": "ME",
+                      "value": "ME"
+                    },
+                    {
+                      "kind": "symbol",
+                      "name": "M",
+                      "value": "M"
+                    }
+                  ]
+                },
+                {
+                  "kind": "intersection",
+                  "value": [
+                    {
+                      "kind": "symbol",
+                      "name": "VE",
+                      "value": "VE"
+                    },
+                    {
+                      "kind": "symbol",
+                      "name": "V",
+                      "value": "V"
+                    }
+                  ]
+                }
+              ],
+              "value": "StencilModifierReturn<M, V>"
+            },
+            "falseType": {
+              "kind": "symbol",
+              "name": "StencilModifierReturn",
+              "typeParameters": [
+                {
+                  "kind": "symbol",
+                  "name": "M",
+                  "value": "M"
+                },
+                {
+                  "kind": "symbol",
+                  "name": "V",
+                  "value": "V"
+                }
+              ],
+              "value": "StencilModifierReturn<M, V>"
+            }
+          },
+          "description": "",
+          "declarations": [
+            {
+              "name": "modifiers",
+              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
+            }
+          ],
+          "tags": {}
+        },
+        {
+          "kind": "property",
+          "name": "defaultModifiers",
+          "required": true,
+          "type": {
+            "kind": "conditional",
+            "check": {
+              "kind": "tuple",
+              "value": [
+                {
+                  "kind": "symbol",
+                  "name": "E",
+                  "value": "E"
+                }
+              ]
+            },
+            "extends": {
+              "kind": "tuple",
+              "value": [
+                {
+                  "kind": "symbol",
+                  "name": "BaseStencil",
+                  "typeParameters": [
+                    {
+                      "kind": "infer",
+                      "value": {
+                        "kind": "typeParameter",
+                        "name": "ME",
+                        "required": true
+                      }
+                    },
+                    {
+                      "kind": "primitive",
+                      "value": "any"
+                    },
+                    {
+                      "kind": "primitive",
+                      "value": "any"
+                    },
+                    {
+                      "kind": "primitive",
+                      "value": "any"
+                    },
+                    {
+                      "kind": "primitive",
+                      "value": "any"
+                    }
+                  ],
+                  "value": "BaseStencil<M, P, V, E, ID>"
+                }
+              ]
+            },
+            "trueType": {
+              "kind": "symbol",
+              "name": "StencilDefaultModifierReturn",
+              "typeParameters": [
+                {
+                  "kind": "intersection",
+                  "value": [
+                    {
+                      "kind": "symbol",
+                      "name": "ME",
+                      "value": "ME"
+                    },
+                    {
+                      "kind": "symbol",
+                      "name": "M",
+                      "value": "M"
+                    }
+                  ]
+                }
+              ],
+              "value": "StencilDefaultModifierReturn<M>"
+            },
+            "falseType": {
+              "kind": "symbol",
+              "name": "StencilDefaultModifierReturn",
+              "typeParameters": [
+                {
+                  "kind": "symbol",
+                  "name": "M",
+                  "value": "M"
+                }
+              ],
+              "value": "StencilDefaultModifierReturn<M>"
+            }
+          },
+          "description": "",
+          "declarations": [
+            {
+              "name": "defaultModifiers",
+              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
+            }
+          ],
+          "tags": {}
+        },
+        {
+          "kind": "property",
+          "name": "__extends",
+          "required": false,
+          "type": {
+            "kind": "symbol",
+            "name": "E",
+            "value": "E"
+          },
+          "description": "",
+          "declarations": [
+            {
+              "name": "__extends",
+              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
+            }
+          ],
+          "tags": {}
+        },
+        {
+          "kind": "property",
+          "name": "__vars",
+          "required": true,
+          "type": {
+            "kind": "symbol",
+            "name": "V",
+            "value": "V"
+          },
+          "description": "",
+          "declarations": [
+            {
+              "name": "__vars",
+              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
+            }
+          ],
+          "tags": {}
+        },
+        {
+          "kind": "property",
+          "name": "__modifiers",
+          "required": true,
+          "type": {
+            "kind": "symbol",
+            "name": "M",
+            "value": "M"
+          },
+          "description": "",
+          "declarations": [
+            {
+              "name": "__modifiers",
+              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
+            }
+          ],
+          "tags": {}
+        },
+        {
+          "kind": "property",
+          "name": "__id",
+          "required": true,
+          "type": {
+            "kind": "symbol",
+            "name": "ID",
+            "value": "ID"
+          },
+          "description": "",
+          "declarations": [
+            {
+              "name": "__id",
+              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
+            }
+          ],
+          "tags": {}
+        },
+        {
+          "kind": "property",
+          "name": "__parts",
+          "required": false,
+          "type": {
+            "kind": "symbol",
+            "name": "P",
+            "value": "P"
+          },
+          "description": "",
+          "declarations": [
+            {
+              "name": "__parts",
+              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
+            }
+          ],
+          "tags": {}
+        }
+      ],
+      "returnType": {
+        "kind": "object",
+        "properties": [
+          {
+            "kind": "property",
+            "name": "className",
+            "required": true,
+            "type": {
+              "kind": "primitive",
+              "value": "string"
+            },
+            "description": "",
+            "declarations": [
+              {
+                "name": "className",
+                "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
+              }
+            ],
+            "tags": {}
+          },
+          {
+            "kind": "property",
+            "name": "style",
+            "required": false,
+            "type": {
+              "kind": "external",
+              "name": "Record",
+              "url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
+              "typeParameters": [
+                {
+                  "kind": "primitive",
+                  "value": "string"
+                },
+                {
+                  "kind": "primitive",
+                  "value": "string"
+                }
+              ]
+            },
+            "description": "",
+            "declarations": [
+              {
+                "name": "style",
+                "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
+              }
+            ],
+            "tags": {}
+          }
+        ]
+      }
+    }
+  },
   {
     "name": "SystemIconCircle",
     "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/icon/lib/SystemIconCircle.tsx",
@@ -222517,7 +223206,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
             "kind": "primitive",
             "value": "string"
           },
-          "description": "The background color of the SystemIconCircle from `@workday/canvas-colors-web`.",
+          "description": "The background color of the SystemIconCircle",
           "declarations": [
             {
               "name": "background",
@@ -222533,6 +223222,30 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
             "value": "base.soap300"
           }
         },
+        {
+          "kind": "property",
+          "name": "color",
+          "required": false,
+          "type": {
+            "kind": "primitive",
+            "value": "string"
+          },
+          "description": "The icon color for the SystemIconCircle. Required if background specified as a CSS variable.\nIf not specified, it will be calculated based on the background color.",
+          "declarations": [
+            {
+              "name": "color",
+              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/icon/lib/SystemIconCircle.tsx"
+            }
+          ],
+          "tags": {
+            "default": "rgba(0,0,0,0.65)"
+          },
+          "defaultValue": {
+            "kind": "symbol",
+            "name": "rgba(0,0,0,0.65)",
+            "value": "rgba(0,0,0,0.65)"
+          }
+        },
         {
           "kind": "property",
           "name": "icon",
@@ -222585,24 +223298,6 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
             "value": "SystemIconCircleSize.l"
           }
         },
-        {
-          "kind": "property",
-          "name": "cs",
-          "required": false,
-          "type": {
-            "kind": "symbol",
-            "name": "CSToPropsInput",
-            "value": "CSToPropsInput"
-          },
-          "description": "The `cs` prop takes in a single value or an array of values. You can pass the CSS class name\nreturned by {@link createStyles}, or the result of {@link createVars} and\n{@link createModifiers}. If you're extending a component already using `cs`, you can merge that\nprop in as well. Any style that is passed to the `cs` prop will override style props. If you\nwish to have styles that are overridden by the `css` prop, or styles added via the `styled`\nAPI, use {@link handleCsProp} wherever `elemProps` is used. If your component needs to also\nhandle style props, use {@link mergeStyles } instead.\n\n\n```tsx\nimport {handleCsProp} from '@workday/canvas-kit-styling';\nimport {mergeStyles} from '@workday/canvas-kit-react/layout';\n\n// ...\n\n// `handleCsProp` handles compat mode with Emotion's runtime APIs. `mergeStyles` has the same\n// function signature, but adds support for style props.\n\nreturn (\n <Element\n   {...handleCsProp(elemProps, [\n     myStyles,\n     myModifiers({ size: 'medium' }),\n     myVars({ backgroundColor: 'red' })\n   ])}\n >\n   {children}\n </Element>\n)\n```",
-          "declarations": [
-            {
-              "name": "cs",
-              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
-            }
-          ],
-          "tags": {}
-        },
         {
           "kind": "property",
           "name": "shouldMirror",
@@ -222615,7 +223310,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
           "declarations": [
             {
               "name": "shouldMirror",
-              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/icon/lib/Svg.tsx"
+              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/icon/lib/SystemIconCircle.tsx"
             }
           ],
           "tags": {
@@ -222626,6 +223321,24 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
             "value": false
           }
         },
+        {
+          "kind": "property",
+          "name": "cs",
+          "required": false,
+          "type": {
+            "kind": "symbol",
+            "name": "CSToPropsInput",
+            "value": "CSToPropsInput"
+          },
+          "description": "The `cs` prop takes in a single value or an array of values. You can pass the CSS class name\nreturned by {@link createStyles}, or the result of {@link createVars} and\n{@link createModifiers}. If you're extending a component already using `cs`, you can merge that\nprop in as well. Any style that is passed to the `cs` prop will override style props. If you\nwish to have styles that are overridden by the `css` prop, or styles added via the `styled`\nAPI, use {@link handleCsProp} wherever `elemProps` is used. If your component needs to also\nhandle style props, use {@link mergeStyles } instead.\n\n\n```tsx\nimport {handleCsProp} from '@workday/canvas-kit-styling';\nimport {mergeStyles} from '@workday/canvas-kit-react/layout';\n\n// ...\n\n// `handleCsProp` handles compat mode with Emotion's runtime APIs. `mergeStyles` has the same\n// function signature, but adds support for style props.\n\nreturn (\n <Element\n   {...handleCsProp(elemProps, [\n     myStyles,\n     myModifiers({ size: 'medium' }),\n     myVars({ backgroundColor: 'red' })\n   ])}\n >\n   {children}\n </Element>\n)\n```",
+          "declarations": [
+            {
+              "name": "cs",
+              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
+            }
+          ],
+          "tags": {}
+        },
         {
           "kind": "property",
           "name": "children",