@workday/canvas-kit-docs 12.0.0-alpha.846-next.0 → 12.0.0-alpha.855-next.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -4692,7 +4692,27 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
4692
4692
  "required": false,
4693
4693
  "type": {
4694
4694
  "kind": "function",
4695
- "parameters": [],
4695
+ "parameters": [
4696
+ {
4697
+ "kind": "parameter",
4698
+ "name": "element",
4699
+ "type": {
4700
+ "kind": "symbol",
4701
+ "name": "HTMLElement",
4702
+ "value": "HTMLElement"
4703
+ },
4704
+ "required": false,
4705
+ "rest": false,
4706
+ "description": "",
4707
+ "declarations": [
4708
+ {
4709
+ "name": "element",
4710
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/popup-stack/lib/PopupStack.ts"
4711
+ }
4712
+ ],
4713
+ "tags": {}
4714
+ }
4715
+ ],
4696
4716
  "members": [],
4697
4717
  "returnType": {
4698
4718
  "kind": "symbol",
@@ -4700,7 +4720,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
4700
4720
  "value": "HTMLElement"
4701
4721
  }
4702
4722
  },
4703
- "description": "",
4723
+ "description": "Returns the container of a stack given an optional element.",
4704
4724
  "declarations": [
4705
4725
  {
4706
4726
  "name": "container",
@@ -98501,24 +98521,6 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
98501
98521
  ],
98502
98522
  "tags": {}
98503
98523
  },
98504
- {
98505
- "kind": "property",
98506
- "name": "theme",
98507
- "required": false,
98508
- "type": {
98509
- "kind": "symbol",
98510
- "name": "EmotionCanvasTheme",
98511
- "value": "EmotionCanvasTheme"
98512
- },
98513
- "description": "",
98514
- "declarations": [
98515
- {
98516
- "name": "theme",
98517
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/types.ts"
98518
- }
98519
- ],
98520
- "tags": {}
98521
- },
98522
98524
  {
98523
98525
  "kind": "property",
98524
98526
  "name": "grow",
@@ -99115,24 +99117,6 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
99115
99117
  ],
99116
99118
  "tags": {}
99117
99119
  },
99118
- {
99119
- "kind": "property",
99120
- "name": "theme",
99121
- "required": false,
99122
- "type": {
99123
- "kind": "symbol",
99124
- "name": "EmotionCanvasTheme",
99125
- "value": "EmotionCanvasTheme"
99126
- },
99127
- "description": "",
99128
- "declarations": [
99129
- {
99130
- "name": "theme",
99131
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/types.ts"
99132
- }
99133
- ],
99134
- "tags": {}
99135
- },
99136
99120
  {
99137
99121
  "kind": "property",
99138
99122
  "name": "grow",
@@ -179672,24 +179656,6 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
179672
179656
  "value": 55
179673
179657
  }
179674
179658
  },
179675
- {
179676
- "kind": "property",
179677
- "name": "theme",
179678
- "required": false,
179679
- "type": {
179680
- "kind": "symbol",
179681
- "name": "EmotionCanvasTheme",
179682
- "value": "EmotionCanvasTheme"
179683
- },
179684
- "description": "",
179685
- "declarations": [
179686
- {
179687
- "name": "theme",
179688
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/types.ts"
179689
- }
179690
- ],
179691
- "tags": {}
179692
- },
179693
179659
  {
179694
179660
  "kind": "property",
179695
179661
  "name": "grow",
@@ -207744,39 +207710,164 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
207744
207710
  },
207745
207711
  {
207746
207712
  "kind": "property",
207747
- "name": "theme",
207713
+ "name": "grow",
207748
207714
  "required": false,
207749
207715
  "type": {
207750
- "kind": "symbol",
207751
- "name": "EmotionCanvasTheme",
207752
- "value": "EmotionCanvasTheme"
207716
+ "kind": "primitive",
207717
+ "value": "boolean"
207753
207718
  },
207754
- "description": "",
207719
+ "description": "True if the component should grow to its container's width. False otherwise.",
207755
207720
  "declarations": [
207756
207721
  {
207757
- "name": "theme",
207758
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/types.ts"
207722
+ "name": "grow",
207723
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/types.ts"
207759
207724
  }
207760
207725
  ],
207761
207726
  "tags": {}
207762
207727
  },
207763
207728
  {
207764
207729
  "kind": "property",
207765
- "name": "grow",
207730
+ "name": "cs",
207766
207731
  "required": false,
207767
207732
  "type": {
207768
- "kind": "primitive",
207769
- "value": "boolean"
207733
+ "kind": "symbol",
207734
+ "name": "CSToPropsInput",
207735
+ "value": "CSToPropsInput"
207770
207736
  },
207771
- "description": "True if the component should grow to its container's width. False otherwise.",
207737
+ "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```",
207772
207738
  "declarations": [
207773
207739
  {
207774
- "name": "grow",
207775
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/types.ts"
207740
+ "name": "cs",
207741
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
207776
207742
  }
207777
207743
  ],
207778
207744
  "tags": {}
207779
207745
  },
