@workday/canvas-kit-docs 11.0.0-alpha.707-next.0 → 11.0.0-alpha.710-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/Specifications.d.ts.map +1 -1
- package/dist/es6/lib/Specifications.js +12 -12
- package/dist/es6/lib/docs.js +772 -1077
- package/dist/es6/mdx/versionsTable.d.ts.map +1 -1
- package/dist/es6/mdx/versionsTable.js +2 -1
- package/dist/mdx/11.0-UPGRADE-GUIDE.mdx +110 -2
- package/dist/mdx/{preview-react → react}/_examples/TablesAdvanced.mdx +1 -1
- package/dist/mdx/{preview-react → react}/_examples/examples/Table/WithExpandableRows.tsx +1 -1
- package/dist/mdx/{preview-react → react}/_examples/examples/Table/WithSelectableRows.tsx +1 -1
- package/dist/mdx/{preview-react → react}/_examples/examples/Table/WithSortableColumnHeaders.tsx +1 -1
- package/dist/mdx/react/table/Table.mdx +34 -73
- package/dist/mdx/react/table/examples/Basic.tsx +31 -26
- package/dist/mdx/{preview-react → react}/table/examples/BasicWithHeading.tsx +8 -4
- package/dist/mdx/{preview-react → react}/table/examples/FixedColumn.tsx +1 -1
- package/dist/mdx/{preview-react → react}/table/examples/RightToLeft.tsx +1 -1
- package/lib/Specifications.tsx +31 -29
- package/package.json +6 -6
- package/dist/mdx/preview-react/table/Table.mdx +0 -66
- package/dist/mdx/preview-react/table/examples/Basic.tsx +0 -36
- package/dist/mdx/react/table/examples/RowHeader.tsx +0 -25
- package/dist/mdx/react/table/examples/RowStates.tsx +0 -54
package/dist/es6/lib/docs.js
CHANGED
|
@@ -31604,960 +31604,6 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
31604
31604
|
}
|
|
31605
31605
|
}
|
|
31606
31606
|
},
|
|
31607
|
-
{
|
|
31608
|
-
"name": "Table",
|
|
31609
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/table/lib/Table.tsx",
|
|
31610
|
-
"description": "`Table` is a simple styled compound component that renders a [table](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/table) element. It is used to present information in a two-dimensional table comprised of rows and columns of cells containing data.\n\n\n```tsx\nimport {Table} from '@workday/canvas-kit-preview-react/table';\n\nexport default function App() {\nreturn (\n <Table>\n <Table.Caption>Table Caption</Table.Caption>\n <Table.Head>\n <Table.Row>\n <Table.Header>Table Header</Table.Header>\n <Table.Header>Table Header</Table.Header>\n </Table.Row>\n </Table.Head>\n <Table.Body>\n <Table.Row>\n <Table.Header>Table Header</Table.Header>\n <Table.Header>Table Header</Table.Header>\n </Table.Row>\n <Table.Row>\n <Table.Header>Table Header</Table.Header>\n <Table.Cell>Table Data Cell</Table.Cell>\n </Table.Row>\n <Table.Row>\n <Table.Header>Table Header</Table.Header>\n <Table.Cell>Table Data Cell</Table.Cell>\n </Table.Row>\n </Table.Body>\n <Table.Footer>\n <Table.Row>\n <Table.Header>Table Header</Table.Header>\n <Table.Cell>Table Data Cell</Table.Cell>\n </Table.Row>\n </Table.Footer>\n </Table>\n);\n}\n```",
|
|
31611
|
-
"declarations": [
|
|
31612
|
-
{
|
|
31613
|
-
"name": "Table",
|
|
31614
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/table/lib/Table.tsx"
|
|
31615
|
-
}
|
|
31616
|
-
],
|
|
31617
|
-
"tags": {},
|
|
31618
|
-
"type": {
|
|
31619
|
-
"kind": "enhancedComponent",
|
|
31620
|
-
"componentType": "regular",
|
|
31621
|
-
"displayName": "Table",
|
|
31622
|
-
"props": [
|
|
31623
|
-
{
|
|
31624
|
-
"kind": "property",
|
|
31625
|
-
"name": "cs",
|
|
31626
|
-
"required": false,
|
|
31627
|
-
"type": {
|
|
31628
|
-
"kind": "symbol",
|
|
31629
|
-
"name": "CSToPropsInput",
|
|
31630
|
-
"value": "CSToPropsInput"
|
|
31631
|
-
},
|
|
31632
|
-
"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```",
|
|
31633
|
-
"declarations": [
|
|
31634
|
-
{
|
|
31635
|
-
"name": "cs",
|
|
31636
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
31637
|
-
}
|
|
31638
|
-
],
|
|
31639
|
-
"tags": {}
|
|
31640
|
-
},
|
|
31641
|
-
{
|
|
31642
|
-
"kind": "property",
|
|
31643
|
-
"name": "children",
|
|
31644
|
-
"required": false,
|
|
31645
|
-
"type": {
|
|
31646
|
-
"kind": "external",
|
|
31647
|
-
"name": "ReactNode",
|
|
31648
|
-
"url": "https://reactjs.org/docs/rendering-elements.html"
|
|
31649
|
-
},
|
|
31650
|
-
"description": "",
|
|
31651
|
-
"declarations": [
|
|
31652
|
-
{
|
|
31653
|
-
"name": "children",
|
|
31654
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/layout/lib/Box.tsx"
|
|
31655
|
-
}
|
|
31656
|
-
],
|
|
31657
|
-
"tags": {}
|
|
31658
|
-
},
|
|
31659
|
-
{
|
|
31660
|
-
"kind": "property",
|
|
31661
|
-
"name": "as",
|
|
31662
|
-
"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.",
|
|
31663
|
-
"tags": {},
|
|
31664
|
-
"declarations": [],
|
|
31665
|
-
"type": {
|
|
31666
|
-
"kind": "external",
|
|
31667
|
-
"name": "React.ElementType",
|
|
31668
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
|
|
31669
|
-
},
|
|
31670
|
-
"defaultValue": {
|
|
31671
|
-
"kind": "external",
|
|
31672
|
-
"name": "table",
|
|
31673
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/table"
|
|
31674
|
-
}
|
|
31675
|
-
},
|
|
31676
|
-
{
|
|
31677
|
-
"kind": "property",
|
|
31678
|
-
"name": "ref",
|
|
31679
|
-
"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`).",
|
|
31680
|
-
"tags": {},
|
|
31681
|
-
"declarations": [],
|
|
31682
|
-
"type": {
|
|
31683
|
-
"kind": "external",
|
|
31684
|
-
"name": "React.Ref",
|
|
31685
|
-
"url": "https://reactjs.org/docs/refs-and-the-dom.html",
|
|
31686
|
-
"typeParameters": [
|
|
31687
|
-
{
|
|
31688
|
-
"kind": "typeParameter",
|
|
31689
|
-
"name": "R",
|
|
31690
|
-
"required": true,
|
|
31691
|
-
"defaultValue": {
|
|
31692
|
-
"kind": "external",
|
|
31693
|
-
"name": "table",
|
|
31694
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/table"
|
|
31695
|
-
}
|
|
31696
|
-
}
|
|
31697
|
-
]
|
|
31698
|
-
}
|
|
31699
|
-
}
|
|
31700
|
-
],
|
|
31701
|
-
"baseElement": {
|
|
31702
|
-
"kind": "external",
|
|
31703
|
-
"name": "table",
|
|
31704
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/table"
|
|
31705
|
-
},
|
|
31706
|
-
"subComponents": [
|
|
31707
|
-
{
|
|
31708
|
-
"name": "Caption",
|
|
31709
|
-
"symbol": "TableCaption",
|
|
31710
|
-
"description": "`Table.Caption` renders a [caption](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/caption) element.\n\n\n```tsx\nimport {Table} from '@workday/canvas-kit-preview-react/table';\n\nexport default function App() {\n return (\n <Table>\n <Table.Caption>Table Caption</Table.Caption>\n <Table.Body>\n <Table.Row>\n <Table.Header>Table Header</Table.Header>\n <Table.Cell>Table Cell</Table.Cell>\n </Table.Row>\n </Table.Body>\n </Table>\n );\n}\n```",
|
|
31711
|
-
"declarations": [
|
|
31712
|
-
{
|
|
31713
|
-
"name": "Caption",
|
|
31714
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/table/lib/Table.tsx"
|
|
31715
|
-
},
|
|
31716
|
-
{
|
|
31717
|
-
"name": "TableCaption",
|
|
31718
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/table/lib/TableCaption.tsx"
|
|
31719
|
-
}
|
|
31720
|
-
],
|
|
31721
|
-
"tags": {}
|
|
31722
|
-
},
|
|
31723
|
-
{
|
|
31724
|
-
"name": "Head",
|
|
31725
|
-
"symbol": "TableHead",
|
|
31726
|
-
"description": "`Table.Head` renders a [thead](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/thead) element.\n\n\n```tsx\nimport {Table} from '@workday/canvas-kit-preview-react/table';\n\nexport default function App() {\nreturn (\n <Table>\n <Table.Head>\n <Table.Row>\n <Table.Header>Table Header</Table.Header>\n <Table.Cell>Table Cell</Table.Cell>\n </Table.Row>\n </Table.Head>\n </Table>\n);\n}\n```",
|
|
31727
|
-
"declarations": [
|
|
31728
|
-
{
|
|
31729
|
-
"name": "Head",
|
|
31730
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/table/lib/Table.tsx"
|
|
31731
|
-
},
|
|
31732
|
-
{
|
|
31733
|
-
"name": "TableHead",
|
|
31734
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/table/lib/TableHead.tsx"
|
|
31735
|
-
}
|
|
31736
|
-
],
|
|
31737
|
-
"tags": {}
|
|
31738
|
-
},
|
|
31739
|
-
{
|
|
31740
|
-
"name": "Body",
|
|
31741
|
-
"symbol": "TableBody",
|
|
31742
|
-
"description": "`Table.Body` renders a [tbody](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/tbody) element.\n\n\n```tsx\nimport {Table} from '@workday/canvas-kit-preview-react/table';\n\nexport default function App() {\nreturn (\n <Table>\n <Table.Body>\n <Table.Row>\n <Table.Header>Table Header</Table.Header>\n <Table.Cell>Table Cell</Table.Cell>\n </Table.Row>\n </Table.Body>\n </Table>\n);\n}\n```",
|
|
31743
|
-
"declarations": [
|
|
31744
|
-
{
|
|
31745
|
-
"name": "Body",
|
|
31746
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/table/lib/Table.tsx"
|
|
31747
|
-
},
|
|
31748
|
-
{
|
|
31749
|
-
"name": "TableBody",
|
|
31750
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/table/lib/TableBody.tsx"
|
|
31751
|
-
}
|
|
31752
|
-
],
|
|
31753
|
-
"tags": {}
|
|
31754
|
-
},
|
|
31755
|
-
{
|
|
31756
|
-
"name": "Row",
|
|
31757
|
-
"symbol": "TableRow",
|
|
31758
|
-
"description": "`Table.Row` renders a [tr](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/tr) element.\n\n**Note**: `Table.Row` is built on [Grid](/docs/components-layout-grid--basic). It will look for\nhow many children are there and if those children are valid React Elements. This will adjust the\namount of columns automatically using the `gridTemplateColumns` style prop and the width of the\ncolumns is also set using a `minmax` function in the `gridTemplateColumns` style prop. If a user\nwould like to adjust this, it can be overwritten on `Table.Row`. See the example below for how to\noverwrite `gridTemplateColumns`.\n\n\n```tsx\nimport {Table} from '@workday/canvas-kit-preview-react/table';\n\nexport default function App() {\nreturn (\n <Table>\n <Table.Head>\n <Table.Row gridTemplateColumns=\"repeat(4, minmax(100px, 1fr))\">\n <Table.Header>Table Header</Table.Header>\n <Table.Cell>Table Cell</Table.Cell>\n </Table.Row>\n </Table.Head>\n </Table>\n);\n}\n```",
|
|
31759
|
-
"declarations": [
|
|
31760
|
-
{
|
|
31761
|
-
"name": "Row",
|
|
31762
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/table/lib/Table.tsx"
|
|
31763
|
-
},
|
|
31764
|
-
{
|
|
31765
|
-
"name": "TableRow",
|
|
31766
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/table/lib/TableRow.tsx"
|
|
31767
|
-
}
|
|
31768
|
-
],
|
|
31769
|
-
"tags": {}
|
|
31770
|
-
},
|
|
31771
|
-
{
|
|
31772
|
-
"name": "Header",
|
|
31773
|
-
"symbol": "TableHeader",
|
|
31774
|
-
"description": "`Table.Header` renders a [th](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/th) element.\n\n\n```tsx\nimport {Table} from '@workday/canvas-kit-preview-react/table';\n\nexport default function App() {\nreturn (\n <Table>\n <Table.Head>\n <Table.Row>\n <Table.Header>Table Header</Table.Header>\n <Table.Cell>Table Cell</Table.Cell>\n </Table.Row>\n </Table.Head>\n </Table>\n);\n}\n```",
|
|
31775
|
-
"declarations": [
|
|
31776
|
-
{
|
|
31777
|
-
"name": "Header",
|
|
31778
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/table/lib/Table.tsx"
|
|
31779
|
-
},
|
|
31780
|
-
{
|
|
31781
|
-
"name": "TableHeader",
|
|
31782
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/table/lib/TableHeader.tsx"
|
|
31783
|
-
}
|
|
31784
|
-
],
|
|
31785
|
-
"tags": {}
|
|
31786
|
-
},
|
|
31787
|
-
{
|
|
31788
|
-
"name": "Cell",
|
|
31789
|
-
"symbol": "TableCell",
|
|
31790
|
-
"description": "`Table.Cell` renders a [td](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/td) element.\n\n\n```tsx\nimport {Table} from '@workday/canvas-kit-preview-react/table';\n\nexport default function App() {\nreturn (\n <Table>\n <Table.Body>\n <Table.Row>\n <Table.Header>Table Header</Table.Header>\n <Table.Cell>Table Cell</Table.Cell>\n </Table.Row>\n </Table.Body>\n </Table>\n);\n}\n```",
|
|
31791
|
-
"declarations": [
|
|
31792
|
-
{
|
|
31793
|
-
"name": "Cell",
|
|
31794
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/table/lib/Table.tsx"
|
|
31795
|
-
},
|
|
31796
|
-
{
|
|
31797
|
-
"name": "TableCell",
|
|
31798
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/table/lib/TableCell.tsx"
|
|
31799
|
-
}
|
|
31800
|
-
],
|
|
31801
|
-
"tags": {}
|
|
31802
|
-
},
|
|
31803
|
-
{
|
|
31804
|
-
"name": "Footer",
|
|
31805
|
-
"symbol": "TableFooter",
|
|
31806
|
-
"description": "`Table.Footer` renders a [tfoot](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/tfoot) element.\n\n\n```tsx\nimport {Table} from '@workday/canvas-kit-preview-react/table';\n\nexport default function App() {\nreturn (\n <Table>\n <Table.Footer>\n <Table.Row>\n <Table.Header>Table Header</Table.Header>\n <Table.Cell>Table Cell</Table.Cell>\n </Table.Row>\n </Table.Footer>\n </Table>\n);\n}\n```",
|
|
31807
|
-
"declarations": [
|
|
31808
|
-
{
|
|
31809
|
-
"name": "Footer",
|
|
31810
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/table/lib/Table.tsx"
|
|
31811
|
-
},
|
|
31812
|
-
{
|
|
31813
|
-
"name": "TableFooter",
|
|
31814
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/table/lib/TableFooter.tsx"
|
|
31815
|
-
}
|
|
31816
|
-
],
|
|
31817
|
-
"tags": {}
|
|
31818
|
-
}
|
|
31819
|
-
],
|
|
31820
|
-
"styleComponent": {
|
|
31821
|
-
"kind": "symbol",
|
|
31822
|
-
"name": "Grid"
|
|
31823
|
-
}
|
|
31824
|
-
}
|
|
31825
|
-
},
|
|
31826
|
-
{
|
|
31827
|
-
"name": "TableBody",
|
|
31828
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/table/lib/TableBody.tsx",
|
|
31829
|
-
"description": "",
|
|
31830
|
-
"declarations": [
|
|
31831
|
-
{
|
|
31832
|
-
"name": "TableBody",
|
|
31833
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/table/lib/TableBody.tsx"
|
|
31834
|
-
}
|
|
31835
|
-
],
|
|
31836
|
-
"tags": {},
|
|
31837
|
-
"type": {
|
|
31838
|
-
"kind": "enhancedComponent",
|
|
31839
|
-
"componentType": "regular",
|
|
31840
|
-
"displayName": "Table.Body",
|
|
31841
|
-
"props": [
|
|
31842
|
-
{
|
|
31843
|
-
"kind": "property",
|
|
31844
|
-
"name": "cs",
|
|
31845
|
-
"required": false,
|
|
31846
|
-
"type": {
|
|
31847
|
-
"kind": "symbol",
|
|
31848
|
-
"name": "CSToPropsInput",
|
|
31849
|
-
"value": "CSToPropsInput"
|
|
31850
|
-
},
|
|
31851
|
-
"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```",
|
|
31852
|
-
"declarations": [
|
|
31853
|
-
{
|
|
31854
|
-
"name": "cs",
|
|
31855
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
31856
|
-
}
|
|
31857
|
-
],
|
|
31858
|
-
"tags": {}
|
|
31859
|
-
},
|
|
31860
|
-
{
|
|
31861
|
-
"kind": "property",
|
|
31862
|
-
"name": "children",
|
|
31863
|
-
"required": false,
|
|
31864
|
-
"type": {
|
|
31865
|
-
"kind": "external",
|
|
31866
|
-
"name": "ReactNode",
|
|
31867
|
-
"url": "https://reactjs.org/docs/rendering-elements.html"
|
|
31868
|
-
},
|
|
31869
|
-
"description": "",
|
|
31870
|
-
"declarations": [
|
|
31871
|
-
{
|
|
31872
|
-
"name": "children",
|
|
31873
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/layout/lib/Box.tsx"
|
|
31874
|
-
}
|
|
31875
|
-
],
|
|
31876
|
-
"tags": {}
|
|
31877
|
-
},
|
|
31878
|
-
{
|
|
31879
|
-
"kind": "property",
|
|
31880
|
-
"name": "as",
|
|
31881
|
-
"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.",
|
|
31882
|
-
"tags": {},
|
|
31883
|
-
"declarations": [],
|
|
31884
|
-
"type": {
|
|
31885
|
-
"kind": "external",
|
|
31886
|
-
"name": "React.ElementType",
|
|
31887
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
|
|
31888
|
-
},
|
|
31889
|
-
"defaultValue": {
|
|
31890
|
-
"kind": "external",
|
|
31891
|
-
"name": "tbody",
|
|
31892
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/tbody"
|
|
31893
|
-
}
|
|
31894
|
-
},
|
|
31895
|
-
{
|
|
31896
|
-
"kind": "property",
|
|
31897
|
-
"name": "ref",
|
|
31898
|
-
"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`).",
|
|
31899
|
-
"tags": {},
|
|
31900
|
-
"declarations": [],
|
|
31901
|
-
"type": {
|
|
31902
|
-
"kind": "external",
|
|
31903
|
-
"name": "React.Ref",
|
|
31904
|
-
"url": "https://reactjs.org/docs/refs-and-the-dom.html",
|
|
31905
|
-
"typeParameters": [
|
|
31906
|
-
{
|
|
31907
|
-
"kind": "typeParameter",
|
|
31908
|
-
"name": "R",
|
|
31909
|
-
"required": true,
|
|
31910
|
-
"defaultValue": {
|
|
31911
|
-
"kind": "external",
|
|
31912
|
-
"name": "tbody",
|
|
31913
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/tbody"
|
|
31914
|
-
}
|
|
31915
|
-
}
|
|
31916
|
-
]
|
|
31917
|
-
}
|
|
31918
|
-
}
|
|
31919
|
-
],
|
|
31920
|
-
"baseElement": {
|
|
31921
|
-
"kind": "external",
|
|
31922
|
-
"name": "tbody",
|
|
31923
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/tbody"
|
|
31924
|
-
},
|
|
31925
|
-
"styleComponent": {
|
|
31926
|
-
"kind": "symbol",
|
|
31927
|
-
"name": "Grid"
|
|
31928
|
-
}
|
|
31929
|
-
}
|
|
31930
|
-
},
|
|
31931
|
-
{
|
|
31932
|
-
"name": "TableCaption",
|
|
31933
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/table/lib/TableCaption.tsx",
|
|
31934
|
-
"description": "",
|
|
31935
|
-
"declarations": [
|
|
31936
|
-
{
|
|
31937
|
-
"name": "TableCaption",
|
|
31938
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/table/lib/TableCaption.tsx"
|
|
31939
|
-
}
|
|
31940
|
-
],
|
|
31941
|
-
"tags": {},
|
|
31942
|
-
"type": {
|
|
31943
|
-
"kind": "enhancedComponent",
|
|
31944
|
-
"componentType": "regular",
|
|
31945
|
-
"displayName": "Table.Caption",
|
|
31946
|
-
"props": [
|
|
31947
|
-
{
|
|
31948
|
-
"kind": "property",
|
|
31949
|
-
"name": "cs",
|
|
31950
|
-
"required": false,
|
|
31951
|
-
"type": {
|
|
31952
|
-
"kind": "symbol",
|
|
31953
|
-
"name": "CSToPropsInput",
|
|
31954
|
-
"value": "CSToPropsInput"
|
|
31955
|
-
},
|
|
31956
|
-
"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```",
|
|
31957
|
-
"declarations": [
|
|
31958
|
-
{
|
|
31959
|
-
"name": "cs",
|
|
31960
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
31961
|
-
}
|
|
31962
|
-
],
|
|
31963
|
-
"tags": {}
|
|
31964
|
-
},
|
|
31965
|
-
{
|
|
31966
|
-
"kind": "property",
|
|
31967
|
-
"name": "children",
|
|
31968
|
-
"required": false,
|
|
31969
|
-
"type": {
|
|
31970
|
-
"kind": "external",
|
|
31971
|
-
"name": "ReactNode",
|
|
31972
|
-
"url": "https://reactjs.org/docs/rendering-elements.html"
|
|
31973
|
-
},
|
|
31974
|
-
"description": "",
|
|
31975
|
-
"declarations": [
|
|
31976
|
-
{
|
|
31977
|
-
"name": "children",
|
|
31978
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/layout/lib/Box.tsx"
|
|
31979
|
-
}
|
|
31980
|
-
],
|
|
31981
|
-
"tags": {}
|
|
31982
|
-
},
|
|
31983
|
-
{
|
|
31984
|
-
"kind": "property",
|
|
31985
|
-
"name": "as",
|
|
31986
|
-
"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.",
|
|
31987
|
-
"tags": {},
|
|
31988
|
-
"declarations": [],
|
|
31989
|
-
"type": {
|
|
31990
|
-
"kind": "external",
|
|
31991
|
-
"name": "React.ElementType",
|
|
31992
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
|
|
31993
|
-
},
|
|
31994
|
-
"defaultValue": {
|
|
31995
|
-
"kind": "external",
|
|
31996
|
-
"name": "caption",
|
|
31997
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/caption"
|
|
31998
|
-
}
|
|
31999
|
-
},
|
|
32000
|
-
{
|
|
32001
|
-
"kind": "property",
|
|
32002
|
-
"name": "ref",
|
|
32003
|
-
"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`).",
|
|
32004
|
-
"tags": {},
|
|
32005
|
-
"declarations": [],
|
|
32006
|
-
"type": {
|
|
32007
|
-
"kind": "external",
|
|
32008
|
-
"name": "React.Ref",
|
|
32009
|
-
"url": "https://reactjs.org/docs/refs-and-the-dom.html",
|
|
32010
|
-
"typeParameters": [
|
|
32011
|
-
{
|
|
32012
|
-
"kind": "typeParameter",
|
|
32013
|
-
"name": "R",
|
|
32014
|
-
"required": true,
|
|
32015
|
-
"defaultValue": {
|
|
32016
|
-
"kind": "external",
|
|
32017
|
-
"name": "caption",
|
|
32018
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/caption"
|
|
32019
|
-
}
|
|
32020
|
-
}
|
|
32021
|
-
]
|
|
32022
|
-
}
|
|
32023
|
-
}
|
|
32024
|
-
],
|
|
32025
|
-
"baseElement": {
|
|
32026
|
-
"kind": "external",
|
|
32027
|
-
"name": "caption",
|
|
32028
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/caption"
|
|
32029
|
-
},
|
|
32030
|
-
"styleComponent": {
|
|
32031
|
-
"kind": "symbol",
|
|
32032
|
-
"name": "Flex"
|
|
32033
|
-
}
|
|
32034
|
-
}
|
|
32035
|
-
},
|
|
32036
|
-
{
|
|
32037
|
-
"name": "TableCell",
|
|
32038
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/table/lib/TableCell.tsx",
|
|
32039
|
-
"description": "",
|
|
32040
|
-
"declarations": [
|
|
32041
|
-
{
|
|
32042
|
-
"name": "TableCell",
|
|
32043
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/table/lib/TableCell.tsx"
|
|
32044
|
-
}
|
|
32045
|
-
],
|
|
32046
|
-
"tags": {},
|
|
32047
|
-
"type": {
|
|
32048
|
-
"kind": "enhancedComponent",
|
|
32049
|
-
"componentType": "regular",
|
|
32050
|
-
"displayName": "Table.Cell",
|
|
32051
|
-
"props": [
|
|
32052
|
-
{
|
|
32053
|
-
"kind": "property",
|
|
32054
|
-
"name": "cs",
|
|
32055
|
-
"required": false,
|
|
32056
|
-
"type": {
|
|
32057
|
-
"kind": "symbol",
|
|
32058
|
-
"name": "CSToPropsInput",
|
|
32059
|
-
"value": "CSToPropsInput"
|
|
32060
|
-
},
|
|
32061
|
-
"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```",
|
|
32062
|
-
"declarations": [
|
|
32063
|
-
{
|
|
32064
|
-
"name": "cs",
|
|
32065
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
32066
|
-
}
|
|
32067
|
-
],
|
|
32068
|
-
"tags": {}
|
|
32069
|
-
},
|
|
32070
|
-
{
|
|
32071
|
-
"kind": "property",
|
|
32072
|
-
"name": "children",
|
|
32073
|
-
"required": false,
|
|
32074
|
-
"type": {
|
|
32075
|
-
"kind": "external",
|
|
32076
|
-
"name": "ReactNode",
|
|
32077
|
-
"url": "https://reactjs.org/docs/rendering-elements.html"
|
|
32078
|
-
},
|
|
32079
|
-
"description": "",
|
|
32080
|
-
"declarations": [
|
|
32081
|
-
{
|
|
32082
|
-
"name": "children",
|
|
32083
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/layout/lib/Box.tsx"
|
|
32084
|
-
}
|
|
32085
|
-
],
|
|
32086
|
-
"tags": {}
|
|
32087
|
-
},
|
|
32088
|
-
{
|
|
32089
|
-
"kind": "property",
|
|
32090
|
-
"name": "as",
|
|
32091
|
-
"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.",
|
|
32092
|
-
"tags": {},
|
|
32093
|
-
"declarations": [],
|
|
32094
|
-
"type": {
|
|
32095
|
-
"kind": "external",
|
|
32096
|
-
"name": "React.ElementType",
|
|
32097
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
|
|
32098
|
-
},
|
|
32099
|
-
"defaultValue": {
|
|
32100
|
-
"kind": "external",
|
|
32101
|
-
"name": "td",
|
|
32102
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/td"
|
|
32103
|
-
}
|
|
32104
|
-
},
|
|
32105
|
-
{
|
|
32106
|
-
"kind": "property",
|
|
32107
|
-
"name": "ref",
|
|
32108
|
-
"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`).",
|
|
32109
|
-
"tags": {},
|
|
32110
|
-
"declarations": [],
|
|
32111
|
-
"type": {
|
|
32112
|
-
"kind": "external",
|
|
32113
|
-
"name": "React.Ref",
|
|
32114
|
-
"url": "https://reactjs.org/docs/refs-and-the-dom.html",
|
|
32115
|
-
"typeParameters": [
|
|
32116
|
-
{
|
|
32117
|
-
"kind": "typeParameter",
|
|
32118
|
-
"name": "R",
|
|
32119
|
-
"required": true,
|
|
32120
|
-
"defaultValue": {
|
|
32121
|
-
"kind": "external",
|
|
32122
|
-
"name": "td",
|
|
32123
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/td"
|
|
32124
|
-
}
|
|
32125
|
-
}
|
|
32126
|
-
]
|
|
32127
|
-
}
|
|
32128
|
-
}
|
|
32129
|
-
],
|
|
32130
|
-
"baseElement": {
|
|
32131
|
-
"kind": "external",
|
|
32132
|
-
"name": "td",
|
|
32133
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/td"
|
|
32134
|
-
},
|
|
32135
|
-
"styleComponent": {
|
|
32136
|
-
"kind": "symbol",
|
|
32137
|
-
"name": "Grid"
|
|
32138
|
-
}
|
|
32139
|
-
}
|
|
32140
|
-
},
|
|
32141
|
-
{
|
|
32142
|
-
"name": "TableFooter",
|
|
32143
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/table/lib/TableFooter.tsx",
|
|
32144
|
-
"description": "",
|
|
32145
|
-
"declarations": [
|
|
32146
|
-
{
|
|
32147
|
-
"name": "TableFooter",
|
|
32148
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/table/lib/TableFooter.tsx"
|
|
32149
|
-
}
|
|
32150
|
-
],
|
|
32151
|
-
"tags": {},
|
|
32152
|
-
"type": {
|
|
32153
|
-
"kind": "enhancedComponent",
|
|
32154
|
-
"componentType": "regular",
|
|
32155
|
-
"displayName": "Table.Footer",
|
|
32156
|
-
"props": [
|
|
32157
|
-
{
|
|
32158
|
-
"kind": "property",
|
|
32159
|
-
"name": "cs",
|
|
32160
|
-
"required": false,
|
|
32161
|
-
"type": {
|
|
32162
|
-
"kind": "symbol",
|
|
32163
|
-
"name": "CSToPropsInput",
|
|
32164
|
-
"value": "CSToPropsInput"
|
|
32165
|
-
},
|
|
32166
|
-
"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```",
|
|
32167
|
-
"declarations": [
|
|
32168
|
-
{
|
|
32169
|
-
"name": "cs",
|
|
32170
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
32171
|
-
}
|
|
32172
|
-
],
|
|
32173
|
-
"tags": {}
|
|
32174
|
-
},
|
|
32175
|
-
{
|
|
32176
|
-
"kind": "property",
|
|
32177
|
-
"name": "children",
|
|
32178
|
-
"required": false,
|
|
32179
|
-
"type": {
|
|
32180
|
-
"kind": "external",
|
|
32181
|
-
"name": "ReactNode",
|
|
32182
|
-
"url": "https://reactjs.org/docs/rendering-elements.html"
|
|
32183
|
-
},
|
|
32184
|
-
"description": "",
|
|
32185
|
-
"declarations": [
|
|
32186
|
-
{
|
|
32187
|
-
"name": "children",
|
|
32188
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/layout/lib/Box.tsx"
|
|
32189
|
-
}
|
|
32190
|
-
],
|
|
32191
|
-
"tags": {}
|
|
32192
|
-
},
|
|
32193
|
-
{
|
|
32194
|
-
"kind": "property",
|
|
32195
|
-
"name": "as",
|
|
32196
|
-
"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.",
|
|
32197
|
-
"tags": {},
|
|
32198
|
-
"declarations": [],
|
|
32199
|
-
"type": {
|
|
32200
|
-
"kind": "external",
|
|
32201
|
-
"name": "React.ElementType",
|
|
32202
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
|
|
32203
|
-
},
|
|
32204
|
-
"defaultValue": {
|
|
32205
|
-
"kind": "external",
|
|
32206
|
-
"name": "tfoot",
|
|
32207
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/tfoot"
|
|
32208
|
-
}
|
|
32209
|
-
},
|
|
32210
|
-
{
|
|
32211
|
-
"kind": "property",
|
|
32212
|
-
"name": "ref",
|
|
32213
|
-
"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`).",
|
|
32214
|
-
"tags": {},
|
|
32215
|
-
"declarations": [],
|
|
32216
|
-
"type": {
|
|
32217
|
-
"kind": "external",
|
|
32218
|
-
"name": "React.Ref",
|
|
32219
|
-
"url": "https://reactjs.org/docs/refs-and-the-dom.html",
|
|
32220
|
-
"typeParameters": [
|
|
32221
|
-
{
|
|
32222
|
-
"kind": "typeParameter",
|
|
32223
|
-
"name": "R",
|
|
32224
|
-
"required": true,
|
|
32225
|
-
"defaultValue": {
|
|
32226
|
-
"kind": "external",
|
|
32227
|
-
"name": "tfoot",
|
|
32228
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/tfoot"
|
|
32229
|
-
}
|
|
32230
|
-
}
|
|
32231
|
-
]
|
|
32232
|
-
}
|
|
32233
|
-
}
|
|
32234
|
-
],
|
|
32235
|
-
"baseElement": {
|
|
32236
|
-
"kind": "external",
|
|
32237
|
-
"name": "tfoot",
|
|
32238
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/tfoot"
|
|
32239
|
-
},
|
|
32240
|
-
"styleComponent": {
|
|
32241
|
-
"kind": "symbol",
|
|
32242
|
-
"name": "Grid"
|
|
32243
|
-
}
|
|
32244
|
-
}
|
|
32245
|
-
},
|
|
32246
|
-
{
|
|
32247
|
-
"name": "TableHead",
|
|
32248
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/table/lib/TableHead.tsx",
|
|
32249
|
-
"description": "",
|
|
32250
|
-
"declarations": [
|
|
32251
|
-
{
|
|
32252
|
-
"name": "TableHead",
|
|
32253
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/table/lib/TableHead.tsx"
|
|
32254
|
-
}
|
|
32255
|
-
],
|
|
32256
|
-
"tags": {},
|
|
32257
|
-
"type": {
|
|
32258
|
-
"kind": "enhancedComponent",
|
|
32259
|
-
"componentType": "regular",
|
|
32260
|
-
"displayName": "Table.Head",
|
|
32261
|
-
"props": [
|
|
32262
|
-
{
|
|
32263
|
-
"kind": "property",
|
|
32264
|
-
"name": "cs",
|
|
32265
|
-
"required": false,
|
|
32266
|
-
"type": {
|
|
32267
|
-
"kind": "symbol",
|
|
32268
|
-
"name": "CSToPropsInput",
|
|
32269
|
-
"value": "CSToPropsInput"
|
|
32270
|
-
},
|
|
32271
|
-
"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```",
|
|
32272
|
-
"declarations": [
|
|
32273
|
-
{
|
|
32274
|
-
"name": "cs",
|
|
32275
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
32276
|
-
}
|
|
32277
|
-
],
|
|
32278
|
-
"tags": {}
|
|
32279
|
-
},
|
|
32280
|
-
{
|
|
32281
|
-
"kind": "property",
|
|
32282
|
-
"name": "children",
|
|
32283
|
-
"required": false,
|
|
32284
|
-
"type": {
|
|
32285
|
-
"kind": "external",
|
|
32286
|
-
"name": "ReactNode",
|
|
32287
|
-
"url": "https://reactjs.org/docs/rendering-elements.html"
|
|
32288
|
-
},
|
|
32289
|
-
"description": "",
|
|
32290
|
-
"declarations": [
|
|
32291
|
-
{
|
|
32292
|
-
"name": "children",
|
|
32293
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/layout/lib/Box.tsx"
|
|
32294
|
-
}
|
|
32295
|
-
],
|
|
32296
|
-
"tags": {}
|
|
32297
|
-
},
|
|
32298
|
-
{
|
|
32299
|
-
"kind": "property",
|
|
32300
|
-
"name": "as",
|
|
32301
|
-
"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.",
|
|
32302
|
-
"tags": {},
|
|
32303
|
-
"declarations": [],
|
|
32304
|
-
"type": {
|
|
32305
|
-
"kind": "external",
|
|
32306
|
-
"name": "React.ElementType",
|
|
32307
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
|
|
32308
|
-
},
|
|
32309
|
-
"defaultValue": {
|
|
32310
|
-
"kind": "external",
|
|
32311
|
-
"name": "thead",
|
|
32312
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/thead"
|
|
32313
|
-
}
|
|
32314
|
-
},
|
|
32315
|
-
{
|
|
32316
|
-
"kind": "property",
|
|
32317
|
-
"name": "ref",
|
|
32318
|
-
"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`).",
|
|
32319
|
-
"tags": {},
|
|
32320
|
-
"declarations": [],
|
|
32321
|
-
"type": {
|
|
32322
|
-
"kind": "external",
|
|
32323
|
-
"name": "React.Ref",
|
|
32324
|
-
"url": "https://reactjs.org/docs/refs-and-the-dom.html",
|
|
32325
|
-
"typeParameters": [
|
|
32326
|
-
{
|
|
32327
|
-
"kind": "typeParameter",
|
|
32328
|
-
"name": "R",
|
|
32329
|
-
"required": true,
|
|
32330
|
-
"defaultValue": {
|
|
32331
|
-
"kind": "external",
|
|
32332
|
-
"name": "thead",
|
|
32333
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/thead"
|
|
32334
|
-
}
|
|
32335
|
-
}
|
|
32336
|
-
]
|
|
32337
|
-
}
|
|
32338
|
-
}
|
|
32339
|
-
],
|
|
32340
|
-
"baseElement": {
|
|
32341
|
-
"kind": "external",
|
|
32342
|
-
"name": "thead",
|
|
32343
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/thead"
|
|
32344
|
-
},
|
|
32345
|
-
"styleComponent": {
|
|
32346
|
-
"kind": "symbol",
|
|
32347
|
-
"name": "Grid"
|
|
32348
|
-
}
|
|
32349
|
-
}
|
|
32350
|
-
},
|
|
32351
|
-
{
|
|
32352
|
-
"name": "TableHeader",
|
|
32353
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/table/lib/TableHeader.tsx",
|
|
32354
|
-
"description": "",
|
|
32355
|
-
"declarations": [
|
|
32356
|
-
{
|
|
32357
|
-
"name": "TableHeader",
|
|
32358
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/table/lib/TableHeader.tsx"
|
|
32359
|
-
}
|
|
32360
|
-
],
|
|
32361
|
-
"tags": {},
|
|
32362
|
-
"type": {
|
|
32363
|
-
"kind": "enhancedComponent",
|
|
32364
|
-
"componentType": "regular",
|
|
32365
|
-
"displayName": "Table.Header",
|
|
32366
|
-
"props": [
|
|
32367
|
-
{
|
|
32368
|
-
"kind": "property",
|
|
32369
|
-
"name": "cs",
|
|
32370
|
-
"required": false,
|
|
32371
|
-
"type": {
|
|
32372
|
-
"kind": "symbol",
|
|
32373
|
-
"name": "CSToPropsInput",
|
|
32374
|
-
"value": "CSToPropsInput"
|
|
32375
|
-
},
|
|
32376
|
-
"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```",
|
|
32377
|
-
"declarations": [
|
|
32378
|
-
{
|
|
32379
|
-
"name": "cs",
|
|
32380
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
32381
|
-
}
|
|
32382
|
-
],
|
|
32383
|
-
"tags": {}
|
|
32384
|
-
},
|
|
32385
|
-
{
|
|
32386
|
-
"kind": "property",
|
|
32387
|
-
"name": "children",
|
|
32388
|
-
"required": false,
|
|
32389
|
-
"type": {
|
|
32390
|
-
"kind": "external",
|
|
32391
|
-
"name": "ReactNode",
|
|
32392
|
-
"url": "https://reactjs.org/docs/rendering-elements.html"
|
|
32393
|
-
},
|
|
32394
|
-
"description": "",
|
|
32395
|
-
"declarations": [
|
|
32396
|
-
{
|
|
32397
|
-
"name": "children",
|
|
32398
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/layout/lib/Box.tsx"
|
|
32399
|
-
}
|
|
32400
|
-
],
|
|
32401
|
-
"tags": {}
|
|
32402
|
-
},
|
|
32403
|
-
{
|
|
32404
|
-
"kind": "property",
|
|
32405
|
-
"name": "as",
|
|
32406
|
-
"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.",
|
|
32407
|
-
"tags": {},
|
|
32408
|
-
"declarations": [],
|
|
32409
|
-
"type": {
|
|
32410
|
-
"kind": "external",
|
|
32411
|
-
"name": "React.ElementType",
|
|
32412
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
|
|
32413
|
-
},
|
|
32414
|
-
"defaultValue": {
|
|
32415
|
-
"kind": "external",
|
|
32416
|
-
"name": "th",
|
|
32417
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/th"
|
|
32418
|
-
}
|
|
32419
|
-
},
|
|
32420
|
-
{
|
|
32421
|
-
"kind": "property",
|
|
32422
|
-
"name": "ref",
|
|
32423
|
-
"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`).",
|
|
32424
|
-
"tags": {},
|
|
32425
|
-
"declarations": [],
|
|
32426
|
-
"type": {
|
|
32427
|
-
"kind": "external",
|
|
32428
|
-
"name": "React.Ref",
|
|
32429
|
-
"url": "https://reactjs.org/docs/refs-and-the-dom.html",
|
|
32430
|
-
"typeParameters": [
|
|
32431
|
-
{
|
|
32432
|
-
"kind": "typeParameter",
|
|
32433
|
-
"name": "R",
|
|
32434
|
-
"required": true,
|
|
32435
|
-
"defaultValue": {
|
|
32436
|
-
"kind": "external",
|
|
32437
|
-
"name": "th",
|
|
32438
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/th"
|
|
32439
|
-
}
|
|
32440
|
-
}
|
|
32441
|
-
]
|
|
32442
|
-
}
|
|
32443
|
-
}
|
|
32444
|
-
],
|
|
32445
|
-
"baseElement": {
|
|
32446
|
-
"kind": "external",
|
|
32447
|
-
"name": "th",
|
|
32448
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/th"
|
|
32449
|
-
},
|
|
32450
|
-
"styleComponent": {
|
|
32451
|
-
"kind": "symbol",
|
|
32452
|
-
"name": "Grid"
|
|
32453
|
-
}
|
|
32454
|
-
}
|
|
32455
|
-
},
|
|
32456
|
-
{
|
|
32457
|
-
"name": "TableRow",
|
|
32458
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/table/lib/TableRow.tsx",
|
|
32459
|
-
"description": "",
|
|
32460
|
-
"declarations": [
|
|
32461
|
-
{
|
|
32462
|
-
"name": "TableRow",
|
|
32463
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/table/lib/TableRow.tsx"
|
|
32464
|
-
}
|
|
32465
|
-
],
|
|
32466
|
-
"tags": {},
|
|
32467
|
-
"type": {
|
|
32468
|
-
"kind": "enhancedComponent",
|
|
32469
|
-
"componentType": "regular",
|
|
32470
|
-
"displayName": "Table.Row",
|
|
32471
|
-
"props": [
|
|
32472
|
-
{
|
|
32473
|
-
"kind": "property",
|
|
32474
|
-
"name": "cs",
|
|
32475
|
-
"required": false,
|
|
32476
|
-
"type": {
|
|
32477
|
-
"kind": "symbol",
|
|
32478
|
-
"name": "CSToPropsInput",
|
|
32479
|
-
"value": "CSToPropsInput"
|
|
32480
|
-
},
|
|
32481
|
-
"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```",
|
|
32482
|
-
"declarations": [
|
|
32483
|
-
{
|
|
32484
|
-
"name": "cs",
|
|
32485
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
32486
|
-
}
|
|
32487
|
-
],
|
|
32488
|
-
"tags": {}
|
|
32489
|
-
},
|
|
32490
|
-
{
|
|
32491
|
-
"kind": "property",
|
|
32492
|
-
"name": "children",
|
|
32493
|
-
"required": false,
|
|
32494
|
-
"type": {
|
|
32495
|
-
"kind": "external",
|
|
32496
|
-
"name": "ReactNode",
|
|
32497
|
-
"url": "https://reactjs.org/docs/rendering-elements.html"
|
|
32498
|
-
},
|
|
32499
|
-
"description": "",
|
|
32500
|
-
"declarations": [
|
|
32501
|
-
{
|
|
32502
|
-
"name": "children",
|
|
32503
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/layout/lib/Box.tsx"
|
|
32504
|
-
}
|
|
32505
|
-
],
|
|
32506
|
-
"tags": {}
|
|
32507
|
-
},
|
|
32508
|
-
{
|
|
32509
|
-
"kind": "property",
|
|
32510
|
-
"name": "as",
|
|
32511
|
-
"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.",
|
|
32512
|
-
"tags": {},
|
|
32513
|
-
"declarations": [],
|
|
32514
|
-
"type": {
|
|
32515
|
-
"kind": "external",
|
|
32516
|
-
"name": "React.ElementType",
|
|
32517
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
|
|
32518
|
-
},
|
|
32519
|
-
"defaultValue": {
|
|
32520
|
-
"kind": "external",
|
|
32521
|
-
"name": "tr",
|
|
32522
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/tr"
|
|
32523
|
-
}
|
|
32524
|
-
},
|
|
32525
|
-
{
|
|
32526
|
-
"kind": "property",
|
|
32527
|
-
"name": "ref",
|
|
32528
|
-
"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`).",
|
|
32529
|
-
"tags": {},
|
|
32530
|
-
"declarations": [],
|
|
32531
|
-
"type": {
|
|
32532
|
-
"kind": "external",
|
|
32533
|
-
"name": "React.Ref",
|
|
32534
|
-
"url": "https://reactjs.org/docs/refs-and-the-dom.html",
|
|
32535
|
-
"typeParameters": [
|
|
32536
|
-
{
|
|
32537
|
-
"kind": "typeParameter",
|
|
32538
|
-
"name": "R",
|
|
32539
|
-
"required": true,
|
|
32540
|
-
"defaultValue": {
|
|
32541
|
-
"kind": "external",
|
|
32542
|
-
"name": "tr",
|
|
32543
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/tr"
|
|
32544
|
-
}
|
|
32545
|
-
}
|
|
32546
|
-
]
|
|
32547
|
-
}
|
|
32548
|
-
}
|
|
32549
|
-
],
|
|
32550
|
-
"baseElement": {
|
|
32551
|
-
"kind": "external",
|
|
32552
|
-
"name": "tr",
|
|
32553
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/tr"
|
|
32554
|
-
},
|
|
32555
|
-
"styleComponent": {
|
|
32556
|
-
"kind": "symbol",
|
|
32557
|
-
"name": "Grid"
|
|
32558
|
-
}
|
|
32559
|
-
}
|
|
32560
|
-
},
|
|
32561
31607
|
{
|
|
32562
31608
|
"name": "TextAreaProps",
|
|
32563
31609
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/text-area/lib/TextArea.tsx",
|
|
@@ -202576,231 +201622,884 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
202576
201622
|
}
|
|
202577
201623
|
},
|
|
202578
201624
|
{
|
|
202579
|
-
"name": "
|
|
201625
|
+
"name": "Table",
|
|
202580
201626
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/table/lib/Table.tsx",
|
|
202581
|
-
"description": "",
|
|
201627
|
+
"description": "`Table` is a simple styled compound component that renders a [table](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/table) element. It is used to present information in a two-dimensional table comprised of rows and columns of cells containing data.\n\n\n```tsx\nimport {Table} from '@workday/canvas-kit-react/table';\n\nexport default function App() {\nreturn (\n <Table>\n <Table.Caption>Table Caption</Table.Caption>\n <Table.Head>\n <Table.Row>\n <Table.Header>Table Header</Table.Header>\n <Table.Header>Table Header</Table.Header>\n </Table.Row>\n </Table.Head>\n <Table.Body>\n <Table.Row>\n <Table.Header>Table Header</Table.Header>\n <Table.Header>Table Header</Table.Header>\n </Table.Row>\n <Table.Row>\n <Table.Header>Table Header</Table.Header>\n <Table.Cell>Table Data Cell</Table.Cell>\n </Table.Row>\n <Table.Row>\n <Table.Header>Table Header</Table.Header>\n <Table.Cell>Table Data Cell</Table.Cell>\n </Table.Row>\n </Table.Body>\n <Table.Footer>\n <Table.Row>\n <Table.Header>Table Header</Table.Header>\n <Table.Cell>Table Data Cell</Table.Cell>\n </Table.Row>\n </Table.Footer>\n </Table>\n);\n}\n```",
|
|
202582
201628
|
"declarations": [
|
|
202583
201629
|
{
|
|
202584
|
-
"name": "
|
|
201630
|
+
"name": "Table",
|
|
202585
201631
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/table/lib/Table.tsx"
|
|
202586
201632
|
}
|
|
202587
201633
|
],
|
|
202588
201634
|
"tags": {},
|
|
202589
201635
|
"type": {
|
|
202590
|
-
"kind": "
|
|
202591
|
-
"
|
|
201636
|
+
"kind": "enhancedComponent",
|
|
201637
|
+
"componentType": "regular",
|
|
201638
|
+
"displayName": "Table",
|
|
201639
|
+
"props": [
|
|
201640
|
+
{
|
|
201641
|
+
"kind": "property",
|
|
201642
|
+
"name": "cs",
|
|
201643
|
+
"required": false,
|
|
201644
|
+
"type": {
|
|
201645
|
+
"kind": "symbol",
|
|
201646
|
+
"name": "CSToPropsInput",
|
|
201647
|
+
"value": "CSToPropsInput"
|
|
201648
|
+
},
|
|
201649
|
+
"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```",
|
|
201650
|
+
"declarations": [
|
|
201651
|
+
{
|
|
201652
|
+
"name": "cs",
|
|
201653
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
201654
|
+
}
|
|
201655
|
+
],
|
|
201656
|
+
"tags": {}
|
|
201657
|
+
},
|
|
201658
|
+
{
|
|
201659
|
+
"kind": "property",
|
|
201660
|
+
"name": "children",
|
|
201661
|
+
"required": false,
|
|
201662
|
+
"type": {
|
|
201663
|
+
"kind": "external",
|
|
201664
|
+
"name": "ReactNode",
|
|
201665
|
+
"url": "https://reactjs.org/docs/rendering-elements.html"
|
|
201666
|
+
},
|
|
201667
|
+
"description": "",
|
|
201668
|
+
"declarations": [
|
|
201669
|
+
{
|
|
201670
|
+
"name": "children",
|
|
201671
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/layout/lib/Box.tsx"
|
|
201672
|
+
}
|
|
201673
|
+
],
|
|
201674
|
+
"tags": {}
|
|
201675
|
+
},
|
|
201676
|
+
{
|
|
201677
|
+
"kind": "property",
|
|
201678
|
+
"name": "as",
|
|
201679
|
+
"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.",
|
|
201680
|
+
"tags": {},
|
|
201681
|
+
"declarations": [],
|
|
201682
|
+
"type": {
|
|
201683
|
+
"kind": "external",
|
|
201684
|
+
"name": "React.ElementType",
|
|
201685
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
|
|
201686
|
+
},
|
|
201687
|
+
"defaultValue": {
|
|
201688
|
+
"kind": "external",
|
|
201689
|
+
"name": "table",
|
|
201690
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/table"
|
|
201691
|
+
}
|
|
201692
|
+
},
|
|
201693
|
+
{
|
|
201694
|
+
"kind": "property",
|
|
201695
|
+
"name": "ref",
|
|
201696
|
+
"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`).",
|
|
201697
|
+
"tags": {},
|
|
201698
|
+
"declarations": [],
|
|
201699
|
+
"type": {
|
|
201700
|
+
"kind": "external",
|
|
201701
|
+
"name": "React.Ref",
|
|
201702
|
+
"url": "https://reactjs.org/docs/refs-and-the-dom.html",
|
|
201703
|
+
"typeParameters": [
|
|
201704
|
+
{
|
|
201705
|
+
"kind": "typeParameter",
|
|
201706
|
+
"name": "R",
|
|
201707
|
+
"required": true,
|
|
201708
|
+
"defaultValue": {
|
|
201709
|
+
"kind": "external",
|
|
201710
|
+
"name": "table",
|
|
201711
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/table"
|
|
201712
|
+
}
|
|
201713
|
+
}
|
|
201714
|
+
]
|
|
201715
|
+
}
|
|
201716
|
+
}
|
|
201717
|
+
],
|
|
201718
|
+
"baseElement": {
|
|
201719
|
+
"kind": "external",
|
|
201720
|
+
"name": "table",
|
|
201721
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/table"
|
|
201722
|
+
},
|
|
201723
|
+
"subComponents": [
|
|
201724
|
+
{
|
|
201725
|
+
"name": "Caption",
|
|
201726
|
+
"symbol": "TableCaption",
|
|
201727
|
+
"description": "`Table.Caption` renders a [caption](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/caption) element.\n\n\n```tsx\nimport {Table} from '@workday/canvas-kit-react/table';\n\nexport default function App() {\n return (\n <Table>\n <Table.Caption>Table Caption</Table.Caption>\n <Table.Body>\n <Table.Row>\n <Table.Header>Table Header</Table.Header>\n <Table.Cell>Table Cell</Table.Cell>\n </Table.Row>\n </Table.Body>\n </Table>\n );\n}\n```",
|
|
201728
|
+
"declarations": [
|
|
201729
|
+
{
|
|
201730
|
+
"name": "Caption",
|
|
201731
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/table/lib/Table.tsx"
|
|
201732
|
+
},
|
|
201733
|
+
{
|
|
201734
|
+
"name": "TableCaption",
|
|
201735
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/table/lib/TableCaption.tsx"
|
|
201736
|
+
}
|
|
201737
|
+
],
|
|
201738
|
+
"tags": {}
|
|
201739
|
+
},
|
|
201740
|
+
{
|
|
201741
|
+
"name": "Head",
|
|
201742
|
+
"symbol": "TableHead",
|
|
201743
|
+
"description": "`Table.Head` renders a [thead](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/thead) element.\n\n\n```tsx\nimport {Table} from '@workday/canvas-kit-react/table';\n\nexport default function App() {\nreturn (\n <Table>\n <Table.Head>\n <Table.Row>\n <Table.Header>Table Header</Table.Header>\n <Table.Cell>Table Cell</Table.Cell>\n </Table.Row>\n </Table.Head>\n </Table>\n);\n}\n```",
|
|
201744
|
+
"declarations": [
|
|
201745
|
+
{
|
|
201746
|
+
"name": "Head",
|
|
201747
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/table/lib/Table.tsx"
|
|
201748
|
+
},
|
|
201749
|
+
{
|
|
201750
|
+
"name": "TableHead",
|
|
201751
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/table/lib/TableHead.tsx"
|
|
201752
|
+
}
|
|
201753
|
+
],
|
|
201754
|
+
"tags": {}
|
|
201755
|
+
},
|
|
201756
|
+
{
|
|
201757
|
+
"name": "Body",
|
|
201758
|
+
"symbol": "TableBody",
|
|
201759
|
+
"description": "`Table.Body` renders a [tbody](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/tbody) element.\n\n\n```tsx\nimport {Table} from '@workday/canvas-kit-react/table';\n\nexport default function App() {\nreturn (\n <Table>\n <Table.Body>\n <Table.Row>\n <Table.Header>Table Header</Table.Header>\n <Table.Cell>Table Cell</Table.Cell>\n </Table.Row>\n </Table.Body>\n </Table>\n);\n}\n```",
|
|
201760
|
+
"declarations": [
|
|
201761
|
+
{
|
|
201762
|
+
"name": "Body",
|
|
201763
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/table/lib/Table.tsx"
|
|
201764
|
+
},
|
|
201765
|
+
{
|
|
201766
|
+
"name": "TableBody",
|
|
201767
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/table/lib/TableBody.tsx"
|
|
201768
|
+
}
|
|
201769
|
+
],
|
|
201770
|
+
"tags": {}
|
|
201771
|
+
},
|
|
201772
|
+
{
|
|
201773
|
+
"name": "Row",
|
|
201774
|
+
"symbol": "TableRow",
|
|
201775
|
+
"description": "`Table.Row` renders a [tr](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/tr) element.\n\n**Note**: `Table.Row` is built on [Grid](/docs/components-layout-grid--basic). It will look for\nhow many children are there and if those children are valid React Elements. This will adjust the\namount of columns automatically using the `gridTemplateColumns` style prop and the width of the\ncolumns is also set using a `minmax` function in the `gridTemplateColumns` style prop. If a user\nwould like to adjust this, it can be overwritten on `Table.Row`. See the example below for how to\noverwrite `gridTemplateColumns`.\n\n\n```tsx\nimport {Table} from '@workday/canvas-kit-react/table';\n\nexport default function App() {\nreturn (\n <Table>\n <Table.Head>\n <Table.Row gridTemplateColumns=\"repeat(4, minmax(100px, 1fr))\">\n <Table.Header>Table Header</Table.Header>\n <Table.Cell>Table Cell</Table.Cell>\n </Table.Row>\n </Table.Head>\n </Table>\n);\n}\n```",
|
|
201776
|
+
"declarations": [
|
|
201777
|
+
{
|
|
201778
|
+
"name": "Row",
|
|
201779
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/table/lib/Table.tsx"
|
|
201780
|
+
},
|
|
201781
|
+
{
|
|
201782
|
+
"name": "TableRow",
|
|
201783
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/table/lib/TableRow.tsx"
|
|
201784
|
+
}
|
|
201785
|
+
],
|
|
201786
|
+
"tags": {}
|
|
201787
|
+
},
|
|
201788
|
+
{
|
|
201789
|
+
"name": "Header",
|
|
201790
|
+
"symbol": "TableHeader",
|
|
201791
|
+
"description": "`Table.Header` renders a [th](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/th) element.\n\n\n```tsx\nimport {Table} from '@workday/canvas-kit-react/table';\n\nexport default function App() {\nreturn (\n <Table>\n <Table.Head>\n <Table.Row>\n <Table.Header>Table Header</Table.Header>\n <Table.Cell>Table Cell</Table.Cell>\n </Table.Row>\n </Table.Head>\n </Table>\n);\n}\n```",
|
|
201792
|
+
"declarations": [
|
|
201793
|
+
{
|
|
201794
|
+
"name": "Header",
|
|
201795
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/table/lib/Table.tsx"
|
|
201796
|
+
},
|
|
201797
|
+
{
|
|
201798
|
+
"name": "TableHeader",
|
|
201799
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/table/lib/TableHeader.tsx"
|
|
201800
|
+
}
|
|
201801
|
+
],
|
|
201802
|
+
"tags": {}
|
|
201803
|
+
},
|
|
201804
|
+
{
|
|
201805
|
+
"name": "Cell",
|
|
201806
|
+
"symbol": "TableCell",
|
|
201807
|
+
"description": "`Table.Cell` renders a [td](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/td) element.\n\n\n```tsx\nimport {Table} from '@workday/canvas-kit-react/table';\n\nexport default function App() {\nreturn (\n <Table>\n <Table.Body>\n <Table.Row>\n <Table.Header>Table Header</Table.Header>\n <Table.Cell>Table Cell</Table.Cell>\n </Table.Row>\n </Table.Body>\n </Table>\n);\n}\n```",
|
|
201808
|
+
"declarations": [
|
|
201809
|
+
{
|
|
201810
|
+
"name": "Cell",
|
|
201811
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/table/lib/Table.tsx"
|
|
201812
|
+
},
|
|
201813
|
+
{
|
|
201814
|
+
"name": "TableCell",
|
|
201815
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/table/lib/TableCell.tsx"
|
|
201816
|
+
}
|
|
201817
|
+
],
|
|
201818
|
+
"tags": {}
|
|
201819
|
+
},
|
|
201820
|
+
{
|
|
201821
|
+
"name": "Footer",
|
|
201822
|
+
"symbol": "TableFooter",
|
|
201823
|
+
"description": "`Table.Footer` renders a [tfoot](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/tfoot) element.\n\n\n```tsx\nimport {Table} from '@workday/canvas-kit-react/table';\n\nexport default function App() {\nreturn (\n <Table>\n <Table.Footer>\n <Table.Row>\n <Table.Header>Table Header</Table.Header>\n <Table.Cell>Table Cell</Table.Cell>\n </Table.Row>\n </Table.Footer>\n </Table>\n);\n}\n```",
|
|
201824
|
+
"declarations": [
|
|
201825
|
+
{
|
|
201826
|
+
"name": "Footer",
|
|
201827
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/table/lib/Table.tsx"
|
|
201828
|
+
},
|
|
201829
|
+
{
|
|
201830
|
+
"name": "TableFooter",
|
|
201831
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/table/lib/TableFooter.tsx"
|
|
201832
|
+
}
|
|
201833
|
+
],
|
|
201834
|
+
"tags": {}
|
|
201835
|
+
}
|
|
201836
|
+
],
|
|
201837
|
+
"styleComponent": {
|
|
201838
|
+
"kind": "symbol",
|
|
201839
|
+
"name": "Grid"
|
|
201840
|
+
}
|
|
202592
201841
|
}
|
|
202593
201842
|
},
|
|
202594
201843
|
{
|
|
202595
|
-
"name": "
|
|
202596
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/table/lib/
|
|
201844
|
+
"name": "TableBody",
|
|
201845
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/table/lib/TableBody.tsx",
|
|
202597
201846
|
"description": "",
|
|
202598
201847
|
"declarations": [
|
|
202599
201848
|
{
|
|
202600
|
-
"name": "
|
|
202601
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/table/lib/
|
|
201849
|
+
"name": "TableBody",
|
|
201850
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/table/lib/TableBody.tsx"
|
|
202602
201851
|
}
|
|
202603
201852
|
],
|
|
202604
201853
|
"tags": {},
|
|
202605
201854
|
"type": {
|
|
202606
|
-
"kind": "
|
|
202607
|
-
"
|
|
201855
|
+
"kind": "enhancedComponent",
|
|
201856
|
+
"componentType": "regular",
|
|
201857
|
+
"displayName": "Table.Body",
|
|
201858
|
+
"props": [
|
|
201859
|
+
{
|
|
201860
|
+
"kind": "property",
|
|
201861
|
+
"name": "cs",
|
|
201862
|
+
"required": false,
|
|
201863
|
+
"type": {
|
|
201864
|
+
"kind": "symbol",
|
|
201865
|
+
"name": "CSToPropsInput",
|
|
201866
|
+
"value": "CSToPropsInput"
|
|
201867
|
+
},
|
|
201868
|
+
"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```",
|
|
201869
|
+
"declarations": [
|
|
201870
|
+
{
|
|
201871
|
+
"name": "cs",
|
|
201872
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
201873
|
+
}
|
|
201874
|
+
],
|
|
201875
|
+
"tags": {}
|
|
201876
|
+
},
|
|
201877
|
+
{
|
|
201878
|
+
"kind": "property",
|
|
201879
|
+
"name": "children",
|
|
201880
|
+
"required": false,
|
|
201881
|
+
"type": {
|
|
201882
|
+
"kind": "external",
|
|
201883
|
+
"name": "ReactNode",
|
|
201884
|
+
"url": "https://reactjs.org/docs/rendering-elements.html"
|
|
201885
|
+
},
|
|
201886
|
+
"description": "",
|
|
201887
|
+
"declarations": [
|
|
201888
|
+
{
|
|
201889
|
+
"name": "children",
|
|
201890
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/layout/lib/Box.tsx"
|
|
201891
|
+
}
|
|
201892
|
+
],
|
|
201893
|
+
"tags": {}
|
|
201894
|
+
},
|
|
201895
|
+
{
|
|
201896
|
+
"kind": "property",
|
|
201897
|
+
"name": "as",
|
|
201898
|
+
"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.",
|
|
201899
|
+
"tags": {},
|
|
201900
|
+
"declarations": [],
|
|
201901
|
+
"type": {
|
|
201902
|
+
"kind": "external",
|
|
201903
|
+
"name": "React.ElementType",
|
|
201904
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
|
|
201905
|
+
},
|
|
201906
|
+
"defaultValue": {
|
|
201907
|
+
"kind": "external",
|
|
201908
|
+
"name": "tbody",
|
|
201909
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/tbody"
|
|
201910
|
+
}
|
|
201911
|
+
},
|
|
201912
|
+
{
|
|
201913
|
+
"kind": "property",
|
|
201914
|
+
"name": "ref",
|
|
201915
|
+
"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`).",
|
|
201916
|
+
"tags": {},
|
|
201917
|
+
"declarations": [],
|
|
201918
|
+
"type": {
|
|
201919
|
+
"kind": "external",
|
|
201920
|
+
"name": "React.Ref",
|
|
201921
|
+
"url": "https://reactjs.org/docs/refs-and-the-dom.html",
|
|
201922
|
+
"typeParameters": [
|
|
201923
|
+
{
|
|
201924
|
+
"kind": "typeParameter",
|
|
201925
|
+
"name": "R",
|
|
201926
|
+
"required": true,
|
|
201927
|
+
"defaultValue": {
|
|
201928
|
+
"kind": "external",
|
|
201929
|
+
"name": "tbody",
|
|
201930
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/tbody"
|
|
201931
|
+
}
|
|
201932
|
+
}
|
|
201933
|
+
]
|
|
201934
|
+
}
|
|
201935
|
+
}
|
|
201936
|
+
],
|
|
201937
|
+
"baseElement": {
|
|
201938
|
+
"kind": "external",
|
|
201939
|
+
"name": "tbody",
|
|
201940
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/tbody"
|
|
201941
|
+
},
|
|
201942
|
+
"styleComponent": {
|
|
201943
|
+
"kind": "symbol",
|
|
201944
|
+
"name": "Grid"
|
|
201945
|
+
}
|
|
202608
201946
|
}
|
|
202609
201947
|
},
|
|
202610
201948
|
{
|
|
202611
|
-
"name": "
|
|
202612
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/table/lib/
|
|
201949
|
+
"name": "TableCaption",
|
|
201950
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/table/lib/TableCaption.tsx",
|
|
202613
201951
|
"description": "",
|
|
202614
201952
|
"declarations": [
|
|
202615
201953
|
{
|
|
202616
|
-
"name": "
|
|
202617
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/table/lib/
|
|
201954
|
+
"name": "TableCaption",
|
|
201955
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/table/lib/TableCaption.tsx"
|
|
202618
201956
|
}
|
|
202619
201957
|
],
|
|
202620
201958
|
"tags": {},
|
|
202621
201959
|
"type": {
|
|
202622
|
-
"kind": "
|
|
202623
|
-
"
|
|
202624
|
-
|
|
202625
|
-
|
|
202626
|
-
|
|
202627
|
-
|
|
202628
|
-
|
|
202629
|
-
|
|
202630
|
-
|
|
202631
|
-
|
|
202632
|
-
|
|
202633
|
-
|
|
201960
|
+
"kind": "enhancedComponent",
|
|
201961
|
+
"componentType": "regular",
|
|
201962
|
+
"displayName": "Table.Caption",
|
|
201963
|
+
"props": [
|
|
201964
|
+
{
|
|
201965
|
+
"kind": "property",
|
|
201966
|
+
"name": "cs",
|
|
201967
|
+
"required": false,
|
|
201968
|
+
"type": {
|
|
201969
|
+
"kind": "symbol",
|
|
201970
|
+
"name": "CSToPropsInput",
|
|
201971
|
+
"value": "CSToPropsInput"
|
|
201972
|
+
},
|
|
201973
|
+
"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```",
|
|
201974
|
+
"declarations": [
|
|
201975
|
+
{
|
|
201976
|
+
"name": "cs",
|
|
201977
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
201978
|
+
}
|
|
201979
|
+
],
|
|
201980
|
+
"tags": {}
|
|
201981
|
+
},
|
|
201982
|
+
{
|
|
201983
|
+
"kind": "property",
|
|
201984
|
+
"name": "children",
|
|
201985
|
+
"required": false,
|
|
201986
|
+
"type": {
|
|
201987
|
+
"kind": "external",
|
|
201988
|
+
"name": "ReactNode",
|
|
201989
|
+
"url": "https://reactjs.org/docs/rendering-elements.html"
|
|
201990
|
+
},
|
|
201991
|
+
"description": "",
|
|
201992
|
+
"declarations": [
|
|
201993
|
+
{
|
|
201994
|
+
"name": "children",
|
|
201995
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/layout/lib/Box.tsx"
|
|
201996
|
+
}
|
|
201997
|
+
],
|
|
201998
|
+
"tags": {}
|
|
201999
|
+
},
|
|
202000
|
+
{
|
|
202001
|
+
"kind": "property",
|
|
202002
|
+
"name": "as",
|
|
202003
|
+
"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.",
|
|
202004
|
+
"tags": {},
|
|
202005
|
+
"declarations": [],
|
|
202006
|
+
"type": {
|
|
202007
|
+
"kind": "external",
|
|
202008
|
+
"name": "React.ElementType",
|
|
202009
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
|
|
202010
|
+
},
|
|
202011
|
+
"defaultValue": {
|
|
202012
|
+
"kind": "external",
|
|
202013
|
+
"name": "caption",
|
|
202014
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/caption"
|
|
202015
|
+
}
|
|
202016
|
+
},
|
|
202017
|
+
{
|
|
202018
|
+
"kind": "property",
|
|
202019
|
+
"name": "ref",
|
|
202020
|
+
"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`).",
|
|
202021
|
+
"tags": {},
|
|
202022
|
+
"declarations": [],
|
|
202023
|
+
"type": {
|
|
202024
|
+
"kind": "external",
|
|
202025
|
+
"name": "React.Ref",
|
|
202026
|
+
"url": "https://reactjs.org/docs/refs-and-the-dom.html",
|
|
202027
|
+
"typeParameters": [
|
|
202028
|
+
{
|
|
202029
|
+
"kind": "typeParameter",
|
|
202030
|
+
"name": "R",
|
|
202031
|
+
"required": true,
|
|
202032
|
+
"defaultValue": {
|
|
202033
|
+
"kind": "external",
|
|
202034
|
+
"name": "caption",
|
|
202035
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/caption"
|
|
202036
|
+
}
|
|
202037
|
+
}
|
|
202038
|
+
]
|
|
202039
|
+
}
|
|
202040
|
+
}
|
|
202041
|
+
],
|
|
202042
|
+
"baseElement": {
|
|
202043
|
+
"kind": "external",
|
|
202044
|
+
"name": "caption",
|
|
202045
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/caption"
|
|
202046
|
+
},
|
|
202047
|
+
"styleComponent": {
|
|
202048
|
+
"kind": "symbol",
|
|
202049
|
+
"name": "Flex"
|
|
202634
202050
|
}
|
|
202635
|
-
],
|
|
202636
|
-
"tags": {
|
|
202637
|
-
"deprecated": "⚠️ `Table` has been deprecated and will be removed in a future major version. Please use [`Table`](https://workday.github.io/canvas-kit/?path=/docs/preview-table--basic) in Preview instead."
|
|
202638
|
-
},
|
|
202639
|
-
"type": {
|
|
202640
|
-
"kind": "component",
|
|
202641
|
-
"props": []
|
|
202642
202051
|
}
|
|
202643
202052
|
},
|
|
202644
202053
|
{
|
|
202645
|
-
"name": "
|
|
202646
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/table/lib/
|
|
202054
|
+
"name": "TableCell",
|
|
202055
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/table/lib/TableCell.tsx",
|
|
202647
202056
|
"description": "",
|
|
202648
202057
|
"declarations": [
|
|
202649
202058
|
{
|
|
202650
|
-
"name": "
|
|
202651
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/table/lib/
|
|
202059
|
+
"name": "TableCell",
|
|
202060
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/table/lib/TableCell.tsx"
|
|
202652
202061
|
}
|
|
202653
202062
|
],
|
|
202654
|
-
"tags": {
|
|
202655
|
-
"deprecated": "⚠️ `Table` has been deprecated and will be removed in a future major version. Please use [`Table`](https://workday.github.io/canvas-kit/?path=/docs/preview-table--basic) in Preview instead."
|
|
202656
|
-
},
|
|
202063
|
+
"tags": {},
|
|
202657
202064
|
"type": {
|
|
202658
|
-
"kind": "
|
|
202659
|
-
"
|
|
202660
|
-
"
|
|
202065
|
+
"kind": "enhancedComponent",
|
|
202066
|
+
"componentType": "regular",
|
|
202067
|
+
"displayName": "Table.Cell",
|
|
202068
|
+
"props": [
|
|
202661
202069
|
{
|
|
202662
202070
|
"kind": "property",
|
|
202663
|
-
"name": "
|
|
202071
|
+
"name": "cs",
|
|
202072
|
+
"required": false,
|
|
202664
202073
|
"type": {
|
|
202665
|
-
"kind": "
|
|
202666
|
-
"
|
|
202667
|
-
|
|
202074
|
+
"kind": "symbol",
|
|
202075
|
+
"name": "CSToPropsInput",
|
|
202076
|
+
"value": "CSToPropsInput"
|
|
202077
|
+
},
|
|
202078
|
+
"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```",
|
|
202079
|
+
"declarations": [
|
|
202080
|
+
{
|
|
202081
|
+
"name": "cs",
|
|
202082
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
202083
|
+
}
|
|
202084
|
+
],
|
|
202085
|
+
"tags": {}
|
|
202668
202086
|
},
|
|
202669
202087
|
{
|
|
202670
202088
|
"kind": "property",
|
|
202671
|
-
"name": "
|
|
202089
|
+
"name": "children",
|
|
202090
|
+
"required": false,
|
|
202672
202091
|
"type": {
|
|
202673
|
-
"kind": "
|
|
202674
|
-
"
|
|
202675
|
-
|
|
202092
|
+
"kind": "external",
|
|
202093
|
+
"name": "ReactNode",
|
|
202094
|
+
"url": "https://reactjs.org/docs/rendering-elements.html"
|
|
202095
|
+
},
|
|
202096
|
+
"description": "",
|
|
202097
|
+
"declarations": [
|
|
202098
|
+
{
|
|
202099
|
+
"name": "children",
|
|
202100
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/layout/lib/Box.tsx"
|
|
202101
|
+
}
|
|
202102
|
+
],
|
|
202103
|
+
"tags": {}
|
|
202676
202104
|
},
|
|
202677
202105
|
{
|
|
202678
202106
|
"kind": "property",
|
|
202679
|
-
"name": "
|
|
202107
|
+
"name": "as",
|
|
202108
|
+
"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.",
|
|
202109
|
+
"tags": {},
|
|
202110
|
+
"declarations": [],
|
|
202680
202111
|
"type": {
|
|
202681
|
-
"kind": "
|
|
202682
|
-
"
|
|
202112
|
+
"kind": "external",
|
|
202113
|
+
"name": "React.ElementType",
|
|
202114
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
|
|
202115
|
+
},
|
|
202116
|
+
"defaultValue": {
|
|
202117
|
+
"kind": "external",
|
|
202118
|
+
"name": "td",
|
|
202119
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/td"
|
|
202683
202120
|
}
|
|
202684
202121
|
},
|
|
202685
202122
|
{
|
|
202686
202123
|
"kind": "property",
|
|
202687
|
-
"name": "
|
|
202124
|
+
"name": "ref",
|
|
202125
|
+
"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`).",
|
|
202126
|
+
"tags": {},
|
|
202127
|
+
"declarations": [],
|
|
202688
202128
|
"type": {
|
|
202689
|
-
"kind": "
|
|
202690
|
-
"
|
|
202129
|
+
"kind": "external",
|
|
202130
|
+
"name": "React.Ref",
|
|
202131
|
+
"url": "https://reactjs.org/docs/refs-and-the-dom.html",
|
|
202132
|
+
"typeParameters": [
|
|
202133
|
+
{
|
|
202134
|
+
"kind": "typeParameter",
|
|
202135
|
+
"name": "R",
|
|
202136
|
+
"required": true,
|
|
202137
|
+
"defaultValue": {
|
|
202138
|
+
"kind": "external",
|
|
202139
|
+
"name": "td",
|
|
202140
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/td"
|
|
202141
|
+
}
|
|
202142
|
+
}
|
|
202143
|
+
]
|
|
202691
202144
|
}
|
|
202145
|
+
}
|
|
202146
|
+
],
|
|
202147
|
+
"baseElement": {
|
|
202148
|
+
"kind": "external",
|
|
202149
|
+
"name": "td",
|
|
202150
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/td"
|
|
202151
|
+
},
|
|
202152
|
+
"styleComponent": {
|
|
202153
|
+
"kind": "symbol",
|
|
202154
|
+
"name": "Grid"
|
|
202155
|
+
}
|
|
202156
|
+
}
|
|
202157
|
+
},
|
|
202158
|
+
{
|
|
202159
|
+
"name": "TableFooter",
|
|
202160
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/table/lib/TableFooter.tsx",
|
|
202161
|
+
"description": "",
|
|
202162
|
+
"declarations": [
|
|
202163
|
+
{
|
|
202164
|
+
"name": "TableFooter",
|
|
202165
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/table/lib/TableFooter.tsx"
|
|
202166
|
+
}
|
|
202167
|
+
],
|
|
202168
|
+
"tags": {},
|
|
202169
|
+
"type": {
|
|
202170
|
+
"kind": "enhancedComponent",
|
|
202171
|
+
"componentType": "regular",
|
|
202172
|
+
"displayName": "Table.Footer",
|
|
202173
|
+
"props": [
|
|
202174
|
+
{
|
|
202175
|
+
"kind": "property",
|
|
202176
|
+
"name": "cs",
|
|
202177
|
+
"required": false,
|
|
202178
|
+
"type": {
|
|
202179
|
+
"kind": "symbol",
|
|
202180
|
+
"name": "CSToPropsInput",
|
|
202181
|
+
"value": "CSToPropsInput"
|
|
202182
|
+
},
|
|
202183
|
+
"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```",
|
|
202184
|
+
"declarations": [
|
|
202185
|
+
{
|
|
202186
|
+
"name": "cs",
|
|
202187
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
202188
|
+
}
|
|
202189
|
+
],
|
|
202190
|
+
"tags": {}
|
|
202692
202191
|
},
|
|
202693
202192
|
{
|
|
202694
202193
|
"kind": "property",
|
|
202695
|
-
"name": "
|
|
202194
|
+
"name": "children",
|
|
202195
|
+
"required": false,
|
|
202696
202196
|
"type": {
|
|
202697
|
-
"kind": "
|
|
202698
|
-
"
|
|
202197
|
+
"kind": "external",
|
|
202198
|
+
"name": "ReactNode",
|
|
202199
|
+
"url": "https://reactjs.org/docs/rendering-elements.html"
|
|
202200
|
+
},
|
|
202201
|
+
"description": "",
|
|
202202
|
+
"declarations": [
|
|
202203
|
+
{
|
|
202204
|
+
"name": "children",
|
|
202205
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/layout/lib/Box.tsx"
|
|
202206
|
+
}
|
|
202207
|
+
],
|
|
202208
|
+
"tags": {}
|
|
202209
|
+
},
|
|
202210
|
+
{
|
|
202211
|
+
"kind": "property",
|
|
202212
|
+
"name": "as",
|
|
202213
|
+
"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.",
|
|
202214
|
+
"tags": {},
|
|
202215
|
+
"declarations": [],
|
|
202216
|
+
"type": {
|
|
202217
|
+
"kind": "external",
|
|
202218
|
+
"name": "React.ElementType",
|
|
202219
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
|
|
202220
|
+
},
|
|
202221
|
+
"defaultValue": {
|
|
202222
|
+
"kind": "external",
|
|
202223
|
+
"name": "tfoot",
|
|
202224
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/tfoot"
|
|
202699
202225
|
}
|
|
202700
202226
|
},
|
|
202701
202227
|
{
|
|
202702
202228
|
"kind": "property",
|
|
202703
|
-
"name": "
|
|
202229
|
+
"name": "ref",
|
|
202230
|
+
"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`).",
|
|
202231
|
+
"tags": {},
|
|
202232
|
+
"declarations": [],
|
|
202704
202233
|
"type": {
|
|
202705
|
-
"kind": "
|
|
202706
|
-
"
|
|
202234
|
+
"kind": "external",
|
|
202235
|
+
"name": "React.Ref",
|
|
202236
|
+
"url": "https://reactjs.org/docs/refs-and-the-dom.html",
|
|
202237
|
+
"typeParameters": [
|
|
202238
|
+
{
|
|
202239
|
+
"kind": "typeParameter",
|
|
202240
|
+
"name": "R",
|
|
202241
|
+
"required": true,
|
|
202242
|
+
"defaultValue": {
|
|
202243
|
+
"kind": "external",
|
|
202244
|
+
"name": "tfoot",
|
|
202245
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/tfoot"
|
|
202246
|
+
}
|
|
202247
|
+
}
|
|
202248
|
+
]
|
|
202707
202249
|
}
|
|
202708
202250
|
}
|
|
202709
202251
|
],
|
|
202710
|
-
"
|
|
202252
|
+
"baseElement": {
|
|
202253
|
+
"kind": "external",
|
|
202254
|
+
"name": "tfoot",
|
|
202255
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/tfoot"
|
|
202256
|
+
},
|
|
202257
|
+
"styleComponent": {
|
|
202258
|
+
"kind": "symbol",
|
|
202259
|
+
"name": "Grid"
|
|
202260
|
+
}
|
|
202711
202261
|
}
|
|
202712
202262
|
},
|
|
202713
202263
|
{
|
|
202714
|
-
"name": "
|
|
202715
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/table/lib/
|
|
202264
|
+
"name": "TableHead",
|
|
202265
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/table/lib/TableHead.tsx",
|
|
202716
202266
|
"description": "",
|
|
202717
202267
|
"declarations": [
|
|
202718
202268
|
{
|
|
202719
|
-
"name": "
|
|
202720
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/table/lib/
|
|
202269
|
+
"name": "TableHead",
|
|
202270
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/table/lib/TableHead.tsx"
|
|
202721
202271
|
}
|
|
202722
202272
|
],
|
|
202723
|
-
"tags": {
|
|
202724
|
-
"deprecated": "⚠️ `Table` has been deprecated and will be removed in a future major version. Please use [`Table`](https://workday.github.io/canvas-kit/?path=/docs/preview-table--basic) in Preview instead."
|
|
202725
|
-
},
|
|
202273
|
+
"tags": {},
|
|
202726
202274
|
"type": {
|
|
202727
|
-
"kind": "
|
|
202728
|
-
"
|
|
202275
|
+
"kind": "enhancedComponent",
|
|
202276
|
+
"componentType": "regular",
|
|
202277
|
+
"displayName": "Table.Head",
|
|
202278
|
+
"props": [
|
|
202279
|
+
{
|
|
202280
|
+
"kind": "property",
|
|
202281
|
+
"name": "cs",
|
|
202282
|
+
"required": false,
|
|
202283
|
+
"type": {
|
|
202284
|
+
"kind": "symbol",
|
|
202285
|
+
"name": "CSToPropsInput",
|
|
202286
|
+
"value": "CSToPropsInput"
|
|
202287
|
+
},
|
|
202288
|
+
"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```",
|
|
202289
|
+
"declarations": [
|
|
202290
|
+
{
|
|
202291
|
+
"name": "cs",
|
|
202292
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
202293
|
+
}
|
|
202294
|
+
],
|
|
202295
|
+
"tags": {}
|
|
202296
|
+
},
|
|
202297
|
+
{
|
|
202298
|
+
"kind": "property",
|
|
202299
|
+
"name": "children",
|
|
202300
|
+
"required": false,
|
|
202301
|
+
"type": {
|
|
202302
|
+
"kind": "external",
|
|
202303
|
+
"name": "ReactNode",
|
|
202304
|
+
"url": "https://reactjs.org/docs/rendering-elements.html"
|
|
202305
|
+
},
|
|
202306
|
+
"description": "",
|
|
202307
|
+
"declarations": [
|
|
202308
|
+
{
|
|
202309
|
+
"name": "children",
|
|
202310
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/layout/lib/Box.tsx"
|
|
202311
|
+
}
|
|
202312
|
+
],
|
|
202313
|
+
"tags": {}
|
|
202314
|
+
},
|
|
202315
|
+
{
|
|
202316
|
+
"kind": "property",
|
|
202317
|
+
"name": "as",
|
|
202318
|
+
"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.",
|
|
202319
|
+
"tags": {},
|
|
202320
|
+
"declarations": [],
|
|
202321
|
+
"type": {
|
|
202322
|
+
"kind": "external",
|
|
202323
|
+
"name": "React.ElementType",
|
|
202324
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
|
|
202325
|
+
},
|
|
202326
|
+
"defaultValue": {
|
|
202327
|
+
"kind": "external",
|
|
202328
|
+
"name": "thead",
|
|
202329
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/thead"
|
|
202330
|
+
}
|
|
202331
|
+
},
|
|
202332
|
+
{
|
|
202333
|
+
"kind": "property",
|
|
202334
|
+
"name": "ref",
|
|
202335
|
+
"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`).",
|
|
202336
|
+
"tags": {},
|
|
202337
|
+
"declarations": [],
|
|
202338
|
+
"type": {
|
|
202339
|
+
"kind": "external",
|
|
202340
|
+
"name": "React.Ref",
|
|
202341
|
+
"url": "https://reactjs.org/docs/refs-and-the-dom.html",
|
|
202342
|
+
"typeParameters": [
|
|
202343
|
+
{
|
|
202344
|
+
"kind": "typeParameter",
|
|
202345
|
+
"name": "R",
|
|
202346
|
+
"required": true,
|
|
202347
|
+
"defaultValue": {
|
|
202348
|
+
"kind": "external",
|
|
202349
|
+
"name": "thead",
|
|
202350
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/thead"
|
|
202351
|
+
}
|
|
202352
|
+
}
|
|
202353
|
+
]
|
|
202354
|
+
}
|
|
202355
|
+
}
|
|
202356
|
+
],
|
|
202357
|
+
"baseElement": {
|
|
202358
|
+
"kind": "external",
|
|
202359
|
+
"name": "thead",
|
|
202360
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/thead"
|
|
202361
|
+
},
|
|
202362
|
+
"styleComponent": {
|
|
202363
|
+
"kind": "symbol",
|
|
202364
|
+
"name": "Grid"
|
|
202365
|
+
}
|
|
202729
202366
|
}
|
|
202730
202367
|
},
|
|
202731
202368
|
{
|
|
202732
|
-
"name": "
|
|
202733
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/table/lib/
|
|
202369
|
+
"name": "TableHeader",
|
|
202370
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/table/lib/TableHeader.tsx",
|
|
202734
202371
|
"description": "",
|
|
202735
202372
|
"declarations": [
|
|
202736
202373
|
{
|
|
202737
|
-
"name": "
|
|
202738
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/table/lib/
|
|
202374
|
+
"name": "TableHeader",
|
|
202375
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/table/lib/TableHeader.tsx"
|
|
202739
202376
|
}
|
|
202740
202377
|
],
|
|
202741
|
-
"tags": {
|
|
202742
|
-
"deprecated": "⚠️ `Table` has been deprecated and will be removed in a future major version. Please use [`Table`](https://workday.github.io/canvas-kit/?path=/docs/preview-table--basic) in Preview instead."
|
|
202743
|
-
},
|
|
202378
|
+
"tags": {},
|
|
202744
202379
|
"type": {
|
|
202745
202380
|
"kind": "enhancedComponent",
|
|
202746
202381
|
"componentType": "regular",
|
|
202747
|
-
"displayName": "
|
|
202382
|
+
"displayName": "Table.Header",
|
|
202748
202383
|
"props": [
|
|
202749
202384
|
{
|
|
202750
202385
|
"kind": "property",
|
|
202751
|
-
"name": "
|
|
202386
|
+
"name": "cs",
|
|
202752
202387
|
"required": false,
|
|
202753
202388
|
"type": {
|
|
202754
202389
|
"kind": "symbol",
|
|
202755
|
-
"name": "
|
|
202756
|
-
"value": "
|
|
202390
|
+
"name": "CSToPropsInput",
|
|
202391
|
+
"value": "CSToPropsInput"
|
|
202757
202392
|
},
|
|
202758
|
-
"description": "The
|
|
202393
|
+
"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```",
|
|
202759
202394
|
"declarations": [
|
|
202760
202395
|
{
|
|
202761
|
-
"name": "
|
|
202762
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/
|
|
202396
|
+
"name": "cs",
|
|
202397
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
202763
202398
|
}
|
|
202764
202399
|
],
|
|
202765
202400
|
"tags": {}
|
|
202766
202401
|
},
|
|
202767
202402
|
{
|
|
202768
202403
|
"kind": "property",
|
|
202769
|
-
"name": "
|
|
202404
|
+
"name": "children",
|
|
202770
202405
|
"required": false,
|
|
202771
202406
|
"type": {
|
|
202772
|
-
"kind": "
|
|
202773
|
-
"
|
|
202407
|
+
"kind": "external",
|
|
202408
|
+
"name": "ReactNode",
|
|
202409
|
+
"url": "https://reactjs.org/docs/rendering-elements.html"
|
|
202774
202410
|
},
|
|
202775
|
-
"description": "
|
|
202411
|
+
"description": "",
|
|
202776
202412
|
"declarations": [
|
|
202777
202413
|
{
|
|
202778
|
-
"name": "
|
|
202779
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/
|
|
202414
|
+
"name": "children",
|
|
202415
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/layout/lib/Box.tsx"
|
|
202780
202416
|
}
|
|
202781
202417
|
],
|
|
202782
|
-
"tags": {
|
|
202783
|
-
|
|
202418
|
+
"tags": {}
|
|
202419
|
+
},
|
|
202420
|
+
{
|
|
202421
|
+
"kind": "property",
|
|
202422
|
+
"name": "as",
|
|
202423
|
+
"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.",
|
|
202424
|
+
"tags": {},
|
|
202425
|
+
"declarations": [],
|
|
202426
|
+
"type": {
|
|
202427
|
+
"kind": "external",
|
|
202428
|
+
"name": "React.ElementType",
|
|
202429
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
|
|
202784
202430
|
},
|
|
202785
202431
|
"defaultValue": {
|
|
202786
|
-
"kind": "
|
|
202787
|
-
"
|
|
202432
|
+
"kind": "external",
|
|
202433
|
+
"name": "th",
|
|
202434
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/th"
|
|
202788
202435
|
}
|
|
202789
202436
|
},
|
|
202790
202437
|
{
|
|
202791
202438
|
"kind": "property",
|
|
202792
|
-
"name": "
|
|
202439
|
+
"name": "ref",
|
|
202440
|
+
"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`).",
|
|
202441
|
+
"tags": {},
|
|
202442
|
+
"declarations": [],
|
|
202443
|
+
"type": {
|
|
202444
|
+
"kind": "external",
|
|
202445
|
+
"name": "React.Ref",
|
|
202446
|
+
"url": "https://reactjs.org/docs/refs-and-the-dom.html",
|
|
202447
|
+
"typeParameters": [
|
|
202448
|
+
{
|
|
202449
|
+
"kind": "typeParameter",
|
|
202450
|
+
"name": "R",
|
|
202451
|
+
"required": true,
|
|
202452
|
+
"defaultValue": {
|
|
202453
|
+
"kind": "external",
|
|
202454
|
+
"name": "th",
|
|
202455
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/th"
|
|
202456
|
+
}
|
|
202457
|
+
}
|
|
202458
|
+
]
|
|
202459
|
+
}
|
|
202460
|
+
}
|
|
202461
|
+
],
|
|
202462
|
+
"baseElement": {
|
|
202463
|
+
"kind": "external",
|
|
202464
|
+
"name": "th",
|
|
202465
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/th"
|
|
202466
|
+
},
|
|
202467
|
+
"styleComponent": {
|
|
202468
|
+
"kind": "symbol",
|
|
202469
|
+
"name": "Grid"
|
|
202470
|
+
}
|
|
202471
|
+
}
|
|
202472
|
+
},
|
|
202473
|
+
{
|
|
202474
|
+
"name": "TableRow",
|
|
202475
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/table/lib/TableRow.tsx",
|
|
202476
|
+
"description": "",
|
|
202477
|
+
"declarations": [
|
|
202478
|
+
{
|
|
202479
|
+
"name": "TableRow",
|
|
202480
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/table/lib/TableRow.tsx"
|
|
202481
|
+
}
|
|
202482
|
+
],
|
|
202483
|
+
"tags": {},
|
|
202484
|
+
"type": {
|
|
202485
|
+
"kind": "enhancedComponent",
|
|
202486
|
+
"componentType": "regular",
|
|
202487
|
+
"displayName": "Table.Row",
|
|
202488
|
+
"props": [
|
|
202489
|
+
{
|
|
202490
|
+
"kind": "property",
|
|
202491
|
+
"name": "cs",
|
|
202793
202492
|
"required": false,
|
|
202794
202493
|
"type": {
|
|
202795
202494
|
"kind": "symbol",
|
|
202796
|
-
"name": "
|
|
202797
|
-
"value": "
|
|
202495
|
+
"name": "CSToPropsInput",
|
|
202496
|
+
"value": "CSToPropsInput"
|
|
202798
202497
|
},
|
|
202799
|
-
"description": "",
|
|
202498
|
+
"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```",
|
|
202800
202499
|
"declarations": [
|
|
202801
202500
|
{
|
|
202802
|
-
"name": "
|
|
202803
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/
|
|
202501
|
+
"name": "cs",
|
|
202502
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
202804
202503
|
}
|
|
202805
202504
|
],
|
|
202806
202505
|
"tags": {}
|
|
@@ -202808,14 +202507,20 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
202808
202507
|
{
|
|
202809
202508
|
"kind": "property",
|
|
202810
202509
|
"name": "children",
|
|
202811
|
-
"
|
|
202812
|
-
"tags": {},
|
|
202813
|
-
"declarations": [],
|
|
202510
|
+
"required": false,
|
|
202814
202511
|
"type": {
|
|
202815
202512
|
"kind": "external",
|
|
202816
|
-
"name": "
|
|
202513
|
+
"name": "ReactNode",
|
|
202817
202514
|
"url": "https://reactjs.org/docs/rendering-elements.html"
|
|
202818
|
-
}
|
|
202515
|
+
},
|
|
202516
|
+
"description": "",
|
|
202517
|
+
"declarations": [
|
|
202518
|
+
{
|
|
202519
|
+
"name": "children",
|
|
202520
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/layout/lib/Box.tsx"
|
|
202521
|
+
}
|
|
202522
|
+
],
|
|
202523
|
+
"tags": {}
|
|
202819
202524
|
},
|
|
202820
202525
|
{
|
|
202821
202526
|
"kind": "property",
|
|
@@ -202864,20 +202569,10 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
202864
202569
|
"name": "tr",
|
|
202865
202570
|
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/tr"
|
|
202866
202571
|
},
|
|
202867
|
-
"
|
|
202868
|
-
|
|
202869
|
-
|
|
202870
|
-
|
|
202871
|
-
"description": "",
|
|
202872
|
-
"declarations": [
|
|
202873
|
-
{
|
|
202874
|
-
"name": "State",
|
|
202875
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/table/lib/TableRow.tsx"
|
|
202876
|
-
}
|
|
202877
|
-
],
|
|
202878
|
-
"tags": {}
|
|
202879
|
-
}
|
|
202880
|
-
]
|
|
202572
|
+
"styleComponent": {
|
|
202573
|
+
"kind": "symbol",
|
|
202574
|
+
"name": "Grid"
|
|
202575
|
+
}
|
|
202881
202576
|
}
|
|
202882
202577
|
},
|
|
202883
202578
|
{
|