@workday/canvas-kit-docs
Version:
Documentation components of Canvas Kit components
1,546 lines (1,545 loc) • 16 MB
JavaScript
import React from 'react';
export const GithubUrl = React.createContext('https://github.com/Workday/canvas-kit/');
export const GithubBranch = React.createContext('master');
export const StorybookUrl = React.createContext(typeof location !== 'undefined' && location.pathname.indexOf('/canvas-kit/') === 0
? '/canvas-kit/'
: '/');
export const docs = (typeof window !== 'undefined' && window.__docs) ||
[
{
"name": "AIIngressButtonProps",
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/ai-ingress-button/lib/AIIngressButton.tsx",
"description": "",
"declarations": [
{
"name": "AIIngressButtonProps",
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/ai-ingress-button/lib/AIIngressButton.tsx"
}
],
"tags": {},
"type": {
"kind": "alias",
"name": "AIIngressButton"
}
},
{
"name": "CanvasColorTokens",
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/layout/lib/utils/background.ts",
"description": "",
"tags": {},
"declarations": [],
"type": {
"kind": "canvasColor"
}
},
{
"name": "AIIngressButtonStencil",
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/ai-ingress-button/lib/AIIngressButton.tsx",
"description": "",
"declarations": [
{
"name": "AIIngressButtonStencil",
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/ai-ingress-button/lib/AIIngressButton.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"
}
]
},
{
"kind": "intersection",
"value": [
{
"kind": "symbol",
"name": "VE",
"value": "VE"
},
{
"kind": "symbol",
"name": "V",
"value": "V"
}
]
}
],
"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": "AIIngressButton",
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/ai-ingress-button/lib/AIIngressButton.tsx",
"description": "",
"declarations": [
{
"name": "AIIngressButton",
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/ai-ingress-button/lib/AIIngressButton.tsx"
}
],
"tags": {},
"type": {
"kind": "enhancedComponent",
"componentType": "regular",
"displayName": "AIIngressButton",
"props": [
{
"kind": "property",
"name": "toggled",
"required": false,
"type": {
"kind": "primitive",
"value": "boolean"
},
"description": "When true, indicates that the AI Ingress button is toggled.",
"declarations": [
{
"name": "toggled",
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/ai-ingress-button/lib/AIIngressButton.tsx"
}
],
"tags": {}
},
{
"kind": "property",
"name": "variant",
"required": false,
"type": {
"kind": "string",
"value": "inverse"
},
"description": "Used on dark backgrounds.",
"declarations": [
{
"name": "variant",
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/ai-ingress-button/lib/AIIngressButton.tsx"
}
],
"tags": {}
},
{
"kind": "property",
"name": "fill",
"required": false,
"type": {
"kind": "primitive",
"value": "string"
},
"description": "The fill color of the SystemIcon. This overrides `color`.",
"declarations": [
{
"name": "fill",
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/icon/lib/SystemIcon.tsx"
}
],
"tags": {
"deprecated": "`fill` is deprecated and will be removed in a future version. Please use `color` and specify `accent` color if you want `accent` to be different from `color`."
}
},
{
"kind": "property",
"name": "background",
"required": false,
"type": {
"kind": "primitive",
"value": "string"
},
"description": "The background color of the SystemIcon.",
"declarations": [
{
"name": "background",
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/icon/lib/SystemIcon.tsx"
}
],
"tags": {
"default": "transparent"
},
"defaultValue": {
"kind": "symbol",
"name": "transparent",
"value": "transparent"
}
},
{
"kind": "property",
"name": "color",
"required": false,
"type": {
"kind": "primitive",
"value": "string"
},
"description": "The color of the SystemIcon. This defines `accent` and `fill`. `color` may be overwritten by `accent` and `fill`.",
"declarations": [
{
"name": "color",
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/icon/lib/SystemIcon.tsx"
}
],
"tags": {
"default": "base.licorice200"
},
"defaultValue": {
"kind": "symbol",
"name": "base.licorice200",
"value": "base.licorice200"
}
},
{
"kind": "property",
"name": "shouldMirror",
"required": false,
"type": {
"kind": "primitive",
"value": "boolean"
},
"description": "If set to `true`, transform the SVG's x-axis to mirror the graphic. Use this if you want to\nalways mirror the icon regardless of the content direction. If the SVG should mirror only when\nin an right-to-left language, use `shouldMirrorInRTL` instead.",
"declarations": [
{
"name": "shouldMirror",
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/icon/lib/Svg.tsx"
}
],
"tags": {
"default": "false"
},
"defaultValue": {
"kind": "boolean",
"value": false
}
},
{
"kind": "property",
"name": "shouldMirrorInRTL",
"required": false,
"type": {
"kind": "primitive",
"value": "boolean"
},
"description": "If set to `true`, transform the SVG's x-axis to mirror the graphic when the content direction\nis `rtl`. Icons don't have enough context to know if they should be mirrored in all cases.\nSetting this to `true` indicates the icon should be mirrored in right-to-left languages.",
"declarations": [
{
"name": "shouldMirrorInRTL",
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/icon/lib/Svg.tsx"
}
],
"tags": {
"default": "false"
},
"defaultValue": {
"kind": "boolean",
"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",
"required": false,
"type": {
"kind": "external",
"name": "ReactNode",
"url": "https://reactjs.org/docs/rendering-elements.html"
},
"description": "",
"declarations": [
{
"name": "children",
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/button/lib/BaseButton.tsx"
}
],
"tags": {}
},
{
"kind": "property",
"name": "accent",
"required": false,
"type": {
"kind": "primitive",
"value": "string"
},
"description": "The accent color of the SystemIcon. This overrides `color`.",
"declarations": [
{
"name": "accent",
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/icon/lib/SystemIcon.tsx"
}
],
"tags": {}
},
{
"kind": "property",
"name": "accentHover",
"required": false,
"type": {
"kind": "primitive",
"value": "string"
},
"description": "The accent color of the SystemIcon on hover. This overrides `colorHover`.",
"declarations": [
{
"name": "accentHover",
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/icon/lib/SystemIcon.tsx"
}
],
"tags": {
"deprecated": "`accentHover` is deprecated and will be removed in a future version. Please use the following instead in your style overrides:\n```tsx\n'&:hover': {\n[systemIconStencil.vars.accent]: desiredAccentHoverColor\n}\n```"
}
},
{
"kind": "property",
"name": "backgroundHover",
"required": false,
"type": {
"kind": "primitive",
"value": "string"
},
"description": "The background color of the SystemIcon on hover.",
"declarations": [
{
"name": "backgroundHover",
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/icon/lib/SystemIcon.tsx"
}
],
"tags": {
"default": "transparent",
"deprecated": "`backgroundHover` is deprecated and will be removed in a future version. Please use the following instead in your style overrides:\n```tsx\n'&:hover': {\n[systemIconStencil.vars.background]: desiredBackgroundHoverColor\n}\n```"
},
"defaultValue": {
"kind": "symbol",
"name": "transparent",
"value": "transparent"
}
},
{
"kind": "property",
"name": "colorHover",
"required": false,
"type": {
"kind": "primitive",
"value": "string"
},
"description": "The hover color of the SystemIcon. This defines `accentHover` and `fillHover`. `colorHover` may be overwritten by `accentHover` and `fillHover`.",
"declarations": [
{
"name": "colorHover",
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/icon/lib/SystemIcon.tsx"
}
],
"tags": {
"default": "base.licorice200",
"deprecated": "`colorHover` is deprecated and will be removed in a future version. We have removed the default hover styles on SystemIcon. Please\nuse the following instead in your style overrides:\n```tsx\n'&:hover': {\n[systemIconStencil.vars.color]: desiredColorHoverColor\n}\n```"
},
"defaultValue": {
"kind": "symbol",
"name": "base.licorice200",
"value": "base.licorice200"
}
},
{
"kind": "property",
"name": "fillHover",
"required": false,
"type": {
"kind": "primitive",
"value": "string"
},
"description": "The fill color of the SystemIcon on hover. This overrides `colorHover`.",
"declarations": [
{
"name": "fillHover",
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/icon/lib/SystemIcon.tsx"
}
],
"tags": {
"deprecated": "`fillHover` is deprecated and will be removed in a future version. Please use the following instead in your style overrides:\n```tsx\n'&:hover': {\n[systemIconStencil.vars.fill]: desiredFillHoverColor\n}\n```"
}
},
{
"kind": "property",
"name": "fillIcon",
"required": false,
"type": {
"kind": "primitive",
"value": "boolean"
},
"description": "Whether the icon should received filled (colored background layer) or regular styles.\nCorresponds to `toggled` in ToolbarIconButton",
"declarations": [
{
"name": "fillIcon",
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/button/lib/BaseButton.tsx"
}
],
"tags": {}
},
{
"kind": "property",
"name": "grow",
"required": false,
"type": {
"kind": "primitive",
"value": "boolean"
},
"description": "True if the component should grow to its container's width. False otherwise.",
"declarations": [
{
"name": "grow",
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/types.ts"
}
],
"tags": {}
},
{
"kind": "property",
"name": "as",
"description": "Optional override of the default element used by the component. Any valid tag or Component. If you provided a Component, this component should forward the ref using `React.forwardRef`and spread extra props to a root element.\n\n**Note:** Not all elements make sense and some elements may cause accessibility issues. Change this value with care.",
"tags": {},
"declarations": [],
"type": {
"kind": "external",
"name": "React.ElementType",
"url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
},
"defaultValue": {
"kind": "external",
"name": "button",
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button"
}
},
{
"kind": "property",
"name": "ref",
"description": "Optional ref. If the component represents an element, this ref will be a reference to the real DOM element of the component. If `as` is set to an element, it will be that element. If `as` is a component, the reference will be to that component (or element if the component uses `React.forwardRef`).",
"tags": {},
"declarations": [],
"type": {
"kind": "external",
"name": "React.Ref",
"url": "https://reactjs.org/docs/refs-and-the-dom.html",
"typeParameters": [
{
"kind": "typeParameter",
"name": "R",
"required": true,
"defaultValue": {
"kind": "external",
"name": "button",
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button"
}
}
]
}
}
],
"baseElement": {
"kind": "external",
"name": "button",
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button"
},
"styleComponent": {
"kind": "symbol",
"name": "Box"
}
}
},
{
"name": "getAIIngressIcon",
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/ai-ingress-button/lib/AIIngressIcon.tsx",
"description": "",
"declarations": [
{
"name": "getAIIngressIcon",
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/ai-ingress-button/lib/AIIngressIcon.tsx"
}
],
"tags": {},
"type": {
"kind": "function",
"parameters": [
{
"kind": "parameter",
"name": "svgId",
"type": {
"kind": "primitive",
"value": "string"
},
"required": true,
"rest": false,
"description": "",
"declarations": [
{
"name": "svgId",
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/ai-ingress-button/lib/AIIngressIcon.tsx"
}
],
"tags": {}
}
],
"members": [],
"returnType": {
"kind": "symbol",
"name": "CanvasSystemIcon",
"value": "CanvasSystemIcon"
}
}
},
{
"name": "AutocompleteList",
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/AutocompleteList.tsx",
"description": "",
"declarations": [
{
"name": "AutocompleteList",
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/AutocompleteList.tsx"
}
],
"tags": {
"deprecated": "⚠️ `AutocompleteList` in Labs has been deprecated and will be removed in a future major version. Please use [`Combobox` in Main](https://workday.github.io/canvas-kit/?path=/docs/features-combobox--docs) instead."
},
"type": {
"kind": "component",
"props": [
{
"kind": "property",
"name": "autocompleteItems",
"required": true,
"type": {
"kind": "union",
"value": [
{
"kind": "array",
"value": {
"kind": "external",
"name": "ReactElement",
"url": "https://reactjs.org/docs/rendering-elements.html",
"typeParameters": [
{
"kind": "primitive",
"value": "any"
}
]
}
},
{
"kind": "array",
"value": {
"kind": "symbol",
"name": "ComboBoxMenuItemGroup",
"value": "ComboBoxMenuItemGroup"
}
}
]
},
"description": "The autocomplete items of the Combobox. This array of menu items is shown under the text input.",
"declarations": [
{
"name": "autocompleteItems",
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/AutocompleteList.tsx"
}
],
"tags": {}
},
{
"kind": "property",
"name": "selectedIndex",
"required": true,
"type": {
"kind": "union",
"value": [
{
"kind": "primitive",
"value": "number"
},
{
"kind": "primitive",
"value": "null"
}
]
},
"description": "Index of the active autocomplete item",
"declarations": [
{
"name": "selectedIndex",
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/AutocompleteList.tsx"
}
],
"tags": {}
},
{
"kind": "property",
"name": "handleAutocompleteClick",
"required": true,
"type": {
"kind": "function",
"parameters": [
{
"kind": "parameter",
"name": "event",
"type": {
"kind": "external",
"name": "SyntheticEvent",
"url": "https://reactjs.org/docs/events.html",
"typeParameters": [
{
"kind": "external",
"name": "Element",
"url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
},
{
"kind": "external",
"name": "Event",
"url": "https://developer.mozilla.org/en-US/docs/Web/API/event"
}
]
},
"required": true,
"rest": false,
"description": "",
"declarations": [
{
"name": "event",
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/AutocompleteList.tsx"
}
],
"tags": {}
},
{
"kind": "parameter",
"name": "menuItemProps",
"type": {
"kind": "primitive",
"value": "any"
},
"required": true,
"rest": false,
"description": "",
"declarations": [
{
"name": "menuItemProps",
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/AutocompleteList.tsx"
}
],
"tags": {}
}
],
"members": [],
"returnType": {
"kind": "primitive",
"value": "void"
}
},
"description": "The function called when an autocomplete item is selected",
"declarations": [
{
"name": "handleAutocompleteClick",
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/AutocompleteList.tsx"
}
],
"tags": {}
},
{
"kind": "property",
"name": "labelId",
"required": true,
"type": {
"kind": "primitive",
"value": "string"
},
"description": "The id of the form field.",
"declarations": [
{
"name": "labelId",
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/AutocompleteList.tsx"
}
],
"tags": {}
},
{
"kind": "property",
"name": "comboboxId",
"required": true,
"type": {
"kind": "primitive",
"value": "string"
},
"description": "The id of the combobox.",
"declarations": [
{
"name": "comboboxId",
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/AutocompleteList.tsx"
}
],
"tags": {}
},
{
"kind": "property",
"name": "showGroupText",
"required": true,
"type": {
"kind": "primitive",
"value": "boolean"
},
"description": "True when group changes via keyboard control",
"declarations": [
{
"name": "showGroupText",
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/AutocompleteList.tsx"
}
],
"tags": {}
}
]
}
},
{
"name": "ComboBoxMenuItemGroup",
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/Combobox.tsx",
"description": "",
"declarations": [
{
"name": "ComboBoxMenuItemGroup",
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/Combobox.tsx"
}
],
"tags": {
"deprecated": "⚠️ `ComboBoxMenuItemGroup` in Labs has been deprecated and will be removed in a future major version. Please use [`Combobox` in Main](https://workday.github.io/canvas-kit/?path=/docs/features-combobox--docs) instead."
},
"type": {
"kind": "object",
"properties": [
{
"kind": "property",
"name": "header",
"required": true,
"type": {
"kind": "external",
"name": "ReactElement",
"url": "https://reactjs.org/docs/rendering-elements.html",
"typeParameters": [
{
"kind": "primitive",
"value": "any"
}
]
},
"description": "",
"declarations": [
{
"name": "header",
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/Combobox.tsx"
}
],
"tags": {}
},
{
"kind": "property",
"name": "items",
"required": true,
"type": {
"kind": "array",
"value": {
"kind": "external",
"name": "ReactElement",
"url": "https://reactjs.org/docs/rendering-elements.html",
"typeParameters": [
{
"kind": "primitive",
"value": "any"
}
]
}
},
"description": "",
"declarations": [
{
"name": "items",
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/Combobox.tsx"
}
],
"tags": {}
}
]
}
},
{
"name": "ComboboxProps",
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/Combobox.tsx",
"description": "",
"declarations": [
{
"name": "ComboboxProps",
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/Combobox.tsx"
}
],
"tags": {
"deprecated": "⚠️ `ComboboxProps` in Labs has been deprecated and will be removed in a future major version. Please use [`Combobox` in Main](https://workday.github.io/canvas-kit/?path=/docs/features-combobox--docs) instead."
},
"type": {
"kind": "alias",
"name": "Combobox"
}
},
{
"name": "listBoxIdPart",
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/Combobox.tsx",
"description": "",
"declarations": [
{
"name": "listBoxIdPart",
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/Combobox.tsx"
}
],
"tags": {
"deprecated": "⚠️ `listBoxIdPart` in Labs has been deprecated and will be removed in a future major version. Please use [`Combobox` in Main](https://workday.github.io/canvas-kit/?path=/docs/features-combobox--docs) instead."
},
"type": {
"kind": "string",
"value": "listbox"
}
},
{
"name": "getOptionId",
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/Combobox.tsx",
"description": "",
"declarations": [
{
"name": "getOptionId",
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/Combobox.tsx"
}
],
"tags": {
"deprecated": "⚠️ `getOptionId` in Labs has been deprecated and will be removed in a future major version. Please use [`Combobox` in Main](https://workday.github.io/canvas-kit/?path=/docs/features-combobox--docs) instead."
},
"type": {
"kind": "function",
"parameters": [
{
"kind": "parameter",
"name": "baseId",
"type": {
"kind": "primitive",
"value": "string"
},
"required": false,
"rest": false,
"description": "",
"declarations": [
{
"name": "baseId",
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/Combobox.tsx"
}
],
"tags": {}
},
{
"kind": "parameter",
"name": "index",
"type": {
"kind": "primitive",
"value": "number"
},
"required": false,
"rest": false,
"description": "",
"declarations": [
{
"name": "index",
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/Combobox.tsx"
}
],
"tags": {}
}
],
"members": [],
"returnType": {
"kind": "primitive",
"value": "string"
}
}
},
{