207746
+ {
207747
+ "kind": "property",
207748
+ "name": "children",
207749
+ "description": "",
207750
+ "tags": {},
207751
+ "declarations": [],
207752
+ "type": {
207753
+ "kind": "external",
207754
+ "name": "React.ReactNode",
207755
+ "url": "https://reactjs.org/docs/rendering-elements.html"
207756
+ }
207757
+ },
207758
+ {
207759
+ "kind": "property",
207760
+ "name": "as",
207761
+ "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.",
207762
+ "tags": {},
207763
+ "declarations": [],
207764
+ "type": {
207765
+ "kind": "external",
207766
+ "name": "React.ElementType",
207767
+ "url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
207768
+ },
207769
+ "defaultValue": {
207770
+ "kind": "symbol",
207771
+ "name": "TextInput"
207772
+ }
207773
+ },
207774
+ {
207775
+ "kind": "property",
207776
+ "name": "ref",
207777
+ "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`).",
207778
+ "tags": {},
207779
+ "declarations": [],
207780
+ "type": {
207781
+ "kind": "external",
207782
+ "name": "React.Ref",
207783
+ "url": "https://reactjs.org/docs/refs-and-the-dom.html",
207784
+ "typeParameters": [
207785
+ {
207786
+ "kind": "typeParameter",
207787
+ "name": "R",
207788
+ "required": true,
207789
+ "defaultValue": {
207790
+ "kind": "symbol",
207791
+ "name": "TextInput"
207792
+ }
207793
+ }
207794
+ ]
207795
+ }
207796
+ },
207797
+ {
207798
+ "kind": "property",
207799
+ "name": "model",
207800
+ "description": "Optional model to pass to the component. This will override the default model created for the component. This can be useful if you want to access to the state and events of the model, or if you have nested components of the same type and you need to override the model provided by React Context.",
207801
+ "tags": {},
207802
+ "declarations": [],
207803
+ "type": {
207804
+ "kind": "symbol",
207805
+ "name": "SelectModel"
207806
+ }
207807
+ },
207808
+ {
207809
+ "kind": "property",
207810
+ "name": "elemPropsHook",
207811
+ "description": "Optional hook that receives the model and all props to be applied to the element. If you use this, it is your responsibility to return props, merging as appropriate. For example, returning an empty object will disable all elemProps hooks associated with this component. This allows finer control over a component without creating a new one.",
207812
+ "tags": {},
207813
+ "declarations": [],
207814
+ "type": {
207815
+ "kind": "function",
207816
+ "parameters": [
207817
+ {
207818
+ "kind": "parameter",
207819
+ "description": "",
207820
+ "tags": {},
207821
+ "declarations": [],
207822
+ "name": "model",
207823
+ "type": {
207824
+ "kind": "symbol",
207825
+ "name": "SelectModel"
207826
+ },
207827
+ "required": true
207828
+ },
207829
+ {
207830
+ "kind": "parameter",
207831
+ "description": "",
207832
+ "tags": {},
207833
+ "declarations": [],
207834
+ "name": "elemProps",
207835
+ "type": {
207836
+ "kind": "generic",
207837
+ "name": "TProps"
207838
+ }
207839
+ }
207840
+ ],
207841
+ "returnType": {
207842
+ "kind": "external",
207843
+ "name": "HTML Attributes",
207844
+ "url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes"
207845
+ }
207846
+ }
207847
+ }
207848
+ ],
207849
+ "baseElement": {
207850
+ "kind": "symbol",
207851
+ "name": "TextInput"
207852
+ },
207853
+ "model": "SelectModel"
207854
+ }
207855
+ },
207856
+ {
207857
+ "name": "SelectItem",
207858
+ "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/select/lib/Select.tsx",
207859
+ "description": "",
207860
+ "declarations": [
207861
+ {
207862
+ "name": "SelectItem",
207863
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/select/lib/Select.tsx"
207864
+ }
207865
+ ],
207866
+ "tags": {},
207867
+ "type": {
207868
+ "kind": "enhancedComponent",
207869
+ "componentType": "subcomponent",
207870
+ "props": [
207780
207871
  {
207781
207872
  "kind": "property",
207782
207873
  "name": "cs",
@@ -207794,225 +207885,82 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
207794
207885
  }
207795
207886
  ],
207796
207887
  "tags": {}
207797
- },
207798
- {
207799
- "kind": "property",
207800
- "name": "children",
207801
- "description": "",
207802
- "tags": {},
207803
- "declarations": [],
207804
- "type": {
207805
- "kind": "external",
207806
- "name": "React.ReactNode",
207807
- "url": "https://reactjs.org/docs/rendering-elements.html"
207808
- }
207809
- },
207810
- {
207811
- "kind": "property",
207812
- "name": "as",
207813
- "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.",
207814
- "tags": {},
207815
- "declarations": [],
207816
- "type": {
207817
- "kind": "external",
207818
- "name": "React.ElementType",
207819
- "url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
207820
- },
207821
- "defaultValue": {
207822
- "kind": "symbol",
207823
- "name": "TextInput"
207824
- }
207825
- },
207826
- {
207827
- "kind": "property",
207828
- "name": "ref",
207829
- "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`).",
207830
- "tags": {},
207831
- "declarations": [],
207832
- "type": {
207833
- "kind": "external",
207834
- "name": "React.Ref",
207835
- "url": "https://reactjs.org/docs/refs-and-the-dom.html",
207836
- "typeParameters": [
207837
- {
207838
- "kind": "typeParameter",
207839
- "name": "R",
207840
- "required": true,
207841
- "defaultValue": {
207842
- "kind": "symbol",
207843
- "name": "TextInput"
207844
- }
207845
- }
207846
- ]
207847
- }
207848
- },
207849
- {
207850
- "kind": "property",
207851
- "name": "model",
207852
- "description": "Optional model to pass to the component. This will override the default model created for the component. This can be useful if you want to access to the state and events of the model, or if you have nested components of the same type and you need to override the model provided by React Context.",
207853
- "tags": {},
207854
- "declarations": [],
207855
- "type": {
207856
- "kind": "symbol",
207857
- "name": "SelectModel"
207858
- }
207859
- },
207860
- {
207861
- "kind": "property",
207862
- "name": "elemPropsHook",
207863
- "description": "Optional hook that receives the model and all props to be applied to the element. If you use this, it is your responsibility to return props, merging as appropriate. For example, returning an empty object will disable all elemProps hooks associated with this component. This allows finer control over a component without creating a new one.",
207864
- "tags": {},
207865
- "declarations": [],
207866
- "type": {
207867
- "kind": "function",
207868
- "parameters": [
207869
- {
207870
- "kind": "parameter",
207871
- "description": "",
207872
- "tags": {},
207873
- "declarations": [],
207874
- "name": "model",
207875
- "type": {
207876
- "kind": "symbol",
207877
- "name": "SelectModel"
207878
- },
207879
- "required": true
207880
- },
207881
- {
207882
- "kind": "parameter",
207883
- "description": "",
207884
- "tags": {},
207885
- "declarations": [],
207886
- "name": "elemProps",
207887
- "type": {
207888
- "kind": "generic",
207889
- "name": "TProps"
207890
- }
207891
- }
207892
- ],
207893
- "returnType": {
207894
- "kind": "external",
207895
- "name": "HTML Attributes",
207896
- "url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes"
207897
- }
207898
- }
207899
- }
207900
- ],
207901
- "baseElement": {
207902
- "kind": "symbol",
207903
- "name": "TextInput"
207904
- },
207905
- "model": "SelectModel"
207906
- }
207907
- },
207908
- {
207909
- "name": "SelectItem",
207910
- "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/select/lib/Select.tsx",
207911
- "description": "",
207912
- "declarations": [
207913
- {
207914
- "name": "SelectItem",
207915
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/select/lib/Select.tsx"
207916
- }
207917
- ],
207918
- "tags": {},
207919
- "type": {
207920
- "kind": "enhancedComponent",
207921
- "componentType": "subcomponent",
207922
- "props": [
207923
- {
207924
- "kind": "property",
207925
- "name": "cs",
207926
- "required": false,
207927
- "type": {
207928
- "kind": "symbol",
207929
- "name": "CSToPropsInput",
207930
- "value": "CSToPropsInput"
207931
- },
207932
- "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```",
207933
- "declarations": [
207934
- {
207935
- "name": "cs",
207936
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
207937
- }
207938
- ],
207939
- "tags": {}
207940
- },
207941
- {
207942
- "kind": "property",
207943
- "name": "ref",
207944
- "required": false,
207945
- "type": {
207946
- "kind": "generic",
207947
- "name": "ExtractRef"
207948
- },
207949
- "description": "Optional ref. If the component represents an element, this ref will be a reference to the\nreal DOM element of the component. If `as` is set to an element, it will be that element.\nIf `as` is a component, the reference will be to that component (or element if the component\nuses `React.forwardRef`).",
207950
- "declarations": [
207951
- {
207952
- "name": "ref",
207953
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
207954
- }
207955
- ],
207956
- "tags": {}
207957
- },
207958
- {
207959
- "kind": "property",
207960
- "name": "theme",
207961
- "required": false,
207962
- "type": {
207963
- "kind": "symbol",
207964
- "name": "Theme",
207965
- "value": "Theme"
207966
- },
207967
- "description": "",
207968
- "declarations": [
207969
- {
207970
- "name": "theme",
207971
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/node_modules/@emotion/styled/types/base.d.ts"
207972
- }
207973
- ],
207974
- "tags": {}
207975
- },
207976
- {
207977
- "kind": "property",
207978
- "name": "as",
207979
- "required": false,
207980
- "type": {
207981
- "kind": "symbol",
207982
- "name": "React.ElementType",
207983
- "value": "ElementType<P>"
207984
- },
207985
- "description": "",
207986
- "declarations": [
207987
- {
207988
- "name": "as",
207989
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
207990
- }
207991
- ],
207992
- "tags": {}
207993
- },
207994
- {
207995
- "kind": "property",
207996
- "name": "isDisabled",
207997
- "required": false,
207998
- "type": {
207999
- "kind": "primitive",
208000
- "value": "boolean"
208001
- },
208002
- "description": "If true, set the StyledMenuItem to the disabled state so it is not clickable.",
208003
- "declarations": [
208004
- {
208005
- "name": "isDisabled",
208006
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/menu/lib/MenuItem.tsx"
208007
- }
208008
- ],
208009
- "tags": {
208010
- "default": "false"
208011
- },
208012
- "defaultValue": {
208013
- "kind": "boolean",
208014
- "value": false
208015
- }
207888
+ },
207889
+ {
207890
+ "kind": "property",
207891
+ "name": "ref",
207892
+ "required": false,
207893
+ "type": {
207894
+ "kind": "generic",
207895
+ "name": "ExtractRef"
207896
+ },
207897
+ "description": "Optional ref. If the component represents an element, this ref will be a reference to the\nreal DOM element of the component. If `as` is set to an element, it will be that element.\nIf `as` is a component, the reference will be to that component (or element if the component\nuses `React.forwardRef`).",
207898
+ "declarations": [
207899
+ {
207900
+ "name": "ref",
207901
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
207902
+ }
207903
+ ],
207904
+ "tags": {}
207905
+ },
207906
+ {
207907
+ "kind": "property",
207908
+ "name": "theme",
207909
+ "required": false,
207910
+ "type": {
207911
+ "kind": "symbol",
207912
+ "name": "Theme",
207913
+ "value": "Theme"
207914
+ },
207915
+ "description": "",
207916
+ "declarations": [
207917
+ {
207918
+ "name": "theme",
207919
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/node_modules/@emotion/styled/types/base.d.ts"
207920
+ }
207921
+ ],
207922
+ "tags": {}
207923
+ },
207924
+ {
207925
+ "kind": "property",
207926
+ "name": "as",
207927
+ "required": false,
207928
+ "type": {
207929
+ "kind": "symbol",
207930
+ "name": "React.ElementType",
207931
+ "value": "ElementType<P>"
207932
+ },
207933
+ "description": "",
207934
+ "declarations": [
207935
+ {
207936
+ "name": "as",
207937
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
207938
+ }
207939
+ ],
207940
+ "tags": {}
207941
+ },
207942
+ {
207943
+ "kind": "property",
207944
+ "name": "isDisabled",
207945
+ "required": false,
207946
+ "type": {
207947
+ "kind": "primitive",
207948
+ "value": "boolean"
207949
+ },
207950
+ "description": "If true, set the StyledMenuItem to the disabled state so it is not clickable.",
207951
+ "declarations": [
207952
+ {
207953
+ "name": "isDisabled",
207954
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/menu/lib/MenuItem.tsx"
207955
+ }
207956
+ ],
207957
+ "tags": {
207958
+ "default": "false"
207959
+ },
207960
+ "defaultValue": {
207961
+ "kind": "boolean",
207962
+ "value": false
207963
+ }
208016
207964
  },
208017
207965
  {
208018
207966
  "kind": "property",
@@ -231488,6 +231436,33 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
231488
231436
  ]
231489
231437
  }
231490
231438
  },
231439
+ {
231440
+ "name": "ValueOf",
231441
+ "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text-area/lib/TextArea.tsx",
231442
+ "description": "",
231443
+ "declarations": [
231444
+ {
231445
+ "name": "ValueOf",
231446
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text-area/lib/TextArea.tsx"
231447
+ }
231448
+ ],
231449
+ "tags": {},
231450
+ "type": {
231451
+ "kind": "type",
231452
+ "typeParameters": [
231453
+ {
231454
+ "kind": "typeParameter",
231455
+ "name": "T",
231456
+ "required": true
231457
+ }
231458
+ ],
231459
+ "value": {
231460
+ "kind": "symbol",
231461
+ "name": "ValueOf",
231462
+ "value": "ValueOf<T>"
231463
+ }
231464
+ }
231465
+ },
231491
231466
  {
231492
231467
  "name": "TextAreaProps",
231493
231468
  "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text-area/lib/TextArea.tsx",
@@ -231517,227 +231492,686 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
231517
231492
  "tags": {},
231518
231493
  "type": {
231519
231494
  "kind": "object",
231520
- "typeParameters": [],
231521
231495
  "properties": [
231522
231496
  {
231523
231497
  "kind": "property",
231524
231498
  "name": "None",
231499
+ "defaultValue": {
231500
+ "kind": "string",
231501
+ "value": "none"
231502
+ },
231525
231503
  "type": {
231526
231504
  "kind": "string",
231527
231505
  "value": "none"
231528
- }
231506
+ },
231507
+ "required": true,
231508
+ "description": "",
231509
+ "declarations": [
231510
+ {
231511
+ "name": "None",
231512
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text-area/lib/TextArea.tsx"
231513
+ }
231514
+ ],
231515
+ "tags": {}
231529
231516
  },
231530
231517
  {
231531
231518
  "kind": "property",
231532
231519
  "name": "Both",
231520
+ "defaultValue": {
231521
+ "kind": "string",
231522
+ "value": "both"
231523
+ },
231533
231524
  "type": {
231534
231525
  "kind": "string",
231535
231526
  "value": "both"
231536
- }
231527
+ },
231528
+ "required": true,
231529
+ "description": "",
231530
+ "declarations": [
231531
+ {
231532
+ "name": "Both",
231533
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text-area/lib/TextArea.tsx"
231534
+ }
231535
+ ],
231536
+ "tags": {}
231537
231537
  },
231538
231538
  {
231539
231539
  "kind": "property",
231540
231540
  "name": "Horizontal",
231541
+ "defaultValue": {
231542
+ "kind": "string",
231543
+ "value": "horizontal"
231544
+ },
231541
231545
  "type": {
231542
231546
  "kind": "string",
231543
231547
  "value": "horizontal"
231544
- }
231548
+ },
231549
+ "required": true,
231550
+ "description": "",
231551
+ "declarations": [
231552
+ {
231553
+ "name": "Horizontal",
231554
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text-area/lib/TextArea.tsx"
231555
+ }
231556
+ ],
231557
+ "tags": {}
231545
231558
  },
231546
231559
  {
231547
231560
  "kind": "property",
231548
231561
  "name": "Vertical",
231562
+ "defaultValue": {
231563
+ "kind": "string",
231564
+ "value": "vertical"
231565
+ },
231549
231566
  "type": {
231550
231567
  "kind": "string",
231551
231568
  "value": "vertical"
231552
- }
231569
+ },
231570
+ "required": true,
231571
+ "description": "",
231572
+ "declarations": [
231573
+ {
231574
+ "name": "Vertical",
231575
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text-area/lib/TextArea.tsx"
231576
+ }
231577
+ ],
231578
+ "tags": {}
231553
231579
  }
