@workday/canvas-kit-docs 11.1.0-821-next.0 → 11.1.0-864-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.
- package/dist/es6/lib/docs.js +2186 -688
- package/dist/es6/lib/specs.js +114 -14
- package/dist/es6/mdx/versionsTable.d.ts.map +1 -1
- package/dist/es6/mdx/versionsTable.js +4 -0
- package/dist/mdx/preview-react/divider/Divider.mdx +36 -0
- package/dist/mdx/preview-react/divider/examples/Basic.tsx +105 -0
- package/dist/mdx/preview-react/divider/examples/CustomSpace.tsx +32 -0
- package/dist/mdx/react/_examples/AriaLiveRegions.mdx +10 -6
- package/dist/mdx/react/_examples/examples/{common → AriaLiveRegions}/FilterListWithLiveStatus.tsx +18 -10
- package/dist/mdx/react/_examples/examples/AriaLiveRegions/HiddenLiveRegion.tsx +46 -0
- package/dist/mdx/react/_examples/examples/AriaLiveRegions/TextInputWithLiveError.tsx +31 -0
- package/dist/mdx/react/_examples/examples/AriaLiveRegions/VisibleLiveRegion.tsx +61 -0
- package/dist/mdx/react/button/button/Button.mdx +7 -0
- package/dist/mdx/react/button/button/examples/CustomStyles.tsx +15 -0
- package/dist/mdx/react/button/button/examples/Grow.tsx +26 -0
- package/dist/mdx/react/popup/Popup.mdx +13 -2
- package/dist/mdx/react/popup/examples/ExternalWindow.tsx +176 -0
- package/package.json +7 -7
- package/dist/mdx/react/_examples/examples/common/HiddenLiveRegion.tsx +0 -30
- package/dist/mdx/react/_examples/examples/common/TextInputWithLiveError.tsx +0 -25
- package/dist/mdx/react/_examples/examples/common/VisibleLiveRegion.tsx +0 -40
- /package/dist/mdx/react/_examples/examples/{common → AriaLiveRegions}/IconButtonsWithLiveBadges.tsx +0 -0
package/dist/es6/lib/docs.js
CHANGED
|
@@ -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",
|
|
@@ -5658,310 +5678,13 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
5658
5678
|
}
|
|
5659
5679
|
},
|
|
5660
5680
|
{
|
|
5661
|
-
"name": "
|
|
5662
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/
|
|
5663
|
-
"description": "",
|
|
5664
|
-
"declarations": [
|
|
5665
|
-
{
|
|
5666
|
-
"name": "FormFieldProps",
|
|
5667
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/FormField.tsx"
|
|
5668
|
-
}
|
|
5669
|
-
],
|
|
5670
|
-
"tags": {},
|
|
5671
|
-
"type": {
|
|
5672
|
-
"kind": "alias",
|
|
5673
|
-
"name": "FormField"
|
|
5674
|
-
}
|
|
5675
|
-
},
|
|
5676
|
-
{
|
|
5677
|
-
"name": "FormField",
|
|
5678
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/FormField.tsx",
|
|
5679
|
-
"description": "Use `FormField` to wrap input components to make them accessible. You can customize the field\nby passing in `TextInput`, `Select`, `RadioGroup` and other form elements to `FormField.Input` through the `as` prop.\n\n```tsx\n<FormField>\n <FormField.Label>First Name</FormField.Label>\n <FormField.Input as={TextInput} value={value} onChange={(e) => console.log(e)} />\n </FormField>\n```",
|
|
5680
|
-
"declarations": [
|
|
5681
|
-
{
|
|
5682
|
-
"name": "FormField",
|
|
5683
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/FormField.tsx"
|
|
5684
|
-
}
|
|
5685
|
-
],
|
|
5686
|
-
"tags": {
|
|
5687
|
-
"stencil": "formFieldStencil"
|
|
5688
|
-
},
|
|
5689
|
-
"type": {
|
|
5690
|
-
"kind": "enhancedComponent",
|
|
5691
|
-
"componentType": "container",
|
|
5692
|
-
"displayName": "FormField",
|
|
5693
|
-
"props": [
|
|
5694
|
-
{
|
|
5695
|
-
"kind": "property",
|
|
5696
|
-
"name": "orientation",
|
|
5697
|
-
"required": false,
|
|
5698
|
-
"type": {
|
|
5699
|
-
"kind": "union",
|
|
5700
|
-
"value": [
|
|
5701
|
-
{
|
|
5702
|
-
"kind": "string",
|
|
5703
|
-
"value": "vertical"
|
|
5704
|
-
},
|
|
5705
|
-
{
|
|
5706
|
-
"kind": "string",
|
|
5707
|
-
"value": "horizontal"
|
|
5708
|
-
}
|
|
5709
|
-
]
|
|
5710
|
-
},
|
|
5711
|
-
"description": "The direction the child elements should stack",
|
|
5712
|
-
"declarations": [
|
|
5713
|
-
{
|
|
5714
|
-
"name": "orientation",
|
|
5715
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/FormField.tsx"
|
|
5716
|
-
}
|
|
5717
|
-
],
|
|
5718
|
-
"tags": {
|
|
5719
|
-
"default": "vertical"
|
|
5720
|
-
},
|
|
5721
|
-
"defaultValue": {
|
|
5722
|
-
"kind": "symbol",
|
|
5723
|
-
"name": "vertical",
|
|
5724
|
-
"value": "vertical"
|
|
5725
|
-
}
|
|
5726
|
-
},
|
|
5727
|
-
{
|
|
5728
|
-
"kind": "property",
|
|
5729
|
-
"name": "children",
|
|
5730
|
-
"required": true,
|
|
5731
|
-
"type": {
|
|
5732
|
-
"kind": "external",
|
|
5733
|
-
"name": "ReactNode",
|
|
5734
|
-
"url": "https://reactjs.org/docs/rendering-elements.html"
|
|
5735
|
-
},
|
|
5736
|
-
"description": "",
|
|
5737
|
-
"declarations": [
|
|
5738
|
-
{
|
|
5739
|
-
"name": "children",
|
|
5740
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/FormField.tsx"
|
|
5741
|
-
}
|
|
5742
|
-
],
|
|
5743
|
-
"tags": {}
|
|
5744
|
-
},
|
|
5745
|
-
{
|
|
5746
|
-
"kind": "property",
|
|
5747
|
-
"name": "cs",
|
|
5748
|
-
"required": false,
|
|
5749
|
-
"type": {
|
|
5750
|
-
"kind": "symbol",
|
|
5751
|
-
"name": "CSToPropsInput",
|
|
5752
|
-
"value": "CSToPropsInput"
|
|
5753
|
-
},
|
|
5754
|
-
"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```",
|
|
5755
|
-
"declarations": [
|
|
5756
|
-
{
|
|
5757
|
-
"name": "cs",
|
|
5758
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
5759
|
-
}
|
|
5760
|
-
],
|
|
5761
|
-
"tags": {}
|
|
5762
|
-
},
|
|
5763
|
-
{
|
|
5764
|
-
"kind": "property",
|
|
5765
|
-
"name": "grow",
|
|
5766
|
-
"required": false,
|
|
5767
|
-
"type": {
|
|
5768
|
-
"kind": "primitive",
|
|
5769
|
-
"value": "boolean"
|
|
5770
|
-
},
|
|
5771
|
-
"description": "True if the component should grow to its container's width. False otherwise.",
|
|
5772
|
-
"declarations": [
|
|
5773
|
-
{
|
|
5774
|
-
"name": "grow",
|
|
5775
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/types.ts"
|
|
5776
|
-
}
|
|
5777
|
-
],
|
|
5778
|
-
"tags": {}
|
|
5779
|
-
},
|
|
5780
|
-
{
|
|
5781
|
-
"kind": "property",
|
|
5782
|
-
"name": "as",
|
|
5783
|
-
"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.",
|
|
5784
|
-
"tags": {},
|
|
5785
|
-
"declarations": [],
|
|
5786
|
-
"type": {
|
|
5787
|
-
"kind": "external",
|
|
5788
|
-
"name": "React.ElementType",
|
|
5789
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
|
|
5790
|
-
},
|
|
5791
|
-
"defaultValue": {
|
|
5792
|
-
"kind": "external",
|
|
5793
|
-
"name": "div",
|
|
5794
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div"
|
|
5795
|
-
}
|
|
5796
|
-
},
|
|
5797
|
-
{
|
|
5798
|
-
"kind": "property",
|
|
5799
|
-
"name": "ref",
|
|
5800
|
-
"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`).",
|
|
5801
|
-
"tags": {},
|
|
5802
|
-
"declarations": [],
|
|
5803
|
-
"type": {
|
|
5804
|
-
"kind": "external",
|
|
5805
|
-
"name": "React.Ref",
|
|
5806
|
-
"url": "https://reactjs.org/docs/refs-and-the-dom.html",
|
|
5807
|
-
"typeParameters": [
|
|
5808
|
-
{
|
|
5809
|
-
"kind": "typeParameter",
|
|
5810
|
-
"name": "R",
|
|
5811
|
-
"required": true,
|
|
5812
|
-
"defaultValue": {
|
|
5813
|
-
"kind": "external",
|
|
5814
|
-
"name": "div",
|
|
5815
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div"
|
|
5816
|
-
}
|
|
5817
|
-
}
|
|
5818
|
-
]
|
|
5819
|
-
}
|
|
5820
|
-
},
|
|
5821
|
-
{
|
|
5822
|
-
"kind": "property",
|
|
5823
|
-
"name": "model",
|
|
5824
|
-
"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.",
|
|
5825
|
-
"tags": {},
|
|
5826
|
-
"declarations": [],
|
|
5827
|
-
"type": {
|
|
5828
|
-
"kind": "symbol",
|
|
5829
|
-
"name": "FormFieldModel"
|
|
5830
|
-
}
|
|
5831
|
-
},
|
|
5832
|
-
{
|
|
5833
|
-
"kind": "property",
|
|
5834
|
-
"name": "elemPropsHook",
|
|
5835
|
-
"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.",
|
|
5836
|
-
"tags": {},
|
|
5837
|
-
"declarations": [],
|
|
5838
|
-
"type": {
|
|
5839
|
-
"kind": "function",
|
|
5840
|
-
"parameters": [
|
|
5841
|
-
{
|
|
5842
|
-
"kind": "parameter",
|
|
5843
|
-
"description": "",
|
|
5844
|
-
"tags": {},
|
|
5845
|
-
"declarations": [],
|
|
5846
|
-
"name": "model",
|
|
5847
|
-
"type": {
|
|
5848
|
-
"kind": "symbol",
|
|
5849
|
-
"name": "FormFieldModel"
|
|
5850
|
-
},
|
|
5851
|
-
"required": true
|
|
5852
|
-
},
|
|
5853
|
-
{
|
|
5854
|
-
"kind": "parameter",
|
|
5855
|
-
"description": "",
|
|
5856
|
-
"tags": {},
|
|
5857
|
-
"declarations": [],
|
|
5858
|
-
"name": "elemProps",
|
|
5859
|
-
"type": {
|
|
5860
|
-
"kind": "generic",
|
|
5861
|
-
"name": "TProps"
|
|
5862
|
-
}
|
|
5863
|
-
}
|
|
5864
|
-
],
|
|
5865
|
-
"returnType": {
|
|
5866
|
-
"kind": "external",
|
|
5867
|
-
"name": "HTML Attributes",
|
|
5868
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes"
|
|
5869
|
-
}
|
|
5870
|
-
}
|
|
5871
|
-
}
|
|
5872
|
-
],
|
|
5873
|
-
"baseElement": {
|
|
5874
|
-
"kind": "external",
|
|
5875
|
-
"name": "div",
|
|
5876
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div"
|
|
5877
|
-
},
|
|
5878
|
-
"model": "FormFieldModel",
|
|
5879
|
-
"styleComponent": {
|
|
5880
|
-
"kind": "symbol",
|
|
5881
|
-
"name": "Flex"
|
|
5882
|
-
},
|
|
5883
|
-
"subComponents": [
|
|
5884
|
-
{
|
|
5885
|
-
"name": "Input",
|
|
5886
|
-
"symbol": "FormFieldInput",
|
|
5887
|
-
"description": "`FormField.Input` will render any `inputs` passed to it via the `as` prop, including `TextInput`, `Select`, `Switch`, `TextArea`, `RadioGroup` or any custom input.\n`FromField.Input` will be associated with `FormField.Label` and `FormField.Hint` by a generated `id`. You can customize this `id` by passing `id` to `FormField`.\n\n**Note: If you pass in a custom input that is *not* as Canvas Kit input, you will have to handle the `error` prop, validation and styling. For a custom approach, reference our Custom storybook example.**\n\n```tsx\n <FormField id='my-unique-id'>\n <FormField.Label>My Label Text</FormField.Label>\n <FormField.Input as={TextInput} onChange={(e) => console.log(e)} />\n <FormField>\n```",
|
|
5888
|
-
"declarations": [
|
|
5889
|
-
{
|
|
5890
|
-
"name": "Input",
|
|
5891
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/FormField.tsx"
|
|
5892
|
-
},
|
|
5893
|
-
{
|
|
5894
|
-
"name": "FormFieldInput",
|
|
5895
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/FormFieldInput.tsx"
|
|
5896
|
-
}
|
|
5897
|
-
],
|
|
5898
|
-
"tags": {}
|
|
5899
|
-
},
|
|
5900
|
-
{
|
|
5901
|
-
"name": "Label",
|
|
5902
|
-
"symbol": "FormFieldLabel",
|
|
5903
|
-
"description": "`FormField.Label` will render a `label` element that has a matching `id` to the `FormField.Input`.\n\n```tsx\n<FormField>\n <FormField.Label>First Name</FormField.Label>\n <FormField.Input as={TextInput} value={value} onChange={(e) => console.log(e)} />\n </FormField>\n```",
|
|
5904
|
-
"declarations": [
|
|
5905
|
-
{
|
|
5906
|
-
"name": "Label",
|
|
5907
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/FormField.tsx"
|
|
5908
|
-
},
|
|
5909
|
-
{
|
|
5910
|
-
"name": "FormFieldLabel",
|
|
5911
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/FormFieldLabel.tsx"
|
|
5912
|
-
}
|
|
5913
|
-
],
|
|
5914
|
-
"tags": {
|
|
5915
|
-
"stencil": "formFieldLabelStencil"
|
|
5916
|
-
}
|
|
5917
|
-
},
|
|
5918
|
-
{
|
|
5919
|
-
"name": "Hint",
|
|
5920
|
-
"symbol": "FormFieldHint",
|
|
5921
|
-
"description": "`FormField.Hint` will render any additional information you want to provide to the `FormField.Input`. If you\nset the `orientation` prop to `horizontal` you should use `FormField.Container` to properly align the hint with your `FormField.Input`.\n\n```tsx\n<FormField>\n <FormField.Label>First Name</FormField.Label>\n <FormField.Input as={TextInput} value={value} onChange={(e) => console.log(e)} />\n <FormField.Hint>This is your hint text</FormField.Hint>\n </FormField>\n```",
|
|
5922
|
-
"declarations": [
|
|
5923
|
-
{
|
|
5924
|
-
"name": "Hint",
|
|
5925
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/FormField.tsx"
|
|
5926
|
-
},
|
|
5927
|
-
{
|
|
5928
|
-
"name": "FormFieldHint",
|
|
5929
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/FormFieldHint.tsx"
|
|
5930
|
-
}
|
|
5931
|
-
],
|
|
5932
|
-
"tags": {
|
|
5933
|
-
"stencil": "formFieldHintStencil"
|
|
5934
|
-
}
|
|
5935
|
-
},
|
|
5936
|
-
{
|
|
5937
|
-
"name": "Container",
|
|
5938
|
-
"symbol": "FormFieldContainer",
|
|
5939
|
-
"description": "`FormField.Container` allows you to properly center `FormField.Label` when the `orientation` is set to `horizontal` and there is hint text..\n\n```tsx\n<FormField orientation=\"horizontal\">\n <FormField.Label>First Name</FormField.Label>\n <FormField.Container>\n <FormField.Input as={TextInput} value={value} onChange={(e) => console.log(e)} />\n <FormField.Hint>This is your hint text</FormField.Hint>\n </FormField.Container>\n </FormField>\n```",
|
|
5940
|
-
"declarations": [
|
|
5941
|
-
{
|
|
5942
|
-
"name": "Container",
|
|
5943
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/FormField.tsx"
|
|
5944
|
-
},
|
|
5945
|
-
{
|
|
5946
|
-
"name": "FormFieldContainer",
|
|
5947
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/FormFieldContainer.tsx"
|
|
5948
|
-
}
|
|
5949
|
-
],
|
|
5950
|
-
"tags": {
|
|
5951
|
-
"stencil": "formFieldContainerStencil"
|
|
5952
|
-
}
|
|
5953
|
-
}
|
|
5954
|
-
]
|
|
5955
|
-
}
|
|
5956
|
-
},
|
|
5957
|
-
{
|
|
5958
|
-
"name": "formFieldContainerStencil",
|
|
5959
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/FormFieldContainer.tsx",
|
|
5681
|
+
"name": "dividerStencil",
|
|
5682
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/divider/lib/Divider.tsx",
|
|
5960
5683
|
"description": "",
|
|
5961
5684
|
"declarations": [
|
|
5962
5685
|
{
|
|
5963
|
-
"name": "
|
|
5964
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/
|
|
5686
|
+
"name": "dividerStencil",
|
|
5687
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/divider/lib/Divider.tsx"
|
|
5965
5688
|
}
|
|
5966
5689
|
],
|
|
5967
5690
|
"tags": {},
|
|
@@ -6518,21 +6241,63 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
6518
6241
|
}
|
|
6519
6242
|
},
|
|
6520
6243
|
{
|
|
6521
|
-
"name": "
|
|
6522
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/
|
|
6244
|
+
"name": "DividerProps",
|
|
6245
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/divider/lib/Divider.tsx",
|
|
6523
6246
|
"description": "",
|
|
6524
6247
|
"declarations": [
|
|
6525
6248
|
{
|
|
6526
|
-
"name": "
|
|
6527
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/
|
|
6249
|
+
"name": "DividerProps",
|
|
6250
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/divider/lib/Divider.tsx"
|
|
6528
6251
|
}
|
|
6529
6252
|
],
|
|
6530
6253
|
"tags": {},
|
|
6254
|
+
"type": {
|
|
6255
|
+
"kind": "alias",
|
|
6256
|
+
"name": "Divider"
|
|
6257
|
+
}
|
|
6258
|
+
},
|
|
6259
|
+
{
|
|
6260
|
+
"name": "Divider",
|
|
6261
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/divider/lib/Divider.tsx",
|
|
6262
|
+
"description": "# Divider\nA divider to segment and visually organize content. By default, it renders a semantic `[<hr>](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/hr)` element.\n\n[View Docs](https://workday.github.io/canvas-kit/?path=/docs/preview-divider-react)\n\nThe `space` prop will equally apply top and bottom margin styles.\nIn the example below, `x2` (0.5rem), adds `0.25rem` margin to the top and `0.25rem` to the bottom",
|
|
6263
|
+
"declarations": [
|
|
6264
|
+
{
|
|
6265
|
+
"name": "Divider",
|
|
6266
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/divider/lib/Divider.tsx"
|
|
6267
|
+
}
|
|
6268
|
+
],
|
|
6269
|
+
"tags": {
|
|
6270
|
+
"example": "```tsx\nimport { Divider } from '@workday/canvas-kit-preview-react/divider';\nimport {system} from '@workday/canvas-tokens-web';\n\n<Divider space={system.space.x2} />\n\n```"
|
|
6271
|
+
},
|
|
6531
6272
|
"type": {
|
|
6532
6273
|
"kind": "enhancedComponent",
|
|
6533
|
-
"componentType": "
|
|
6534
|
-
"displayName": "
|
|
6274
|
+
"componentType": "regular",
|
|
6275
|
+
"displayName": "Divider",
|
|
6535
6276
|
"props": [
|
|
6277
|
+
{
|
|
6278
|
+
"kind": "property",
|
|
6279
|
+
"name": "space",
|
|
6280
|
+
"required": false,
|
|
6281
|
+
"type": {
|
|
6282
|
+
"kind": "primitive",
|
|
6283
|
+
"value": "string"
|
|
6284
|
+
},
|
|
6285
|
+
"description": "Applies top and bottom margin evenly. It divides the provided value by two and applies half to each end.\nE.g. `space=\"2rem\"` would apply `1rem` margin to the top, and `1rem` margin to the bottom.",
|
|
6286
|
+
"declarations": [
|
|
6287
|
+
{
|
|
6288
|
+
"name": "space",
|
|
6289
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/divider/lib/Divider.tsx"
|
|
6290
|
+
}
|
|
6291
|
+
],
|
|
6292
|
+
"tags": {
|
|
6293
|
+
"default": "`system.space.x4` (1rem)"
|
|
6294
|
+
},
|
|
6295
|
+
"defaultValue": {
|
|
6296
|
+
"kind": "symbol",
|
|
6297
|
+
"name": "`system.space.x4` (1rem)",
|
|
6298
|
+
"value": "`system.space.x4` (1rem)"
|
|
6299
|
+
}
|
|
6300
|
+
},
|
|
6536
6301
|
{
|
|
6537
6302
|
"kind": "property",
|
|
6538
6303
|
"name": "cs",
|
|
@@ -6563,6 +6328,175 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
6563
6328
|
"url": "https://reactjs.org/docs/rendering-elements.html"
|
|
6564
6329
|
}
|
|
6565
6330
|
},
|
|
6331
|
+
{
|
|
6332
|
+
"kind": "property",
|
|
6333
|
+
"name": "as",
|
|
6334
|
+
"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.",
|
|
6335
|
+
"tags": {},
|
|
6336
|
+
"declarations": [],
|
|
6337
|
+
"type": {
|
|
6338
|
+
"kind": "external",
|
|
6339
|
+
"name": "React.ElementType",
|
|
6340
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
|
|
6341
|
+
},
|
|
6342
|
+
"defaultValue": {
|
|
6343
|
+
"kind": "external",
|
|
6344
|
+
"name": "hr",
|
|
6345
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/hr"
|
|
6346
|
+
}
|
|
6347
|
+
},
|
|
6348
|
+
{
|
|
6349
|
+
"kind": "property",
|
|
6350
|
+
"name": "ref",
|
|
6351
|
+
"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`).",
|
|
6352
|
+
"tags": {},
|
|
6353
|
+
"declarations": [],
|
|
6354
|
+
"type": {
|
|
6355
|
+
"kind": "external",
|
|
6356
|
+
"name": "React.Ref",
|
|
6357
|
+
"url": "https://reactjs.org/docs/refs-and-the-dom.html",
|
|
6358
|
+
"typeParameters": [
|
|
6359
|
+
{
|
|
6360
|
+
"kind": "typeParameter",
|
|
6361
|
+
"name": "R",
|
|
6362
|
+
"required": true,
|
|
6363
|
+
"defaultValue": {
|
|
6364
|
+
"kind": "external",
|
|
6365
|
+
"name": "hr",
|
|
6366
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/hr"
|
|
6367
|
+
}
|
|
6368
|
+
}
|
|
6369
|
+
]
|
|
6370
|
+
}
|
|
6371
|
+
}
|
|
6372
|
+
],
|
|
6373
|
+
"baseElement": {
|
|
6374
|
+
"kind": "external",
|
|
6375
|
+
"name": "hr",
|
|
6376
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/hr"
|
|
6377
|
+
}
|
|
6378
|
+
}
|
|
6379
|
+
},
|
|
6380
|
+
{
|
|
6381
|
+
"name": "FormFieldProps",
|
|
6382
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/FormField.tsx",
|
|
6383
|
+
"description": "",
|
|
6384
|
+
"declarations": [
|
|
6385
|
+
{
|
|
6386
|
+
"name": "FormFieldProps",
|
|
6387
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/FormField.tsx"
|
|
6388
|
+
}
|
|
6389
|
+
],
|
|
6390
|
+
"tags": {},
|
|
6391
|
+
"type": {
|
|
6392
|
+
"kind": "alias",
|
|
6393
|
+
"name": "FormField"
|
|
6394
|
+
}
|
|
6395
|
+
},
|
|
6396
|
+
{
|
|
6397
|
+
"name": "FormField",
|
|
6398
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/FormField.tsx",
|
|
6399
|
+
"description": "Use `FormField` to wrap input components to make them accessible. You can customize the field\nby passing in `TextInput`, `Select`, `RadioGroup` and other form elements to `FormField.Input` through the `as` prop.\n\n```tsx\n<FormField>\n <FormField.Label>First Name</FormField.Label>\n <FormField.Input as={TextInput} value={value} onChange={(e) => console.log(e)} />\n </FormField>\n```",
|
|
6400
|
+
"declarations": [
|
|
6401
|
+
{
|
|
6402
|
+
"name": "FormField",
|
|
6403
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/FormField.tsx"
|
|
6404
|
+
}
|
|
6405
|
+
],
|
|
6406
|
+
"tags": {
|
|
6407
|
+
"stencil": "formFieldStencil"
|
|
6408
|
+
},
|
|
6409
|
+
"type": {
|
|
6410
|
+
"kind": "enhancedComponent",
|
|
6411
|
+
"componentType": "container",
|
|
6412
|
+
"displayName": "FormField",
|
|
6413
|
+
"props": [
|
|
6414
|
+
{
|
|
6415
|
+
"kind": "property",
|
|
6416
|
+
"name": "orientation",
|
|
6417
|
+
"required": false,
|
|
6418
|
+
"type": {
|
|
6419
|
+
"kind": "union",
|
|
6420
|
+
"value": [
|
|
6421
|
+
{
|
|
6422
|
+
"kind": "string",
|
|
6423
|
+
"value": "vertical"
|
|
6424
|
+
},
|
|
6425
|
+
{
|
|
6426
|
+
"kind": "string",
|
|
6427
|
+
"value": "horizontal"
|
|
6428
|
+
}
|
|
6429
|
+
]
|
|
6430
|
+
},
|
|
6431
|
+
"description": "The direction the child elements should stack",
|
|
6432
|
+
"declarations": [
|
|
6433
|
+
{
|
|
6434
|
+
"name": "orientation",
|
|
6435
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/FormField.tsx"
|
|
6436
|
+
}
|
|
6437
|
+
],
|
|
6438
|
+
"tags": {
|
|
6439
|
+
"default": "vertical"
|
|
6440
|
+
},
|
|
6441
|
+
"defaultValue": {
|
|
6442
|
+
"kind": "symbol",
|
|
6443
|
+
"name": "vertical",
|
|
6444
|
+
"value": "vertical"
|
|
6445
|
+
}
|
|
6446
|
+
},
|
|
6447
|
+
{
|
|
6448
|
+
"kind": "property",
|
|
6449
|
+
"name": "children",
|
|
6450
|
+
"required": true,
|
|
6451
|
+
"type": {
|
|
6452
|
+
"kind": "external",
|
|
6453
|
+
"name": "ReactNode",
|
|
6454
|
+
"url": "https://reactjs.org/docs/rendering-elements.html"
|
|
6455
|
+
},
|
|
6456
|
+
"description": "",
|
|
6457
|
+
"declarations": [
|
|
6458
|
+
{
|
|
6459
|
+
"name": "children",
|
|
6460
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/FormField.tsx"
|
|
6461
|
+
}
|
|
6462
|
+
],
|
|
6463
|
+
"tags": {}
|
|
6464
|
+
},
|
|
6465
|
+
{
|
|
6466
|
+
"kind": "property",
|
|
6467
|
+
"name": "cs",
|
|
6468
|
+
"required": false,
|
|
6469
|
+
"type": {
|
|
6470
|
+
"kind": "symbol",
|
|
6471
|
+
"name": "CSToPropsInput",
|
|
6472
|
+
"value": "CSToPropsInput"
|
|
6473
|
+
},
|
|
6474
|
+
"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```",
|
|
6475
|
+
"declarations": [
|
|
6476
|
+
{
|
|
6477
|
+
"name": "cs",
|
|
6478
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
6479
|
+
}
|
|
6480
|
+
],
|
|
6481
|
+
"tags": {}
|
|
6482
|
+
},
|
|
6483
|
+
{
|
|
6484
|
+
"kind": "property",
|
|
6485
|
+
"name": "grow",
|
|
6486
|
+
"required": false,
|
|
6487
|
+
"type": {
|
|
6488
|
+
"kind": "primitive",
|
|
6489
|
+
"value": "boolean"
|
|
6490
|
+
},
|
|
6491
|
+
"description": "True if the component should grow to its container's width. False otherwise.",
|
|
6492
|
+
"declarations": [
|
|
6493
|
+
{
|
|
6494
|
+
"name": "grow",
|
|
6495
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/types.ts"
|
|
6496
|
+
}
|
|
6497
|
+
],
|
|
6498
|
+
"tags": {}
|
|
6499
|
+
},
|
|
6566
6500
|
{
|
|
6567
6501
|
"kind": "property",
|
|
6568
6502
|
"name": "as",
|
|
@@ -6661,17 +6595,93 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
6661
6595
|
"name": "div",
|
|
6662
6596
|
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div"
|
|
6663
6597
|
},
|
|
6664
|
-
"model": "FormFieldModel"
|
|
6598
|
+
"model": "FormFieldModel",
|
|
6599
|
+
"styleComponent": {
|
|
6600
|
+
"kind": "symbol",
|
|
6601
|
+
"name": "Flex"
|
|
6602
|
+
},
|
|
6603
|
+
"subComponents": [
|
|
6604
|
+
{
|
|
6605
|
+
"name": "Input",
|
|
6606
|
+
"symbol": "FormFieldInput",
|
|
6607
|
+
"description": "`FormField.Input` will render any `inputs` passed to it via the `as` prop, including `TextInput`, `Select`, `Switch`, `TextArea`, `RadioGroup` or any custom input.\n`FromField.Input` will be associated with `FormField.Label` and `FormField.Hint` by a generated `id`. You can customize this `id` by passing `id` to `FormField`.\n\n**Note: If you pass in a custom input that is *not* as Canvas Kit input, you will have to handle the `error` prop, validation and styling. For a custom approach, reference our Custom storybook example.**\n\n```tsx\n <FormField id='my-unique-id'>\n <FormField.Label>My Label Text</FormField.Label>\n <FormField.Input as={TextInput} onChange={(e) => console.log(e)} />\n <FormField>\n```",
|
|
6608
|
+
"declarations": [
|
|
6609
|
+
{
|
|
6610
|
+
"name": "Input",
|
|
6611
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/FormField.tsx"
|
|
6612
|
+
},
|
|
6613
|
+
{
|
|
6614
|
+
"name": "FormFieldInput",
|
|
6615
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/FormFieldInput.tsx"
|
|
6616
|
+
}
|
|
6617
|
+
],
|
|
6618
|
+
"tags": {}
|
|
6619
|
+
},
|
|
6620
|
+
{
|
|
6621
|
+
"name": "Label",
|
|
6622
|
+
"symbol": "FormFieldLabel",
|
|
6623
|
+
"description": "`FormField.Label` will render a `label` element that has a matching `id` to the `FormField.Input`.\n\n```tsx\n<FormField>\n <FormField.Label>First Name</FormField.Label>\n <FormField.Input as={TextInput} value={value} onChange={(e) => console.log(e)} />\n </FormField>\n```",
|
|
6624
|
+
"declarations": [
|
|
6625
|
+
{
|
|
6626
|
+
"name": "Label",
|
|
6627
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/FormField.tsx"
|
|
6628
|
+
},
|
|
6629
|
+
{
|
|
6630
|
+
"name": "FormFieldLabel",
|
|
6631
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/FormFieldLabel.tsx"
|
|
6632
|
+
}
|
|
6633
|
+
],
|
|
6634
|
+
"tags": {
|
|
6635
|
+
"stencil": "formFieldLabelStencil"
|
|
6636
|
+
}
|
|
6637
|
+
},
|
|
6638
|
+
{
|
|
6639
|
+
"name": "Hint",
|
|
6640
|
+
"symbol": "FormFieldHint",
|
|
6641
|
+
"description": "`FormField.Hint` will render any additional information you want to provide to the `FormField.Input`. If you\nset the `orientation` prop to `horizontal` you should use `FormField.Container` to properly align the hint with your `FormField.Input`.\n\n```tsx\n<FormField>\n <FormField.Label>First Name</FormField.Label>\n <FormField.Input as={TextInput} value={value} onChange={(e) => console.log(e)} />\n <FormField.Hint>This is your hint text</FormField.Hint>\n </FormField>\n```",
|
|
6642
|
+
"declarations": [
|
|
6643
|
+
{
|
|
6644
|
+
"name": "Hint",
|
|
6645
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/FormField.tsx"
|
|
6646
|
+
},
|
|
6647
|
+
{
|
|
6648
|
+
"name": "FormFieldHint",
|
|
6649
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/FormFieldHint.tsx"
|
|
6650
|
+
}
|
|
6651
|
+
],
|
|
6652
|
+
"tags": {
|
|
6653
|
+
"stencil": "formFieldHintStencil"
|
|
6654
|
+
}
|
|
6655
|
+
},
|
|
6656
|
+
{
|
|
6657
|
+
"name": "Container",
|
|
6658
|
+
"symbol": "FormFieldContainer",
|
|
6659
|
+
"description": "`FormField.Container` allows you to properly center `FormField.Label` when the `orientation` is set to `horizontal` and there is hint text..\n\n```tsx\n<FormField orientation=\"horizontal\">\n <FormField.Label>First Name</FormField.Label>\n <FormField.Container>\n <FormField.Input as={TextInput} value={value} onChange={(e) => console.log(e)} />\n <FormField.Hint>This is your hint text</FormField.Hint>\n </FormField.Container>\n </FormField>\n```",
|
|
6660
|
+
"declarations": [
|
|
6661
|
+
{
|
|
6662
|
+
"name": "Container",
|
|
6663
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/FormField.tsx"
|
|
6664
|
+
},
|
|
6665
|
+
{
|
|
6666
|
+
"name": "FormFieldContainer",
|
|
6667
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/FormFieldContainer.tsx"
|
|
6668
|
+
}
|
|
6669
|
+
],
|
|
6670
|
+
"tags": {
|
|
6671
|
+
"stencil": "formFieldContainerStencil"
|
|
6672
|
+
}
|
|
6673
|
+
}
|
|
6674
|
+
]
|
|
6665
6675
|
}
|
|
6666
6676
|
},
|
|
6667
6677
|
{
|
|
6668
|
-
"name": "
|
|
6669
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/
|
|
6678
|
+
"name": "formFieldContainerStencil",
|
|
6679
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/FormFieldContainer.tsx",
|
|
6670
6680
|
"description": "",
|
|
6671
6681
|
"declarations": [
|
|
6672
6682
|
{
|
|
6673
|
-
"name": "
|
|
6674
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/
|
|
6683
|
+
"name": "formFieldContainerStencil",
|
|
6684
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/FormFieldContainer.tsx"
|
|
6675
6685
|
}
|
|
6676
6686
|
],
|
|
6677
6687
|
"tags": {},
|
|
@@ -7228,275 +7238,20 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
7228
7238
|
}
|
|
7229
7239
|
},
|
|
7230
7240
|
{
|
|
7231
|
-
"name": "
|
|
7232
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/
|
|
7233
|
-
"description": "",
|
|
7234
|
-
"declarations": [
|
|
7235
|
-
{
|
|
7236
|
-
"name": "FormFieldHint",
|
|
7237
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/FormFieldHint.tsx"
|
|
7238
|
-
}
|
|
7239
|
-
],
|
|
7240
|
-
"tags": {},
|
|
7241
|
-
"type": {
|
|
7242
|
-
"kind": "enhancedComponent",
|
|
7243
|
-
"componentType": "subcomponent",
|
|
7244
|
-
"elemPropsHook": "useFormFieldHint",
|
|
7245
|
-
"displayName": "FormField.Hint",
|
|
7246
|
-
"props": [
|
|
7247
|
-
{
|
|
7248
|
-
"kind": "property",
|
|
7249
|
-
"name": "typeLevel",
|
|
7250
|
-
"required": false,
|
|
7251
|
-
"type": {
|
|
7252
|
-
"kind": "union",
|
|
7253
|
-
"value": [
|
|
7254
|
-
{
|
|
7255
|
-
"kind": "string",
|
|
7256
|
-
"value": "subtext.medium"
|
|
7257
|
-
},
|
|
7258
|
-
{
|
|
7259
|
-
"kind": "string",
|
|
7260
|
-
"value": "title.large"
|
|
7261
|
-
},
|
|
7262
|
-
{
|
|
7263
|
-
"kind": "string",
|
|
7264
|
-
"value": "title.medium"
|
|
7265
|
-
},
|
|
7266
|
-
{
|
|
7267
|
-
"kind": "string",
|
|
7268
|
-
"value": "title.small"
|
|
7269
|
-
},
|
|
7270
|
-
{
|
|
7271
|
-
"kind": "string",
|
|
7272
|
-
"value": "heading.large"
|
|
7273
|
-
},
|
|
7274
|
-
{
|
|
7275
|
-
"kind": "string",
|
|
7276
|
-
"value": "heading.medium"
|
|
7277
|
-
},
|
|
7278
|
-
{
|
|
7279
|
-
"kind": "string",
|
|
7280
|
-
"value": "heading.small"
|
|
7281
|
-
},
|
|
7282
|
-
{
|
|
7283
|
-
"kind": "string",
|
|
7284
|
-
"value": "body.large"
|
|
7285
|
-
},
|
|
7286
|
-
{
|
|
7287
|
-
"kind": "string",
|
|
7288
|
-
"value": "body.medium"
|
|
7289
|
-
},
|
|
7290
|
-
{
|
|
7291
|
-
"kind": "string",
|
|
7292
|
-
"value": "body.small"
|
|
7293
|
-
},
|
|
7294
|
-
{
|
|
7295
|
-
"kind": "string",
|
|
7296
|
-
"value": "subtext.large"
|
|
7297
|
-
},
|
|
7298
|
-
{
|
|
7299
|
-
"kind": "string",
|
|
7300
|
-
"value": "subtext.small"
|
|
7301
|
-
}
|
|
7302
|
-
]
|
|
7303
|
-
},
|
|
7304
|
-
"description": "Type token as string with level and size separated by dot.\nThese values map to our [Canvas type levels](https://canvas.workday.com/tokens/type#type-styles).\n\n```tsx\n<Text typeLevel=\"body.small\">Small body text</Text>\n```",
|
|
7305
|
-
"declarations": [
|
|
7306
|
-
{
|
|
7307
|
-
"name": "typeLevel",
|
|
7308
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/Text.tsx"
|
|
7309
|
-
}
|
|
7310
|
-
],
|
|
7311
|
-
"tags": {}
|
|
7312
|
-
},
|
|
7313
|
-
{
|
|
7314
|
-
"kind": "property",
|
|
7315
|
-
"name": "variant",
|
|
7316
|
-
"required": false,
|
|
7317
|
-
"type": {
|
|
7318
|
-
"kind": "union",
|
|
7319
|
-
"value": [
|
|
7320
|
-
{
|
|
7321
|
-
"kind": "string",
|
|
7322
|
-
"value": "error"
|
|
7323
|
-
},
|
|
7324
|
-
{
|
|
7325
|
-
"kind": "string",
|
|
7326
|
-
"value": "hint"
|
|
7327
|
-
},
|
|
7328
|
-
{
|
|
7329
|
-
"kind": "string",
|
|
7330
|
-
"value": "inverse"
|
|
7331
|
-
}
|
|
7332
|
-
]
|
|
7333
|
-
},
|
|
7334
|
-
"description": "Type variant token names: `error`, `hint` or `inverse`.\n\n```tsx\n<Text variant=\"error\" typeLevel=\"subtext.large\">Error text</Text>\n```",
|
|
7335
|
-
"declarations": [
|
|
7336
|
-
{
|
|
7337
|
-
"name": "variant",
|
|
7338
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/Text.tsx"
|
|
7339
|
-
}
|
|
7340
|
-
],
|
|
7341
|
-
"tags": {}
|
|
7342
|
-
},
|
|
7343
|
-
{
|
|
7344
|
-
"kind": "property",
|
|
7345
|
-
"name": "cs",
|
|
7346
|
-
"required": false,
|
|
7347
|
-
"type": {
|
|
7348
|
-
"kind": "symbol",
|
|
7349
|
-
"name": "CSToPropsInput",
|
|
7350
|
-
"value": "CSToPropsInput"
|
|
7351
|
-
},
|
|
7352
|
-
"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```",
|
|
7353
|
-
"declarations": [
|
|
7354
|
-
{
|
|
7355
|
-
"name": "cs",
|
|
7356
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
7357
|
-
}
|
|
7358
|
-
],
|
|
7359
|
-
"tags": {}
|
|
7360
|
-
},
|
|
7361
|
-
{
|
|
7362
|
-
"kind": "property",
|
|
7363
|
-
"name": "children",
|
|
7364
|
-
"required": false,
|
|
7365
|
-
"type": {
|
|
7366
|
-
"kind": "external",
|
|
7367
|
-
"name": "ReactNode",
|
|
7368
|
-
"url": "https://reactjs.org/docs/rendering-elements.html"
|
|
7369
|
-
},
|
|
7370
|
-
"description": "",
|
|
7371
|
-
"declarations": [
|
|
7372
|
-
{
|
|
7373
|
-
"name": "children",
|
|
7374
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/layout/lib/Box.tsx"
|
|
7375
|
-
}
|
|
7376
|
-
],
|
|
7377
|
-
"tags": {}
|
|
7378
|
-
},
|
|
7379
|
-
{
|
|
7380
|
-
"kind": "property",
|
|
7381
|
-
"name": "as",
|
|
7382
|
-
"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.",
|
|
7383
|
-
"tags": {},
|
|
7384
|
-
"declarations": [],
|
|
7385
|
-
"type": {
|
|
7386
|
-
"kind": "external",
|
|
7387
|
-
"name": "React.ElementType",
|
|
7388
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
|
|
7389
|
-
},
|
|
7390
|
-
"defaultValue": {
|
|
7391
|
-
"kind": "external",
|
|
7392
|
-
"name": "p",
|
|
7393
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/p"
|
|
7394
|
-
}
|
|
7395
|
-
},
|
|
7396
|
-
{
|
|
7397
|
-
"kind": "property",
|
|
7398
|
-
"name": "ref",
|
|
7399
|
-
"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`).",
|
|
7400
|
-
"tags": {},
|
|
7401
|
-
"declarations": [],
|
|
7402
|
-
"type": {
|
|
7403
|
-
"kind": "external",
|
|
7404
|
-
"name": "React.Ref",
|
|
7405
|
-
"url": "https://reactjs.org/docs/refs-and-the-dom.html",
|
|
7406
|
-
"typeParameters": [
|
|
7407
|
-
{
|
|
7408
|
-
"kind": "typeParameter",
|
|
7409
|
-
"name": "R",
|
|
7410
|
-
"required": true,
|
|
7411
|
-
"defaultValue": {
|
|
7412
|
-
"kind": "external",
|
|
7413
|
-
"name": "p",
|
|
7414
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/p"
|
|
7415
|
-
}
|
|
7416
|
-
}
|
|
7417
|
-
]
|
|
7418
|
-
}
|
|
7419
|
-
},
|
|
7420
|
-
{
|
|
7421
|
-
"kind": "property",
|
|
7422
|
-
"name": "model",
|
|
7423
|
-
"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.",
|
|
7424
|
-
"tags": {},
|
|
7425
|
-
"declarations": [],
|
|
7426
|
-
"type": {
|
|
7427
|
-
"kind": "symbol",
|
|
7428
|
-
"name": "FormFieldModel"
|
|
7429
|
-
}
|
|
7430
|
-
},
|
|
7431
|
-
{
|
|
7432
|
-
"kind": "property",
|
|
7433
|
-
"name": "elemPropsHook",
|
|
7434
|
-
"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.",
|
|
7435
|
-
"tags": {},
|
|
7436
|
-
"declarations": [],
|
|
7437
|
-
"type": {
|
|
7438
|
-
"kind": "function",
|
|
7439
|
-
"parameters": [
|
|
7440
|
-
{
|
|
7441
|
-
"kind": "parameter",
|
|
7442
|
-
"description": "",
|
|
7443
|
-
"tags": {},
|
|
7444
|
-
"declarations": [],
|
|
7445
|
-
"name": "model",
|
|
7446
|
-
"type": {
|
|
7447
|
-
"kind": "symbol",
|
|
7448
|
-
"name": "FormFieldModel"
|
|
7449
|
-
},
|
|
7450
|
-
"required": true
|
|
7451
|
-
},
|
|
7452
|
-
{
|
|
7453
|
-
"kind": "parameter",
|
|
7454
|
-
"description": "",
|
|
7455
|
-
"tags": {},
|
|
7456
|
-
"declarations": [],
|
|
7457
|
-
"name": "elemProps",
|
|
7458
|
-
"type": {
|
|
7459
|
-
"kind": "generic",
|
|
7460
|
-
"name": "TProps"
|
|
7461
|
-
}
|
|
7462
|
-
}
|
|
7463
|
-
],
|
|
7464
|
-
"returnType": {
|
|
7465
|
-
"kind": "external",
|
|
7466
|
-
"name": "HTML Attributes",
|
|
7467
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes"
|
|
7468
|
-
}
|
|
7469
|
-
}
|
|
7470
|
-
}
|
|
7471
|
-
],
|
|
7472
|
-
"baseElement": {
|
|
7473
|
-
"kind": "external",
|
|
7474
|
-
"name": "p",
|
|
7475
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/p"
|
|
7476
|
-
},
|
|
7477
|
-
"styleComponent": {
|
|
7478
|
-
"kind": "symbol",
|
|
7479
|
-
"name": "Box"
|
|
7480
|
-
},
|
|
7481
|
-
"model": "FormFieldModel"
|
|
7482
|
-
}
|
|
7483
|
-
},
|
|
7484
|
-
{
|
|
7485
|
-
"name": "FormFieldInput",
|
|
7486
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/FormFieldInput.tsx",
|
|
7241
|
+
"name": "FormFieldContainer",
|
|
7242
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/FormFieldContainer.tsx",
|
|
7487
7243
|
"description": "",
|
|
7488
7244
|
"declarations": [
|
|
7489
7245
|
{
|
|
7490
|
-
"name": "
|
|
7491
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/
|
|
7246
|
+
"name": "FormFieldContainer",
|
|
7247
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/FormFieldContainer.tsx"
|
|
7492
7248
|
}
|
|
7493
7249
|
],
|
|
7494
7250
|
"tags": {},
|
|
7495
7251
|
"type": {
|
|
7496
7252
|
"kind": "enhancedComponent",
|
|
7497
7253
|
"componentType": "subcomponent",
|
|
7498
|
-
"
|
|
7499
|
-
"displayName": "FormField.Input",
|
|
7254
|
+
"displayName": "FormField.Container",
|
|
7500
7255
|
"props": [
|
|
7501
7256
|
{
|
|
7502
7257
|
"kind": "property",
|
|
@@ -7541,8 +7296,8 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
7541
7296
|
},
|
|
7542
7297
|
"defaultValue": {
|
|
7543
7298
|
"kind": "external",
|
|
7544
|
-
"name": "
|
|
7545
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/
|
|
7299
|
+
"name": "div",
|
|
7300
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div"
|
|
7546
7301
|
}
|
|
7547
7302
|
},
|
|
7548
7303
|
{
|
|
@@ -7562,8 +7317,8 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
7562
7317
|
"required": true,
|
|
7563
7318
|
"defaultValue": {
|
|
7564
7319
|
"kind": "external",
|
|
7565
|
-
"name": "
|
|
7566
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/
|
|
7320
|
+
"name": "div",
|
|
7321
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div"
|
|
7567
7322
|
}
|
|
7568
7323
|
}
|
|
7569
7324
|
]
|
|
@@ -7623,40 +7378,20 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
7623
7378
|
],
|
|
7624
7379
|
"baseElement": {
|
|
7625
7380
|
"kind": "external",
|
|
7626
|
-
"name": "
|
|
7627
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/
|
|
7628
|
-
},
|
|
7629
|
-
"styleComponent": {
|
|
7630
|
-
"kind": "symbol",
|
|
7631
|
-
"name": "Box"
|
|
7381
|
+
"name": "div",
|
|
7382
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div"
|
|
7632
7383
|
},
|
|
7633
7384
|
"model": "FormFieldModel"
|
|
7634
7385
|
}
|
|
7635
7386
|
},
|
|
7636
7387
|
{
|
|
7637
|
-
"name": "
|
|
7638
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/
|
|
7639
|
-
"description": "",
|
|
7640
|
-
"declarations": [
|
|
7641
|
-
{
|
|
7642
|
-
"name": "FormFieldLabelProps",
|
|
7643
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/FormFieldLabel.tsx"
|
|
7644
|
-
}
|
|
7645
|
-
],
|
|
7646
|
-
"tags": {},
|
|
7647
|
-
"type": {
|
|
7648
|
-
"kind": "alias",
|
|
7649
|
-
"name": "FormFieldLabel"
|
|
7650
|
-
}
|
|
7651
|
-
},
|
|
7652
|
-
{
|
|
7653
|
-
"name": "formFieldLabelStencil",
|
|
7654
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/FormFieldLabel.tsx",
|
|
7388
|
+
"name": "formFieldHintStencil",
|
|
7389
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/FormFieldHint.tsx",
|
|
7655
7390
|
"description": "",
|
|
7656
7391
|
"declarations": [
|
|
7657
7392
|
{
|
|
7658
|
-
"name": "
|
|
7659
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/
|
|
7393
|
+
"name": "formFieldHintStencil",
|
|
7394
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/FormFieldHint.tsx"
|
|
7660
7395
|
}
|
|
7661
7396
|
],
|
|
7662
7397
|
"tags": {},
|
|
@@ -8213,88 +7948,22 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
8213
7948
|
}
|
|
8214
7949
|
},
|
|
8215
7950
|
{
|
|
8216
|
-
"name": "
|
|
8217
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/
|
|
7951
|
+
"name": "FormFieldHint",
|
|
7952
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/FormFieldHint.tsx",
|
|
8218
7953
|
"description": "",
|
|
8219
7954
|
"declarations": [
|
|
8220
7955
|
{
|
|
8221
|
-
"name": "
|
|
8222
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/
|
|
7956
|
+
"name": "FormFieldHint",
|
|
7957
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/FormFieldHint.tsx"
|
|
8223
7958
|
}
|
|
8224
7959
|
],
|
|
8225
7960
|
"tags": {},
|
|
8226
7961
|
"type": {
|
|
8227
7962
|
"kind": "enhancedComponent",
|
|
8228
7963
|
"componentType": "subcomponent",
|
|
8229
|
-
"elemPropsHook": "
|
|
8230
|
-
"displayName": "FormField.
|
|
7964
|
+
"elemPropsHook": "useFormFieldHint",
|
|
7965
|
+
"displayName": "FormField.Hint",
|
|
8231
7966
|
"props": [
|
|
8232
|
-
{
|
|
8233
|
-
"kind": "property",
|
|
8234
|
-
"name": "children",
|
|
8235
|
-
"required": true,
|
|
8236
|
-
"type": {
|
|
8237
|
-
"kind": "external",
|
|
8238
|
-
"name": "ReactNode",
|
|
8239
|
-
"url": "https://reactjs.org/docs/rendering-elements.html"
|
|
8240
|
-
},
|
|
8241
|
-
"description": "The text of the label.",
|
|
8242
|
-
"declarations": [
|
|
8243
|
-
{
|
|
8244
|
-
"name": "children",
|
|
8245
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/FormFieldLabel.tsx"
|
|
8246
|
-
}
|
|
8247
|
-
],
|
|
8248
|
-
"tags": {}
|
|
8249
|
-
},
|
|
8250
|
-
{
|
|
8251
|
-
"kind": "property",
|
|
8252
|
-
"name": "cs",
|
|
8253
|
-
"required": false,
|
|
8254
|
-
"type": {
|
|
8255
|
-
"kind": "symbol",
|
|
8256
|
-
"name": "CSToPropsInput",
|
|
8257
|
-
"value": "CSToPropsInput"
|
|
8258
|
-
},
|
|
8259
|
-
"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```",
|
|
8260
|
-
"declarations": [
|
|
8261
|
-
{
|
|
8262
|
-
"name": "cs",
|
|
8263
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
8264
|
-
}
|
|
8265
|
-
],
|
|
8266
|
-
"tags": {}
|
|
8267
|
-
},
|
|
8268
|
-
{
|
|
8269
|
-
"kind": "property",
|
|
8270
|
-
"name": "variant",
|
|
8271
|
-
"required": false,
|
|
8272
|
-
"type": {
|
|
8273
|
-
"kind": "union",
|
|
8274
|
-
"value": [
|
|
8275
|
-
{
|
|
8276
|
-
"kind": "string",
|
|
8277
|
-
"value": "error"
|
|
8278
|
-
},
|
|
8279
|
-
{
|
|
8280
|
-
"kind": "string",
|
|
8281
|
-
"value": "hint"
|
|
8282
|
-
},
|
|
8283
|
-
{
|
|
8284
|
-
"kind": "string",
|
|
8285
|
-
"value": "inverse"
|
|
8286
|
-
}
|
|
8287
|
-
]
|
|
8288
|
-
},
|
|
8289
|
-
"description": "Type variant token names: `error`, `hint` or `inverse`.\n\n```tsx\n<Text variant=\"error\" typeLevel=\"subtext.large\">Error text</Text>\n```",
|
|
8290
|
-
"declarations": [
|
|
8291
|
-
{
|
|
8292
|
-
"name": "variant",
|
|
8293
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/Text.tsx"
|
|
8294
|
-
}
|
|
8295
|
-
],
|
|
8296
|
-
"tags": {}
|
|
8297
|
-
},
|
|
8298
7967
|
{
|
|
8299
7968
|
"kind": "property",
|
|
8300
7969
|
"name": "typeLevel",
|
|
@@ -8361,6 +8030,72 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
8361
8030
|
],
|
|
8362
8031
|
"tags": {}
|
|
8363
8032
|
},
|
|
8033
|
+
{
|
|
8034
|
+
"kind": "property",
|
|
8035
|
+
"name": "variant",
|
|
8036
|
+
"required": false,
|
|
8037
|
+
"type": {
|
|
8038
|
+
"kind": "union",
|
|
8039
|
+
"value": [
|
|
8040
|
+
{
|
|
8041
|
+
"kind": "string",
|
|
8042
|
+
"value": "error"
|
|
8043
|
+
},
|
|
8044
|
+
{
|
|
8045
|
+
"kind": "string",
|
|
8046
|
+
"value": "hint"
|
|
8047
|
+
},
|
|
8048
|
+
{
|
|
8049
|
+
"kind": "string",
|
|
8050
|
+
"value": "inverse"
|
|
8051
|
+
}
|
|
8052
|
+
]
|
|
8053
|
+
},
|
|
8054
|
+
"description": "Type variant token names: `error`, `hint` or `inverse`.\n\n```tsx\n<Text variant=\"error\" typeLevel=\"subtext.large\">Error text</Text>\n```",
|
|
8055
|
+
"declarations": [
|
|
8056
|
+
{
|
|
8057
|
+
"name": "variant",
|
|
8058
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/Text.tsx"
|
|
8059
|
+
}
|
|
8060
|
+
],
|
|
8061
|
+
"tags": {}
|
|
8062
|
+
},
|
|
8063
|
+
{
|
|
8064
|
+
"kind": "property",
|
|
8065
|
+
"name": "cs",
|
|
8066
|
+
"required": false,
|
|
8067
|
+
"type": {
|
|
8068
|
+
"kind": "symbol",
|
|
8069
|
+
"name": "CSToPropsInput",
|
|
8070
|
+
"value": "CSToPropsInput"
|
|
8071
|
+
},
|
|
8072
|
+
"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```",
|
|
8073
|
+
"declarations": [
|
|
8074
|
+
{
|
|
8075
|
+
"name": "cs",
|
|
8076
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
8077
|
+
}
|
|
8078
|
+
],
|
|
8079
|
+
"tags": {}
|
|
8080
|
+
},
|
|
8081
|
+
{
|
|
8082
|
+
"kind": "property",
|
|
8083
|
+
"name": "children",
|
|
8084
|
+
"required": false,
|
|
8085
|
+
"type": {
|
|
8086
|
+
"kind": "external",
|
|
8087
|
+
"name": "ReactNode",
|
|
8088
|
+
"url": "https://reactjs.org/docs/rendering-elements.html"
|
|
8089
|
+
},
|
|
8090
|
+
"description": "",
|
|
8091
|
+
"declarations": [
|
|
8092
|
+
{
|
|
8093
|
+
"name": "children",
|
|
8094
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/layout/lib/Box.tsx"
|
|
8095
|
+
}
|
|
8096
|
+
],
|
|
8097
|
+
"tags": {}
|
|
8098
|
+
},
|
|
8364
8099
|
{
|
|
8365
8100
|
"kind": "property",
|
|
8366
8101
|
"name": "as",
|
|
@@ -8374,8 +8109,8 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
8374
8109
|
},
|
|
8375
8110
|
"defaultValue": {
|
|
8376
8111
|
"kind": "external",
|
|
8377
|
-
"name": "
|
|
8378
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/
|
|
8112
|
+
"name": "p",
|
|
8113
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/p"
|
|
8379
8114
|
}
|
|
8380
8115
|
},
|
|
8381
8116
|
{
|
|
@@ -8395,8 +8130,8 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
8395
8130
|
"required": true,
|
|
8396
8131
|
"defaultValue": {
|
|
8397
8132
|
"kind": "external",
|
|
8398
|
-
"name": "
|
|
8399
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/
|
|
8133
|
+
"name": "p",
|
|
8134
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/p"
|
|
8400
8135
|
}
|
|
8401
8136
|
}
|
|
8402
8137
|
]
|
|
@@ -8456,24 +8191,1009 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
8456
8191
|
],
|
|
8457
8192
|
"baseElement": {
|
|
8458
8193
|
"kind": "external",
|
|
8459
|
-
"name": "
|
|
8460
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/
|
|
8194
|
+
"name": "p",
|
|
8195
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/p"
|
|
8461
8196
|
},
|
|
8462
8197
|
"styleComponent": {
|
|
8463
8198
|
"kind": "symbol",
|
|
8464
|
-
"name": "
|
|
8199
|
+
"name": "Box"
|
|
8465
8200
|
},
|
|
8466
8201
|
"model": "FormFieldModel"
|
|
8467
8202
|
}
|
|
8468
8203
|
},
|
|
8469
8204
|
{
|
|
8470
|
-
"name": "
|
|
8471
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/
|
|
8205
|
+
"name": "FormFieldInput",
|
|
8206
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/FormFieldInput.tsx",
|
|
8472
8207
|
"description": "",
|
|
8473
8208
|
"declarations": [
|
|
8474
8209
|
{
|
|
8475
|
-
"name": "
|
|
8476
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/
|
|
8210
|
+
"name": "FormFieldInput",
|
|
8211
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/FormFieldInput.tsx"
|
|
8212
|
+
}
|
|
8213
|
+
],
|
|
8214
|
+
"tags": {},
|
|
8215
|
+
"type": {
|
|
8216
|
+
"kind": "enhancedComponent",
|
|
8217
|
+
"componentType": "subcomponent",
|
|
8218
|
+
"elemPropsHook": "useFormFieldInput",
|
|
8219
|
+
"displayName": "FormField.Input",
|
|
8220
|
+
"props": [
|
|
8221
|
+
{
|
|
8222
|
+
"kind": "property",
|
|
8223
|
+
"name": "cs",
|
|
8224
|
+
"required": false,
|
|
8225
|
+
"type": {
|
|
8226
|
+
"kind": "symbol",
|
|
8227
|
+
"name": "CSToPropsInput",
|
|
8228
|
+
"value": "CSToPropsInput"
|
|
8229
|
+
},
|
|
8230
|
+
"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```",
|
|
8231
|
+
"declarations": [
|
|
8232
|
+
{
|
|
8233
|
+
"name": "cs",
|
|
8234
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
8235
|
+
}
|
|
8236
|
+
],
|
|
8237
|
+
"tags": {}
|
|
8238
|
+
},
|
|
8239
|
+
{
|
|
8240
|
+
"kind": "property",
|
|
8241
|
+
"name": "children",
|
|
8242
|
+
"description": "",
|
|
8243
|
+
"tags": {},
|
|
8244
|
+
"declarations": [],
|
|
8245
|
+
"type": {
|
|
8246
|
+
"kind": "external",
|
|
8247
|
+
"name": "React.ReactNode",
|
|
8248
|
+
"url": "https://reactjs.org/docs/rendering-elements.html"
|
|
8249
|
+
}
|
|
8250
|
+
},
|
|
8251
|
+
{
|
|
8252
|
+
"kind": "property",
|
|
8253
|
+
"name": "as",
|
|
8254
|
+
"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.",
|
|
8255
|
+
"tags": {},
|
|
8256
|
+
"declarations": [],
|
|
8257
|
+
"type": {
|
|
8258
|
+
"kind": "external",
|
|
8259
|
+
"name": "React.ElementType",
|
|
8260
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
|
|
8261
|
+
},
|
|
8262
|
+
"defaultValue": {
|
|
8263
|
+
"kind": "external",
|
|
8264
|
+
"name": "input",
|
|
8265
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input"
|
|
8266
|
+
}
|
|
8267
|
+
},
|
|
8268
|
+
{
|
|
8269
|
+
"kind": "property",
|
|
8270
|
+
"name": "ref",
|
|
8271
|
+
"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`).",
|
|
8272
|
+
"tags": {},
|
|
8273
|
+
"declarations": [],
|
|
8274
|
+
"type": {
|
|
8275
|
+
"kind": "external",
|
|
8276
|
+
"name": "React.Ref",
|
|
8277
|
+
"url": "https://reactjs.org/docs/refs-and-the-dom.html",
|
|
8278
|
+
"typeParameters": [
|
|
8279
|
+
{
|
|
8280
|
+
"kind": "typeParameter",
|
|
8281
|
+
"name": "R",
|
|
8282
|
+
"required": true,
|
|
8283
|
+
"defaultValue": {
|
|
8284
|
+
"kind": "external",
|
|
8285
|
+
"name": "input",
|
|
8286
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input"
|
|
8287
|
+
}
|
|
8288
|
+
}
|
|
8289
|
+
]
|
|
8290
|
+
}
|
|
8291
|
+
},
|
|
8292
|
+
{
|
|
8293
|
+
"kind": "property",
|
|
8294
|
+
"name": "model",
|
|
8295
|
+
"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.",
|
|
8296
|
+
"tags": {},
|
|
8297
|
+
"declarations": [],
|
|
8298
|
+
"type": {
|
|
8299
|
+
"kind": "symbol",
|
|
8300
|
+
"name": "FormFieldModel"
|
|
8301
|
+
}
|
|
8302
|
+
},
|
|
8303
|
+
{
|
|
8304
|
+
"kind": "property",
|
|
8305
|
+
"name": "elemPropsHook",
|
|
8306
|
+
"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.",
|
|
8307
|
+
"tags": {},
|
|
8308
|
+
"declarations": [],
|
|
8309
|
+
"type": {
|
|
8310
|
+
"kind": "function",
|
|
8311
|
+
"parameters": [
|
|
8312
|
+
{
|
|
8313
|
+
"kind": "parameter",
|
|
8314
|
+
"description": "",
|
|
8315
|
+
"tags": {},
|
|
8316
|
+
"declarations": [],
|
|
8317
|
+
"name": "model",
|
|
8318
|
+
"type": {
|
|
8319
|
+
"kind": "symbol",
|
|
8320
|
+
"name": "FormFieldModel"
|
|
8321
|
+
},
|
|
8322
|
+
"required": true
|
|
8323
|
+
},
|
|
8324
|
+
{
|
|
8325
|
+
"kind": "parameter",
|
|
8326
|
+
"description": "",
|
|
8327
|
+
"tags": {},
|
|
8328
|
+
"declarations": [],
|
|
8329
|
+
"name": "elemProps",
|
|
8330
|
+
"type": {
|
|
8331
|
+
"kind": "generic",
|
|
8332
|
+
"name": "TProps"
|
|
8333
|
+
}
|
|
8334
|
+
}
|
|
8335
|
+
],
|
|
8336
|
+
"returnType": {
|
|
8337
|
+
"kind": "external",
|
|
8338
|
+
"name": "HTML Attributes",
|
|
8339
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes"
|
|
8340
|
+
}
|
|
8341
|
+
}
|
|
8342
|
+
}
|
|
8343
|
+
],
|
|
8344
|
+
"baseElement": {
|
|
8345
|
+
"kind": "external",
|
|
8346
|
+
"name": "input",
|
|
8347
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input"
|
|
8348
|
+
},
|
|
8349
|
+
"styleComponent": {
|
|
8350
|
+
"kind": "symbol",
|
|
8351
|
+
"name": "Box"
|
|
8352
|
+
},
|
|
8353
|
+
"model": "FormFieldModel"
|
|
8354
|
+
}
|
|
8355
|
+
},
|
|
8356
|
+
{
|
|
8357
|
+
"name": "FormFieldLabelProps",
|
|
8358
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/FormFieldLabel.tsx",
|
|
8359
|
+
"description": "",
|
|
8360
|
+
"declarations": [
|
|
8361
|
+
{
|
|
8362
|
+
"name": "FormFieldLabelProps",
|
|
8363
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/FormFieldLabel.tsx"
|
|
8364
|
+
}
|
|
8365
|
+
],
|
|
8366
|
+
"tags": {},
|
|
8367
|
+
"type": {
|
|
8368
|
+
"kind": "alias",
|
|
8369
|
+
"name": "FormFieldLabel"
|
|
8370
|
+
}
|
|
8371
|
+
},
|
|
8372
|
+
{
|
|
8373
|
+
"name": "formFieldLabelStencil",
|
|
8374
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/FormFieldLabel.tsx",
|
|
8375
|
+
"description": "",
|
|
8376
|
+
"declarations": [
|
|
8377
|
+
{
|
|
8378
|
+
"name": "formFieldLabelStencil",
|
|
8379
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/FormFieldLabel.tsx"
|
|
8380
|
+
}
|
|
8381
|
+
],
|
|
8382
|
+
"tags": {},
|
|
8383
|
+
"type": {
|
|
8384
|
+
"kind": "function",
|
|
8385
|
+
"parameters": [
|
|
8386
|
+
{
|
|
8387
|
+
"kind": "parameter",
|
|
8388
|
+
"name": "options",
|
|
8389
|
+
"type": {
|
|
8390
|
+
"kind": "conditional",
|
|
8391
|
+
"check": {
|
|
8392
|
+
"kind": "tuple",
|
|
8393
|
+
"value": [
|
|
8394
|
+
{
|
|
8395
|
+
"kind": "symbol",
|
|
8396
|
+
"name": "E",
|
|
8397
|
+
"value": "E"
|
|
8398
|
+
}
|
|
8399
|
+
]
|
|
8400
|
+
},
|
|
8401
|
+
"extends": {
|
|
8402
|
+
"kind": "tuple",
|
|
8403
|
+
"value": [
|
|
8404
|
+
{
|
|
8405
|
+
"kind": "primitive",
|
|
8406
|
+
"value": "never"
|
|
8407
|
+
}
|
|
8408
|
+
]
|
|
8409
|
+
},
|
|
8410
|
+
"trueType": {
|
|
8411
|
+
"kind": "intersection",
|
|
8412
|
+
"value": [
|
|
8413
|
+
{
|
|
8414
|
+
"kind": "symbol",
|
|
8415
|
+
"name": "ModifierValuesStencil",
|
|
8416
|
+
"typeParameters": [
|
|
8417
|
+
{
|
|
8418
|
+
"kind": "symbol",
|
|
8419
|
+
"name": "M",
|
|
8420
|
+
"value": "M"
|
|
8421
|
+
},
|
|
8422
|
+
{
|
|
8423
|
+
"kind": "symbol",
|
|
8424
|
+
"name": "V",
|
|
8425
|
+
"value": "V"
|
|
8426
|
+
}
|
|
8427
|
+
],
|
|
8428
|
+
"value": "ModifierValuesStencil<M, V>"
|
|
8429
|
+
},
|
|
8430
|
+
{
|
|
8431
|
+
"kind": "symbol",
|
|
8432
|
+
"name": "VariableValuesStencil",
|
|
8433
|
+
"typeParameters": [
|
|
8434
|
+
{
|
|
8435
|
+
"kind": "symbol",
|
|
8436
|
+
"name": "V",
|
|
8437
|
+
"value": "V"
|
|
8438
|
+
}
|
|
8439
|
+
],
|
|
8440
|
+
"value": "VariableValuesStencil<V>"
|
|
8441
|
+
}
|
|
8442
|
+
]
|
|
8443
|
+
},
|
|
8444
|
+
"falseType": {
|
|
8445
|
+
"kind": "conditional",
|
|
8446
|
+
"check": {
|
|
8447
|
+
"kind": "symbol",
|
|
8448
|
+
"name": "E",
|
|
8449
|
+
"value": "E"
|
|
8450
|
+
},
|
|
8451
|
+
"extends": {
|
|
8452
|
+
"kind": "symbol",
|
|
8453
|
+
"name": "BaseStencil",
|
|
8454
|
+
"typeParameters": [
|
|
8455
|
+
{
|
|
8456
|
+
"kind": "infer",
|
|
8457
|
+
"value": {
|
|
8458
|
+
"kind": "typeParameter",
|
|
8459
|
+
"name": "ME",
|
|
8460
|
+
"required": true
|
|
8461
|
+
}
|
|
8462
|
+
},
|
|
8463
|
+
{
|
|
8464
|
+
"kind": "infer",
|
|
8465
|
+
"value": {
|
|
8466
|
+
"kind": "typeParameter",
|
|
8467
|
+
"name": "VE",
|
|
8468
|
+
"required": true
|
|
8469
|
+
}
|
|
8470
|
+
},
|
|
8471
|
+
{
|
|
8472
|
+
"kind": "primitive",
|
|
8473
|
+
"value": "any"
|
|
8474
|
+
},
|
|
8475
|
+
{
|
|
8476
|
+
"kind": "primitive",
|
|
8477
|
+
"value": "any"
|
|
8478
|
+
}
|
|
8479
|
+
],
|
|
8480
|
+
"value": "BaseStencil<M, V, E, ID>"
|
|
8481
|
+
},
|
|
8482
|
+
"trueType": {
|
|
8483
|
+
"kind": "intersection",
|
|
8484
|
+
"value": [
|
|
8485
|
+
{
|
|
8486
|
+
"kind": "symbol",
|
|
8487
|
+
"name": "ModifierValuesStencil",
|
|
8488
|
+
"typeParameters": [
|
|
8489
|
+
{
|
|
8490
|
+
"kind": "intersection",
|
|
8491
|
+
"value": [
|
|
8492
|
+
{
|
|
8493
|
+
"kind": "symbol",
|
|
8494
|
+
"name": "ME",
|
|
8495
|
+
"value": "ME"
|
|
8496
|
+
},
|
|
8497
|
+
{
|
|
8498
|
+
"kind": "symbol",
|
|
8499
|
+
"name": "M",
|
|
8500
|
+
"value": "M"
|
|
8501
|
+
}
|
|
8502
|
+
]
|
|
8503
|
+
}
|
|
8504
|
+
],
|
|
8505
|
+
"value": "ModifierValuesStencil<M, V>"
|
|
8506
|
+
},
|
|
8507
|
+
{
|
|
8508
|
+
"kind": "symbol",
|
|
8509
|
+
"name": "VariableValuesStencil",
|
|
8510
|
+
"typeParameters": [
|
|
8511
|
+
{
|
|
8512
|
+
"kind": "intersection",
|
|
8513
|
+
"value": [
|
|
8514
|
+
{
|
|
8515
|
+
"kind": "symbol",
|
|
8516
|
+
"name": "VE",
|
|
8517
|
+
"value": "VE"
|
|
8518
|
+
},
|
|
8519
|
+
{
|
|
8520
|
+
"kind": "symbol",
|
|
8521
|
+
"name": "V",
|
|
8522
|
+
"value": "V"
|
|
8523
|
+
}
|
|
8524
|
+
]
|
|
8525
|
+
}
|
|
8526
|
+
],
|
|
8527
|
+
"value": "VariableValuesStencil<V>"
|
|
8528
|
+
}
|
|
8529
|
+
]
|
|
8530
|
+
},
|
|
8531
|
+
"falseType": {
|
|
8532
|
+
"kind": "primitive",
|
|
8533
|
+
"value": "never"
|
|
8534
|
+
}
|
|
8535
|
+
}
|
|
8536
|
+
},
|
|
8537
|
+
"required": false,
|
|
8538
|
+
"rest": false,
|
|
8539
|
+
"description": "",
|
|
8540
|
+
"declarations": [
|
|
8541
|
+
{
|
|
8542
|
+
"name": "options",
|
|
8543
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
8544
|
+
}
|
|
8545
|
+
],
|
|
8546
|
+
"tags": {}
|
|
8547
|
+
}
|
|
8548
|
+
],
|
|
8549
|
+
"members": [
|
|
8550
|
+
{
|
|
8551
|
+
"kind": "property",
|
|
8552
|
+
"name": "vars",
|
|
8553
|
+
"required": true,
|
|
8554
|
+
"type": {
|
|
8555
|
+
"kind": "symbol",
|
|
8556
|
+
"name": "StencilDefaultVars",
|
|
8557
|
+
"typeParameters": [
|
|
8558
|
+
{
|
|
8559
|
+
"kind": "symbol",
|
|
8560
|
+
"name": "V",
|
|
8561
|
+
"value": "V"
|
|
8562
|
+
},
|
|
8563
|
+
{
|
|
8564
|
+
"kind": "symbol",
|
|
8565
|
+
"name": "E",
|
|
8566
|
+
"value": "E"
|
|
8567
|
+
},
|
|
8568
|
+
{
|
|
8569
|
+
"kind": "symbol",
|
|
8570
|
+
"name": "ID",
|
|
8571
|
+
"value": "ID"
|
|
8572
|
+
}
|
|
8573
|
+
],
|
|
8574
|
+
"value": "StencilDefaultVars<V, E, ID>"
|
|
8575
|
+
},
|
|
8576
|
+
"description": "",
|
|
8577
|
+
"declarations": [
|
|
8578
|
+
{
|
|
8579
|
+
"name": "vars",
|
|
8580
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
8581
|
+
}
|
|
8582
|
+
],
|
|
8583
|
+
"tags": {}
|
|
8584
|
+
},
|
|
8585
|
+
{
|
|
8586
|
+
"kind": "property",
|
|
8587
|
+
"name": "base",
|
|
8588
|
+
"required": true,
|
|
8589
|
+
"type": {
|
|
8590
|
+
"kind": "primitive",
|
|
8591
|
+
"value": "string"
|
|
8592
|
+
},
|
|
8593
|
+
"description": "",
|
|
8594
|
+
"declarations": [
|
|
8595
|
+
{
|
|
8596
|
+
"name": "base",
|
|
8597
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
8598
|
+
}
|
|
8599
|
+
],
|
|
8600
|
+
"tags": {}
|
|
8601
|
+
},
|
|
8602
|
+
{
|
|
8603
|
+
"kind": "property",
|
|
8604
|
+
"name": "modifiers",
|
|
8605
|
+
"required": true,
|
|
8606
|
+
"type": {
|
|
8607
|
+
"kind": "conditional",
|
|
8608
|
+
"check": {
|
|
8609
|
+
"kind": "tuple",
|
|
8610
|
+
"value": [
|
|
8611
|
+
{
|
|
8612
|
+
"kind": "symbol",
|
|
8613
|
+
"name": "E",
|
|
8614
|
+
"value": "E"
|
|
8615
|
+
}
|
|
8616
|
+
]
|
|
8617
|
+
},
|
|
8618
|
+
"extends": {
|
|
8619
|
+
"kind": "tuple",
|
|
8620
|
+
"value": [
|
|
8621
|
+
{
|
|
8622
|
+
"kind": "symbol",
|
|
8623
|
+
"name": "BaseStencil",
|
|
8624
|
+
"typeParameters": [
|
|
8625
|
+
{
|
|
8626
|
+
"kind": "infer",
|
|
8627
|
+
"value": {
|
|
8628
|
+
"kind": "typeParameter",
|
|
8629
|
+
"name": "ME",
|
|
8630
|
+
"required": true
|
|
8631
|
+
}
|
|
8632
|
+
},
|
|
8633
|
+
{
|
|
8634
|
+
"kind": "infer",
|
|
8635
|
+
"value": {
|
|
8636
|
+
"kind": "typeParameter",
|
|
8637
|
+
"name": "VE",
|
|
8638
|
+
"required": true
|
|
8639
|
+
}
|
|
8640
|
+
},
|
|
8641
|
+
{
|
|
8642
|
+
"kind": "primitive",
|
|
8643
|
+
"value": "any"
|
|
8644
|
+
},
|
|
8645
|
+
{
|
|
8646
|
+
"kind": "primitive",
|
|
8647
|
+
"value": "any"
|
|
8648
|
+
}
|
|
8649
|
+
],
|
|
8650
|
+
"value": "BaseStencil<M, V, E, ID>"
|
|
8651
|
+
}
|
|
8652
|
+
]
|
|
8653
|
+
},
|
|
8654
|
+
"trueType": {
|
|
8655
|
+
"kind": "symbol",
|
|
8656
|
+
"name": "StencilModifierReturn",
|
|
8657
|
+
"typeParameters": [
|
|
8658
|
+
{
|
|
8659
|
+
"kind": "intersection",
|
|
8660
|
+
"value": [
|
|
8661
|
+
{
|
|
8662
|
+
"kind": "symbol",
|
|
8663
|
+
"name": "ME",
|
|
8664
|
+
"value": "ME"
|
|
8665
|
+
},
|
|
8666
|
+
{
|
|
8667
|
+
"kind": "symbol",
|
|
8668
|
+
"name": "M",
|
|
8669
|
+
"value": "M"
|
|
8670
|
+
}
|
|
8671
|
+
]
|
|
8672
|
+
},
|
|
8673
|
+
{
|
|
8674
|
+
"kind": "intersection",
|
|
8675
|
+
"value": [
|
|
8676
|
+
{
|
|
8677
|
+
"kind": "symbol",
|
|
8678
|
+
"name": "VE",
|
|
8679
|
+
"value": "VE"
|
|
8680
|
+
},
|
|
8681
|
+
{
|
|
8682
|
+
"kind": "symbol",
|
|
8683
|
+
"name": "V",
|
|
8684
|
+
"value": "V"
|
|
8685
|
+
}
|
|
8686
|
+
]
|
|
8687
|
+
}
|
|
8688
|
+
],
|
|
8689
|
+
"value": "StencilModifierReturn<M, V>"
|
|
8690
|
+
},
|
|
8691
|
+
"falseType": {
|
|
8692
|
+
"kind": "symbol",
|
|
8693
|
+
"name": "StencilModifierReturn",
|
|
8694
|
+
"typeParameters": [
|
|
8695
|
+
{
|
|
8696
|
+
"kind": "symbol",
|
|
8697
|
+
"name": "M",
|
|
8698
|
+
"value": "M"
|
|
8699
|
+
},
|
|
8700
|
+
{
|
|
8701
|
+
"kind": "symbol",
|
|
8702
|
+
"name": "V",
|
|
8703
|
+
"value": "V"
|
|
8704
|
+
}
|
|
8705
|
+
],
|
|
8706
|
+
"value": "StencilModifierReturn<M, V>"
|
|
8707
|
+
}
|
|
8708
|
+
},
|
|
8709
|
+
"description": "",
|
|
8710
|
+
"declarations": [
|
|
8711
|
+
{
|
|
8712
|
+
"name": "modifiers",
|
|
8713
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
8714
|
+
}
|
|
8715
|
+
],
|
|
8716
|
+
"tags": {}
|
|
8717
|
+
},
|
|
8718
|
+
{
|
|
8719
|
+
"kind": "property",
|
|
8720
|
+
"name": "defaultModifiers",
|
|
8721
|
+
"required": true,
|
|
8722
|
+
"type": {
|
|
8723
|
+
"kind": "conditional",
|
|
8724
|
+
"check": {
|
|
8725
|
+
"kind": "tuple",
|
|
8726
|
+
"value": [
|
|
8727
|
+
{
|
|
8728
|
+
"kind": "symbol",
|
|
8729
|
+
"name": "E",
|
|
8730
|
+
"value": "E"
|
|
8731
|
+
}
|
|
8732
|
+
]
|
|
8733
|
+
},
|
|
8734
|
+
"extends": {
|
|
8735
|
+
"kind": "tuple",
|
|
8736
|
+
"value": [
|
|
8737
|
+
{
|
|
8738
|
+
"kind": "symbol",
|
|
8739
|
+
"name": "BaseStencil",
|
|
8740
|
+
"typeParameters": [
|
|
8741
|
+
{
|
|
8742
|
+
"kind": "infer",
|
|
8743
|
+
"value": {
|
|
8744
|
+
"kind": "typeParameter",
|
|
8745
|
+
"name": "ME",
|
|
8746
|
+
"required": true
|
|
8747
|
+
}
|
|
8748
|
+
},
|
|
8749
|
+
{
|
|
8750
|
+
"kind": "primitive",
|
|
8751
|
+
"value": "any"
|
|
8752
|
+
},
|
|
8753
|
+
{
|
|
8754
|
+
"kind": "primitive",
|
|
8755
|
+
"value": "any"
|
|
8756
|
+
},
|
|
8757
|
+
{
|
|
8758
|
+
"kind": "primitive",
|
|
8759
|
+
"value": "any"
|
|
8760
|
+
}
|
|
8761
|
+
],
|
|
8762
|
+
"value": "BaseStencil<M, V, E, ID>"
|
|
8763
|
+
}
|
|
8764
|
+
]
|
|
8765
|
+
},
|
|
8766
|
+
"trueType": {
|
|
8767
|
+
"kind": "symbol",
|
|
8768
|
+
"name": "StencilDefaultModifierReturn",
|
|
8769
|
+
"typeParameters": [
|
|
8770
|
+
{
|
|
8771
|
+
"kind": "intersection",
|
|
8772
|
+
"value": [
|
|
8773
|
+
{
|
|
8774
|
+
"kind": "symbol",
|
|
8775
|
+
"name": "ME",
|
|
8776
|
+
"value": "ME"
|
|
8777
|
+
},
|
|
8778
|
+
{
|
|
8779
|
+
"kind": "symbol",
|
|
8780
|
+
"name": "M",
|
|
8781
|
+
"value": "M"
|
|
8782
|
+
}
|
|
8783
|
+
]
|
|
8784
|
+
}
|
|
8785
|
+
],
|
|
8786
|
+
"value": "StencilDefaultModifierReturn<M>"
|
|
8787
|
+
},
|
|
8788
|
+
"falseType": {
|
|
8789
|
+
"kind": "symbol",
|
|
8790
|
+
"name": "StencilDefaultModifierReturn",
|
|
8791
|
+
"typeParameters": [
|
|
8792
|
+
{
|
|
8793
|
+
"kind": "symbol",
|
|
8794
|
+
"name": "M",
|
|
8795
|
+
"value": "M"
|
|
8796
|
+
}
|
|
8797
|
+
],
|
|
8798
|
+
"value": "StencilDefaultModifierReturn<M>"
|
|
8799
|
+
}
|
|
8800
|
+
},
|
|
8801
|
+
"description": "",
|
|
8802
|
+
"declarations": [
|
|
8803
|
+
{
|
|
8804
|
+
"name": "defaultModifiers",
|
|
8805
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
8806
|
+
}
|
|
8807
|
+
],
|
|
8808
|
+
"tags": {}
|
|
8809
|
+
},
|
|
8810
|
+
{
|
|
8811
|
+
"kind": "property",
|
|
8812
|
+
"name": "__extends",
|
|
8813
|
+
"required": false,
|
|
8814
|
+
"type": {
|
|
8815
|
+
"kind": "symbol",
|
|
8816
|
+
"name": "E",
|
|
8817
|
+
"value": "E"
|
|
8818
|
+
},
|
|
8819
|
+
"description": "",
|
|
8820
|
+
"declarations": [
|
|
8821
|
+
{
|
|
8822
|
+
"name": "__extends",
|
|
8823
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
8824
|
+
}
|
|
8825
|
+
],
|
|
8826
|
+
"tags": {}
|
|
8827
|
+
},
|
|
8828
|
+
{
|
|
8829
|
+
"kind": "property",
|
|
8830
|
+
"name": "__vars",
|
|
8831
|
+
"required": true,
|
|
8832
|
+
"type": {
|
|
8833
|
+
"kind": "symbol",
|
|
8834
|
+
"name": "V",
|
|
8835
|
+
"value": "V"
|
|
8836
|
+
},
|
|
8837
|
+
"description": "",
|
|
8838
|
+
"declarations": [
|
|
8839
|
+
{
|
|
8840
|
+
"name": "__vars",
|
|
8841
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
8842
|
+
}
|
|
8843
|
+
],
|
|
8844
|
+
"tags": {}
|
|
8845
|
+
},
|
|
8846
|
+
{
|
|
8847
|
+
"kind": "property",
|
|
8848
|
+
"name": "__modifiers",
|
|
8849
|
+
"required": true,
|
|
8850
|
+
"type": {
|
|
8851
|
+
"kind": "symbol",
|
|
8852
|
+
"name": "M",
|
|
8853
|
+
"value": "M"
|
|
8854
|
+
},
|
|
8855
|
+
"description": "",
|
|
8856
|
+
"declarations": [
|
|
8857
|
+
{
|
|
8858
|
+
"name": "__modifiers",
|
|
8859
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
8860
|
+
}
|
|
8861
|
+
],
|
|
8862
|
+
"tags": {}
|
|
8863
|
+
},
|
|
8864
|
+
{
|
|
8865
|
+
"kind": "property",
|
|
8866
|
+
"name": "__id",
|
|
8867
|
+
"required": true,
|
|
8868
|
+
"type": {
|
|
8869
|
+
"kind": "symbol",
|
|
8870
|
+
"name": "ID",
|
|
8871
|
+
"value": "ID"
|
|
8872
|
+
},
|
|
8873
|
+
"description": "",
|
|
8874
|
+
"declarations": [
|
|
8875
|
+
{
|
|
8876
|
+
"name": "__id",
|
|
8877
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
8878
|
+
}
|
|
8879
|
+
],
|
|
8880
|
+
"tags": {}
|
|
8881
|
+
}
|
|
8882
|
+
],
|
|
8883
|
+
"returnType": {
|
|
8884
|
+
"kind": "object",
|
|
8885
|
+
"properties": [
|
|
8886
|
+
{
|
|
8887
|
+
"kind": "property",
|
|
8888
|
+
"name": "className",
|
|
8889
|
+
"required": true,
|
|
8890
|
+
"type": {
|
|
8891
|
+
"kind": "primitive",
|
|
8892
|
+
"value": "string"
|
|
8893
|
+
},
|
|
8894
|
+
"description": "",
|
|
8895
|
+
"declarations": [
|
|
8896
|
+
{
|
|
8897
|
+
"name": "className",
|
|
8898
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
8899
|
+
}
|
|
8900
|
+
],
|
|
8901
|
+
"tags": {}
|
|
8902
|
+
},
|
|
8903
|
+
{
|
|
8904
|
+
"kind": "property",
|
|
8905
|
+
"name": "style",
|
|
8906
|
+
"required": false,
|
|
8907
|
+
"type": {
|
|
8908
|
+
"kind": "external",
|
|
8909
|
+
"name": "Record",
|
|
8910
|
+
"url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
|
|
8911
|
+
"typeParameters": [
|
|
8912
|
+
{
|
|
8913
|
+
"kind": "primitive",
|
|
8914
|
+
"value": "string"
|
|
8915
|
+
},
|
|
8916
|
+
{
|
|
8917
|
+
"kind": "primitive",
|
|
8918
|
+
"value": "string"
|
|
8919
|
+
}
|
|
8920
|
+
]
|
|
8921
|
+
},
|
|
8922
|
+
"description": "",
|
|
8923
|
+
"declarations": [
|
|
8924
|
+
{
|
|
8925
|
+
"name": "style",
|
|
8926
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
8927
|
+
}
|
|
8928
|
+
],
|
|
8929
|
+
"tags": {}
|
|
8930
|
+
}
|
|
8931
|
+
]
|
|
8932
|
+
}
|
|
8933
|
+
}
|
|
8934
|
+
},
|
|
8935
|
+
{
|
|
8936
|
+
"name": "FormFieldLabel",
|
|
8937
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/FormFieldLabel.tsx",
|
|
8938
|
+
"description": "",
|
|
8939
|
+
"declarations": [
|
|
8940
|
+
{
|
|
8941
|
+
"name": "FormFieldLabel",
|
|
8942
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/FormFieldLabel.tsx"
|
|
8943
|
+
}
|
|
8944
|
+
],
|
|
8945
|
+
"tags": {},
|
|
8946
|
+
"type": {
|
|
8947
|
+
"kind": "enhancedComponent",
|
|
8948
|
+
"componentType": "subcomponent",
|
|
8949
|
+
"elemPropsHook": "useFormFieldLabel",
|
|
8950
|
+
"displayName": "FormField.Label",
|
|
8951
|
+
"props": [
|
|
8952
|
+
{
|
|
8953
|
+
"kind": "property",
|
|
8954
|
+
"name": "children",
|
|
8955
|
+
"required": true,
|
|
8956
|
+
"type": {
|
|
8957
|
+
"kind": "external",
|
|
8958
|
+
"name": "ReactNode",
|
|
8959
|
+
"url": "https://reactjs.org/docs/rendering-elements.html"
|
|
8960
|
+
},
|
|
8961
|
+
"description": "The text of the label.",
|
|
8962
|
+
"declarations": [
|
|
8963
|
+
{
|
|
8964
|
+
"name": "children",
|
|
8965
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/FormFieldLabel.tsx"
|
|
8966
|
+
}
|
|
8967
|
+
],
|
|
8968
|
+
"tags": {}
|
|
8969
|
+
},
|
|
8970
|
+
{
|
|
8971
|
+
"kind": "property",
|
|
8972
|
+
"name": "cs",
|
|
8973
|
+
"required": false,
|
|
8974
|
+
"type": {
|
|
8975
|
+
"kind": "symbol",
|
|
8976
|
+
"name": "CSToPropsInput",
|
|
8977
|
+
"value": "CSToPropsInput"
|
|
8978
|
+
},
|
|
8979
|
+
"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```",
|
|
8980
|
+
"declarations": [
|
|
8981
|
+
{
|
|
8982
|
+
"name": "cs",
|
|
8983
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
8984
|
+
}
|
|
8985
|
+
],
|
|
8986
|
+
"tags": {}
|
|
8987
|
+
},
|
|
8988
|
+
{
|
|
8989
|
+
"kind": "property",
|
|
8990
|
+
"name": "variant",
|
|
8991
|
+
"required": false,
|
|
8992
|
+
"type": {
|
|
8993
|
+
"kind": "union",
|
|
8994
|
+
"value": [
|
|
8995
|
+
{
|
|
8996
|
+
"kind": "string",
|
|
8997
|
+
"value": "error"
|
|
8998
|
+
},
|
|
8999
|
+
{
|
|
9000
|
+
"kind": "string",
|
|
9001
|
+
"value": "hint"
|
|
9002
|
+
},
|
|
9003
|
+
{
|
|
9004
|
+
"kind": "string",
|
|
9005
|
+
"value": "inverse"
|
|
9006
|
+
}
|
|
9007
|
+
]
|
|
9008
|
+
},
|
|
9009
|
+
"description": "Type variant token names: `error`, `hint` or `inverse`.\n\n```tsx\n<Text variant=\"error\" typeLevel=\"subtext.large\">Error text</Text>\n```",
|
|
9010
|
+
"declarations": [
|
|
9011
|
+
{
|
|
9012
|
+
"name": "variant",
|
|
9013
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/Text.tsx"
|
|
9014
|
+
}
|
|
9015
|
+
],
|
|
9016
|
+
"tags": {}
|
|
9017
|
+
},
|
|
9018
|
+
{
|
|
9019
|
+
"kind": "property",
|
|
9020
|
+
"name": "typeLevel",
|
|
9021
|
+
"required": false,
|
|
9022
|
+
"type": {
|
|
9023
|
+
"kind": "union",
|
|
9024
|
+
"value": [
|
|
9025
|
+
{
|
|
9026
|
+
"kind": "string",
|
|
9027
|
+
"value": "subtext.medium"
|
|
9028
|
+
},
|
|
9029
|
+
{
|
|
9030
|
+
"kind": "string",
|
|
9031
|
+
"value": "title.large"
|
|
9032
|
+
},
|
|
9033
|
+
{
|
|
9034
|
+
"kind": "string",
|
|
9035
|
+
"value": "title.medium"
|
|
9036
|
+
},
|
|
9037
|
+
{
|
|
9038
|
+
"kind": "string",
|
|
9039
|
+
"value": "title.small"
|
|
9040
|
+
},
|
|
9041
|
+
{
|
|
9042
|
+
"kind": "string",
|
|
9043
|
+
"value": "heading.large"
|
|
9044
|
+
},
|
|
9045
|
+
{
|
|
9046
|
+
"kind": "string",
|
|
9047
|
+
"value": "heading.medium"
|
|
9048
|
+
},
|
|
9049
|
+
{
|
|
9050
|
+
"kind": "string",
|
|
9051
|
+
"value": "heading.small"
|
|
9052
|
+
},
|
|
9053
|
+
{
|
|
9054
|
+
"kind": "string",
|
|
9055
|
+
"value": "body.large"
|
|
9056
|
+
},
|
|
9057
|
+
{
|
|
9058
|
+
"kind": "string",
|
|
9059
|
+
"value": "body.medium"
|
|
9060
|
+
},
|
|
9061
|
+
{
|
|
9062
|
+
"kind": "string",
|
|
9063
|
+
"value": "body.small"
|
|
9064
|
+
},
|
|
9065
|
+
{
|
|
9066
|
+
"kind": "string",
|
|
9067
|
+
"value": "subtext.large"
|
|
9068
|
+
},
|
|
9069
|
+
{
|
|
9070
|
+
"kind": "string",
|
|
9071
|
+
"value": "subtext.small"
|
|
9072
|
+
}
|
|
9073
|
+
]
|
|
9074
|
+
},
|
|
9075
|
+
"description": "Type token as string with level and size separated by dot.\nThese values map to our [Canvas type levels](https://canvas.workday.com/tokens/type#type-styles).\n\n```tsx\n<Text typeLevel=\"body.small\">Small body text</Text>\n```",
|
|
9076
|
+
"declarations": [
|
|
9077
|
+
{
|
|
9078
|
+
"name": "typeLevel",
|
|
9079
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/Text.tsx"
|
|
9080
|
+
}
|
|
9081
|
+
],
|
|
9082
|
+
"tags": {}
|
|
9083
|
+
},
|
|
9084
|
+
{
|
|
9085
|
+
"kind": "property",
|
|
9086
|
+
"name": "as",
|
|
9087
|
+
"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.",
|
|
9088
|
+
"tags": {},
|
|
9089
|
+
"declarations": [],
|
|
9090
|
+
"type": {
|
|
9091
|
+
"kind": "external",
|
|
9092
|
+
"name": "React.ElementType",
|
|
9093
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
|
|
9094
|
+
},
|
|
9095
|
+
"defaultValue": {
|
|
9096
|
+
"kind": "external",
|
|
9097
|
+
"name": "label",
|
|
9098
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/label"
|
|
9099
|
+
}
|
|
9100
|
+
},
|
|
9101
|
+
{
|
|
9102
|
+
"kind": "property",
|
|
9103
|
+
"name": "ref",
|
|
9104
|
+
"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`).",
|
|
9105
|
+
"tags": {},
|
|
9106
|
+
"declarations": [],
|
|
9107
|
+
"type": {
|
|
9108
|
+
"kind": "external",
|
|
9109
|
+
"name": "React.Ref",
|
|
9110
|
+
"url": "https://reactjs.org/docs/refs-and-the-dom.html",
|
|
9111
|
+
"typeParameters": [
|
|
9112
|
+
{
|
|
9113
|
+
"kind": "typeParameter",
|
|
9114
|
+
"name": "R",
|
|
9115
|
+
"required": true,
|
|
9116
|
+
"defaultValue": {
|
|
9117
|
+
"kind": "external",
|
|
9118
|
+
"name": "label",
|
|
9119
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/label"
|
|
9120
|
+
}
|
|
9121
|
+
}
|
|
9122
|
+
]
|
|
9123
|
+
}
|
|
9124
|
+
},
|
|
9125
|
+
{
|
|
9126
|
+
"kind": "property",
|
|
9127
|
+
"name": "model",
|
|
9128
|
+
"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.",
|
|
9129
|
+
"tags": {},
|
|
9130
|
+
"declarations": [],
|
|
9131
|
+
"type": {
|
|
9132
|
+
"kind": "symbol",
|
|
9133
|
+
"name": "FormFieldModel"
|
|
9134
|
+
}
|
|
9135
|
+
},
|
|
9136
|
+
{
|
|
9137
|
+
"kind": "property",
|
|
9138
|
+
"name": "elemPropsHook",
|
|
9139
|
+
"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.",
|
|
9140
|
+
"tags": {},
|
|
9141
|
+
"declarations": [],
|
|
9142
|
+
"type": {
|
|
9143
|
+
"kind": "function",
|
|
9144
|
+
"parameters": [
|
|
9145
|
+
{
|
|
9146
|
+
"kind": "parameter",
|
|
9147
|
+
"description": "",
|
|
9148
|
+
"tags": {},
|
|
9149
|
+
"declarations": [],
|
|
9150
|
+
"name": "model",
|
|
9151
|
+
"type": {
|
|
9152
|
+
"kind": "symbol",
|
|
9153
|
+
"name": "FormFieldModel"
|
|
9154
|
+
},
|
|
9155
|
+
"required": true
|
|
9156
|
+
},
|
|
9157
|
+
{
|
|
9158
|
+
"kind": "parameter",
|
|
9159
|
+
"description": "",
|
|
9160
|
+
"tags": {},
|
|
9161
|
+
"declarations": [],
|
|
9162
|
+
"name": "elemProps",
|
|
9163
|
+
"type": {
|
|
9164
|
+
"kind": "generic",
|
|
9165
|
+
"name": "TProps"
|
|
9166
|
+
}
|
|
9167
|
+
}
|
|
9168
|
+
],
|
|
9169
|
+
"returnType": {
|
|
9170
|
+
"kind": "external",
|
|
9171
|
+
"name": "HTML Attributes",
|
|
9172
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes"
|
|
9173
|
+
}
|
|
9174
|
+
}
|
|
9175
|
+
}
|
|
9176
|
+
],
|
|
9177
|
+
"baseElement": {
|
|
9178
|
+
"kind": "external",
|
|
9179
|
+
"name": "label",
|
|
9180
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/label"
|
|
9181
|
+
},
|
|
9182
|
+
"styleComponent": {
|
|
9183
|
+
"kind": "symbol",
|
|
9184
|
+
"name": "Flex"
|
|
9185
|
+
},
|
|
9186
|
+
"model": "FormFieldModel"
|
|
9187
|
+
}
|
|
9188
|
+
},
|
|
9189
|
+
{
|
|
9190
|
+
"name": "formFieldStencil",
|
|
9191
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/formFieldStencil.ts",
|
|
9192
|
+
"description": "",
|
|
9193
|
+
"declarations": [
|
|
9194
|
+
{
|
|
9195
|
+
"name": "formFieldStencil",
|
|
9196
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/formFieldStencil.ts"
|
|
8477
9197
|
}
|
|
8478
9198
|
],
|
|
8479
9199
|
"tags": {},
|
|
@@ -66689,6 +67409,243 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
66689
67409
|
],
|
|
66690
67410
|
"tags": {}
|
|
66691
67411
|
},
|
|
67412
|
+
{
|
|
67413
|
+
"kind": "property",
|
|
67414
|
+
"name": "marginTop",
|
|
67415
|
+
"required": false,
|
|
67416
|
+
"type": {
|
|
67417
|
+
"kind": "union",
|
|
67418
|
+
"value": [
|
|
67419
|
+
{
|
|
67420
|
+
"kind": "primitive",
|
|
67421
|
+
"value": "undefined"
|
|
67422
|
+
},
|
|
67423
|
+
{
|
|
67424
|
+
"kind": "primitive",
|
|
67425
|
+
"value": "number"
|
|
67426
|
+
},
|
|
67427
|
+
{
|
|
67428
|
+
"kind": "intersection",
|
|
67429
|
+
"value": [
|
|
67430
|
+
{
|
|
67431
|
+
"kind": "primitive",
|
|
67432
|
+
"value": "string"
|
|
67433
|
+
},
|
|
67434
|
+
{
|
|
67435
|
+
"kind": "object",
|
|
67436
|
+
"properties": []
|
|
67437
|
+
}
|
|
67438
|
+
]
|
|
67439
|
+
},
|
|
67440
|
+
{
|
|
67441
|
+
"kind": "string",
|
|
67442
|
+
"value": "s"
|
|
67443
|
+
},
|
|
67444
|
+
{
|
|
67445
|
+
"kind": "string",
|
|
67446
|
+
"value": "zero"
|
|
67447
|
+
},
|
|
67448
|
+
{
|
|
67449
|
+
"kind": "string",
|
|
67450
|
+
"value": "m"
|
|
67451
|
+
},
|
|
67452
|
+
{
|
|
67453
|
+
"kind": "string",
|
|
67454
|
+
"value": "l"
|
|
67455
|
+
},
|
|
67456
|
+
{
|
|
67457
|
+
"kind": "string",
|
|
67458
|
+
"value": "xxxs"
|
|
67459
|
+
},
|
|
67460
|
+
{
|
|
67461
|
+
"kind": "string",
|
|
67462
|
+
"value": "xxs"
|
|
67463
|
+
},
|
|
67464
|
+
{
|
|
67465
|
+
"kind": "string",
|
|
67466
|
+
"value": "xs"
|
|
67467
|
+
},
|
|
67468
|
+
{
|
|
67469
|
+
"kind": "string",
|
|
67470
|
+
"value": "xl"
|
|
67471
|
+
},
|
|
67472
|
+
{
|
|
67473
|
+
"kind": "string",
|
|
67474
|
+
"value": "xxl"
|
|
67475
|
+
},
|
|
67476
|
+
{
|
|
67477
|
+
"kind": "string",
|
|
67478
|
+
"value": "xxxl"
|
|
67479
|
+
}
|
|
67480
|
+
]
|
|
67481
|
+
},
|
|
67482
|
+
"description": "Set the margin top of the list box. You must use this prop and not style any other way. The\n`Menu` uses virtualization and needs margins to be set on the correct element. This ensure\nproper rendering. If a `marginTop` is not provided, the value falls back to `marginY`.",
|
|
67483
|
+
"declarations": [
|
|
67484
|
+
{
|
|
67485
|
+
"name": "marginTop",
|
|
67486
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/ListBox.tsx"
|
|
67487
|
+
}
|
|
67488
|
+
],
|
|
67489
|
+
"tags": {}
|
|
67490
|
+
},
|
|
67491
|
+
{
|
|
67492
|
+
"kind": "property",
|
|
67493
|
+
"name": "marginBottom",
|
|
67494
|
+
"required": false,
|
|
67495
|
+
"type": {
|
|
67496
|
+
"kind": "union",
|
|
67497
|
+
"value": [
|
|
67498
|
+
{
|
|
67499
|
+
"kind": "primitive",
|
|
67500
|
+
"value": "undefined"
|
|
67501
|
+
},
|
|
67502
|
+
{
|
|
67503
|
+
"kind": "primitive",
|
|
67504
|
+
"value": "number"
|
|
67505
|
+
},
|
|
67506
|
+
{
|
|
67507
|
+
"kind": "intersection",
|
|
67508
|
+
"value": [
|
|
67509
|
+
{
|
|
67510
|
+
"kind": "primitive",
|
|
67511
|
+
"value": "string"
|
|
67512
|
+
},
|
|
67513
|
+
{
|
|
67514
|
+
"kind": "object",
|
|
67515
|
+
"properties": []
|
|
67516
|
+
}
|
|
67517
|
+
]
|
|
67518
|
+
},
|
|
67519
|
+
{
|
|
67520
|
+
"kind": "string",
|
|
67521
|
+
"value": "s"
|
|
67522
|
+
},
|
|
67523
|
+
{
|
|
67524
|
+
"kind": "string",
|
|
67525
|
+
"value": "zero"
|
|
67526
|
+
},
|
|
67527
|
+
{
|
|
67528
|
+
"kind": "string",
|
|
67529
|
+
"value": "m"
|
|
67530
|
+
},
|
|
67531
|
+
{
|
|
67532
|
+
"kind": "string",
|
|
67533
|
+
"value": "l"
|
|
67534
|
+
},
|
|
67535
|
+
{
|
|
67536
|
+
"kind": "string",
|
|
67537
|
+
"value": "xxxs"
|
|
67538
|
+
},
|
|
67539
|
+
{
|
|
67540
|
+
"kind": "string",
|
|
67541
|
+
"value": "xxs"
|
|
67542
|
+
},
|
|
67543
|
+
{
|
|
67544
|
+
"kind": "string",
|
|
67545
|
+
"value": "xs"
|
|
67546
|
+
},
|
|
67547
|
+
{
|
|
67548
|
+
"kind": "string",
|
|
67549
|
+
"value": "xl"
|
|
67550
|
+
},
|
|
67551
|
+
{
|
|
67552
|
+
"kind": "string",
|
|
67553
|
+
"value": "xxl"
|
|
67554
|
+
},
|
|
67555
|
+
{
|
|
67556
|
+
"kind": "string",
|
|
67557
|
+
"value": "xxxl"
|
|
67558
|
+
}
|
|
67559
|
+
]
|
|
67560
|
+
},
|
|
67561
|
+
"description": "Set the margin bottom of the list box. You must use this prop and not style any other way. The\n`Menu` uses virtualization and needs margins to be set on the correct element. This ensure\nproper rendering. If a `marginBottom` is not provided, the value falls back to `marginY`.",
|
|
67562
|
+
"declarations": [
|
|
67563
|
+
{
|
|
67564
|
+
"name": "marginBottom",
|
|
67565
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/ListBox.tsx"
|
|
67566
|
+
}
|
|
67567
|
+
],
|
|
67568
|
+
"tags": {}
|
|
67569
|
+
},
|
|
67570
|
+
{
|
|
67571
|
+
"kind": "property",
|
|
67572
|
+
"name": "marginY",
|
|
67573
|
+
"required": false,
|
|
67574
|
+
"type": {
|
|
67575
|
+
"kind": "union",
|
|
67576
|
+
"value": [
|
|
67577
|
+
{
|
|
67578
|
+
"kind": "primitive",
|
|
67579
|
+
"value": "undefined"
|
|
67580
|
+
},
|
|
67581
|
+
{
|
|
67582
|
+
"kind": "primitive",
|
|
67583
|
+
"value": "number"
|
|
67584
|
+
},
|
|
67585
|
+
{
|
|
67586
|
+
"kind": "intersection",
|
|
67587
|
+
"value": [
|
|
67588
|
+
{
|
|
67589
|
+
"kind": "primitive",
|
|
67590
|
+
"value": "string"
|
|
67591
|
+
},
|
|
67592
|
+
{
|
|
67593
|
+
"kind": "object",
|
|
67594
|
+
"properties": []
|
|
67595
|
+
}
|
|
67596
|
+
]
|
|
67597
|
+
},
|
|
67598
|
+
{
|
|
67599
|
+
"kind": "string",
|
|
67600
|
+
"value": "s"
|
|
67601
|
+
},
|
|
67602
|
+
{
|
|
67603
|
+
"kind": "string",
|
|
67604
|
+
"value": "zero"
|
|
67605
|
+
},
|
|
67606
|
+
{
|
|
67607
|
+
"kind": "string",
|
|
67608
|
+
"value": "m"
|
|
67609
|
+
},
|
|
67610
|
+
{
|
|
67611
|
+
"kind": "string",
|
|
67612
|
+
"value": "l"
|
|
67613
|
+
},
|
|
67614
|
+
{
|
|
67615
|
+
"kind": "string",
|
|
67616
|
+
"value": "xxxs"
|
|
67617
|
+
},
|
|
67618
|
+
{
|
|
67619
|
+
"kind": "string",
|
|
67620
|
+
"value": "xxs"
|
|
67621
|
+
},
|
|
67622
|
+
{
|
|
67623
|
+
"kind": "string",
|
|
67624
|
+
"value": "xs"
|
|
67625
|
+
},
|
|
67626
|
+
{
|
|
67627
|
+
"kind": "string",
|
|
67628
|
+
"value": "xl"
|
|
67629
|
+
},
|
|
67630
|
+
{
|
|
67631
|
+
"kind": "string",
|
|
67632
|
+
"value": "xxl"
|
|
67633
|
+
},
|
|
67634
|
+
{
|
|
67635
|
+
"kind": "string",
|
|
67636
|
+
"value": "xxxl"
|
|
67637
|
+
}
|
|
67638
|
+
]
|
|
67639
|
+
},
|
|
67640
|
+
"description": "Set the margin top and bottom of the list box. You must use this prop and not style any other way. The\n`Menu` uses virtualization and needs margins to be set on the correct element. This ensure\nproper rendering.",
|
|
67641
|
+
"declarations": [
|
|
67642
|
+
{
|
|
67643
|
+
"name": "marginY",
|
|
67644
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/ListBox.tsx"
|
|
67645
|
+
}
|
|
67646
|
+
],
|
|
67647
|
+
"tags": {}
|
|
67648
|
+
},
|
|
66692
67649
|
{
|
|
66693
67650
|
"kind": "property",
|
|
66694
67651
|
"name": "cs",
|
|
@@ -102538,6 +103495,243 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
102538
103495
|
],
|
|
102539
103496
|
"tags": {}
|
|
102540
103497
|
},
|
|
103498
|
+
{
|
|
103499
|
+
"kind": "property",
|
|
103500
|
+
"name": "marginTop",
|
|
103501
|
+
"required": false,
|
|
103502
|
+
"type": {
|
|
103503
|
+
"kind": "union",
|
|
103504
|
+
"value": [
|
|
103505
|
+
{
|
|
103506
|
+
"kind": "primitive",
|
|
103507
|
+
"value": "undefined"
|
|
103508
|
+
},
|
|
103509
|
+
{
|
|
103510
|
+
"kind": "primitive",
|
|
103511
|
+
"value": "number"
|
|
103512
|
+
},
|
|
103513
|
+
{
|
|
103514
|
+
"kind": "intersection",
|
|
103515
|
+
"value": [
|
|
103516
|
+
{
|
|
103517
|
+
"kind": "primitive",
|
|
103518
|
+
"value": "string"
|
|
103519
|
+
},
|
|
103520
|
+
{
|
|
103521
|
+
"kind": "object",
|
|
103522
|
+
"properties": []
|
|
103523
|
+
}
|
|
103524
|
+
]
|
|
103525
|
+
},
|
|
103526
|
+
{
|
|
103527
|
+
"kind": "string",
|
|
103528
|
+
"value": "s"
|
|
103529
|
+
},
|
|
103530
|
+
{
|
|
103531
|
+
"kind": "string",
|
|
103532
|
+
"value": "zero"
|
|
103533
|
+
},
|
|
103534
|
+
{
|
|
103535
|
+
"kind": "string",
|
|
103536
|
+
"value": "m"
|
|
103537
|
+
},
|
|
103538
|
+
{
|
|
103539
|
+
"kind": "string",
|
|
103540
|
+
"value": "l"
|
|
103541
|
+
},
|
|
103542
|
+
{
|
|
103543
|
+
"kind": "string",
|
|
103544
|
+
"value": "xxxs"
|
|
103545
|
+
},
|
|
103546
|
+
{
|
|
103547
|
+
"kind": "string",
|
|
103548
|
+
"value": "xxs"
|
|
103549
|
+
},
|
|
103550
|
+
{
|
|
103551
|
+
"kind": "string",
|
|
103552
|
+
"value": "xs"
|
|
103553
|
+
},
|
|
103554
|
+
{
|
|
103555
|
+
"kind": "string",
|
|
103556
|
+
"value": "xl"
|
|
103557
|
+
},
|
|
103558
|
+
{
|
|
103559
|
+
"kind": "string",
|
|
103560
|
+
"value": "xxl"
|
|
103561
|
+
},
|
|
103562
|
+
{
|
|
103563
|
+
"kind": "string",
|
|
103564
|
+
"value": "xxxl"
|
|
103565
|
+
}
|
|
103566
|
+
]
|
|
103567
|
+
},
|
|
103568
|
+
"description": "Set the margin top of the list box. You must use this prop and not style any other way. The\n`Menu` uses virtualization and needs margins to be set on the correct element. This ensure\nproper rendering. If a `marginTop` is not provided, the value falls back to `marginY`.",
|
|
103569
|
+
"declarations": [
|
|
103570
|
+
{
|
|
103571
|
+
"name": "marginTop",
|
|
103572
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/ListBox.tsx"
|
|
103573
|
+
}
|
|
103574
|
+
],
|
|
103575
|
+
"tags": {}
|
|
103576
|
+
},
|
|
103577
|
+
{
|
|
103578
|
+
"kind": "property",
|
|
103579
|
+
"name": "marginBottom",
|
|
103580
|
+
"required": false,
|
|
103581
|
+
"type": {
|
|
103582
|
+
"kind": "union",
|
|
103583
|
+
"value": [
|
|
103584
|
+
{
|
|
103585
|
+
"kind": "primitive",
|
|
103586
|
+
"value": "undefined"
|
|
103587
|
+
},
|
|
103588
|
+
{
|
|
103589
|
+
"kind": "primitive",
|
|
103590
|
+
"value": "number"
|
|
103591
|
+
},
|
|
103592
|
+
{
|
|
103593
|
+
"kind": "intersection",
|
|
103594
|
+
"value": [
|
|
103595
|
+
{
|
|
103596
|
+
"kind": "primitive",
|
|
103597
|
+
"value": "string"
|
|
103598
|
+
},
|
|
103599
|
+
{
|
|
103600
|
+
"kind": "object",
|
|
103601
|
+
"properties": []
|
|
103602
|
+
}
|
|
103603
|
+
]
|
|
103604
|
+
},
|
|
103605
|
+
{
|
|
103606
|
+
"kind": "string",
|
|
103607
|
+
"value": "s"
|
|
103608
|
+
},
|
|
103609
|
+
{
|
|
103610
|
+
"kind": "string",
|
|
103611
|
+
"value": "zero"
|
|
103612
|
+
},
|
|
103613
|
+
{
|
|
103614
|
+
"kind": "string",
|
|
103615
|
+
"value": "m"
|
|
103616
|
+
},
|
|
103617
|
+
{
|
|
103618
|
+
"kind": "string",
|
|
103619
|
+
"value": "l"
|
|
103620
|
+
},
|
|
103621
|
+
{
|
|
103622
|
+
"kind": "string",
|
|
103623
|
+
"value": "xxxs"
|
|
103624
|
+
},
|
|
103625
|
+
{
|
|
103626
|
+
"kind": "string",
|
|
103627
|
+
"value": "xxs"
|
|
103628
|
+
},
|
|
103629
|
+
{
|
|
103630
|
+
"kind": "string",
|
|
103631
|
+
"value": "xs"
|
|
103632
|
+
},
|
|
103633
|
+
{
|
|
103634
|
+
"kind": "string",
|
|
103635
|
+
"value": "xl"
|
|
103636
|
+
},
|
|
103637
|
+
{
|
|
103638
|
+
"kind": "string",
|
|
103639
|
+
"value": "xxl"
|
|
103640
|
+
},
|
|
103641
|
+
{
|
|
103642
|
+
"kind": "string",
|
|
103643
|
+
"value": "xxxl"
|
|
103644
|
+
}
|
|
103645
|
+
]
|
|
103646
|
+
},
|
|
103647
|
+
"description": "Set the margin bottom of the list box. You must use this prop and not style any other way. The\n`Menu` uses virtualization and needs margins to be set on the correct element. This ensure\nproper rendering. If a `marginBottom` is not provided, the value falls back to `marginY`.",
|
|
103648
|
+
"declarations": [
|
|
103649
|
+
{
|
|
103650
|
+
"name": "marginBottom",
|
|
103651
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/ListBox.tsx"
|
|
103652
|
+
}
|
|
103653
|
+
],
|
|
103654
|
+
"tags": {}
|
|
103655
|
+
},
|
|
103656
|
+
{
|
|
103657
|
+
"kind": "property",
|
|
103658
|
+
"name": "marginY",
|
|
103659
|
+
"required": false,
|
|
103660
|
+
"type": {
|
|
103661
|
+
"kind": "union",
|
|
103662
|
+
"value": [
|
|
103663
|
+
{
|
|
103664
|
+
"kind": "primitive",
|
|
103665
|
+
"value": "undefined"
|
|
103666
|
+
},
|
|
103667
|
+
{
|
|
103668
|
+
"kind": "primitive",
|
|
103669
|
+
"value": "number"
|
|
103670
|
+
},
|
|
103671
|
+
{
|
|
103672
|
+
"kind": "intersection",
|
|
103673
|
+
"value": [
|
|
103674
|
+
{
|
|
103675
|
+
"kind": "primitive",
|
|
103676
|
+
"value": "string"
|
|
103677
|
+
},
|
|
103678
|
+
{
|
|
103679
|
+
"kind": "object",
|
|
103680
|
+
"properties": []
|
|
103681
|
+
}
|
|
103682
|
+
]
|
|
103683
|
+
},
|
|
103684
|
+
{
|
|
103685
|
+
"kind": "string",
|
|
103686
|
+
"value": "s"
|
|
103687
|
+
},
|
|
103688
|
+
{
|
|
103689
|
+
"kind": "string",
|
|
103690
|
+
"value": "zero"
|
|
103691
|
+
},
|
|
103692
|
+
{
|
|
103693
|
+
"kind": "string",
|
|
103694
|
+
"value": "m"
|
|
103695
|
+
},
|
|
103696
|
+
{
|
|
103697
|
+
"kind": "string",
|
|
103698
|
+
"value": "l"
|
|
103699
|
+
},
|
|
103700
|
+
{
|
|
103701
|
+
"kind": "string",
|
|
103702
|
+
"value": "xxxs"
|
|
103703
|
+
},
|
|
103704
|
+
{
|
|
103705
|
+
"kind": "string",
|
|
103706
|
+
"value": "xxs"
|
|
103707
|
+
},
|
|
103708
|
+
{
|
|
103709
|
+
"kind": "string",
|
|
103710
|
+
"value": "xs"
|
|
103711
|
+
},
|
|
103712
|
+
{
|
|
103713
|
+
"kind": "string",
|
|
103714
|
+
"value": "xl"
|
|
103715
|
+
},
|
|
103716
|
+
{
|
|
103717
|
+
"kind": "string",
|
|
103718
|
+
"value": "xxl"
|
|
103719
|
+
},
|
|
103720
|
+
{
|
|
103721
|
+
"kind": "string",
|
|
103722
|
+
"value": "xxxl"
|
|
103723
|
+
}
|
|
103724
|
+
]
|
|
103725
|
+
},
|
|
103726
|
+
"description": "Set the margin top and bottom of the list box. You must use this prop and not style any other way. The\n`Menu` uses virtualization and needs margins to be set on the correct element. This ensure\nproper rendering.",
|
|
103727
|
+
"declarations": [
|
|
103728
|
+
{
|
|
103729
|
+
"name": "marginY",
|
|
103730
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/ListBox.tsx"
|
|
103731
|
+
}
|
|
103732
|
+
],
|
|
103733
|
+
"tags": {}
|
|
103734
|
+
},
|
|
102541
103735
|
{
|
|
102542
103736
|
"kind": "property",
|
|
102543
103737
|
"name": "cs",
|
|
@@ -114006,6 +115200,73 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
114006
115200
|
}
|
|
114007
115201
|
}
|
|
114008
115202
|
},
|
|
115203
|
+
{
|
|
115204
|
+
"name": "filterOutProps",
|
|
115205
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/styled.ts",
|
|
115206
|
+
"description": "",
|
|
115207
|
+
"declarations": [
|
|
115208
|
+
{
|
|
115209
|
+
"name": "filterOutProps",
|
|
115210
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/styled.ts"
|
|
115211
|
+
}
|
|
115212
|
+
],
|
|
115213
|
+
"tags": {},
|
|
115214
|
+
"type": {
|
|
115215
|
+
"kind": "function",
|
|
115216
|
+
"parameters": [
|
|
115217
|
+
{
|
|
115218
|
+
"kind": "parameter",
|
|
115219
|
+
"name": "omittedProps",
|
|
115220
|
+
"type": {
|
|
115221
|
+
"kind": "array",
|
|
115222
|
+
"value": {
|
|
115223
|
+
"kind": "primitive",
|
|
115224
|
+
"value": "string"
|
|
115225
|
+
}
|
|
115226
|
+
},
|
|
115227
|
+
"required": true,
|
|
115228
|
+
"rest": false,
|
|
115229
|
+
"description": "",
|
|
115230
|
+
"declarations": [
|
|
115231
|
+
{
|
|
115232
|
+
"name": "omittedProps",
|
|
115233
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/styled.ts"
|
|
115234
|
+
}
|
|
115235
|
+
],
|
|
115236
|
+
"tags": {}
|
|
115237
|
+
}
|
|
115238
|
+
],
|
|
115239
|
+
"members": [],
|
|
115240
|
+
"returnType": {
|
|
115241
|
+
"kind": "function",
|
|
115242
|
+
"parameters": [
|
|
115243
|
+
{
|
|
115244
|
+
"kind": "parameter",
|
|
115245
|
+
"name": "prop",
|
|
115246
|
+
"type": {
|
|
115247
|
+
"kind": "primitive",
|
|
115248
|
+
"value": "string"
|
|
115249
|
+
},
|
|
115250
|
+
"required": true,
|
|
115251
|
+
"rest": false,
|
|
115252
|
+
"description": "",
|
|
115253
|
+
"declarations": [
|
|
115254
|
+
{
|
|
115255
|
+
"name": "prop",
|
|
115256
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/styled.ts"
|
|
115257
|
+
}
|
|
115258
|
+
],
|
|
115259
|
+
"tags": {}
|
|
115260
|
+
}
|
|
115261
|
+
],
|
|
115262
|
+
"members": [],
|
|
115263
|
+
"returnType": {
|
|
115264
|
+
"kind": "primitive",
|
|
115265
|
+
"value": "boolean"
|
|
115266
|
+
}
|
|
115267
|
+
}
|
|
115268
|
+
}
|
|
115269
|
+
},
|
|
114009
115270
|
{
|
|
114010
115271
|
"name": "StyleRewriteFn",
|
|
114011
115272
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/styled.ts",
|
|
@@ -158840,6 +160101,243 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
158840
160101
|
],
|
|
158841
160102
|
"tags": {}
|
|
158842
160103
|
},
|
|
160104
|
+
{
|
|
160105
|
+
"kind": "property",
|
|
160106
|
+
"name": "marginY",
|
|
160107
|
+
"required": false,
|
|
160108
|
+
"type": {
|
|
160109
|
+
"kind": "union",
|
|
160110
|
+
"value": [
|
|
160111
|
+
{
|
|
160112
|
+
"kind": "primitive",
|
|
160113
|
+
"value": "undefined"
|
|
160114
|
+
},
|
|
160115
|
+
{
|
|
160116
|
+
"kind": "primitive",
|
|
160117
|
+
"value": "number"
|
|
160118
|
+
},
|
|
160119
|
+
{
|
|
160120
|
+
"kind": "intersection",
|
|
160121
|
+
"value": [
|
|
160122
|
+
{
|
|
160123
|
+
"kind": "primitive",
|
|
160124
|
+
"value": "string"
|
|
160125
|
+
},
|
|
160126
|
+
{
|
|
160127
|
+
"kind": "object",
|
|
160128
|
+
"properties": []
|
|
160129
|
+
}
|
|
160130
|
+
]
|
|
160131
|
+
},
|
|
160132
|
+
{
|
|
160133
|
+
"kind": "string",
|
|
160134
|
+
"value": "s"
|
|
160135
|
+
},
|
|
160136
|
+
{
|
|
160137
|
+
"kind": "string",
|
|
160138
|
+
"value": "zero"
|
|
160139
|
+
},
|
|
160140
|
+
{
|
|
160141
|
+
"kind": "string",
|
|
160142
|
+
"value": "m"
|
|
160143
|
+
},
|
|
160144
|
+
{
|
|
160145
|
+
"kind": "string",
|
|
160146
|
+
"value": "l"
|
|
160147
|
+
},
|
|
160148
|
+
{
|
|
160149
|
+
"kind": "string",
|
|
160150
|
+
"value": "xxxs"
|
|
160151
|
+
},
|
|
160152
|
+
{
|
|
160153
|
+
"kind": "string",
|
|
160154
|
+
"value": "xxs"
|
|
160155
|
+
},
|
|
160156
|
+
{
|
|
160157
|
+
"kind": "string",
|
|
160158
|
+
"value": "xs"
|
|
160159
|
+
},
|
|
160160
|
+
{
|
|
160161
|
+
"kind": "string",
|
|
160162
|
+
"value": "xl"
|
|
160163
|
+
},
|
|
160164
|
+
{
|
|
160165
|
+
"kind": "string",
|
|
160166
|
+
"value": "xxl"
|
|
160167
|
+
},
|
|
160168
|
+
{
|
|
160169
|
+
"kind": "string",
|
|
160170
|
+
"value": "xxxl"
|
|
160171
|
+
}
|
|
160172
|
+
]
|
|
160173
|
+
},
|
|
160174
|
+
"description": "Set the margin top and bottom of the list box. You must use this prop and not style any other way. The\n`Menu` uses virtualization and needs margins to be set on the correct element. This ensure\nproper rendering.",
|
|
160175
|
+
"declarations": [
|
|
160176
|
+
{
|
|
160177
|
+
"name": "marginY",
|
|
160178
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/ListBox.tsx"
|
|
160179
|
+
}
|
|
160180
|
+
],
|
|
160181
|
+
"tags": {}
|
|
160182
|
+
},
|
|
160183
|
+
{
|
|
160184
|
+
"kind": "property",
|
|
160185
|
+
"name": "marginTop",
|
|
160186
|
+
"required": false,
|
|
160187
|
+
"type": {
|
|
160188
|
+
"kind": "union",
|
|
160189
|
+
"value": [
|
|
160190
|
+
{
|
|
160191
|
+
"kind": "primitive",
|
|
160192
|
+
"value": "undefined"
|
|
160193
|
+
},
|
|
160194
|
+
{
|
|
160195
|
+
"kind": "primitive",
|
|
160196
|
+
"value": "number"
|
|
160197
|
+
},
|
|
160198
|
+
{
|
|
160199
|
+
"kind": "intersection",
|
|
160200
|
+
"value": [
|
|
160201
|
+
{
|
|
160202
|
+
"kind": "primitive",
|
|
160203
|
+
"value": "string"
|
|
160204
|
+
},
|
|
160205
|
+
{
|
|
160206
|
+
"kind": "object",
|
|
160207
|
+
"properties": []
|
|
160208
|
+
}
|
|
160209
|
+
]
|
|
160210
|
+
},
|
|
160211
|
+
{
|
|
160212
|
+
"kind": "string",
|
|
160213
|
+
"value": "s"
|
|
160214
|
+
},
|
|
160215
|
+
{
|
|
160216
|
+
"kind": "string",
|
|
160217
|
+
"value": "zero"
|
|
160218
|
+
},
|
|
160219
|
+
{
|
|
160220
|
+
"kind": "string",
|
|
160221
|
+
"value": "m"
|
|
160222
|
+
},
|
|
160223
|
+
{
|
|
160224
|
+
"kind": "string",
|
|
160225
|
+
"value": "l"
|
|
160226
|
+
},
|
|
160227
|
+
{
|
|
160228
|
+
"kind": "string",
|
|
160229
|
+
"value": "xxxs"
|
|
160230
|
+
},
|
|
160231
|
+
{
|
|
160232
|
+
"kind": "string",
|
|
160233
|
+
"value": "xxs"
|
|
160234
|
+
},
|
|
160235
|
+
{
|
|
160236
|
+
"kind": "string",
|
|
160237
|
+
"value": "xs"
|
|
160238
|
+
},
|
|
160239
|
+
{
|
|
160240
|
+
"kind": "string",
|
|
160241
|
+
"value": "xl"
|
|
160242
|
+
},
|
|
160243
|
+
{
|
|
160244
|
+
"kind": "string",
|
|
160245
|
+
"value": "xxl"
|
|
160246
|
+
},
|
|
160247
|
+
{
|
|
160248
|
+
"kind": "string",
|
|
160249
|
+
"value": "xxxl"
|
|
160250
|
+
}
|
|
160251
|
+
]
|
|
160252
|
+
},
|
|
160253
|
+
"description": "Set the margin top of the list box. You must use this prop and not style any other way. The\n`Menu` uses virtualization and needs margins to be set on the correct element. This ensure\nproper rendering. If a `marginTop` is not provided, the value falls back to `marginY`.",
|
|
160254
|
+
"declarations": [
|
|
160255
|
+
{
|
|
160256
|
+
"name": "marginTop",
|
|
160257
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/ListBox.tsx"
|
|
160258
|
+
}
|
|
160259
|
+
],
|
|
160260
|
+
"tags": {}
|
|
160261
|
+
},
|
|
160262
|
+
{
|
|
160263
|
+
"kind": "property",
|
|
160264
|
+
"name": "marginBottom",
|
|
160265
|
+
"required": false,
|
|
160266
|
+
"type": {
|
|
160267
|
+
"kind": "union",
|
|
160268
|
+
"value": [
|
|
160269
|
+
{
|
|
160270
|
+
"kind": "primitive",
|
|
160271
|
+
"value": "undefined"
|
|
160272
|
+
},
|
|
160273
|
+
{
|
|
160274
|
+
"kind": "primitive",
|
|
160275
|
+
"value": "number"
|
|
160276
|
+
},
|
|
160277
|
+
{
|
|
160278
|
+
"kind": "intersection",
|
|
160279
|
+
"value": [
|
|
160280
|
+
{
|
|
160281
|
+
"kind": "primitive",
|
|
160282
|
+
"value": "string"
|
|
160283
|
+
},
|
|
160284
|
+
{
|
|
160285
|
+
"kind": "object",
|
|
160286
|
+
"properties": []
|
|
160287
|
+
}
|
|
160288
|
+
]
|
|
160289
|
+
},
|
|
160290
|
+
{
|
|
160291
|
+
"kind": "string",
|
|
160292
|
+
"value": "s"
|
|
160293
|
+
},
|
|
160294
|
+
{
|
|
160295
|
+
"kind": "string",
|
|
160296
|
+
"value": "zero"
|
|
160297
|
+
},
|
|
160298
|
+
{
|
|
160299
|
+
"kind": "string",
|
|
160300
|
+
"value": "m"
|
|
160301
|
+
},
|
|
160302
|
+
{
|
|
160303
|
+
"kind": "string",
|
|
160304
|
+
"value": "l"
|
|
160305
|
+
},
|
|
160306
|
+
{
|
|
160307
|
+
"kind": "string",
|
|
160308
|
+
"value": "xxxs"
|
|
160309
|
+
},
|
|
160310
|
+
{
|
|
160311
|
+
"kind": "string",
|
|
160312
|
+
"value": "xxs"
|
|
160313
|
+
},
|
|
160314
|
+
{
|
|
160315
|
+
"kind": "string",
|
|
160316
|
+
"value": "xs"
|
|
160317
|
+
},
|
|
160318
|
+
{
|
|
160319
|
+
"kind": "string",
|
|
160320
|
+
"value": "xl"
|
|
160321
|
+
},
|
|
160322
|
+
{
|
|
160323
|
+
"kind": "string",
|
|
160324
|
+
"value": "xxl"
|
|
160325
|
+
},
|
|
160326
|
+
{
|
|
160327
|
+
"kind": "string",
|
|
160328
|
+
"value": "xxxl"
|
|
160329
|
+
}
|
|
160330
|
+
]
|
|
160331
|
+
},
|
|
160332
|
+
"description": "Set the margin bottom of the list box. You must use this prop and not style any other way. The\n`Menu` uses virtualization and needs margins to be set on the correct element. This ensure\nproper rendering. If a `marginBottom` is not provided, the value falls back to `marginY`.",
|
|
160333
|
+
"declarations": [
|
|
160334
|
+
{
|
|
160335
|
+
"name": "marginBottom",
|
|
160336
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/ListBox.tsx"
|
|
160337
|
+
}
|
|
160338
|
+
],
|
|
160339
|
+
"tags": {}
|
|
160340
|
+
},
|
|
158843
160341
|
{
|
|
158844
160342
|
"kind": "property",
|
|
158845
160343
|
"name": "cs",
|
|
@@ -169284,7 +170782,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
169284
170782
|
{
|
|
169285
170783
|
"name": "Card",
|
|
169286
170784
|
"symbol": "ModalCard",
|
|
169287
|
-
"description": "The `Modal.Card` is wraps a {@link PopupCard Popup.Card} which wraps a {@link Card}. It is\nthe `role=\"dialog\"` element and is uses `useModalCard` behavior hook which sets\n`aria-modal=\"
|
|
170785
|
+
"description": "The `Modal.Card` is wraps a {@link PopupCard Popup.Card} which wraps a {@link Card}. It is\nthe `role=\"dialog\"` element and is uses `useModalCard` behavior hook which sets\n`aria-modal=\"false\"` and sets the `aria-labelledby` that points to the `id` of the\n{@link ModalHeading Modal.Heading}. If you don't use a `Modal.Heading`, add an `aria-label`\ninstead. The default element is a `div` and can be changed via the `as` prop.",
|
|
169288
170786
|
"declarations": [
|
|
169289
170787
|
{
|
|
169290
170788
|
"name": "Card",
|