231554
- ],
231555
- "callSignatures": []
231580
+ ]
231556
231581
  }
231557
231582
  },
231558
231583
  {
231559
- "name": "TextArea",
231584
+ "name": "textAreaStencil",
231560
231585
  "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text-area/lib/TextArea.tsx",
231561
231586
  "description": "",
231562
231587
  "declarations": [
231563
231588
  {
231564
- "name": "TextArea",
231589
+ "name": "textAreaStencil",
231565
231590
  "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text-area/lib/TextArea.tsx"
231566
231591
  }
231567
231592
  ],
231568
231593
  "tags": {},
231569
231594
  "type": {
231570
- "kind": "enhancedComponent",
231571
- "componentType": "regular",
231572
- "displayName": "TextArea",
231573
- "props": [
231595
+ "kind": "function",
231596
+ "parameters": [
231574
231597
  {
231575
- "kind": "property",
231576
- "name": "disabled",
231577
- "required": false,
231598
+ "kind": "parameter",
231599
+ "name": "options",
231578
231600
  "type": {
231579
- "kind": "primitive",
231580
- "value": "boolean"
231601
+ "kind": "conditional",
231602
+ "check": {
231603
+ "kind": "tuple",
231604
+ "value": [
231605
+ {
231606
+ "kind": "symbol",
231607
+ "name": "E",
231608
+ "value": "E"
231609
+ }
231610
+ ]
231611
+ },
231612
+ "extends": {
231613
+ "kind": "tuple",
231614
+ "value": [
231615
+ {
231616
+ "kind": "primitive",
231617
+ "value": "never"
231618
+ }
231619
+ ]
231620
+ },
231621
+ "trueType": {
231622
+ "kind": "intersection",
231623
+ "value": [
231624
+ {
231625
+ "kind": "symbol",
231626
+ "name": "ModifierValuesStencil",
231627
+ "typeParameters": [
231628
+ {
231629
+ "kind": "symbol",
231630
+ "name": "M",
231631
+ "value": "M"
231632
+ },
231633
+ {
231634
+ "kind": "symbol",
231635
+ "name": "V",
231636
+ "value": "V"
231637
+ }
231638
+ ],
231639
+ "value": "ModifierValuesStencil<M, V>"
231640
+ },
231641
+ {
231642
+ "kind": "symbol",
231643
+ "name": "VariableValuesStencil",
231644
+ "typeParameters": [
231645
+ {
231646
+ "kind": "symbol",
231647
+ "name": "V",
231648
+ "value": "V"
231649
+ }
231650
+ ],
231651
+ "value": "VariableValuesStencil<V>"
231652
+ }
231653
+ ]
231654
+ },
231655
+ "falseType": {
231656
+ "kind": "conditional",
231657
+ "check": {
231658
+ "kind": "symbol",
231659
+ "name": "E",
231660
+ "value": "E"
231661
+ },
231662
+ "extends": {
231663
+ "kind": "symbol",
231664
+ "name": "BaseStencil",
231665
+ "typeParameters": [
231666
+ {
231667
+ "kind": "infer",
231668
+ "value": {
231669
+ "kind": "typeParameter",
231670
+ "name": "ME",
231671
+ "required": true
231672
+ }
231673
+ },
231674
+ {
231675
+ "kind": "infer",
231676
+ "value": {
231677
+ "kind": "typeParameter",
231678
+ "name": "VE",
231679
+ "required": true
231680
+ }
231681
+ },
231682
+ {
231683
+ "kind": "primitive",
231684
+ "value": "any"
231685
+ },
231686
+ {
231687
+ "kind": "primitive",
231688
+ "value": "any"
231689
+ }
231690
+ ],
231691
+ "value": "BaseStencil<M, V, E, ID>"
231692
+ },
231693
+ "trueType": {
231694
+ "kind": "intersection",
231695
+ "value": [
231696
+ {
231697
+ "kind": "symbol",
231698
+ "name": "ModifierValuesStencil",
231699
+ "typeParameters": [
231700
+ {
231701
+ "kind": "intersection",
231702
+ "value": [
231703
+ {
231704
+ "kind": "symbol",
231705
+ "name": "ME",
231706
+ "value": "ME"
231707
+ },
231708
+ {
231709
+ "kind": "symbol",
231710
+ "name": "M",
231711
+ "value": "M"
231712
+ }
231713
+ ]
231714
+ }
231715
+ ],
231716
+ "value": "ModifierValuesStencil<M, V>"
231717
+ },
231718
+ {
231719
+ "kind": "symbol",
231720
+ "name": "VariableValuesStencil",
231721
+ "typeParameters": [
231722
+ {
231723
+ "kind": "intersection",
231724
+ "value": [
231725
+ {
231726
+ "kind": "symbol",
231727
+ "name": "VE",
231728
+ "value": "VE"
231729
+ },
231730
+ {
231731
+ "kind": "symbol",
231732
+ "name": "V",
231733
+ "value": "V"
231734
+ }
231735
+ ]
231736
+ }
231737
+ ],
231738
+ "value": "VariableValuesStencil<V>"
231739
+ }
231740
+ ]
231741
+ },
231742
+ "falseType": {
231743
+ "kind": "primitive",
231744
+ "value": "never"
231745
+ }
231746
+ }
231581
231747
  },
231582
- "description": "If true, set the TextArea to the disabled state.",
231748
+ "required": false,
231749
+ "rest": false,
231750
+ "description": "",
231583
231751
  "declarations": [
231584
231752
  {
231585
- "name": "disabled",
231586
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text-area/lib/TextArea.tsx"
231753
+ "name": "options",
231754
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
231587
231755
  }
231588
231756
  ],
231589
- "tags": {
231590
- "default": "false"
231757
+ "tags": {}
231758
+ }
231759
+ ],
231760
+ "members": [
231761
+ {
231762
+ "kind": "property",
231763
+ "name": "vars",
231764
+ "required": true,
231765
+ "type": {
231766
+ "kind": "symbol",
231767
+ "name": "StencilDefaultVars",
231768
+ "typeParameters": [
231769
+ {
231770
+ "kind": "symbol",
231771
+ "name": "V",
231772
+ "value": "V"
231773
+ },
231774
+ {
231775
+ "kind": "symbol",
231776
+ "name": "E",
231777
+ "value": "E"
231778
+ },
231779
+ {
231780
+ "kind": "symbol",
231781
+ "name": "ID",
231782
+ "value": "ID"
231783
+ }
231784
+ ],
231785
+ "value": "StencilDefaultVars<V, E, ID>"
231591
231786
  },
231592
- "defaultValue": {
231593
- "kind": "boolean",
231594
- "value": false
231595
- }
231787
+ "description": "",
231788
+ "declarations": [
231789
+ {
231790
+ "name": "vars",
231791
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
231792
+ }
231793
+ ],
231794
+ "tags": {}
231596
231795
  },
231597
231796
  {
231598
231797
  "kind": "property",
231599
- "name": "error",
231600
- "required": false,
231798
+ "name": "base",
231799
+ "required": true,
231601
231800
  "type": {
231602
- "kind": "symbol",
231603
- "name": "ErrorType",
231604
- "value": "ErrorType"
231801
+ "kind": "primitive",
231802
+ "value": "string"
231605
231803
  },
231606
- "description": "The type of error associated with the TextArea (if applicable).",
231804
+ "description": "",
231607
231805
  "declarations": [
231608
231806
  {
231609
- "name": "error",
231610
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text-area/lib/TextArea.tsx"
231807
+ "name": "base",
231808
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
231611
231809
  }
231612
231810
  ],
231613
231811
  "tags": {}
231614
231812
  },
231615
231813
  {
231616
231814
  "kind": "property",
231617
- "name": "onChange",
231618
- "required": false,
231815
+ "name": "modifiers",
231816
+ "required": true,
231619
231817
  "type": {
231620
- "kind": "function",
231621
- "parameters": [
231622
- {
231623
- "kind": "parameter",
231624
- "name": "e",
231625
- "type": {
231818
+ "kind": "conditional",
231819
+ "check": {
231820
+ "kind": "tuple",
231821
+ "value": [
231822
+ {
231626
231823
  "kind": "symbol",
231627
- "name": "React.ChangeEvent",
231824
+ "name": "E",
231825
+ "value": "E"
231826
+ }
231827
+ ]
231828
+ },
231829
+ "extends": {
231830
+ "kind": "tuple",
231831
+ "value": [
231832
+ {
231833
+ "kind": "symbol",
231834
+ "name": "BaseStencil",
231628
231835
  "typeParameters": [
231629
231836
  {
231630
- "kind": "symbol",
231631
- "name": "HTMLTextAreaElement",
231632
- "value": "HTMLTextAreaElement"
231837
+ "kind": "infer",
231838
+ "value": {
231839
+ "kind": "typeParameter",
231840
+ "name": "ME",
231841
+ "required": true
231842
+ }
231843
+ },
231844
+ {
231845
+ "kind": "infer",
231846
+ "value": {
231847
+ "kind": "typeParameter",
231848
+ "name": "VE",
231849
+ "required": true
231850
+ }
231851
+ },
231852
+ {
231853
+ "kind": "primitive",
231854
+ "value": "any"
231855
+ },
231856
+ {
231857
+ "kind": "primitive",
231858
+ "value": "any"
231633
231859
  }
231634
231860
  ],
231635
- "value": "ChangeEvent<T>"
231861
+ "value": "BaseStencil<M, V, E, ID>"
231862
+ }
231863
+ ]
231864
+ },
231865
+ "trueType": {
231866
+ "kind": "symbol",
231867
+ "name": "StencilModifierReturn",
231868
+ "typeParameters": [
231869
+ {
231870
+ "kind": "intersection",
231871
+ "value": [
231872
+ {
231873
+ "kind": "symbol",
231874
+ "name": "ME",
231875
+ "value": "ME"
231876
+ },
231877
+ {
231878
+ "kind": "symbol",
231879
+ "name": "M",
231880
+ "value": "M"
231881
+ }
231882
+ ]
231636
231883
  },
231637
- "required": true,
231638
- "rest": false,
231639
- "description": "",
231640
- "declarations": [
231641
- {
231642
- "name": "e",
231643
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text-area/lib/TextArea.tsx"
231644
- }
231645
- ],
231646
- "tags": {}
231647
- }
231648
- ],
231649
- "members": [],
231650
- "returnType": {
231651
- "kind": "primitive",
231652
- "value": "void"
231884
+ {
231885
+ "kind": "intersection",
231886
+ "value": [
231887
+ {
231888
+ "kind": "symbol",
231889
+ "name": "VE",
231890
+ "value": "VE"
231891
+ },
231892
+ {
231893
+ "kind": "symbol",
231894
+ "name": "V",
231895
+ "value": "V"
231896
+ }
231897
+ ]
231898
+ }
231899
+ ],
231900
+ "value": "StencilModifierReturn<M, V>"
231901
+ },
231902
+ "falseType": {
231903
+ "kind": "symbol",
231904
+ "name": "StencilModifierReturn",
231905
+ "typeParameters": [
231906
+ {
231907
+ "kind": "symbol",
231908
+ "name": "M",
231909
+ "value": "M"
231910
+ },
231911
+ {
231912
+ "kind": "symbol",
231913
+ "name": "V",
231914
+ "value": "V"
231915
+ }
231916
+ ],
231917
+ "value": "StencilModifierReturn<M, V>"
231653
231918
  }
231654
231919
  },
231655
- "description": "The function called when the TextArea state changes.",
231920
+ "description": "",
231656
231921
  "declarations": [
231657
231922
  {
231658
- "name": "onChange",
231659
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text-area/lib/TextArea.tsx"
231923
+ "name": "modifiers",
231924
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
231660
231925
  }
231661
231926
  ],
231662
231927
  "tags": {}
231663
231928
  },
231664
231929
  {
231665
231930
  "kind": "property",
231666
- "name": "placeholder",
231667
- "required": false,
231931
+ "name": "defaultModifiers",
231932
+ "required": true,
231668
231933
  "type": {
231669
- "kind": "primitive",
231670
- "value": "string"
231934
+ "kind": "conditional",
231935
+ "check": {
231936
+ "kind": "tuple",
231937
+ "value": [
231938
+ {
231939
+ "kind": "symbol",
231940
+ "name": "E",
231941
+ "value": "E"
231942
+ }
231943
+ ]
231944
+ },
231945
+ "extends": {
231946
+ "kind": "tuple",
231947
+ "value": [
231948
+ {
231949
+ "kind": "symbol",
231950
+ "name": "BaseStencil",
231951
+ "typeParameters": [
231952
+ {
231953
+ "kind": "infer",
231954
+ "value": {
231955
+ "kind": "typeParameter",
231956
+ "name": "ME",
231957
+ "required": true
231958
+ }
231959
+ },
231960
+ {
231961
+ "kind": "primitive",
231962
+ "value": "any"
231963
+ },
231964
+ {
231965
+ "kind": "primitive",
231966
+ "value": "any"
231967
+ },
231968
+ {
231969
+ "kind": "primitive",
231970
+ "value": "any"
231971
+ }
231972
+ ],
231973
+ "value": "BaseStencil<M, V, E, ID>"
231974
+ }
231975
+ ]
231976
+ },
231977
+ "trueType": {
231978
+ "kind": "symbol",
231979
+ "name": "StencilDefaultModifierReturn",
231980
+ "typeParameters": [
231981
+ {
231982
+ "kind": "intersection",
231983
+ "value": [
231984
+ {
231985
+ "kind": "symbol",
231986
+ "name": "ME",
231987
+ "value": "ME"
231988
+ },
231989
+ {
231990
+ "kind": "symbol",
231991
+ "name": "M",
231992
+ "value": "M"
231993
+ }
231994
+ ]
231995
+ }
231996
+ ],
231997
+ "value": "StencilDefaultModifierReturn<M>"
231998
+ },
231999
+ "falseType": {
232000
+ "kind": "symbol",
232001
+ "name": "StencilDefaultModifierReturn",
232002
+ "typeParameters": [
232003
+ {
232004
+ "kind": "symbol",
232005
+ "name": "M",
232006
+ "value": "M"
232007
+ }
232008
+ ],
232009
+ "value": "StencilDefaultModifierReturn<M>"
232010
+ }
231671
232011
  },
231672
- "description": "The placeholder text of the TextArea.",
232012
+ "description": "",
231673
232013
  "declarations": [
231674
232014
  {
231675
- "name": "placeholder",
231676
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text-area/lib/TextArea.tsx"
232015
+ "name": "defaultModifiers",
232016
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
231677
232017
  }
231678
232018
  ],
231679
232019
  "tags": {}
231680
232020
  },
231681
232021
  {
231682
232022
  "kind": "property",
231683
- "name": "readOnly",
232023
+ "name": "__extends",
231684
232024
  "required": false,
231685
232025
  "type": {
231686
- "kind": "primitive",
231687
- "value": "boolean"
232026
+ "kind": "symbol",
232027
+ "name": "E",
232028
+ "value": "E"
231688
232029
  },
231689
- "description": "If true, set the TextArea to read-only. The user will be unable to interact with the TextArea.",
232030
+ "description": "",
231690
232031
  "declarations": [
231691
232032
  {
231692
- "name": "readOnly",
231693
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text-area/lib/TextArea.tsx"
232033
+ "name": "__extends",
232034
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
231694
232035
  }
231695
232036
  ],
231696
- "tags": {
231697
- "default": "false"
231698
- },
231699
- "defaultValue": {
231700
- "kind": "boolean",
231701
- "value": false
231702
- }
232037
+ "tags": {}
231703
232038
  },
231704
232039
  {
231705
232040
  "kind": "property",
231706
- "name": "resize",
231707
- "required": false,
232041
+ "name": "__vars",
232042
+ "required": true,
231708
232043
  "type": {
231709
232044
  "kind": "symbol",
231710
- "name": "TextAreaResizeDirection",
231711
- "value": "TextAreaResizeDirection"
232045
+ "name": "V",
232046
+ "value": "V"
231712
232047
  },
231713
- "description": "The resize constraints of the TextArea.",
232048
+ "description": "",
231714
232049
  "declarations": [
231715
232050
  {
231716
- "name": "resize",
231717
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text-area/lib/TextArea.tsx"
232051
+ "name": "__vars",
232052
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
231718
232053
  }
231719
232054
  ],
231720
- "tags": {
231721
- "default": "TextArea.ResizeDirection.Both"
232055
+ "tags": {}
232056
+ },
232057
+ {
232058
+ "kind": "property",
232059
+ "name": "__modifiers",
232060
+ "required": true,
232061
+ "type": {
232062
+ "kind": "symbol",
232063
+ "name": "M",
232064
+ "value": "M"
231722
232065
  },
231723
- "defaultValue": {
232066
+ "description": "",
232067
+ "declarations": [
232068
+ {
232069
+ "name": "__modifiers",
232070
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
232071
+ }
232072
+ ],
232073
+ "tags": {}
232074
+ },
232075
+ {
232076
+ "kind": "property",
232077
+ "name": "__id",
232078
+ "required": true,
232079
+ "type": {
231724
232080
  "kind": "symbol",
231725
- "name": "TextArea.ResizeDirection.Both",
231726
- "value": "TextArea.ResizeDirection.Both"
232081
+ "name": "ID",
232082
+ "value": "ID"
232083
+ },
232084
+ "description": "",
232085
+ "declarations": [
232086
+ {
232087
+ "name": "__id",
232088
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
232089
+ }
232090
+ ],
232091
+ "tags": {}
232092
+ }
232093
+ ],
232094
+ "returnType": {
232095
+ "kind": "object",
232096
+ "properties": [
232097
+ {
232098
+ "kind": "property",
232099
+ "name": "className",
232100
+ "required": true,
232101
+ "type": {
232102
+ "kind": "primitive",
232103
+ "value": "string"
232104
+ },
232105
+ "description": "",
232106
+ "declarations": [
232107
+ {
232108
+ "name": "className",
232109
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
232110
+ }
232111
+ ],
232112
+ "tags": {}
232113
+ },
232114
+ {
232115
+ "kind": "property",
232116
+ "name": "style",
232117
+ "required": false,
232118
+ "type": {
232119
+ "kind": "external",
232120
+ "name": "Record",
232121
+ "url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
232122
+ "typeParameters": [
232123
+ {
232124
+ "kind": "primitive",
232125
+ "value": "string"
232126
+ },
232127
+ {
232128
+ "kind": "primitive",
232129
+ "value": "string"
232130
+ }
232131
+ ]
232132
+ },
232133
+ "description": "",
232134
+ "declarations": [
232135
+ {
232136
+ "name": "style",
232137
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
232138
+ }
232139
+ ],
232140
+ "tags": {}
231727
232141
  }
231728
- },
232142
+ ]
232143
+ }
232144
+ }
232145
+ },
232146
+ {
232147
+ "name": "TextArea",
232148
+ "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text-area/lib/TextArea.tsx",
232149
+ "description": "",
232150
+ "declarations": [
232151
+ {
232152
+ "name": "TextArea",
232153
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text-area/lib/TextArea.tsx"
232154
+ }
232155
+ ],
232156
+ "tags": {},
232157
+ "type": {
232158
+ "kind": "enhancedComponent",
232159
+ "componentType": "regular",
232160
+ "displayName": "TextArea",
232161
+ "props": [
231729
232162
  {
231730
232163
  "kind": "property",
231731
- "name": "value",
232164
+ "name": "error",
231732
232165
  "required": false,
231733
232166
  "type": {
231734
- "kind": "primitive",
231735
- "value": "any"
232167
+ "kind": "symbol",
232168
+ "name": "ErrorType",
232169
+ "value": "ErrorType"
231736
232170
  },
231737
- "description": "The value of the TextArea.",
232171
+ "description": "The type of error associated with the TextArea (if applicable).",
231738
232172
  "declarations": [
231739
232173
  {
231740
- "name": "value",
232174
+ "name": "error",
231741
232175
  "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text-area/lib/TextArea.tsx"
231742
232176
  }
231743
232177
  ],
@@ -231745,21 +232179,27 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
231745
232179
  },
231746
232180
  {
231747
232181
  "kind": "property",
231748
- "name": "theme",
232182
+ "name": "resize",
231749
232183
  "required": false,
231750
232184
  "type": {
231751
232185
  "kind": "symbol",
231752
- "name": "EmotionCanvasTheme",
231753
- "value": "EmotionCanvasTheme"
232186
+ "name": "TextAreaResizeDirection"
231754
232187
  },
231755
- "description": "",
232188
+ "description": "The resize constraints of the TextArea.",
231756
232189
  "declarations": [
231757
232190
  {
231758
- "name": "theme",
231759
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/types.ts"
232191
+ "name": "resize",
232192
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text-area/lib/TextArea.tsx"
231760
232193
  }
231761
232194
  ],
231762
- "tags": {}
232195
+ "tags": {
232196
+ "default": "TextArea.ResizeDirection.Both"
232197
+ },
232198
+ "defaultValue": {
232199
+ "kind": "symbol",
232200
+ "name": "TextArea.ResizeDirection.Both",
232201
+ "value": "TextArea.ResizeDirection.Both"
232202
+ }
231763
232203
  },
231764
232204
  {
231765
232205
  "kind": "property",
@@ -233418,90 +233858,582 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
233418
233858
  }
233419
233859
  },
233420
233860
  {
233421
- "name": "InputIconContainerProps",
233422
- "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text-input/lib/InputIconContainer.tsx",
233423
- "description": "### ⚠️ We've deprecated `InputIconContainerProps` from Main because it doesn't handle bidirectionality or icons at the start of an input. ⚠️\nPlease consider using [`InputGroup`](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-text-input--icons) instead.",
233861
+ "name": "TextInputProps",
233862
+ "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text-input/lib/TextInput.tsx",
233863
+ "description": "",
233424
233864
  "declarations": [
233425
233865
  {
233426
- "name": "InputIconContainerProps",
233427
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text-input/lib/InputIconContainer.tsx"
233866
+ "name": "TextInputProps",
233867
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text-input/lib/TextInput.tsx"
233428
233868
  }
233429
233869
  ],
233430
- "tags": {
233431
- "deprecated": ""
233432
- },
233870
+ "tags": {},
233433
233871
  "type": {
233434
233872
  "kind": "alias",
233435
- "name": "InputIconContainer"
233873
+ "name": "TextInput"
233436
233874
  }
233437
233875
  },
233438
233876
  {
233439
- "name": "InputIconContainer",
233440
- "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text-input/lib/InputIconContainer.tsx",
233441
- "description": "### ⚠️ We've deprecated `InputIconContainer` from Main because it doesn't handle bidirectionality or icons at the start of an input. ⚠️\nPlease consider using [`InputGroup`](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-text-input--icons) instead.",
233877
+ "name": "textInputStencil",
233878
+ "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text-input/lib/TextInput.tsx",
233879
+ "description": "",
233442
233880
  "declarations": [
233443
233881
  {
233444
- "name": "InputIconContainer",
233445
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text-input/lib/InputIconContainer.tsx"
233882
+ "name": "textInputStencil",
233883
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text-input/lib/TextInput.tsx"
233446
233884
  }
233447
233885
  ],
233448
- "tags": {
233449
- "deprecated": ""
233450
- },
233886
+ "tags": {},
233451
233887
  "type": {
233452
- "kind": "component",
233453
- "props": [
233888
+ "kind": "function",
233889
+ "parameters": [
233454
233890
  {
233455
- "kind": "property",
233456
- "name": "icon",
233891
+ "kind": "parameter",
233892
+ "name": "options",
233893
+ "type": {
233894
+ "kind": "conditional",
233895
+ "check": {
233896
+ "kind": "tuple",
233897
+ "value": [
233898
+ {
233899
+ "kind": "symbol",
233900
+ "name": "E",
233901
+ "value": "E"
233902
+ }
233903
+ ]
233904
+ },
233905
+ "extends": {
233906
+ "kind": "tuple",
233907
+ "value": [
233908
+ {
233909
+ "kind": "primitive",
233910
+ "value": "never"
233911
+ }
233912
+ ]
233913
+ },
233914
+ "trueType": {
233915
+ "kind": "intersection",
233916
+ "value": [
233917
+ {
233918
+ "kind": "symbol",
233919
+ "name": "ModifierValuesStencil",
233920
+ "typeParameters": [
233921
+ {
233922
+ "kind": "symbol",
233923
+ "name": "M",
233924
+ "value": "M"
233925
+ },
233926
+ {
233927
+ "kind": "symbol",
233928
+ "name": "V",
233929
+ "value": "V"
233930
+ }
233931
+ ],
233932
+ "value": "ModifierValuesStencil<M, V>"
233933
+ },
233934
+ {
233935
+ "kind": "symbol",
233936
+ "name": "VariableValuesStencil",
233937
+ "typeParameters": [
233938
+ {
233939
+ "kind": "symbol",
233940
+ "name": "V",
233941
+ "value": "V"
233942
+ }
233943
+ ],
233944
+ "value": "VariableValuesStencil<V>"
233945
+ }
233946
+ ]
233947
+ },
233948
+ "falseType": {
233949
+ "kind": "conditional",
233950
+ "check": {
233951
+ "kind": "symbol",
233952
+ "name": "E",
233953
+ "value": "E"
233954
+ },
233955
+ "extends": {
233956
+ "kind": "symbol",
233957
+ "name": "BaseStencil",
233958
+ "typeParameters": [
233959
+ {
233960
+ "kind": "infer",
233961
+ "value": {
233962
+ "kind": "typeParameter",
233963
+ "name": "ME",
233964
+ "required": true
233965
+ }
233966
+ },
233967
+ {
233968
+ "kind": "infer",
233969
+ "value": {
233970
+ "kind": "typeParameter",
233971
+ "name": "VE",
233972
+ "required": true
233973
+ }
233974
+ },
233975
+ {
233976
+ "kind": "primitive",
233977
+ "value": "any"
233978
+ },
233979
+ {
233980
+ "kind": "primitive",
233981
+ "value": "any"
233982
+ }
233983
+ ],
233984
+ "value": "BaseStencil<M, V, E, ID>"
233985
+ },
233986
+ "trueType": {
233987
+ "kind": "intersection",
233988
+ "value": [
233989
+ {
233990
+ "kind": "symbol",
233991
+ "name": "ModifierValuesStencil",
233992
+ "typeParameters": [
233993
+ {
233994
+ "kind": "intersection",
233995
+ "value": [
233996
+ {
233997
+ "kind": "symbol",
233998
+ "name": "ME",
233999
+ "value": "ME"
234000
+ },
234001
+ {
234002
+ "kind": "symbol",
234003
+ "name": "M",
234004
+ "value": "M"
234005
+ }
234006
+ ]
234007
+ }
234008
+ ],
234009
+ "value": "ModifierValuesStencil<M, V>"
234010
+ },
234011
+ {
234012
+ "kind": "symbol",
234013
+ "name": "VariableValuesStencil",
234014
+ "typeParameters": [
234015
+ {
234016
+ "kind": "intersection",
234017
+ "value": [
234018
+ {
234019
+ "kind": "symbol",
234020
+ "name": "VE",
234021
+ "value": "VE"
234022
+ },
234023
+ {
234024
+ "kind": "symbol",
234025
+ "name": "V",
234026
+ "value": "V"
234027
+ }
234028
+ ]
234029
+ }
234030
+ ],
234031
+ "value": "VariableValuesStencil<V>"
234032
+ }
234033
+ ]
234034
+ },
234035
+ "falseType": {
234036
+ "kind": "primitive",
234037
+ "value": "never"
234038
+ }
234039
+ }
234040
+ },
233457
234041
  "required": false,
234042
+ "rest": false,
234043
+ "description": "",
234044
+ "declarations": [
234045
+ {
234046
+ "name": "options",
234047
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
234048
+ }
234049
+ ],
234050
+ "tags": {}
234051
+ }
234052
+ ],
234053
+ "members": [
234054
+ {
234055
+ "kind": "property",
234056
+ "name": "vars",
234057
+ "required": true,
233458
234058
  "type": {
233459
234059
  "kind": "symbol",
233460
- "name": "SystemIcon"
234060
+ "name": "StencilDefaultVars",
234061
+ "typeParameters": [
234062
+ {
234063
+ "kind": "symbol",
234064
+ "name": "V",
234065
+ "value": "V"
234066
+ },
234067
+ {
234068
+ "kind": "symbol",
234069
+ "name": "E",
234070
+ "value": "E"
234071
+ },
234072
+ {
234073
+ "kind": "symbol",
234074
+ "name": "ID",
234075
+ "value": "ID"
234076
+ }
234077
+ ],
234078
+ "value": "StencilDefaultVars<V, E, ID>"
233461
234079
  },
233462
234080
  "description": "",
233463
234081
  "declarations": [
233464
234082
  {
233465
- "name": "icon",
233466
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text-input/lib/InputIconContainer.tsx"
234083
+ "name": "vars",
234084
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
233467
234085
  }
233468
234086
  ],
233469
234087
  "tags": {}
233470
234088
  },
233471
234089
  {
233472
234090
  "kind": "property",
233473
- "name": "grow",
233474
- "required": false,
234091
+ "name": "base",
234092
+ "required": true,
233475
234093
  "type": {
233476
234094
  "kind": "primitive",
233477
- "value": "boolean"
234095
+ "value": "string"
233478
234096
  },
233479
- "description": "True if the component should grow to its container's width. False otherwise.",
234097
+ "description": "",
233480
234098
  "declarations": [
233481
234099
  {
233482
- "name": "grow",
233483
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/types.ts"
234100
+ "name": "base",
234101
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
234102
+ }
234103
+ ],
234104
+ "tags": {}
234105
+ },
234106
+ {
234107
+ "kind": "property",
234108
+ "name": "modifiers",
234109
+ "required": true,
234110
+ "type": {
234111
+ "kind": "conditional",
234112
+ "check": {
234113
+ "kind": "tuple",
234114
+ "value": [
234115
+ {
234116
+ "kind": "symbol",
234117
+ "name": "E",
234118
+ "value": "E"
234119
+ }
234120
+ ]
234121
+ },
234122
+ "extends": {
234123
+ "kind": "tuple",
234124
+ "value": [
234125
+ {
234126
+ "kind": "symbol",
234127
+ "name": "BaseStencil",
234128
+ "typeParameters": [
234129
+ {
234130
+ "kind": "infer",
234131
+ "value": {
234132
+ "kind": "typeParameter",
234133
+ "name": "ME",
234134
+ "required": true
234135
+ }
234136
+ },
234137
+ {
234138
+ "kind": "infer",
234139
+ "value": {
234140
+ "kind": "typeParameter",
234141
+ "name": "VE",
234142
+ "required": true
234143
+ }
234144
+ },
234145
+ {
234146
+ "kind": "primitive",
234147
+ "value": "any"
234148
+ },
234149
+ {
234150
+ "kind": "primitive",
234151
+ "value": "any"
234152
+ }
234153
+ ],
234154
+ "value": "BaseStencil<M, V, E, ID>"
234155
+ }
234156
+ ]
234157
+ },
234158
+ "trueType": {
234159
+ "kind": "symbol",
234160
+ "name": "StencilModifierReturn",
234161
+ "typeParameters": [
234162
+ {
234163
+ "kind": "intersection",
234164
+ "value": [
234165
+ {
234166
+ "kind": "symbol",
234167
+ "name": "ME",
234168
+ "value": "ME"
234169
+ },
234170
+ {
234171
+ "kind": "symbol",
234172
+ "name": "M",
234173
+ "value": "M"
234174
+ }
234175
+ ]
234176
+ },
234177
+ {
234178
+ "kind": "intersection",
234179
+ "value": [
234180
+ {
234181
+ "kind": "symbol",
234182
+ "name": "VE",
234183
+ "value": "VE"
234184
+ },
234185
+ {
234186
+ "kind": "symbol",
234187
+ "name": "V",
234188
+ "value": "V"
234189
+ }
234190
+ ]
234191
+ }
234192
+ ],
234193
+ "value": "StencilModifierReturn<M, V>"
234194
+ },
234195
+ "falseType": {
234196
+ "kind": "symbol",
234197
+ "name": "StencilModifierReturn",
234198
+ "typeParameters": [
234199
+ {
234200
+ "kind": "symbol",
234201
+ "name": "M",
234202
+ "value": "M"
234203
+ },
234204
+ {
234205
+ "kind": "symbol",
234206
+ "name": "V",
234207
+ "value": "V"
234208
+ }
234209
+ ],
234210
+ "value": "StencilModifierReturn<M, V>"
234211
+ }
234212
+ },
234213
+ "description": "",
234214
+ "declarations": [
234215
+ {
234216
+ "name": "modifiers",
234217
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
234218
+ }
234219
+ ],
234220
+ "tags": {}
234221
+ },
234222
+ {
234223
+ "kind": "property",
234224
+ "name": "defaultModifiers",
234225
+ "required": true,
234226
+ "type": {
234227
+ "kind": "conditional",
234228
+ "check": {
234229
+ "kind": "tuple",
234230
+ "value": [
234231
+ {
234232
+ "kind": "symbol",
234233
+ "name": "E",
234234
+ "value": "E"
234235
+ }
234236
+ ]
234237
+ },
234238
+ "extends": {
234239
+ "kind": "tuple",
234240
+ "value": [
234241
+ {
234242
+ "kind": "symbol",
234243
+ "name": "BaseStencil",
234244
+ "typeParameters": [
234245
+ {
234246
+ "kind": "infer",
234247
+ "value": {
234248
+ "kind": "typeParameter",
234249
+ "name": "ME",
234250
+ "required": true
234251
+ }
234252
+ },
234253
+ {
234254
+ "kind": "primitive",
234255
+ "value": "any"
234256
+ },
234257
+ {
234258
+ "kind": "primitive",
234259
+ "value": "any"
234260
+ },
234261
+ {
234262
+ "kind": "primitive",
234263
+ "value": "any"
234264
+ }
234265
+ ],
234266
+ "value": "BaseStencil<M, V, E, ID>"
234267
+ }
234268
+ ]
234269
+ },
234270
+ "trueType": {
234271
+ "kind": "symbol",
234272
+ "name": "StencilDefaultModifierReturn",
234273
+ "typeParameters": [
234274
+ {
234275
+ "kind": "intersection",
234276
+ "value": [
234277
+ {
234278
+ "kind": "symbol",
234279
+ "name": "ME",
234280
+ "value": "ME"
234281
+ },
234282
+ {
234283
+ "kind": "symbol",
234284
+ "name": "M",
234285
+ "value": "M"
234286
+ }
234287
+ ]
234288
+ }
234289
+ ],
234290
+ "value": "StencilDefaultModifierReturn<M>"
234291
+ },
234292
+ "falseType": {
234293
+ "kind": "symbol",
234294
+ "name": "StencilDefaultModifierReturn",
234295
+ "typeParameters": [
234296
+ {
234297
+ "kind": "symbol",
234298
+ "name": "M",
234299
+ "value": "M"
234300
+ }
234301
+ ],
234302
+ "value": "StencilDefaultModifierReturn<M>"
234303
+ }
234304
+ },
234305
+ "description": "",
234306
+ "declarations": [
234307
+ {
234308
+ "name": "defaultModifiers",
234309
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
234310
+ }
234311
+ ],
234312
+ "tags": {}
234313
+ },
234314
+ {
234315
+ "kind": "property",
234316
+ "name": "__extends",
234317
+ "required": false,
234318
+ "type": {
234319
+ "kind": "symbol",
234320
+ "name": "E",
234321
+ "value": "E"
234322
+ },
234323
+ "description": "",
234324
+ "declarations": [
234325
+ {
234326
+ "name": "__extends",
234327
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
234328
+ }
234329
+ ],
234330
+ "tags": {}
234331
+ },
234332
+ {
234333
+ "kind": "property",
234334
+ "name": "__vars",
234335
+ "required": true,
234336
+ "type": {
234337
+ "kind": "symbol",
234338
+ "name": "V",
234339
+ "value": "V"
234340
+ },
234341
+ "description": "",
234342
+ "declarations": [
234343
+ {
234344
+ "name": "__vars",
234345
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
234346
+ }
234347
+ ],
234348
+ "tags": {}
234349
+ },
234350
+ {
234351
+ "kind": "property",
234352
+ "name": "__modifiers",
234353
+ "required": true,
234354
+ "type": {
234355
+ "kind": "symbol",
234356
+ "name": "M",
234357
+ "value": "M"
234358
+ },
234359
+ "description": "",
234360
+ "declarations": [
234361
+ {
234362
+ "name": "__modifiers",
234363
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
234364
+ }
234365
+ ],
234366
+ "tags": {}
234367
+ },
234368
+ {
234369
+ "kind": "property",
234370
+ "name": "__id",
234371
+ "required": true,
234372
+ "type": {
234373
+ "kind": "symbol",
234374
+ "name": "ID",
234375
+ "value": "ID"
234376
+ },
234377
+ "description": "",
234378
+ "declarations": [
234379
+ {
234380
+ "name": "__id",
234381
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
233484
234382
  }
233485
234383
  ],
233486
234384
  "tags": {}
233487
234385
  }
233488
- ]
233489
- }
233490
- },
233491
- {
233492
- "name": "TextInputProps",
233493
- "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text-input/lib/TextInput.tsx",
233494
- "description": "",
233495
- "declarations": [
233496
- {
233497
- "name": "TextInputProps",
233498
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text-input/lib/TextInput.tsx"
234386
+ ],
234387
+ "returnType": {
234388
+ "kind": "object",
234389
+ "properties": [
234390
+ {
234391
+ "kind": "property",
234392
+ "name": "className",
234393
+ "required": true,
234394
+ "type": {
234395
+ "kind": "primitive",
234396
+ "value": "string"
234397
+ },
234398
+ "description": "",
234399
+ "declarations": [
234400
+ {
234401
+ "name": "className",
234402
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
234403
+ }
234404
+ ],
234405
+ "tags": {}
234406
+ },
234407
+ {
234408
+ "kind": "property",
234409
+ "name": "style",
234410
+ "required": false,
234411
+ "type": {
234412
+ "kind": "external",
234413
+ "name": "Record",
234414
+ "url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
234415
+ "typeParameters": [
234416
+ {
234417
+ "kind": "primitive",
234418
+ "value": "string"
234419
+ },
234420
+ {
234421
+ "kind": "primitive",
234422
+ "value": "string"
234423
+ }
234424
+ ]
234425
+ },
234426
+ "description": "",
234427
+ "declarations": [
234428
+ {
234429
+ "name": "style",
234430
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
234431
+ }
234432
+ ],
234433
+ "tags": {}
234434
+ }
234435
+ ]
233499
234436
  }
233500
- ],
233501
- "tags": {},
233502
- "type": {
233503
- "kind": "alias",
233504
- "name": "TextInput"
233505
234437
  }
233506
234438
  },
233507
234439
  {
@@ -233564,24 +234496,6 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
233564
234496
  ],
233565
234497
  "tags": {}
233566
234498
  },
233567
- {
233568
- "kind": "property",
233569
- "name": "theme",
233570
- "required": false,
233571
- "type": {
233572
- "kind": "symbol",
233573
- "name": "EmotionCanvasTheme",
233574
- "value": "EmotionCanvasTheme"
233575
- },
233576
- "description": "",
233577
- "declarations": [
233578
- {
233579
- "name": "theme",
233580
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/types.ts"
233581
- }
233582
- ],
233583
- "tags": {}
233584
- },
233585
234499
  {
233586
234500
  "kind": "property",
233587
234501
  "name": "grow",