@workday/canvas-kit-docs 12.2.1 → 12.3.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/index.d.ts +0 -1
- package/dist/es6/index.d.ts.map +1 -1
- package/dist/es6/index.js +0 -1
- package/dist/es6/lib/docs.js +2540 -843
- package/dist/mdx/preview-react/InformationHighlight/InformationHighlight.mdx +109 -0
- package/dist/mdx/preview-react/InformationHighlight/examples/Basic.tsx +18 -0
- package/dist/mdx/preview-react/InformationHighlight/examples/Body.tsx +13 -0
- package/dist/mdx/preview-react/InformationHighlight/examples/Caution.tsx +27 -0
- package/dist/mdx/preview-react/InformationHighlight/examples/Critical.tsx +33 -0
- package/dist/mdx/preview-react/InformationHighlight/examples/CustomIconCritical.tsx +28 -0
- package/dist/mdx/preview-react/InformationHighlight/examples/Heading.tsx +11 -0
- package/dist/mdx/preview-react/InformationHighlight/examples/Informational.tsx +27 -0
- package/dist/mdx/preview-react/InformationHighlight/examples/RTL.tsx +42 -0
- package/dist/mdx/react/button/button/Button.mdx +7 -0
- package/dist/mdx/react/button/button/examples/ThemeOverrides.tsx +73 -0
- package/dist/mdx/react/tokens/Tokens.mdx +2 -1
- package/index.ts +0 -1
- package/package.json +7 -7
- package/dist/es6/lib/InformationHighlight/Base.d.ts +0 -5
- package/dist/es6/lib/InformationHighlight/Base.d.ts.map +0 -1
- package/dist/es6/lib/InformationHighlight/Base.js +0 -9
- package/dist/es6/lib/InformationHighlight/Body.d.ts +0 -2
- package/dist/es6/lib/InformationHighlight/Body.d.ts.map +0 -1
- package/dist/es6/lib/InformationHighlight/Body.js +0 -18
- package/dist/es6/lib/InformationHighlight/Heading.d.ts +0 -2
- package/dist/es6/lib/InformationHighlight/Heading.d.ts.map +0 -1
- package/dist/es6/lib/InformationHighlight/Heading.js +0 -17
- package/dist/es6/lib/InformationHighlight/Icon.d.ts +0 -13
- package/dist/es6/lib/InformationHighlight/Icon.d.ts.map +0 -1
- package/dist/es6/lib/InformationHighlight/Icon.js +0 -44
- package/dist/es6/lib/InformationHighlight/Link.d.ts +0 -2
- package/dist/es6/lib/InformationHighlight/Link.d.ts.map +0 -1
- package/dist/es6/lib/InformationHighlight/Link.js +0 -18
- package/dist/es6/lib/InformationHighlight/index.d.ts +0 -25
- package/dist/es6/lib/InformationHighlight/index.d.ts.map +0 -1
- package/dist/es6/lib/InformationHighlight/index.js +0 -44
- package/dist/es6/lib/InformationHighlight/modelHook.d.ts +0 -19
- package/dist/es6/lib/InformationHighlight/modelHook.d.ts.map +0 -1
- package/dist/es6/lib/InformationHighlight/modelHook.js +0 -13
- package/lib/InformationHighlight/Base.tsx +0 -12
- package/lib/InformationHighlight/Body.tsx +0 -21
- package/lib/InformationHighlight/Heading.tsx +0 -20
- package/lib/InformationHighlight/Icon.tsx +0 -65
- package/lib/InformationHighlight/Link.tsx +0 -20
- package/lib/InformationHighlight/index.tsx +0 -62
- package/lib/InformationHighlight/modelHook.ts +0 -16
package/dist/es6/lib/docs.js
CHANGED
|
@@ -6648,6 +6648,1631 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
6648
6648
|
}
|
|
6649
6649
|
}
|
|
6650
6650
|
},
|
|
6651
|
+
{
|
|
6652
|
+
"name": "useInformationHighlightModel",
|
|
6653
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/InformationHighlight/lib/hooks/useInformationHighlightModel.ts",
|
|
6654
|
+
"description": "",
|
|
6655
|
+
"declarations": [
|
|
6656
|
+
{
|
|
6657
|
+
"name": "useInformationHighlightModel",
|
|
6658
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/InformationHighlight/lib/hooks/useInformationHighlightModel.ts"
|
|
6659
|
+
}
|
|
6660
|
+
],
|
|
6661
|
+
"tags": {},
|
|
6662
|
+
"type": {
|
|
6663
|
+
"kind": "modelHook",
|
|
6664
|
+
"name": "useInformationHighlightModel",
|
|
6665
|
+
"defaultConfig": [
|
|
6666
|
+
{
|
|
6667
|
+
"kind": "property",
|
|
6668
|
+
"name": "variant",
|
|
6669
|
+
"defaultValue": {
|
|
6670
|
+
"kind": "string",
|
|
6671
|
+
"value": "informational"
|
|
6672
|
+
},
|
|
6673
|
+
"type": {
|
|
6674
|
+
"kind": "union",
|
|
6675
|
+
"value": [
|
|
6676
|
+
{
|
|
6677
|
+
"kind": "string",
|
|
6678
|
+
"value": "informational"
|
|
6679
|
+
},
|
|
6680
|
+
{
|
|
6681
|
+
"kind": "string",
|
|
6682
|
+
"value": "caution"
|
|
6683
|
+
},
|
|
6684
|
+
{
|
|
6685
|
+
"kind": "string",
|
|
6686
|
+
"value": "critical"
|
|
6687
|
+
}
|
|
6688
|
+
]
|
|
6689
|
+
},
|
|
6690
|
+
"required": false,
|
|
6691
|
+
"description": "",
|
|
6692
|
+
"declarations": [
|
|
6693
|
+
{
|
|
6694
|
+
"name": "variant",
|
|
6695
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/InformationHighlight/lib/hooks/useInformationHighlightModel.ts"
|
|
6696
|
+
}
|
|
6697
|
+
],
|
|
6698
|
+
"tags": {}
|
|
6699
|
+
},
|
|
6700
|
+
{
|
|
6701
|
+
"kind": "property",
|
|
6702
|
+
"name": "emphasis",
|
|
6703
|
+
"defaultValue": {
|
|
6704
|
+
"kind": "string",
|
|
6705
|
+
"value": "low"
|
|
6706
|
+
},
|
|
6707
|
+
"type": {
|
|
6708
|
+
"kind": "union",
|
|
6709
|
+
"value": [
|
|
6710
|
+
{
|
|
6711
|
+
"kind": "string",
|
|
6712
|
+
"value": "low"
|
|
6713
|
+
},
|
|
6714
|
+
{
|
|
6715
|
+
"kind": "string",
|
|
6716
|
+
"value": "high"
|
|
6717
|
+
}
|
|
6718
|
+
]
|
|
6719
|
+
},
|
|
6720
|
+
"required": false,
|
|
6721
|
+
"description": "",
|
|
6722
|
+
"declarations": [
|
|
6723
|
+
{
|
|
6724
|
+
"name": "emphasis",
|
|
6725
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/InformationHighlight/lib/hooks/useInformationHighlightModel.ts"
|
|
6726
|
+
}
|
|
6727
|
+
],
|
|
6728
|
+
"tags": {}
|
|
6729
|
+
}
|
|
6730
|
+
],
|
|
6731
|
+
"requiredConfig": []
|
|
6732
|
+
}
|
|
6733
|
+
},
|
|
6734
|
+
{
|
|
6735
|
+
"name": "InformationHighlightModel",
|
|
6736
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/InformationHighlight/lib/hooks/useInformationHighlightModel.ts",
|
|
6737
|
+
"description": "",
|
|
6738
|
+
"declarations": [
|
|
6739
|
+
{
|
|
6740
|
+
"name": "useInformationHighlightModel",
|
|
6741
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/InformationHighlight/lib/hooks/useInformationHighlightModel.ts"
|
|
6742
|
+
}
|
|
6743
|
+
],
|
|
6744
|
+
"tags": {},
|
|
6745
|
+
"type": {
|
|
6746
|
+
"kind": "model",
|
|
6747
|
+
"state": [
|
|
6748
|
+
{
|
|
6749
|
+
"kind": "property",
|
|
6750
|
+
"name": "variant",
|
|
6751
|
+
"type": {
|
|
6752
|
+
"kind": "union",
|
|
6753
|
+
"value": [
|
|
6754
|
+
{
|
|
6755
|
+
"kind": "string",
|
|
6756
|
+
"value": "informational"
|
|
6757
|
+
},
|
|
6758
|
+
{
|
|
6759
|
+
"kind": "string",
|
|
6760
|
+
"value": "caution"
|
|
6761
|
+
},
|
|
6762
|
+
{
|
|
6763
|
+
"kind": "string",
|
|
6764
|
+
"value": "critical"
|
|
6765
|
+
}
|
|
6766
|
+
]
|
|
6767
|
+
},
|
|
6768
|
+
"required": true,
|
|
6769
|
+
"description": "",
|
|
6770
|
+
"declarations": [
|
|
6771
|
+
{
|
|
6772
|
+
"name": "variant",
|
|
6773
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/InformationHighlight/lib/hooks/useInformationHighlightModel.ts"
|
|
6774
|
+
}
|
|
6775
|
+
],
|
|
6776
|
+
"tags": {}
|
|
6777
|
+
},
|
|
6778
|
+
{
|
|
6779
|
+
"kind": "property",
|
|
6780
|
+
"name": "emphasis",
|
|
6781
|
+
"type": {
|
|
6782
|
+
"kind": "union",
|
|
6783
|
+
"value": [
|
|
6784
|
+
{
|
|
6785
|
+
"kind": "string",
|
|
6786
|
+
"value": "low"
|
|
6787
|
+
},
|
|
6788
|
+
{
|
|
6789
|
+
"kind": "string",
|
|
6790
|
+
"value": "high"
|
|
6791
|
+
}
|
|
6792
|
+
]
|
|
6793
|
+
},
|
|
6794
|
+
"required": true,
|
|
6795
|
+
"description": "",
|
|
6796
|
+
"declarations": [
|
|
6797
|
+
{
|
|
6798
|
+
"name": "emphasis",
|
|
6799
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/InformationHighlight/lib/hooks/useInformationHighlightModel.ts"
|
|
6800
|
+
}
|
|
6801
|
+
],
|
|
6802
|
+
"tags": {}
|
|
6803
|
+
}
|
|
6804
|
+
],
|
|
6805
|
+
"events": [],
|
|
6806
|
+
"modelProperties": []
|
|
6807
|
+
}
|
|
6808
|
+
},
|
|
6809
|
+
{
|
|
6810
|
+
"name": "InformationHighlightModelConfig",
|
|
6811
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/InformationHighlight/lib/hooks/useInformationHighlightModel.ts",
|
|
6812
|
+
"description": "",
|
|
6813
|
+
"declarations": [
|
|
6814
|
+
{
|
|
6815
|
+
"name": "useInformationHighlightModel",
|
|
6816
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/InformationHighlight/lib/hooks/useInformationHighlightModel.ts"
|
|
6817
|
+
}
|
|
6818
|
+
],
|
|
6819
|
+
"tags": {},
|
|
6820
|
+
"type": {
|
|
6821
|
+
"kind": "object",
|
|
6822
|
+
"properties": [
|
|
6823
|
+
{
|
|
6824
|
+
"kind": "property",
|
|
6825
|
+
"name": "variant",
|
|
6826
|
+
"defaultValue": {
|
|
6827
|
+
"kind": "string",
|
|
6828
|
+
"value": "informational"
|
|
6829
|
+
},
|
|
6830
|
+
"type": {
|
|
6831
|
+
"kind": "union",
|
|
6832
|
+
"value": [
|
|
6833
|
+
{
|
|
6834
|
+
"kind": "string",
|
|
6835
|
+
"value": "informational"
|
|
6836
|
+
},
|
|
6837
|
+
{
|
|
6838
|
+
"kind": "string",
|
|
6839
|
+
"value": "caution"
|
|
6840
|
+
},
|
|
6841
|
+
{
|
|
6842
|
+
"kind": "string",
|
|
6843
|
+
"value": "critical"
|
|
6844
|
+
}
|
|
6845
|
+
]
|
|
6846
|
+
},
|
|
6847
|
+
"required": false,
|
|
6848
|
+
"description": "",
|
|
6849
|
+
"declarations": [
|
|
6850
|
+
{
|
|
6851
|
+
"name": "variant",
|
|
6852
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/InformationHighlight/lib/hooks/useInformationHighlightModel.ts"
|
|
6853
|
+
}
|
|
6854
|
+
],
|
|
6855
|
+
"tags": {}
|
|
6856
|
+
},
|
|
6857
|
+
{
|
|
6858
|
+
"kind": "property",
|
|
6859
|
+
"name": "emphasis",
|
|
6860
|
+
"defaultValue": {
|
|
6861
|
+
"kind": "string",
|
|
6862
|
+
"value": "low"
|
|
6863
|
+
},
|
|
6864
|
+
"type": {
|
|
6865
|
+
"kind": "union",
|
|
6866
|
+
"value": [
|
|
6867
|
+
{
|
|
6868
|
+
"kind": "string",
|
|
6869
|
+
"value": "low"
|
|
6870
|
+
},
|
|
6871
|
+
{
|
|
6872
|
+
"kind": "string",
|
|
6873
|
+
"value": "high"
|
|
6874
|
+
}
|
|
6875
|
+
]
|
|
6876
|
+
},
|
|
6877
|
+
"required": false,
|
|
6878
|
+
"description": "",
|
|
6879
|
+
"declarations": [
|
|
6880
|
+
{
|
|
6881
|
+
"name": "emphasis",
|
|
6882
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/InformationHighlight/lib/hooks/useInformationHighlightModel.ts"
|
|
6883
|
+
}
|
|
6884
|
+
],
|
|
6885
|
+
"tags": {}
|
|
6886
|
+
},
|
|
6887
|
+
null
|
|
6888
|
+
]
|
|
6889
|
+
}
|
|
6890
|
+
},
|
|
6891
|
+
{
|
|
6892
|
+
"name": "InformationHighlightModelState",
|
|
6893
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/InformationHighlight/lib/hooks/useInformationHighlightModel.ts",
|
|
6894
|
+
"description": "",
|
|
6895
|
+
"tags": {},
|
|
6896
|
+
"declarations": [],
|
|
6897
|
+
"type": {
|
|
6898
|
+
"kind": "object",
|
|
6899
|
+
"properties": [
|
|
6900
|
+
{
|
|
6901
|
+
"kind": "property",
|
|
6902
|
+
"name": "variant",
|
|
6903
|
+
"type": {
|
|
6904
|
+
"kind": "union",
|
|
6905
|
+
"value": [
|
|
6906
|
+
{
|
|
6907
|
+
"kind": "string",
|
|
6908
|
+
"value": "informational"
|
|
6909
|
+
},
|
|
6910
|
+
{
|
|
6911
|
+
"kind": "string",
|
|
6912
|
+
"value": "caution"
|
|
6913
|
+
},
|
|
6914
|
+
{
|
|
6915
|
+
"kind": "string",
|
|
6916
|
+
"value": "critical"
|
|
6917
|
+
}
|
|
6918
|
+
]
|
|
6919
|
+
},
|
|
6920
|
+
"required": true,
|
|
6921
|
+
"description": "",
|
|
6922
|
+
"declarations": [
|
|
6923
|
+
{
|
|
6924
|
+
"name": "variant",
|
|
6925
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/InformationHighlight/lib/hooks/useInformationHighlightModel.ts"
|
|
6926
|
+
}
|
|
6927
|
+
],
|
|
6928
|
+
"tags": {}
|
|
6929
|
+
},
|
|
6930
|
+
{
|
|
6931
|
+
"kind": "property",
|
|
6932
|
+
"name": "emphasis",
|
|
6933
|
+
"type": {
|
|
6934
|
+
"kind": "union",
|
|
6935
|
+
"value": [
|
|
6936
|
+
{
|
|
6937
|
+
"kind": "string",
|
|
6938
|
+
"value": "low"
|
|
6939
|
+
},
|
|
6940
|
+
{
|
|
6941
|
+
"kind": "string",
|
|
6942
|
+
"value": "high"
|
|
6943
|
+
}
|
|
6944
|
+
]
|
|
6945
|
+
},
|
|
6946
|
+
"required": true,
|
|
6947
|
+
"description": "",
|
|
6948
|
+
"declarations": [
|
|
6949
|
+
{
|
|
6950
|
+
"name": "emphasis",
|
|
6951
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/InformationHighlight/lib/hooks/useInformationHighlightModel.ts"
|
|
6952
|
+
}
|
|
6953
|
+
],
|
|
6954
|
+
"tags": {}
|
|
6955
|
+
}
|
|
6956
|
+
]
|
|
6957
|
+
}
|
|
6958
|
+
},
|
|
6959
|
+
{
|
|
6960
|
+
"name": "InformationHighlightModelEvents",
|
|
6961
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/InformationHighlight/lib/hooks/useInformationHighlightModel.ts",
|
|
6962
|
+
"description": "",
|
|
6963
|
+
"tags": {},
|
|
6964
|
+
"declarations": [],
|
|
6965
|
+
"type": {
|
|
6966
|
+
"kind": "object",
|
|
6967
|
+
"properties": []
|
|
6968
|
+
}
|
|
6969
|
+
},
|
|
6970
|
+
{
|
|
6971
|
+
"name": "informationHighlightStencil",
|
|
6972
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/InformationHighlight/lib/InformationHighlight.tsx",
|
|
6973
|
+
"description": "",
|
|
6974
|
+
"declarations": [
|
|
6975
|
+
{
|
|
6976
|
+
"name": "informationHighlightStencil",
|
|
6977
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/InformationHighlight/lib/InformationHighlight.tsx"
|
|
6978
|
+
}
|
|
6979
|
+
],
|
|
6980
|
+
"tags": {},
|
|
6981
|
+
"type": {
|
|
6982
|
+
"kind": "function",
|
|
6983
|
+
"parameters": [
|
|
6984
|
+
{
|
|
6985
|
+
"kind": "parameter",
|
|
6986
|
+
"name": "options",
|
|
6987
|
+
"type": {
|
|
6988
|
+
"kind": "conditional",
|
|
6989
|
+
"check": {
|
|
6990
|
+
"kind": "tuple",
|
|
6991
|
+
"value": [
|
|
6992
|
+
{
|
|
6993
|
+
"kind": "symbol",
|
|
6994
|
+
"name": "E",
|
|
6995
|
+
"value": "E"
|
|
6996
|
+
}
|
|
6997
|
+
]
|
|
6998
|
+
},
|
|
6999
|
+
"extends": {
|
|
7000
|
+
"kind": "tuple",
|
|
7001
|
+
"value": [
|
|
7002
|
+
{
|
|
7003
|
+
"kind": "primitive",
|
|
7004
|
+
"value": "never"
|
|
7005
|
+
}
|
|
7006
|
+
]
|
|
7007
|
+
},
|
|
7008
|
+
"trueType": {
|
|
7009
|
+
"kind": "intersection",
|
|
7010
|
+
"value": [
|
|
7011
|
+
{
|
|
7012
|
+
"kind": "symbol",
|
|
7013
|
+
"name": "ModifierValuesStencil",
|
|
7014
|
+
"typeParameters": [
|
|
7015
|
+
{
|
|
7016
|
+
"kind": "symbol",
|
|
7017
|
+
"name": "M",
|
|
7018
|
+
"value": "M"
|
|
7019
|
+
},
|
|
7020
|
+
{
|
|
7021
|
+
"kind": "symbol",
|
|
7022
|
+
"name": "V",
|
|
7023
|
+
"value": "V"
|
|
7024
|
+
}
|
|
7025
|
+
],
|
|
7026
|
+
"value": "ModifierValuesStencil<M, V>"
|
|
7027
|
+
},
|
|
7028
|
+
{
|
|
7029
|
+
"kind": "symbol",
|
|
7030
|
+
"name": "VariableValuesStencil",
|
|
7031
|
+
"typeParameters": [
|
|
7032
|
+
{
|
|
7033
|
+
"kind": "symbol",
|
|
7034
|
+
"name": "V",
|
|
7035
|
+
"value": "V"
|
|
7036
|
+
}
|
|
7037
|
+
],
|
|
7038
|
+
"value": "VariableValuesStencil<V>"
|
|
7039
|
+
}
|
|
7040
|
+
]
|
|
7041
|
+
},
|
|
7042
|
+
"falseType": {
|
|
7043
|
+
"kind": "conditional",
|
|
7044
|
+
"check": {
|
|
7045
|
+
"kind": "symbol",
|
|
7046
|
+
"name": "E",
|
|
7047
|
+
"value": "E"
|
|
7048
|
+
},
|
|
7049
|
+
"extends": {
|
|
7050
|
+
"kind": "symbol",
|
|
7051
|
+
"name": "BaseStencil",
|
|
7052
|
+
"typeParameters": [
|
|
7053
|
+
{
|
|
7054
|
+
"kind": "infer",
|
|
7055
|
+
"value": {
|
|
7056
|
+
"kind": "typeParameter",
|
|
7057
|
+
"name": "ME",
|
|
7058
|
+
"required": true
|
|
7059
|
+
}
|
|
7060
|
+
},
|
|
7061
|
+
{
|
|
7062
|
+
"kind": "infer",
|
|
7063
|
+
"value": {
|
|
7064
|
+
"kind": "typeParameter",
|
|
7065
|
+
"name": "VE",
|
|
7066
|
+
"required": true
|
|
7067
|
+
}
|
|
7068
|
+
},
|
|
7069
|
+
{
|
|
7070
|
+
"kind": "primitive",
|
|
7071
|
+
"value": "any"
|
|
7072
|
+
},
|
|
7073
|
+
{
|
|
7074
|
+
"kind": "primitive",
|
|
7075
|
+
"value": "any"
|
|
7076
|
+
}
|
|
7077
|
+
],
|
|
7078
|
+
"value": "BaseStencil<M, V, E, ID>"
|
|
7079
|
+
},
|
|
7080
|
+
"trueType": {
|
|
7081
|
+
"kind": "intersection",
|
|
7082
|
+
"value": [
|
|
7083
|
+
{
|
|
7084
|
+
"kind": "symbol",
|
|
7085
|
+
"name": "ModifierValuesStencil",
|
|
7086
|
+
"typeParameters": [
|
|
7087
|
+
{
|
|
7088
|
+
"kind": "intersection",
|
|
7089
|
+
"value": [
|
|
7090
|
+
{
|
|
7091
|
+
"kind": "symbol",
|
|
7092
|
+
"name": "ME",
|
|
7093
|
+
"value": "ME"
|
|
7094
|
+
},
|
|
7095
|
+
{
|
|
7096
|
+
"kind": "symbol",
|
|
7097
|
+
"name": "M",
|
|
7098
|
+
"value": "M"
|
|
7099
|
+
}
|
|
7100
|
+
]
|
|
7101
|
+
}
|
|
7102
|
+
],
|
|
7103
|
+
"value": "ModifierValuesStencil<M, V>"
|
|
7104
|
+
},
|
|
7105
|
+
{
|
|
7106
|
+
"kind": "symbol",
|
|
7107
|
+
"name": "VariableValuesStencil",
|
|
7108
|
+
"typeParameters": [
|
|
7109
|
+
{
|
|
7110
|
+
"kind": "intersection",
|
|
7111
|
+
"value": [
|
|
7112
|
+
{
|
|
7113
|
+
"kind": "symbol",
|
|
7114
|
+
"name": "VE",
|
|
7115
|
+
"value": "VE"
|
|
7116
|
+
},
|
|
7117
|
+
{
|
|
7118
|
+
"kind": "symbol",
|
|
7119
|
+
"name": "V",
|
|
7120
|
+
"value": "V"
|
|
7121
|
+
}
|
|
7122
|
+
]
|
|
7123
|
+
}
|
|
7124
|
+
],
|
|
7125
|
+
"value": "VariableValuesStencil<V>"
|
|
7126
|
+
}
|
|
7127
|
+
]
|
|
7128
|
+
},
|
|
7129
|
+
"falseType": {
|
|
7130
|
+
"kind": "primitive",
|
|
7131
|
+
"value": "never"
|
|
7132
|
+
}
|
|
7133
|
+
}
|
|
7134
|
+
},
|
|
7135
|
+
"required": false,
|
|
7136
|
+
"rest": false,
|
|
7137
|
+
"description": "",
|
|
7138
|
+
"declarations": [
|
|
7139
|
+
{
|
|
7140
|
+
"name": "options",
|
|
7141
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
7142
|
+
}
|
|
7143
|
+
],
|
|
7144
|
+
"tags": {}
|
|
7145
|
+
}
|
|
7146
|
+
],
|
|
7147
|
+
"members": [
|
|
7148
|
+
{
|
|
7149
|
+
"kind": "property",
|
|
7150
|
+
"name": "vars",
|
|
7151
|
+
"required": true,
|
|
7152
|
+
"type": {
|
|
7153
|
+
"kind": "symbol",
|
|
7154
|
+
"name": "StencilDefaultVars",
|
|
7155
|
+
"typeParameters": [
|
|
7156
|
+
{
|
|
7157
|
+
"kind": "symbol",
|
|
7158
|
+
"name": "V",
|
|
7159
|
+
"value": "V"
|
|
7160
|
+
},
|
|
7161
|
+
{
|
|
7162
|
+
"kind": "symbol",
|
|
7163
|
+
"name": "E",
|
|
7164
|
+
"value": "E"
|
|
7165
|
+
},
|
|
7166
|
+
{
|
|
7167
|
+
"kind": "symbol",
|
|
7168
|
+
"name": "ID",
|
|
7169
|
+
"value": "ID"
|
|
7170
|
+
}
|
|
7171
|
+
],
|
|
7172
|
+
"value": "StencilDefaultVars<V, E, ID>"
|
|
7173
|
+
},
|
|
7174
|
+
"description": "",
|
|
7175
|
+
"declarations": [
|
|
7176
|
+
{
|
|
7177
|
+
"name": "vars",
|
|
7178
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
7179
|
+
}
|
|
7180
|
+
],
|
|
7181
|
+
"tags": {}
|
|
7182
|
+
},
|
|
7183
|
+
{
|
|
7184
|
+
"kind": "property",
|
|
7185
|
+
"name": "base",
|
|
7186
|
+
"required": true,
|
|
7187
|
+
"type": {
|
|
7188
|
+
"kind": "primitive",
|
|
7189
|
+
"value": "string"
|
|
7190
|
+
},
|
|
7191
|
+
"description": "",
|
|
7192
|
+
"declarations": [
|
|
7193
|
+
{
|
|
7194
|
+
"name": "base",
|
|
7195
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
7196
|
+
}
|
|
7197
|
+
],
|
|
7198
|
+
"tags": {}
|
|
7199
|
+
},
|
|
7200
|
+
{
|
|
7201
|
+
"kind": "property",
|
|
7202
|
+
"name": "modifiers",
|
|
7203
|
+
"required": true,
|
|
7204
|
+
"type": {
|
|
7205
|
+
"kind": "conditional",
|
|
7206
|
+
"check": {
|
|
7207
|
+
"kind": "tuple",
|
|
7208
|
+
"value": [
|
|
7209
|
+
{
|
|
7210
|
+
"kind": "symbol",
|
|
7211
|
+
"name": "E",
|
|
7212
|
+
"value": "E"
|
|
7213
|
+
}
|
|
7214
|
+
]
|
|
7215
|
+
},
|
|
7216
|
+
"extends": {
|
|
7217
|
+
"kind": "tuple",
|
|
7218
|
+
"value": [
|
|
7219
|
+
{
|
|
7220
|
+
"kind": "symbol",
|
|
7221
|
+
"name": "BaseStencil",
|
|
7222
|
+
"typeParameters": [
|
|
7223
|
+
{
|
|
7224
|
+
"kind": "infer",
|
|
7225
|
+
"value": {
|
|
7226
|
+
"kind": "typeParameter",
|
|
7227
|
+
"name": "ME",
|
|
7228
|
+
"required": true
|
|
7229
|
+
}
|
|
7230
|
+
},
|
|
7231
|
+
{
|
|
7232
|
+
"kind": "infer",
|
|
7233
|
+
"value": {
|
|
7234
|
+
"kind": "typeParameter",
|
|
7235
|
+
"name": "VE",
|
|
7236
|
+
"required": true
|
|
7237
|
+
}
|
|
7238
|
+
},
|
|
7239
|
+
{
|
|
7240
|
+
"kind": "primitive",
|
|
7241
|
+
"value": "any"
|
|
7242
|
+
},
|
|
7243
|
+
{
|
|
7244
|
+
"kind": "primitive",
|
|
7245
|
+
"value": "any"
|
|
7246
|
+
}
|
|
7247
|
+
],
|
|
7248
|
+
"value": "BaseStencil<M, V, E, ID>"
|
|
7249
|
+
}
|
|
7250
|
+
]
|
|
7251
|
+
},
|
|
7252
|
+
"trueType": {
|
|
7253
|
+
"kind": "symbol",
|
|
7254
|
+
"name": "StencilModifierReturn",
|
|
7255
|
+
"typeParameters": [
|
|
7256
|
+
{
|
|
7257
|
+
"kind": "intersection",
|
|
7258
|
+
"value": [
|
|
7259
|
+
{
|
|
7260
|
+
"kind": "symbol",
|
|
7261
|
+
"name": "ME",
|
|
7262
|
+
"value": "ME"
|
|
7263
|
+
},
|
|
7264
|
+
{
|
|
7265
|
+
"kind": "symbol",
|
|
7266
|
+
"name": "M",
|
|
7267
|
+
"value": "M"
|
|
7268
|
+
}
|
|
7269
|
+
]
|
|
7270
|
+
},
|
|
7271
|
+
{
|
|
7272
|
+
"kind": "intersection",
|
|
7273
|
+
"value": [
|
|
7274
|
+
{
|
|
7275
|
+
"kind": "symbol",
|
|
7276
|
+
"name": "VE",
|
|
7277
|
+
"value": "VE"
|
|
7278
|
+
},
|
|
7279
|
+
{
|
|
7280
|
+
"kind": "symbol",
|
|
7281
|
+
"name": "V",
|
|
7282
|
+
"value": "V"
|
|
7283
|
+
}
|
|
7284
|
+
]
|
|
7285
|
+
}
|
|
7286
|
+
],
|
|
7287
|
+
"value": "StencilModifierReturn<M, V>"
|
|
7288
|
+
},
|
|
7289
|
+
"falseType": {
|
|
7290
|
+
"kind": "symbol",
|
|
7291
|
+
"name": "StencilModifierReturn",
|
|
7292
|
+
"typeParameters": [
|
|
7293
|
+
{
|
|
7294
|
+
"kind": "symbol",
|
|
7295
|
+
"name": "M",
|
|
7296
|
+
"value": "M"
|
|
7297
|
+
},
|
|
7298
|
+
{
|
|
7299
|
+
"kind": "symbol",
|
|
7300
|
+
"name": "V",
|
|
7301
|
+
"value": "V"
|
|
7302
|
+
}
|
|
7303
|
+
],
|
|
7304
|
+
"value": "StencilModifierReturn<M, V>"
|
|
7305
|
+
}
|
|
7306
|
+
},
|
|
7307
|
+
"description": "",
|
|
7308
|
+
"declarations": [
|
|
7309
|
+
{
|
|
7310
|
+
"name": "modifiers",
|
|
7311
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
7312
|
+
}
|
|
7313
|
+
],
|
|
7314
|
+
"tags": {}
|
|
7315
|
+
},
|
|
7316
|
+
{
|
|
7317
|
+
"kind": "property",
|
|
7318
|
+
"name": "defaultModifiers",
|
|
7319
|
+
"required": true,
|
|
7320
|
+
"type": {
|
|
7321
|
+
"kind": "conditional",
|
|
7322
|
+
"check": {
|
|
7323
|
+
"kind": "tuple",
|
|
7324
|
+
"value": [
|
|
7325
|
+
{
|
|
7326
|
+
"kind": "symbol",
|
|
7327
|
+
"name": "E",
|
|
7328
|
+
"value": "E"
|
|
7329
|
+
}
|
|
7330
|
+
]
|
|
7331
|
+
},
|
|
7332
|
+
"extends": {
|
|
7333
|
+
"kind": "tuple",
|
|
7334
|
+
"value": [
|
|
7335
|
+
{
|
|
7336
|
+
"kind": "symbol",
|
|
7337
|
+
"name": "BaseStencil",
|
|
7338
|
+
"typeParameters": [
|
|
7339
|
+
{
|
|
7340
|
+
"kind": "infer",
|
|
7341
|
+
"value": {
|
|
7342
|
+
"kind": "typeParameter",
|
|
7343
|
+
"name": "ME",
|
|
7344
|
+
"required": true
|
|
7345
|
+
}
|
|
7346
|
+
},
|
|
7347
|
+
{
|
|
7348
|
+
"kind": "primitive",
|
|
7349
|
+
"value": "any"
|
|
7350
|
+
},
|
|
7351
|
+
{
|
|
7352
|
+
"kind": "primitive",
|
|
7353
|
+
"value": "any"
|
|
7354
|
+
},
|
|
7355
|
+
{
|
|
7356
|
+
"kind": "primitive",
|
|
7357
|
+
"value": "any"
|
|
7358
|
+
}
|
|
7359
|
+
],
|
|
7360
|
+
"value": "BaseStencil<M, V, E, ID>"
|
|
7361
|
+
}
|
|
7362
|
+
]
|
|
7363
|
+
},
|
|
7364
|
+
"trueType": {
|
|
7365
|
+
"kind": "symbol",
|
|
7366
|
+
"name": "StencilDefaultModifierReturn",
|
|
7367
|
+
"typeParameters": [
|
|
7368
|
+
{
|
|
7369
|
+
"kind": "intersection",
|
|
7370
|
+
"value": [
|
|
7371
|
+
{
|
|
7372
|
+
"kind": "symbol",
|
|
7373
|
+
"name": "ME",
|
|
7374
|
+
"value": "ME"
|
|
7375
|
+
},
|
|
7376
|
+
{
|
|
7377
|
+
"kind": "symbol",
|
|
7378
|
+
"name": "M",
|
|
7379
|
+
"value": "M"
|
|
7380
|
+
}
|
|
7381
|
+
]
|
|
7382
|
+
}
|
|
7383
|
+
],
|
|
7384
|
+
"value": "StencilDefaultModifierReturn<M>"
|
|
7385
|
+
},
|
|
7386
|
+
"falseType": {
|
|
7387
|
+
"kind": "symbol",
|
|
7388
|
+
"name": "StencilDefaultModifierReturn",
|
|
7389
|
+
"typeParameters": [
|
|
7390
|
+
{
|
|
7391
|
+
"kind": "symbol",
|
|
7392
|
+
"name": "M",
|
|
7393
|
+
"value": "M"
|
|
7394
|
+
}
|
|
7395
|
+
],
|
|
7396
|
+
"value": "StencilDefaultModifierReturn<M>"
|
|
7397
|
+
}
|
|
7398
|
+
},
|
|
7399
|
+
"description": "",
|
|
7400
|
+
"declarations": [
|
|
7401
|
+
{
|
|
7402
|
+
"name": "defaultModifiers",
|
|
7403
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
7404
|
+
}
|
|
7405
|
+
],
|
|
7406
|
+
"tags": {}
|
|
7407
|
+
},
|
|
7408
|
+
{
|
|
7409
|
+
"kind": "property",
|
|
7410
|
+
"name": "__extends",
|
|
7411
|
+
"required": false,
|
|
7412
|
+
"type": {
|
|
7413
|
+
"kind": "symbol",
|
|
7414
|
+
"name": "E",
|
|
7415
|
+
"value": "E"
|
|
7416
|
+
},
|
|
7417
|
+
"description": "",
|
|
7418
|
+
"declarations": [
|
|
7419
|
+
{
|
|
7420
|
+
"name": "__extends",
|
|
7421
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
7422
|
+
}
|
|
7423
|
+
],
|
|
7424
|
+
"tags": {}
|
|
7425
|
+
},
|
|
7426
|
+
{
|
|
7427
|
+
"kind": "property",
|
|
7428
|
+
"name": "__vars",
|
|
7429
|
+
"required": true,
|
|
7430
|
+
"type": {
|
|
7431
|
+
"kind": "symbol",
|
|
7432
|
+
"name": "V",
|
|
7433
|
+
"value": "V"
|
|
7434
|
+
},
|
|
7435
|
+
"description": "",
|
|
7436
|
+
"declarations": [
|
|
7437
|
+
{
|
|
7438
|
+
"name": "__vars",
|
|
7439
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
7440
|
+
}
|
|
7441
|
+
],
|
|
7442
|
+
"tags": {}
|
|
7443
|
+
},
|
|
7444
|
+
{
|
|
7445
|
+
"kind": "property",
|
|
7446
|
+
"name": "__modifiers",
|
|
7447
|
+
"required": true,
|
|
7448
|
+
"type": {
|
|
7449
|
+
"kind": "symbol",
|
|
7450
|
+
"name": "M",
|
|
7451
|
+
"value": "M"
|
|
7452
|
+
},
|
|
7453
|
+
"description": "",
|
|
7454
|
+
"declarations": [
|
|
7455
|
+
{
|
|
7456
|
+
"name": "__modifiers",
|
|
7457
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
7458
|
+
}
|
|
7459
|
+
],
|
|
7460
|
+
"tags": {}
|
|
7461
|
+
},
|
|
7462
|
+
{
|
|
7463
|
+
"kind": "property",
|
|
7464
|
+
"name": "__id",
|
|
7465
|
+
"required": true,
|
|
7466
|
+
"type": {
|
|
7467
|
+
"kind": "symbol",
|
|
7468
|
+
"name": "ID",
|
|
7469
|
+
"value": "ID"
|
|
7470
|
+
},
|
|
7471
|
+
"description": "",
|
|
7472
|
+
"declarations": [
|
|
7473
|
+
{
|
|
7474
|
+
"name": "__id",
|
|
7475
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
7476
|
+
}
|
|
7477
|
+
],
|
|
7478
|
+
"tags": {}
|
|
7479
|
+
}
|
|
7480
|
+
],
|
|
7481
|
+
"returnType": {
|
|
7482
|
+
"kind": "object",
|
|
7483
|
+
"properties": [
|
|
7484
|
+
{
|
|
7485
|
+
"kind": "property",
|
|
7486
|
+
"name": "className",
|
|
7487
|
+
"required": true,
|
|
7488
|
+
"type": {
|
|
7489
|
+
"kind": "primitive",
|
|
7490
|
+
"value": "string"
|
|
7491
|
+
},
|
|
7492
|
+
"description": "",
|
|
7493
|
+
"declarations": [
|
|
7494
|
+
{
|
|
7495
|
+
"name": "className",
|
|
7496
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
7497
|
+
}
|
|
7498
|
+
],
|
|
7499
|
+
"tags": {}
|
|
7500
|
+
},
|
|
7501
|
+
{
|
|
7502
|
+
"kind": "property",
|
|
7503
|
+
"name": "style",
|
|
7504
|
+
"required": false,
|
|
7505
|
+
"type": {
|
|
7506
|
+
"kind": "external",
|
|
7507
|
+
"name": "Record",
|
|
7508
|
+
"url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
|
|
7509
|
+
"typeParameters": [
|
|
7510
|
+
{
|
|
7511
|
+
"kind": "primitive",
|
|
7512
|
+
"value": "string"
|
|
7513
|
+
},
|
|
7514
|
+
{
|
|
7515
|
+
"kind": "primitive",
|
|
7516
|
+
"value": "string"
|
|
7517
|
+
}
|
|
7518
|
+
]
|
|
7519
|
+
},
|
|
7520
|
+
"description": "",
|
|
7521
|
+
"declarations": [
|
|
7522
|
+
{
|
|
7523
|
+
"name": "style",
|
|
7524
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
7525
|
+
}
|
|
7526
|
+
],
|
|
7527
|
+
"tags": {}
|
|
7528
|
+
}
|
|
7529
|
+
]
|
|
7530
|
+
}
|
|
7531
|
+
}
|
|
7532
|
+
},
|
|
7533
|
+
{
|
|
7534
|
+
"name": "InformationHighlight",
|
|
7535
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/InformationHighlight/lib/InformationHighlight.tsx",
|
|
7536
|
+
"description": "",
|
|
7537
|
+
"declarations": [
|
|
7538
|
+
{
|
|
7539
|
+
"name": "InformationHighlight",
|
|
7540
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/InformationHighlight/lib/InformationHighlight.tsx"
|
|
7541
|
+
}
|
|
7542
|
+
],
|
|
7543
|
+
"tags": {},
|
|
7544
|
+
"type": {
|
|
7545
|
+
"kind": "enhancedComponent",
|
|
7546
|
+
"componentType": "container",
|
|
7547
|
+
"displayName": "InformationHighlight",
|
|
7548
|
+
"props": [
|
|
7549
|
+
{
|
|
7550
|
+
"kind": "property",
|
|
7551
|
+
"name": "model",
|
|
7552
|
+
"description": "Optional model to pass to the component. This will override the default model created for the component. This can be useful if you want to access to the state and events of the model, or if you have nested components of the same type and you need to override the model provided by React Context.",
|
|
7553
|
+
"tags": {},
|
|
7554
|
+
"declarations": [],
|
|
7555
|
+
"type": {
|
|
7556
|
+
"kind": "symbol",
|
|
7557
|
+
"name": "InformationHighlightModel"
|
|
7558
|
+
}
|
|
7559
|
+
},
|
|
7560
|
+
{
|
|
7561
|
+
"kind": "property",
|
|
7562
|
+
"name": "elemPropsHook",
|
|
7563
|
+
"description": "Optional hook that receives the model and all props to be applied to the element. If you use this, it is your responsibility to return props, merging as appropriate. For example, returning an empty object will disable all elemProps hooks associated with this component. This allows finer control over a component without creating a new one.",
|
|
7564
|
+
"tags": {},
|
|
7565
|
+
"declarations": [],
|
|
7566
|
+
"type": {
|
|
7567
|
+
"kind": "function",
|
|
7568
|
+
"parameters": [
|
|
7569
|
+
{
|
|
7570
|
+
"kind": "parameter",
|
|
7571
|
+
"description": "",
|
|
7572
|
+
"tags": {},
|
|
7573
|
+
"declarations": [],
|
|
7574
|
+
"name": "model",
|
|
7575
|
+
"type": {
|
|
7576
|
+
"kind": "symbol",
|
|
7577
|
+
"name": "InformationHighlightModel"
|
|
7578
|
+
},
|
|
7579
|
+
"required": true
|
|
7580
|
+
},
|
|
7581
|
+
{
|
|
7582
|
+
"kind": "parameter",
|
|
7583
|
+
"description": "",
|
|
7584
|
+
"tags": {},
|
|
7585
|
+
"declarations": [],
|
|
7586
|
+
"name": "elemProps",
|
|
7587
|
+
"type": {
|
|
7588
|
+
"kind": "generic",
|
|
7589
|
+
"name": "TProps"
|
|
7590
|
+
}
|
|
7591
|
+
}
|
|
7592
|
+
],
|
|
7593
|
+
"returnType": {
|
|
7594
|
+
"kind": "external",
|
|
7595
|
+
"name": "HTML Attributes",
|
|
7596
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes"
|
|
7597
|
+
}
|
|
7598
|
+
}
|
|
7599
|
+
}
|
|
7600
|
+
],
|
|
7601
|
+
"baseElement": {
|
|
7602
|
+
"kind": "external",
|
|
7603
|
+
"name": "section",
|
|
7604
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/section"
|
|
7605
|
+
},
|
|
7606
|
+
"model": "InformationHighlightModel",
|
|
7607
|
+
"subComponents": [
|
|
7608
|
+
{
|
|
7609
|
+
"name": "Icon",
|
|
7610
|
+
"symbol": "Icon",
|
|
7611
|
+
"description": "",
|
|
7612
|
+
"declarations": [
|
|
7613
|
+
{
|
|
7614
|
+
"name": "Icon",
|
|
7615
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/InformationHighlight/lib/InformationHighlight.tsx"
|
|
7616
|
+
},
|
|
7617
|
+
{
|
|
7618
|
+
"name": "Icon",
|
|
7619
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/InformationHighlight/lib/parts/Icon.tsx"
|
|
7620
|
+
}
|
|
7621
|
+
],
|
|
7622
|
+
"tags": {}
|
|
7623
|
+
},
|
|
7624
|
+
{
|
|
7625
|
+
"name": "Heading",
|
|
7626
|
+
"symbol": "InformationHighlightHeading",
|
|
7627
|
+
"description": "",
|
|
7628
|
+
"declarations": [
|
|
7629
|
+
{
|
|
7630
|
+
"name": "Heading",
|
|
7631
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/InformationHighlight/lib/InformationHighlight.tsx"
|
|
7632
|
+
},
|
|
7633
|
+
{
|
|
7634
|
+
"name": "InformationHighlightHeading",
|
|
7635
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/InformationHighlight/lib/parts/Heading.tsx"
|
|
7636
|
+
}
|
|
7637
|
+
],
|
|
7638
|
+
"tags": {}
|
|
7639
|
+
},
|
|
7640
|
+
{
|
|
7641
|
+
"name": "Body",
|
|
7642
|
+
"symbol": "Body",
|
|
7643
|
+
"description": "",
|
|
7644
|
+
"declarations": [
|
|
7645
|
+
{
|
|
7646
|
+
"name": "Body",
|
|
7647
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/InformationHighlight/lib/InformationHighlight.tsx"
|
|
7648
|
+
},
|
|
7649
|
+
{
|
|
7650
|
+
"name": "Body",
|
|
7651
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/InformationHighlight/lib/parts/Body.tsx"
|
|
7652
|
+
}
|
|
7653
|
+
],
|
|
7654
|
+
"tags": {}
|
|
7655
|
+
},
|
|
7656
|
+
{
|
|
7657
|
+
"name": "Link",
|
|
7658
|
+
"symbol": "Link",
|
|
7659
|
+
"description": "",
|
|
7660
|
+
"declarations": [
|
|
7661
|
+
{
|
|
7662
|
+
"name": "Link",
|
|
7663
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/InformationHighlight/lib/InformationHighlight.tsx"
|
|
7664
|
+
},
|
|
7665
|
+
{
|
|
7666
|
+
"name": "Link",
|
|
7667
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/InformationHighlight/lib/parts/Link.tsx"
|
|
7668
|
+
}
|
|
7669
|
+
],
|
|
7670
|
+
"tags": {}
|
|
7671
|
+
}
|
|
7672
|
+
]
|
|
7673
|
+
}
|
|
7674
|
+
},
|
|
7675
|
+
{
|
|
7676
|
+
"name": "Body",
|
|
7677
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/InformationHighlight/lib/parts/Body.tsx",
|
|
7678
|
+
"description": "",
|
|
7679
|
+
"declarations": [
|
|
7680
|
+
{
|
|
7681
|
+
"name": "Body",
|
|
7682
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/InformationHighlight/lib/parts/Body.tsx"
|
|
7683
|
+
}
|
|
7684
|
+
],
|
|
7685
|
+
"tags": {},
|
|
7686
|
+
"type": {
|
|
7687
|
+
"kind": "enhancedComponent",
|
|
7688
|
+
"componentType": "regular",
|
|
7689
|
+
"displayName": "Body",
|
|
7690
|
+
"props": [
|
|
7691
|
+
{
|
|
7692
|
+
"kind": "property",
|
|
7693
|
+
"name": "typeLevel",
|
|
7694
|
+
"required": false,
|
|
7695
|
+
"type": {
|
|
7696
|
+
"kind": "union",
|
|
7697
|
+
"value": [
|
|
7698
|
+
{
|
|
7699
|
+
"kind": "string",
|
|
7700
|
+
"value": "body.medium"
|
|
7701
|
+
},
|
|
7702
|
+
{
|
|
7703
|
+
"kind": "string",
|
|
7704
|
+
"value": "body.large"
|
|
7705
|
+
},
|
|
7706
|
+
{
|
|
7707
|
+
"kind": "string",
|
|
7708
|
+
"value": "body.small"
|
|
7709
|
+
},
|
|
7710
|
+
{
|
|
7711
|
+
"kind": "string",
|
|
7712
|
+
"value": "title.medium"
|
|
7713
|
+
},
|
|
7714
|
+
{
|
|
7715
|
+
"kind": "string",
|
|
7716
|
+
"value": "title.large"
|
|
7717
|
+
},
|
|
7718
|
+
{
|
|
7719
|
+
"kind": "string",
|
|
7720
|
+
"value": "title.small"
|
|
7721
|
+
},
|
|
7722
|
+
{
|
|
7723
|
+
"kind": "string",
|
|
7724
|
+
"value": "subtext.medium"
|
|
7725
|
+
},
|
|
7726
|
+
{
|
|
7727
|
+
"kind": "string",
|
|
7728
|
+
"value": "subtext.large"
|
|
7729
|
+
},
|
|
7730
|
+
{
|
|
7731
|
+
"kind": "string",
|
|
7732
|
+
"value": "subtext.small"
|
|
7733
|
+
},
|
|
7734
|
+
{
|
|
7735
|
+
"kind": "string",
|
|
7736
|
+
"value": "heading.medium"
|
|
7737
|
+
},
|
|
7738
|
+
{
|
|
7739
|
+
"kind": "string",
|
|
7740
|
+
"value": "heading.large"
|
|
7741
|
+
},
|
|
7742
|
+
{
|
|
7743
|
+
"kind": "string",
|
|
7744
|
+
"value": "heading.small"
|
|
7745
|
+
}
|
|
7746
|
+
]
|
|
7747
|
+
},
|
|
7748
|
+
"description": "Type token as string with level and size separated by dot.\nThese values map to our [Canvas type levels](https://canvas.workday.com/tokens/type#type-styles).\n\n```tsx\n<Text typeLevel=\"body.small\">Small body text</Text>\n```",
|
|
7749
|
+
"declarations": [
|
|
7750
|
+
{
|
|
7751
|
+
"name": "typeLevel",
|
|
7752
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/Text.tsx"
|
|
7753
|
+
}
|
|
7754
|
+
],
|
|
7755
|
+
"tags": {}
|
|
7756
|
+
},
|
|
7757
|
+
{
|
|
7758
|
+
"kind": "property",
|
|
7759
|
+
"name": "variant",
|
|
7760
|
+
"required": false,
|
|
7761
|
+
"type": {
|
|
7762
|
+
"kind": "union",
|
|
7763
|
+
"value": [
|
|
7764
|
+
{
|
|
7765
|
+
"kind": "string",
|
|
7766
|
+
"value": "error"
|
|
7767
|
+
},
|
|
7768
|
+
{
|
|
7769
|
+
"kind": "string",
|
|
7770
|
+
"value": "hint"
|
|
7771
|
+
},
|
|
7772
|
+
{
|
|
7773
|
+
"kind": "string",
|
|
7774
|
+
"value": "inverse"
|
|
7775
|
+
}
|
|
7776
|
+
]
|
|
7777
|
+
},
|
|
7778
|
+
"description": "Type variant token names: `error`, `hint` or `inverse`.\n\n```tsx\n<Text variant=\"error\" typeLevel=\"subtext.large\">Error text</Text>\n```",
|
|
7779
|
+
"declarations": [
|
|
7780
|
+
{
|
|
7781
|
+
"name": "variant",
|
|
7782
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/Text.tsx"
|
|
7783
|
+
}
|
|
7784
|
+
],
|
|
7785
|
+
"tags": {}
|
|
7786
|
+
},
|
|
7787
|
+
{
|
|
7788
|
+
"kind": "property",
|
|
7789
|
+
"name": "cs",
|
|
7790
|
+
"required": false,
|
|
7791
|
+
"type": {
|
|
7792
|
+
"kind": "symbol",
|
|
7793
|
+
"name": "CSToPropsInput",
|
|
7794
|
+
"value": "CSToPropsInput"
|
|
7795
|
+
},
|
|
7796
|
+
"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```",
|
|
7797
|
+
"declarations": [
|
|
7798
|
+
{
|
|
7799
|
+
"name": "cs",
|
|
7800
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
7801
|
+
}
|
|
7802
|
+
],
|
|
7803
|
+
"tags": {}
|
|
7804
|
+
},
|
|
7805
|
+
{
|
|
7806
|
+
"kind": "property",
|
|
7807
|
+
"name": "children",
|
|
7808
|
+
"required": false,
|
|
7809
|
+
"type": {
|
|
7810
|
+
"kind": "external",
|
|
7811
|
+
"name": "ReactNode",
|
|
7812
|
+
"url": "https://reactjs.org/docs/rendering-elements.html"
|
|
7813
|
+
},
|
|
7814
|
+
"description": "",
|
|
7815
|
+
"declarations": [
|
|
7816
|
+
{
|
|
7817
|
+
"name": "children",
|
|
7818
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/layout/lib/Box.tsx"
|
|
7819
|
+
}
|
|
7820
|
+
],
|
|
7821
|
+
"tags": {}
|
|
7822
|
+
},
|
|
7823
|
+
{
|
|
7824
|
+
"kind": "property",
|
|
7825
|
+
"name": "as",
|
|
7826
|
+
"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.",
|
|
7827
|
+
"tags": {},
|
|
7828
|
+
"declarations": [],
|
|
7829
|
+
"type": {
|
|
7830
|
+
"kind": "external",
|
|
7831
|
+
"name": "React.ElementType",
|
|
7832
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
|
|
7833
|
+
},
|
|
7834
|
+
"defaultValue": {
|
|
7835
|
+
"kind": "external",
|
|
7836
|
+
"name": "p",
|
|
7837
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/p"
|
|
7838
|
+
}
|
|
7839
|
+
},
|
|
7840
|
+
{
|
|
7841
|
+
"kind": "property",
|
|
7842
|
+
"name": "ref",
|
|
7843
|
+
"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`).",
|
|
7844
|
+
"tags": {},
|
|
7845
|
+
"declarations": [],
|
|
7846
|
+
"type": {
|
|
7847
|
+
"kind": "external",
|
|
7848
|
+
"name": "React.Ref",
|
|
7849
|
+
"url": "https://reactjs.org/docs/refs-and-the-dom.html",
|
|
7850
|
+
"typeParameters": [
|
|
7851
|
+
{
|
|
7852
|
+
"kind": "typeParameter",
|
|
7853
|
+
"name": "R",
|
|
7854
|
+
"required": true,
|
|
7855
|
+
"defaultValue": {
|
|
7856
|
+
"kind": "external",
|
|
7857
|
+
"name": "p",
|
|
7858
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/p"
|
|
7859
|
+
}
|
|
7860
|
+
}
|
|
7861
|
+
]
|
|
7862
|
+
}
|
|
7863
|
+
}
|
|
7864
|
+
],
|
|
7865
|
+
"baseElement": {
|
|
7866
|
+
"kind": "external",
|
|
7867
|
+
"name": "p",
|
|
7868
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/p"
|
|
7869
|
+
},
|
|
7870
|
+
"styleComponent": {
|
|
7871
|
+
"kind": "symbol",
|
|
7872
|
+
"name": "Box"
|
|
7873
|
+
}
|
|
7874
|
+
}
|
|
7875
|
+
},
|
|
7876
|
+
{
|
|
7877
|
+
"name": "InformationHighlightHeadingProps",
|
|
7878
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/InformationHighlight/lib/parts/Heading.tsx",
|
|
7879
|
+
"description": "",
|
|
7880
|
+
"declarations": [
|
|
7881
|
+
{
|
|
7882
|
+
"name": "InformationHighlightHeadingProps",
|
|
7883
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/InformationHighlight/lib/parts/Heading.tsx"
|
|
7884
|
+
}
|
|
7885
|
+
],
|
|
7886
|
+
"tags": {},
|
|
7887
|
+
"type": {
|
|
7888
|
+
"kind": "alias",
|
|
7889
|
+
"name": "InformationHighlightHeading"
|
|
7890
|
+
}
|
|
7891
|
+
},
|
|
7892
|
+
{
|
|
7893
|
+
"name": "InformationHighlightHeading",
|
|
7894
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/InformationHighlight/lib/parts/Heading.tsx",
|
|
7895
|
+
"description": "",
|
|
7896
|
+
"declarations": [
|
|
7897
|
+
{
|
|
7898
|
+
"name": "InformationHighlightHeading",
|
|
7899
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/InformationHighlight/lib/parts/Heading.tsx"
|
|
7900
|
+
}
|
|
7901
|
+
],
|
|
7902
|
+
"tags": {},
|
|
7903
|
+
"type": {
|
|
7904
|
+
"kind": "enhancedComponent",
|
|
7905
|
+
"componentType": "regular",
|
|
7906
|
+
"displayName": "Heading",
|
|
7907
|
+
"props": [
|
|
7908
|
+
{
|
|
7909
|
+
"kind": "property",
|
|
7910
|
+
"name": "size",
|
|
7911
|
+
"required": true,
|
|
7912
|
+
"type": {
|
|
7913
|
+
"kind": "symbol",
|
|
7914
|
+
"name": "Size",
|
|
7915
|
+
"value": "Size"
|
|
7916
|
+
},
|
|
7917
|
+
"description": "Each type level has three sizes: `large`, `medium`, and `small`.",
|
|
7918
|
+
"declarations": [
|
|
7919
|
+
{
|
|
7920
|
+
"name": "size",
|
|
7921
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/TypeLevelComponents.tsx"
|
|
7922
|
+
}
|
|
7923
|
+
],
|
|
7924
|
+
"tags": {},
|
|
7925
|
+
"defaultValue": {
|
|
7926
|
+
"kind": "string",
|
|
7927
|
+
"value": "small"
|
|
7928
|
+
}
|
|
7929
|
+
},
|
|
7930
|
+
{
|
|
7931
|
+
"kind": "property",
|
|
7932
|
+
"name": "variant",
|
|
7933
|
+
"required": false,
|
|
7934
|
+
"type": {
|
|
7935
|
+
"kind": "union",
|
|
7936
|
+
"value": [
|
|
7937
|
+
{
|
|
7938
|
+
"kind": "string",
|
|
7939
|
+
"value": "error"
|
|
7940
|
+
},
|
|
7941
|
+
{
|
|
7942
|
+
"kind": "string",
|
|
7943
|
+
"value": "hint"
|
|
7944
|
+
},
|
|
7945
|
+
{
|
|
7946
|
+
"kind": "string",
|
|
7947
|
+
"value": "inverse"
|
|
7948
|
+
}
|
|
7949
|
+
]
|
|
7950
|
+
},
|
|
7951
|
+
"description": "Type variant token names: `error`, `hint` or `inverse`.\n\n```tsx\n<Text variant=\"error\" typeLevel=\"subtext.large\">Error text</Text>\n```",
|
|
7952
|
+
"declarations": [
|
|
7953
|
+
{
|
|
7954
|
+
"name": "variant",
|
|
7955
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/Text.tsx"
|
|
7956
|
+
}
|
|
7957
|
+
],
|
|
7958
|
+
"tags": {}
|
|
7959
|
+
},
|
|
7960
|
+
{
|
|
7961
|
+
"kind": "property",
|
|
7962
|
+
"name": "cs",
|
|
7963
|
+
"required": false,
|
|
7964
|
+
"type": {
|
|
7965
|
+
"kind": "symbol",
|
|
7966
|
+
"name": "CSToPropsInput",
|
|
7967
|
+
"value": "CSToPropsInput"
|
|
7968
|
+
},
|
|
7969
|
+
"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```",
|
|
7970
|
+
"declarations": [
|
|
7971
|
+
{
|
|
7972
|
+
"name": "cs",
|
|
7973
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
7974
|
+
}
|
|
7975
|
+
],
|
|
7976
|
+
"tags": {}
|
|
7977
|
+
},
|
|
7978
|
+
{
|
|
7979
|
+
"kind": "property",
|
|
7980
|
+
"name": "children",
|
|
7981
|
+
"required": false,
|
|
7982
|
+
"type": {
|
|
7983
|
+
"kind": "external",
|
|
7984
|
+
"name": "ReactNode",
|
|
7985
|
+
"url": "https://reactjs.org/docs/rendering-elements.html"
|
|
7986
|
+
},
|
|
7987
|
+
"description": "",
|
|
7988
|
+
"declarations": [
|
|
7989
|
+
{
|
|
7990
|
+
"name": "children",
|
|
7991
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/layout/lib/Box.tsx"
|
|
7992
|
+
}
|
|
7993
|
+
],
|
|
7994
|
+
"tags": {}
|
|
7995
|
+
},
|
|
7996
|
+
{
|
|
7997
|
+
"kind": "property",
|
|
7998
|
+
"name": "as",
|
|
7999
|
+
"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.",
|
|
8000
|
+
"tags": {},
|
|
8001
|
+
"declarations": [],
|
|
8002
|
+
"type": {
|
|
8003
|
+
"kind": "external",
|
|
8004
|
+
"name": "React.ElementType",
|
|
8005
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
|
|
8006
|
+
},
|
|
8007
|
+
"defaultValue": {
|
|
8008
|
+
"kind": "external",
|
|
8009
|
+
"name": "h3",
|
|
8010
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/h3"
|
|
8011
|
+
}
|
|
8012
|
+
},
|
|
8013
|
+
{
|
|
8014
|
+
"kind": "property",
|
|
8015
|
+
"name": "ref",
|
|
8016
|
+
"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`).",
|
|
8017
|
+
"tags": {},
|
|
8018
|
+
"declarations": [],
|
|
8019
|
+
"type": {
|
|
8020
|
+
"kind": "external",
|
|
8021
|
+
"name": "React.Ref",
|
|
8022
|
+
"url": "https://reactjs.org/docs/refs-and-the-dom.html",
|
|
8023
|
+
"typeParameters": [
|
|
8024
|
+
{
|
|
8025
|
+
"kind": "typeParameter",
|
|
8026
|
+
"name": "R",
|
|
8027
|
+
"required": true,
|
|
8028
|
+
"defaultValue": {
|
|
8029
|
+
"kind": "external",
|
|
8030
|
+
"name": "h3",
|
|
8031
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/h3"
|
|
8032
|
+
}
|
|
8033
|
+
}
|
|
8034
|
+
]
|
|
8035
|
+
}
|
|
8036
|
+
}
|
|
8037
|
+
],
|
|
8038
|
+
"baseElement": {
|
|
8039
|
+
"kind": "external",
|
|
8040
|
+
"name": "h3",
|
|
8041
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/h3"
|
|
8042
|
+
},
|
|
8043
|
+
"styleComponent": {
|
|
8044
|
+
"kind": "symbol",
|
|
8045
|
+
"name": "Box"
|
|
8046
|
+
}
|
|
8047
|
+
}
|
|
8048
|
+
},
|
|
8049
|
+
{
|
|
8050
|
+
"name": "IconProps",
|
|
8051
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/InformationHighlight/lib/parts/Icon.tsx",
|
|
8052
|
+
"description": "",
|
|
8053
|
+
"declarations": [
|
|
8054
|
+
{
|
|
8055
|
+
"name": "IconProps",
|
|
8056
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/InformationHighlight/lib/parts/Icon.tsx"
|
|
8057
|
+
}
|
|
8058
|
+
],
|
|
8059
|
+
"tags": {},
|
|
8060
|
+
"type": {
|
|
8061
|
+
"kind": "alias",
|
|
8062
|
+
"name": "Icon"
|
|
8063
|
+
}
|
|
8064
|
+
},
|
|
8065
|
+
{
|
|
8066
|
+
"name": "Icon",
|
|
8067
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/InformationHighlight/lib/parts/Icon.tsx",
|
|
8068
|
+
"description": "",
|
|
8069
|
+
"declarations": [
|
|
8070
|
+
{
|
|
8071
|
+
"name": "Icon",
|
|
8072
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/InformationHighlight/lib/parts/Icon.tsx"
|
|
8073
|
+
}
|
|
8074
|
+
],
|
|
8075
|
+
"tags": {},
|
|
8076
|
+
"type": {
|
|
8077
|
+
"kind": "enhancedComponent",
|
|
8078
|
+
"componentType": "subcomponent",
|
|
8079
|
+
"displayName": "Icon",
|
|
8080
|
+
"props": [
|
|
8081
|
+
{
|
|
8082
|
+
"kind": "property",
|
|
8083
|
+
"name": "model",
|
|
8084
|
+
"description": "Optional model to pass to the component. This will override the default model created for the component. This can be useful if you want to access to the state and events of the model, or if you have nested components of the same type and you need to override the model provided by React Context.",
|
|
8085
|
+
"tags": {},
|
|
8086
|
+
"declarations": [],
|
|
8087
|
+
"type": {
|
|
8088
|
+
"kind": "symbol",
|
|
8089
|
+
"name": "InformationHighlightModel"
|
|
8090
|
+
}
|
|
8091
|
+
},
|
|
8092
|
+
{
|
|
8093
|
+
"kind": "property",
|
|
8094
|
+
"name": "elemPropsHook",
|
|
8095
|
+
"description": "Optional hook that receives the model and all props to be applied to the element. If you use this, it is your responsibility to return props, merging as appropriate. For example, returning an empty object will disable all elemProps hooks associated with this component. This allows finer control over a component without creating a new one.",
|
|
8096
|
+
"tags": {},
|
|
8097
|
+
"declarations": [],
|
|
8098
|
+
"type": {
|
|
8099
|
+
"kind": "function",
|
|
8100
|
+
"parameters": [
|
|
8101
|
+
{
|
|
8102
|
+
"kind": "parameter",
|
|
8103
|
+
"description": "",
|
|
8104
|
+
"tags": {},
|
|
8105
|
+
"declarations": [],
|
|
8106
|
+
"name": "model",
|
|
8107
|
+
"type": {
|
|
8108
|
+
"kind": "symbol",
|
|
8109
|
+
"name": "InformationHighlightModel"
|
|
8110
|
+
},
|
|
8111
|
+
"required": true
|
|
8112
|
+
},
|
|
8113
|
+
{
|
|
8114
|
+
"kind": "parameter",
|
|
8115
|
+
"description": "",
|
|
8116
|
+
"tags": {},
|
|
8117
|
+
"declarations": [],
|
|
8118
|
+
"name": "elemProps",
|
|
8119
|
+
"type": {
|
|
8120
|
+
"kind": "generic",
|
|
8121
|
+
"name": "TProps"
|
|
8122
|
+
}
|
|
8123
|
+
}
|
|
8124
|
+
],
|
|
8125
|
+
"returnType": {
|
|
8126
|
+
"kind": "external",
|
|
8127
|
+
"name": "HTML Attributes",
|
|
8128
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes"
|
|
8129
|
+
}
|
|
8130
|
+
}
|
|
8131
|
+
}
|
|
8132
|
+
],
|
|
8133
|
+
"baseElement": {
|
|
8134
|
+
"kind": "external",
|
|
8135
|
+
"name": "span",
|
|
8136
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/span"
|
|
8137
|
+
},
|
|
8138
|
+
"model": "InformationHighlightModel"
|
|
8139
|
+
}
|
|
8140
|
+
},
|
|
8141
|
+
{
|
|
8142
|
+
"name": "Link",
|
|
8143
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/InformationHighlight/lib/parts/Link.tsx",
|
|
8144
|
+
"description": "",
|
|
8145
|
+
"declarations": [
|
|
8146
|
+
{
|
|
8147
|
+
"name": "Link",
|
|
8148
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/InformationHighlight/lib/parts/Link.tsx"
|
|
8149
|
+
}
|
|
8150
|
+
],
|
|
8151
|
+
"tags": {},
|
|
8152
|
+
"type": {
|
|
8153
|
+
"kind": "enhancedComponent",
|
|
8154
|
+
"componentType": "regular",
|
|
8155
|
+
"displayName": "Link",
|
|
8156
|
+
"props": [
|
|
8157
|
+
{
|
|
8158
|
+
"kind": "property",
|
|
8159
|
+
"name": "variant",
|
|
8160
|
+
"required": false,
|
|
8161
|
+
"type": {
|
|
8162
|
+
"kind": "string",
|
|
8163
|
+
"value": "inverse"
|
|
8164
|
+
},
|
|
8165
|
+
"description": "sets modifier styles for Hyperlink\n- `inverse`: sets the color to frenchVanilla100 and updates hover, focus, and active pseudo-classes",
|
|
8166
|
+
"declarations": [
|
|
8167
|
+
{
|
|
8168
|
+
"name": "variant",
|
|
8169
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/button/lib/Hyperlink.tsx"
|
|
8170
|
+
}
|
|
8171
|
+
],
|
|
8172
|
+
"tags": {}
|
|
8173
|
+
},
|
|
8174
|
+
{
|
|
8175
|
+
"kind": "property",
|
|
8176
|
+
"name": "href",
|
|
8177
|
+
"required": false,
|
|
8178
|
+
"type": {
|
|
8179
|
+
"kind": "primitive",
|
|
8180
|
+
"value": "string"
|
|
8181
|
+
},
|
|
8182
|
+
"description": "attribute for the hyperlink URL",
|
|
8183
|
+
"declarations": [
|
|
8184
|
+
{
|
|
8185
|
+
"name": "href",
|
|
8186
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/button/lib/Hyperlink.tsx"
|
|
8187
|
+
}
|
|
8188
|
+
],
|
|
8189
|
+
"tags": {}
|
|
8190
|
+
},
|
|
8191
|
+
{
|
|
8192
|
+
"kind": "property",
|
|
8193
|
+
"name": "children",
|
|
8194
|
+
"required": false,
|
|
8195
|
+
"type": {
|
|
8196
|
+
"kind": "external",
|
|
8197
|
+
"name": "ReactNode",
|
|
8198
|
+
"url": "https://reactjs.org/docs/rendering-elements.html"
|
|
8199
|
+
},
|
|
8200
|
+
"description": "",
|
|
8201
|
+
"declarations": [
|
|
8202
|
+
{
|
|
8203
|
+
"name": "children",
|
|
8204
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/button/lib/Hyperlink.tsx"
|
|
8205
|
+
}
|
|
8206
|
+
],
|
|
8207
|
+
"tags": {}
|
|
8208
|
+
},
|
|
8209
|
+
{
|
|
8210
|
+
"kind": "property",
|
|
8211
|
+
"name": "cs",
|
|
8212
|
+
"required": false,
|
|
8213
|
+
"type": {
|
|
8214
|
+
"kind": "symbol",
|
|
8215
|
+
"name": "CSToPropsInput",
|
|
8216
|
+
"value": "CSToPropsInput"
|
|
8217
|
+
},
|
|
8218
|
+
"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```",
|
|
8219
|
+
"declarations": [
|
|
8220
|
+
{
|
|
8221
|
+
"name": "cs",
|
|
8222
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
8223
|
+
}
|
|
8224
|
+
],
|
|
8225
|
+
"tags": {}
|
|
8226
|
+
},
|
|
8227
|
+
{
|
|
8228
|
+
"kind": "property",
|
|
8229
|
+
"name": "as",
|
|
8230
|
+
"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.",
|
|
8231
|
+
"tags": {},
|
|
8232
|
+
"declarations": [],
|
|
8233
|
+
"type": {
|
|
8234
|
+
"kind": "external",
|
|
8235
|
+
"name": "React.ElementType",
|
|
8236
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
|
|
8237
|
+
},
|
|
8238
|
+
"defaultValue": {
|
|
8239
|
+
"kind": "external",
|
|
8240
|
+
"name": "a",
|
|
8241
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a"
|
|
8242
|
+
}
|
|
8243
|
+
},
|
|
8244
|
+
{
|
|
8245
|
+
"kind": "property",
|
|
8246
|
+
"name": "ref",
|
|
8247
|
+
"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`).",
|
|
8248
|
+
"tags": {},
|
|
8249
|
+
"declarations": [],
|
|
8250
|
+
"type": {
|
|
8251
|
+
"kind": "external",
|
|
8252
|
+
"name": "React.Ref",
|
|
8253
|
+
"url": "https://reactjs.org/docs/refs-and-the-dom.html",
|
|
8254
|
+
"typeParameters": [
|
|
8255
|
+
{
|
|
8256
|
+
"kind": "typeParameter",
|
|
8257
|
+
"name": "R",
|
|
8258
|
+
"required": true,
|
|
8259
|
+
"defaultValue": {
|
|
8260
|
+
"kind": "external",
|
|
8261
|
+
"name": "a",
|
|
8262
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a"
|
|
8263
|
+
}
|
|
8264
|
+
}
|
|
8265
|
+
]
|
|
8266
|
+
}
|
|
8267
|
+
}
|
|
8268
|
+
],
|
|
8269
|
+
"baseElement": {
|
|
8270
|
+
"kind": "external",
|
|
8271
|
+
"name": "a",
|
|
8272
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a"
|
|
8273
|
+
}
|
|
8274
|
+
}
|
|
8275
|
+
},
|
|
6651
8276
|
{
|
|
6652
8277
|
"name": "LoadingSparkles",
|
|
6653
8278
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/loading-sparkles/lib/LoadingSparkles.tsx",
|
|
@@ -41567,27 +43192,27 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
41567
43192
|
},
|
|
41568
43193
|
{
|
|
41569
43194
|
"kind": "string",
|
|
41570
|
-
"value": "
|
|
43195
|
+
"value": "subtext.medium"
|
|
41571
43196
|
},
|
|
41572
43197
|
{
|
|
41573
43198
|
"kind": "string",
|
|
41574
|
-
"value": "
|
|
43199
|
+
"value": "subtext.large"
|
|
41575
43200
|
},
|
|
41576
43201
|
{
|
|
41577
43202
|
"kind": "string",
|
|
41578
|
-
"value": "
|
|
43203
|
+
"value": "subtext.small"
|
|
41579
43204
|
},
|
|
41580
43205
|
{
|
|
41581
43206
|
"kind": "string",
|
|
41582
|
-
"value": "
|
|
43207
|
+
"value": "heading.medium"
|
|
41583
43208
|
},
|
|
41584
43209
|
{
|
|
41585
43210
|
"kind": "string",
|
|
41586
|
-
"value": "
|
|
43211
|
+
"value": "heading.large"
|
|
41587
43212
|
},
|
|
41588
43213
|
{
|
|
41589
43214
|
"kind": "string",
|
|
41590
|
-
"value": "
|
|
43215
|
+
"value": "heading.small"
|
|
41591
43216
|
}
|
|
41592
43217
|
]
|
|
41593
43218
|
},
|
|
@@ -56521,27 +58146,27 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
56521
58146
|
},
|
|
56522
58147
|
{
|
|
56523
58148
|
"kind": "string",
|
|
56524
|
-
"value": "
|
|
58149
|
+
"value": "subtext.medium"
|
|
56525
58150
|
},
|
|
56526
58151
|
{
|
|
56527
58152
|
"kind": "string",
|
|
56528
|
-
"value": "
|
|
58153
|
+
"value": "subtext.large"
|
|
56529
58154
|
},
|
|
56530
58155
|
{
|
|
56531
58156
|
"kind": "string",
|
|
56532
|
-
"value": "
|
|
58157
|
+
"value": "subtext.small"
|
|
56533
58158
|
},
|
|
56534
58159
|
{
|
|
56535
58160
|
"kind": "string",
|
|
56536
|
-
"value": "
|
|
58161
|
+
"value": "heading.medium"
|
|
56537
58162
|
},
|
|
56538
58163
|
{
|
|
56539
58164
|
"kind": "string",
|
|
56540
|
-
"value": "
|
|
58165
|
+
"value": "heading.large"
|
|
56541
58166
|
},
|
|
56542
58167
|
{
|
|
56543
58168
|
"kind": "string",
|
|
56544
|
-
"value": "
|
|
58169
|
+
"value": "heading.small"
|
|
56545
58170
|
}
|
|
56546
58171
|
]
|
|
56547
58172
|
},
|
|
@@ -74891,6 +76516,24 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
74891
76516
|
],
|
|
74892
76517
|
"tags": {}
|
|
74893
76518
|
},
|
|
76519
|
+
{
|
|
76520
|
+
"kind": "property",
|
|
76521
|
+
"name": "cs",
|
|
76522
|
+
"required": false,
|
|
76523
|
+
"type": {
|
|
76524
|
+
"kind": "symbol",
|
|
76525
|
+
"name": "CSToPropsInput",
|
|
76526
|
+
"value": "CSToPropsInput"
|
|
76527
|
+
},
|
|
76528
|
+
"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```",
|
|
76529
|
+
"declarations": [
|
|
76530
|
+
{
|
|
76531
|
+
"name": "cs",
|
|
76532
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
76533
|
+
}
|
|
76534
|
+
],
|
|
76535
|
+
"tags": {}
|
|
76536
|
+
},
|
|
74894
76537
|
{
|
|
74895
76538
|
"kind": "property",
|
|
74896
76539
|
"name": "as",
|
|
@@ -75024,6 +76667,24 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
75024
76667
|
],
|
|
75025
76668
|
"tags": {}
|
|
75026
76669
|
},
|
|
76670
|
+
{
|
|
76671
|
+
"kind": "property",
|
|
76672
|
+
"name": "cs",
|
|
76673
|
+
"required": false,
|
|
76674
|
+
"type": {
|
|
76675
|
+
"kind": "symbol",
|
|
76676
|
+
"name": "CSToPropsInput",
|
|
76677
|
+
"value": "CSToPropsInput"
|
|
76678
|
+
},
|
|
76679
|
+
"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```",
|
|
76680
|
+
"declarations": [
|
|
76681
|
+
{
|
|
76682
|
+
"name": "cs",
|
|
76683
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
76684
|
+
}
|
|
76685
|
+
],
|
|
76686
|
+
"tags": {}
|
|
76687
|
+
},
|
|
75027
76688
|
{
|
|
75028
76689
|
"kind": "property",
|
|
75029
76690
|
"name": "as",
|
|
@@ -137707,6 +139368,24 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
137707
139368
|
}
|
|
137708
139369
|
],
|
|
137709
139370
|
"tags": {}
|
|
139371
|
+
},
|
|
139372
|
+
{
|
|
139373
|
+
"kind": "property",
|
|
139374
|
+
"name": "action",
|
|
139375
|
+
"required": true,
|
|
139376
|
+
"type": {
|
|
139377
|
+
"kind": "symbol",
|
|
139378
|
+
"name": "CanvasThemePalette",
|
|
139379
|
+
"value": "CanvasThemePalette"
|
|
139380
|
+
},
|
|
139381
|
+
"description": "",
|
|
139382
|
+
"declarations": [
|
|
139383
|
+
{
|
|
139384
|
+
"name": "action",
|
|
139385
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/types.ts"
|
|
139386
|
+
}
|
|
139387
|
+
],
|
|
139388
|
+
"tags": {}
|
|
137710
139389
|
}
|
|
137711
139390
|
]
|
|
137712
139391
|
},
|
|
@@ -153371,27 +155050,27 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
153371
155050
|
},
|
|
153372
155051
|
{
|
|
153373
155052
|
"kind": "string",
|
|
153374
|
-
"value": "
|
|
155053
|
+
"value": "subtext.medium"
|
|
153375
155054
|
},
|
|
153376
155055
|
{
|
|
153377
155056
|
"kind": "string",
|
|
153378
|
-
"value": "
|
|
155057
|
+
"value": "subtext.large"
|
|
153379
155058
|
},
|
|
153380
155059
|
{
|
|
153381
155060
|
"kind": "string",
|
|
153382
|
-
"value": "
|
|
155061
|
+
"value": "subtext.small"
|
|
153383
155062
|
},
|
|
153384
155063
|
{
|
|
153385
155064
|
"kind": "string",
|
|
153386
|
-
"value": "
|
|
155065
|
+
"value": "heading.medium"
|
|
153387
155066
|
},
|
|
153388
155067
|
{
|
|
153389
155068
|
"kind": "string",
|
|
153390
|
-
"value": "
|
|
155069
|
+
"value": "heading.large"
|
|
153391
155070
|
},
|
|
153392
155071
|
{
|
|
153393
155072
|
"kind": "string",
|
|
153394
|
-
"value": "
|
|
155073
|
+
"value": "heading.small"
|
|
153395
155074
|
}
|
|
153396
155075
|
]
|
|
153397
155076
|
},
|
|
@@ -154295,27 +155974,27 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
154295
155974
|
},
|
|
154296
155975
|
{
|
|
154297
155976
|
"kind": "string",
|
|
154298
|
-
"value": "
|
|
155977
|
+
"value": "subtext.medium"
|
|
154299
155978
|
},
|
|
154300
155979
|
{
|
|
154301
155980
|
"kind": "string",
|
|
154302
|
-
"value": "
|
|
155981
|
+
"value": "subtext.large"
|
|
154303
155982
|
},
|
|
154304
155983
|
{
|
|
154305
155984
|
"kind": "string",
|
|
154306
|
-
"value": "
|
|
155985
|
+
"value": "subtext.small"
|
|
154307
155986
|
},
|
|
154308
155987
|
{
|
|
154309
155988
|
"kind": "string",
|
|
154310
|
-
"value": "
|
|
155989
|
+
"value": "heading.medium"
|
|
154311
155990
|
},
|
|
154312
155991
|
{
|
|
154313
155992
|
"kind": "string",
|
|
154314
|
-
"value": "
|
|
155993
|
+
"value": "heading.large"
|
|
154315
155994
|
},
|
|
154316
155995
|
{
|
|
154317
155996
|
"kind": "string",
|
|
154318
|
-
"value": "
|
|
155997
|
+
"value": "heading.small"
|
|
154319
155998
|
}
|
|
154320
155999
|
]
|
|
154321
156000
|
},
|
|
@@ -155363,27 +157042,27 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
155363
157042
|
},
|
|
155364
157043
|
{
|
|
155365
157044
|
"kind": "string",
|
|
155366
|
-
"value": "
|
|
157045
|
+
"value": "subtext.medium"
|
|
155367
157046
|
},
|
|
155368
157047
|
{
|
|
155369
157048
|
"kind": "string",
|
|
155370
|
-
"value": "
|
|
157049
|
+
"value": "subtext.large"
|
|
155371
157050
|
},
|
|
155372
157051
|
{
|
|
155373
157052
|
"kind": "string",
|
|
155374
|
-
"value": "
|
|
157053
|
+
"value": "subtext.small"
|
|
155375
157054
|
},
|
|
155376
157055
|
{
|
|
155377
157056
|
"kind": "string",
|
|
155378
|
-
"value": "
|
|
157057
|
+
"value": "heading.medium"
|
|
155379
157058
|
},
|
|
155380
157059
|
{
|
|
155381
157060
|
"kind": "string",
|
|
155382
|
-
"value": "
|
|
157061
|
+
"value": "heading.large"
|
|
155383
157062
|
},
|
|
155384
157063
|
{
|
|
155385
157064
|
"kind": "string",
|
|
155386
|
-
"value": "
|
|
157065
|
+
"value": "heading.small"
|
|
155387
157066
|
}
|
|
155388
157067
|
]
|
|
155389
157068
|
},
|
|
@@ -156312,11 +157991,11 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
156312
157991
|
"value": [
|
|
156313
157992
|
{
|
|
156314
157993
|
"kind": "string",
|
|
156315
|
-
"value": "
|
|
157994
|
+
"value": "error"
|
|
156316
157995
|
},
|
|
156317
157996
|
{
|
|
156318
157997
|
"kind": "string",
|
|
156319
|
-
"value": "
|
|
157998
|
+
"value": "alert"
|
|
156320
157999
|
},
|
|
156321
158000
|
{
|
|
156322
158001
|
"kind": "primitive",
|
|
@@ -156446,11 +158125,11 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
156446
158125
|
"value": [
|
|
156447
158126
|
{
|
|
156448
158127
|
"kind": "string",
|
|
156449
|
-
"value": "
|
|
158128
|
+
"value": "error"
|
|
156450
158129
|
},
|
|
156451
158130
|
{
|
|
156452
158131
|
"kind": "string",
|
|
156453
|
-
"value": "
|
|
158132
|
+
"value": "alert"
|
|
156454
158133
|
},
|
|
156455
158134
|
{
|
|
156456
158135
|
"kind": "primitive",
|
|
@@ -156592,11 +158271,11 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
156592
158271
|
"value": [
|
|
156593
158272
|
{
|
|
156594
158273
|
"kind": "string",
|
|
156595
|
-
"value": "
|
|
158274
|
+
"value": "error"
|
|
156596
158275
|
},
|
|
156597
158276
|
{
|
|
156598
158277
|
"kind": "string",
|
|
156599
|
-
"value": "
|
|
158278
|
+
"value": "alert"
|
|
156600
158279
|
},
|
|
156601
158280
|
{
|
|
156602
158281
|
"kind": "primitive",
|
|
@@ -156696,11 +158375,11 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
156696
158375
|
"value": [
|
|
156697
158376
|
{
|
|
156698
158377
|
"kind": "string",
|
|
156699
|
-
"value": "
|
|
158378
|
+
"value": "error"
|
|
156700
158379
|
},
|
|
156701
158380
|
{
|
|
156702
158381
|
"kind": "string",
|
|
156703
|
-
"value": "
|
|
158382
|
+
"value": "alert"
|
|
156704
158383
|
},
|
|
156705
158384
|
{
|
|
156706
158385
|
"kind": "primitive",
|
|
@@ -156837,11 +158516,11 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
156837
158516
|
"value": [
|
|
156838
158517
|
{
|
|
156839
158518
|
"kind": "string",
|
|
156840
|
-
"value": "
|
|
158519
|
+
"value": "error"
|
|
156841
158520
|
},
|
|
156842
158521
|
{
|
|
156843
158522
|
"kind": "string",
|
|
156844
|
-
"value": "
|
|
158523
|
+
"value": "alert"
|
|
156845
158524
|
},
|
|
156846
158525
|
{
|
|
156847
158526
|
"kind": "primitive",
|
|
@@ -272239,27 +273918,27 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
272239
273918
|
},
|
|
272240
273919
|
{
|
|
272241
273920
|
"kind": "string",
|
|
272242
|
-
"value": "
|
|
273921
|
+
"value": "subtext.medium"
|
|
272243
273922
|
},
|
|
272244
273923
|
{
|
|
272245
273924
|
"kind": "string",
|
|
272246
|
-
"value": "
|
|
273925
|
+
"value": "subtext.large"
|
|
272247
273926
|
},
|
|
272248
273927
|
{
|
|
272249
273928
|
"kind": "string",
|
|
272250
|
-
"value": "
|
|
273929
|
+
"value": "subtext.small"
|
|
272251
273930
|
},
|
|
272252
273931
|
{
|
|
272253
273932
|
"kind": "string",
|
|
272254
|
-
"value": "
|
|
273933
|
+
"value": "heading.medium"
|
|
272255
273934
|
},
|
|
272256
273935
|
{
|
|
272257
273936
|
"kind": "string",
|
|
272258
|
-
"value": "
|
|
273937
|
+
"value": "heading.large"
|
|
272259
273938
|
},
|
|
272260
273939
|
{
|
|
272261
273940
|
"kind": "string",
|
|
272262
|
-
"value": "
|
|
273941
|
+
"value": "heading.small"
|
|
272263
273942
|
}
|
|
272264
273943
|
]
|
|
272265
273944
|
},
|
|
@@ -276844,18 +278523,6 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
276844
278523
|
"kind": "string",
|
|
276845
278524
|
"value": "title.small"
|
|
276846
278525
|
},
|
|
276847
|
-
{
|
|
276848
|
-
"kind": "string",
|
|
276849
|
-
"value": "heading.medium"
|
|
276850
|
-
},
|
|
276851
|
-
{
|
|
276852
|
-
"kind": "string",
|
|
276853
|
-
"value": "heading.large"
|
|
276854
|
-
},
|
|
276855
|
-
{
|
|
276856
|
-
"kind": "string",
|
|
276857
|
-
"value": "heading.small"
|
|
276858
|
-
},
|
|
276859
278526
|
{
|
|
276860
278527
|
"kind": "string",
|
|
276861
278528
|
"value": "subtext.medium"
|
|
@@ -276867,779 +278534,6 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
276867
278534
|
{
|
|
276868
278535
|
"kind": "string",
|
|
276869
278536
|
"value": "subtext.small"
|
|
276870
|
-
}
|
|
276871
|
-
]
|
|
276872
|
-
},
|
|
276873
|
-
"description": "",
|
|
276874
|
-
"declarations": [
|
|
276875
|
-
{
|
|
276876
|
-
"name": "typeLevel",
|
|
276877
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/LabelText.tsx"
|
|
276878
|
-
}
|
|
276879
|
-
],
|
|
276880
|
-
"tags": {}
|
|
276881
|
-
},
|
|
276882
|
-
{
|
|
276883
|
-
"kind": "property",
|
|
276884
|
-
"name": "disabled",
|
|
276885
|
-
"required": false,
|
|
276886
|
-
"type": {
|
|
276887
|
-
"kind": "primitive",
|
|
276888
|
-
"value": "boolean"
|
|
276889
|
-
},
|
|
276890
|
-
"description": "Disabled state as a boolean\n\n```tsx\n<LabelText disabled={true}>Error text</LabelText>\n```",
|
|
276891
|
-
"declarations": [
|
|
276892
|
-
{
|
|
276893
|
-
"name": "disabled",
|
|
276894
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/LabelText.tsx"
|
|
276895
|
-
}
|
|
276896
|
-
],
|
|
276897
|
-
"tags": {}
|
|
276898
|
-
},
|
|
276899
|
-
{
|
|
276900
|
-
"kind": "property",
|
|
276901
|
-
"name": "variant",
|
|
276902
|
-
"required": false,
|
|
276903
|
-
"type": {
|
|
276904
|
-
"kind": "union",
|
|
276905
|
-
"value": [
|
|
276906
|
-
{
|
|
276907
|
-
"kind": "string",
|
|
276908
|
-
"value": "error"
|
|
276909
|
-
},
|
|
276910
|
-
{
|
|
276911
|
-
"kind": "string",
|
|
276912
|
-
"value": "hint"
|
|
276913
|
-
},
|
|
276914
|
-
{
|
|
276915
|
-
"kind": "string",
|
|
276916
|
-
"value": "inverse"
|
|
276917
|
-
}
|
|
276918
|
-
]
|
|
276919
|
-
},
|
|
276920
|
-
"description": "Type variant token names: `error`, `hint` or `inverse`.\n\n```tsx\n<LabelText variant=\"error\">Error text</LabelText>\n```",
|
|
276921
|
-
"declarations": [
|
|
276922
|
-
{
|
|
276923
|
-
"name": "variant",
|
|
276924
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/LabelText.tsx"
|
|
276925
|
-
}
|
|
276926
|
-
],
|
|
276927
|
-
"tags": {}
|
|
276928
|
-
},
|
|
276929
|
-
{
|
|
276930
|
-
"kind": "property",
|
|
276931
|
-
"name": "cs",
|
|
276932
|
-
"required": false,
|
|
276933
|
-
"type": {
|
|
276934
|
-
"kind": "symbol",
|
|
276935
|
-
"name": "CSToPropsInput",
|
|
276936
|
-
"value": "CSToPropsInput"
|
|
276937
|
-
},
|
|
276938
|
-
"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```",
|
|
276939
|
-
"declarations": [
|
|
276940
|
-
{
|
|
276941
|
-
"name": "cs",
|
|
276942
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
276943
|
-
}
|
|
276944
|
-
],
|
|
276945
|
-
"tags": {}
|
|
276946
|
-
},
|
|
276947
|
-
{
|
|
276948
|
-
"kind": "property",
|
|
276949
|
-
"name": "children",
|
|
276950
|
-
"required": false,
|
|
276951
|
-
"type": {
|
|
276952
|
-
"kind": "external",
|
|
276953
|
-
"name": "ReactNode",
|
|
276954
|
-
"url": "https://reactjs.org/docs/rendering-elements.html"
|
|
276955
|
-
},
|
|
276956
|
-
"description": "",
|
|
276957
|
-
"declarations": [
|
|
276958
|
-
{
|
|
276959
|
-
"name": "children",
|
|
276960
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/layout/lib/Box.tsx"
|
|
276961
|
-
}
|
|
276962
|
-
],
|
|
276963
|
-
"tags": {}
|
|
276964
|
-
},
|
|
276965
|
-
{
|
|
276966
|
-
"kind": "property",
|
|
276967
|
-
"name": "as",
|
|
276968
|
-
"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.",
|
|
276969
|
-
"tags": {},
|
|
276970
|
-
"declarations": [],
|
|
276971
|
-
"type": {
|
|
276972
|
-
"kind": "external",
|
|
276973
|
-
"name": "React.ElementType",
|
|
276974
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
|
|
276975
|
-
},
|
|
276976
|
-
"defaultValue": {
|
|
276977
|
-
"kind": "external",
|
|
276978
|
-
"name": "label",
|
|
276979
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/label"
|
|
276980
|
-
}
|
|
276981
|
-
},
|
|
276982
|
-
{
|
|
276983
|
-
"kind": "property",
|
|
276984
|
-
"name": "ref",
|
|
276985
|
-
"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`).",
|
|
276986
|
-
"tags": {},
|
|
276987
|
-
"declarations": [],
|
|
276988
|
-
"type": {
|
|
276989
|
-
"kind": "external",
|
|
276990
|
-
"name": "React.Ref",
|
|
276991
|
-
"url": "https://reactjs.org/docs/refs-and-the-dom.html",
|
|
276992
|
-
"typeParameters": [
|
|
276993
|
-
{
|
|
276994
|
-
"kind": "typeParameter",
|
|
276995
|
-
"name": "R",
|
|
276996
|
-
"required": true,
|
|
276997
|
-
"defaultValue": {
|
|
276998
|
-
"kind": "external",
|
|
276999
|
-
"name": "label",
|
|
277000
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/label"
|
|
277001
|
-
}
|
|
277002
|
-
}
|
|
277003
|
-
]
|
|
277004
|
-
}
|
|
277005
|
-
}
|
|
277006
|
-
],
|
|
277007
|
-
"baseElement": {
|
|
277008
|
-
"kind": "external",
|
|
277009
|
-
"name": "label",
|
|
277010
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/label"
|
|
277011
|
-
},
|
|
277012
|
-
"styleComponent": {
|
|
277013
|
-
"kind": "symbol",
|
|
277014
|
-
"name": "Box"
|
|
277015
|
-
}
|
|
277016
|
-
}
|
|
277017
|
-
},
|
|
277018
|
-
{
|
|
277019
|
-
"name": "TextProps",
|
|
277020
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/Text.tsx",
|
|
277021
|
-
"description": "",
|
|
277022
|
-
"declarations": [
|
|
277023
|
-
{
|
|
277024
|
-
"name": "TextProps",
|
|
277025
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/Text.tsx"
|
|
277026
|
-
}
|
|
277027
|
-
],
|
|
277028
|
-
"tags": {},
|
|
277029
|
-
"type": {
|
|
277030
|
-
"kind": "alias",
|
|
277031
|
-
"name": "Text"
|
|
277032
|
-
}
|
|
277033
|
-
},
|
|
277034
|
-
{
|
|
277035
|
-
"name": "textStencil",
|
|
277036
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/Text.tsx",
|
|
277037
|
-
"description": "",
|
|
277038
|
-
"declarations": [
|
|
277039
|
-
{
|
|
277040
|
-
"name": "textStencil",
|
|
277041
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/Text.tsx"
|
|
277042
|
-
}
|
|
277043
|
-
],
|
|
277044
|
-
"tags": {},
|
|
277045
|
-
"type": {
|
|
277046
|
-
"kind": "function",
|
|
277047
|
-
"parameters": [
|
|
277048
|
-
{
|
|
277049
|
-
"kind": "parameter",
|
|
277050
|
-
"name": "options",
|
|
277051
|
-
"type": {
|
|
277052
|
-
"kind": "conditional",
|
|
277053
|
-
"check": {
|
|
277054
|
-
"kind": "tuple",
|
|
277055
|
-
"value": [
|
|
277056
|
-
{
|
|
277057
|
-
"kind": "symbol",
|
|
277058
|
-
"name": "E",
|
|
277059
|
-
"value": "E"
|
|
277060
|
-
}
|
|
277061
|
-
]
|
|
277062
|
-
},
|
|
277063
|
-
"extends": {
|
|
277064
|
-
"kind": "tuple",
|
|
277065
|
-
"value": [
|
|
277066
|
-
{
|
|
277067
|
-
"kind": "primitive",
|
|
277068
|
-
"value": "never"
|
|
277069
|
-
}
|
|
277070
|
-
]
|
|
277071
|
-
},
|
|
277072
|
-
"trueType": {
|
|
277073
|
-
"kind": "intersection",
|
|
277074
|
-
"value": [
|
|
277075
|
-
{
|
|
277076
|
-
"kind": "symbol",
|
|
277077
|
-
"name": "ModifierValuesStencil",
|
|
277078
|
-
"typeParameters": [
|
|
277079
|
-
{
|
|
277080
|
-
"kind": "symbol",
|
|
277081
|
-
"name": "M",
|
|
277082
|
-
"value": "M"
|
|
277083
|
-
},
|
|
277084
|
-
{
|
|
277085
|
-
"kind": "symbol",
|
|
277086
|
-
"name": "V",
|
|
277087
|
-
"value": "V"
|
|
277088
|
-
}
|
|
277089
|
-
],
|
|
277090
|
-
"value": "ModifierValuesStencil<M, V>"
|
|
277091
|
-
},
|
|
277092
|
-
{
|
|
277093
|
-
"kind": "symbol",
|
|
277094
|
-
"name": "VariableValuesStencil",
|
|
277095
|
-
"typeParameters": [
|
|
277096
|
-
{
|
|
277097
|
-
"kind": "symbol",
|
|
277098
|
-
"name": "V",
|
|
277099
|
-
"value": "V"
|
|
277100
|
-
}
|
|
277101
|
-
],
|
|
277102
|
-
"value": "VariableValuesStencil<V>"
|
|
277103
|
-
}
|
|
277104
|
-
]
|
|
277105
|
-
},
|
|
277106
|
-
"falseType": {
|
|
277107
|
-
"kind": "conditional",
|
|
277108
|
-
"check": {
|
|
277109
|
-
"kind": "symbol",
|
|
277110
|
-
"name": "E",
|
|
277111
|
-
"value": "E"
|
|
277112
|
-
},
|
|
277113
|
-
"extends": {
|
|
277114
|
-
"kind": "symbol",
|
|
277115
|
-
"name": "BaseStencil",
|
|
277116
|
-
"typeParameters": [
|
|
277117
|
-
{
|
|
277118
|
-
"kind": "infer",
|
|
277119
|
-
"value": {
|
|
277120
|
-
"kind": "typeParameter",
|
|
277121
|
-
"name": "ME",
|
|
277122
|
-
"required": true
|
|
277123
|
-
}
|
|
277124
|
-
},
|
|
277125
|
-
{
|
|
277126
|
-
"kind": "infer",
|
|
277127
|
-
"value": {
|
|
277128
|
-
"kind": "typeParameter",
|
|
277129
|
-
"name": "VE",
|
|
277130
|
-
"required": true
|
|
277131
|
-
}
|
|
277132
|
-
},
|
|
277133
|
-
{
|
|
277134
|
-
"kind": "primitive",
|
|
277135
|
-
"value": "any"
|
|
277136
|
-
},
|
|
277137
|
-
{
|
|
277138
|
-
"kind": "primitive",
|
|
277139
|
-
"value": "any"
|
|
277140
|
-
}
|
|
277141
|
-
],
|
|
277142
|
-
"value": "BaseStencil<M, V, E, ID>"
|
|
277143
|
-
},
|
|
277144
|
-
"trueType": {
|
|
277145
|
-
"kind": "intersection",
|
|
277146
|
-
"value": [
|
|
277147
|
-
{
|
|
277148
|
-
"kind": "symbol",
|
|
277149
|
-
"name": "ModifierValuesStencil",
|
|
277150
|
-
"typeParameters": [
|
|
277151
|
-
{
|
|
277152
|
-
"kind": "intersection",
|
|
277153
|
-
"value": [
|
|
277154
|
-
{
|
|
277155
|
-
"kind": "symbol",
|
|
277156
|
-
"name": "ME",
|
|
277157
|
-
"value": "ME"
|
|
277158
|
-
},
|
|
277159
|
-
{
|
|
277160
|
-
"kind": "symbol",
|
|
277161
|
-
"name": "M",
|
|
277162
|
-
"value": "M"
|
|
277163
|
-
}
|
|
277164
|
-
]
|
|
277165
|
-
}
|
|
277166
|
-
],
|
|
277167
|
-
"value": "ModifierValuesStencil<M, V>"
|
|
277168
|
-
},
|
|
277169
|
-
{
|
|
277170
|
-
"kind": "symbol",
|
|
277171
|
-
"name": "VariableValuesStencil",
|
|
277172
|
-
"typeParameters": [
|
|
277173
|
-
{
|
|
277174
|
-
"kind": "intersection",
|
|
277175
|
-
"value": [
|
|
277176
|
-
{
|
|
277177
|
-
"kind": "symbol",
|
|
277178
|
-
"name": "VE",
|
|
277179
|
-
"value": "VE"
|
|
277180
|
-
},
|
|
277181
|
-
{
|
|
277182
|
-
"kind": "symbol",
|
|
277183
|
-
"name": "V",
|
|
277184
|
-
"value": "V"
|
|
277185
|
-
}
|
|
277186
|
-
]
|
|
277187
|
-
}
|
|
277188
|
-
],
|
|
277189
|
-
"value": "VariableValuesStencil<V>"
|
|
277190
|
-
}
|
|
277191
|
-
]
|
|
277192
|
-
},
|
|
277193
|
-
"falseType": {
|
|
277194
|
-
"kind": "primitive",
|
|
277195
|
-
"value": "never"
|
|
277196
|
-
}
|
|
277197
|
-
}
|
|
277198
|
-
},
|
|
277199
|
-
"required": false,
|
|
277200
|
-
"rest": false,
|
|
277201
|
-
"description": "",
|
|
277202
|
-
"declarations": [
|
|
277203
|
-
{
|
|
277204
|
-
"name": "options",
|
|
277205
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
277206
|
-
}
|
|
277207
|
-
],
|
|
277208
|
-
"tags": {}
|
|
277209
|
-
}
|
|
277210
|
-
],
|
|
277211
|
-
"members": [
|
|
277212
|
-
{
|
|
277213
|
-
"kind": "property",
|
|
277214
|
-
"name": "vars",
|
|
277215
|
-
"required": true,
|
|
277216
|
-
"type": {
|
|
277217
|
-
"kind": "symbol",
|
|
277218
|
-
"name": "StencilDefaultVars",
|
|
277219
|
-
"typeParameters": [
|
|
277220
|
-
{
|
|
277221
|
-
"kind": "symbol",
|
|
277222
|
-
"name": "V",
|
|
277223
|
-
"value": "V"
|
|
277224
|
-
},
|
|
277225
|
-
{
|
|
277226
|
-
"kind": "symbol",
|
|
277227
|
-
"name": "E",
|
|
277228
|
-
"value": "E"
|
|
277229
|
-
},
|
|
277230
|
-
{
|
|
277231
|
-
"kind": "symbol",
|
|
277232
|
-
"name": "ID",
|
|
277233
|
-
"value": "ID"
|
|
277234
|
-
}
|
|
277235
|
-
],
|
|
277236
|
-
"value": "StencilDefaultVars<V, E, ID>"
|
|
277237
|
-
},
|
|
277238
|
-
"description": "",
|
|
277239
|
-
"declarations": [
|
|
277240
|
-
{
|
|
277241
|
-
"name": "vars",
|
|
277242
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
277243
|
-
}
|
|
277244
|
-
],
|
|
277245
|
-
"tags": {}
|
|
277246
|
-
},
|
|
277247
|
-
{
|
|
277248
|
-
"kind": "property",
|
|
277249
|
-
"name": "base",
|
|
277250
|
-
"required": true,
|
|
277251
|
-
"type": {
|
|
277252
|
-
"kind": "primitive",
|
|
277253
|
-
"value": "string"
|
|
277254
|
-
},
|
|
277255
|
-
"description": "",
|
|
277256
|
-
"declarations": [
|
|
277257
|
-
{
|
|
277258
|
-
"name": "base",
|
|
277259
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
277260
|
-
}
|
|
277261
|
-
],
|
|
277262
|
-
"tags": {}
|
|
277263
|
-
},
|
|
277264
|
-
{
|
|
277265
|
-
"kind": "property",
|
|
277266
|
-
"name": "modifiers",
|
|
277267
|
-
"required": true,
|
|
277268
|
-
"type": {
|
|
277269
|
-
"kind": "conditional",
|
|
277270
|
-
"check": {
|
|
277271
|
-
"kind": "tuple",
|
|
277272
|
-
"value": [
|
|
277273
|
-
{
|
|
277274
|
-
"kind": "symbol",
|
|
277275
|
-
"name": "E",
|
|
277276
|
-
"value": "E"
|
|
277277
|
-
}
|
|
277278
|
-
]
|
|
277279
|
-
},
|
|
277280
|
-
"extends": {
|
|
277281
|
-
"kind": "tuple",
|
|
277282
|
-
"value": [
|
|
277283
|
-
{
|
|
277284
|
-
"kind": "symbol",
|
|
277285
|
-
"name": "BaseStencil",
|
|
277286
|
-
"typeParameters": [
|
|
277287
|
-
{
|
|
277288
|
-
"kind": "infer",
|
|
277289
|
-
"value": {
|
|
277290
|
-
"kind": "typeParameter",
|
|
277291
|
-
"name": "ME",
|
|
277292
|
-
"required": true
|
|
277293
|
-
}
|
|
277294
|
-
},
|
|
277295
|
-
{
|
|
277296
|
-
"kind": "infer",
|
|
277297
|
-
"value": {
|
|
277298
|
-
"kind": "typeParameter",
|
|
277299
|
-
"name": "VE",
|
|
277300
|
-
"required": true
|
|
277301
|
-
}
|
|
277302
|
-
},
|
|
277303
|
-
{
|
|
277304
|
-
"kind": "primitive",
|
|
277305
|
-
"value": "any"
|
|
277306
|
-
},
|
|
277307
|
-
{
|
|
277308
|
-
"kind": "primitive",
|
|
277309
|
-
"value": "any"
|
|
277310
|
-
}
|
|
277311
|
-
],
|
|
277312
|
-
"value": "BaseStencil<M, V, E, ID>"
|
|
277313
|
-
}
|
|
277314
|
-
]
|
|
277315
|
-
},
|
|
277316
|
-
"trueType": {
|
|
277317
|
-
"kind": "symbol",
|
|
277318
|
-
"name": "StencilModifierReturn",
|
|
277319
|
-
"typeParameters": [
|
|
277320
|
-
{
|
|
277321
|
-
"kind": "intersection",
|
|
277322
|
-
"value": [
|
|
277323
|
-
{
|
|
277324
|
-
"kind": "symbol",
|
|
277325
|
-
"name": "ME",
|
|
277326
|
-
"value": "ME"
|
|
277327
|
-
},
|
|
277328
|
-
{
|
|
277329
|
-
"kind": "symbol",
|
|
277330
|
-
"name": "M",
|
|
277331
|
-
"value": "M"
|
|
277332
|
-
}
|
|
277333
|
-
]
|
|
277334
|
-
},
|
|
277335
|
-
{
|
|
277336
|
-
"kind": "intersection",
|
|
277337
|
-
"value": [
|
|
277338
|
-
{
|
|
277339
|
-
"kind": "symbol",
|
|
277340
|
-
"name": "VE",
|
|
277341
|
-
"value": "VE"
|
|
277342
|
-
},
|
|
277343
|
-
{
|
|
277344
|
-
"kind": "symbol",
|
|
277345
|
-
"name": "V",
|
|
277346
|
-
"value": "V"
|
|
277347
|
-
}
|
|
277348
|
-
]
|
|
277349
|
-
}
|
|
277350
|
-
],
|
|
277351
|
-
"value": "StencilModifierReturn<M, V>"
|
|
277352
|
-
},
|
|
277353
|
-
"falseType": {
|
|
277354
|
-
"kind": "symbol",
|
|
277355
|
-
"name": "StencilModifierReturn",
|
|
277356
|
-
"typeParameters": [
|
|
277357
|
-
{
|
|
277358
|
-
"kind": "symbol",
|
|
277359
|
-
"name": "M",
|
|
277360
|
-
"value": "M"
|
|
277361
|
-
},
|
|
277362
|
-
{
|
|
277363
|
-
"kind": "symbol",
|
|
277364
|
-
"name": "V",
|
|
277365
|
-
"value": "V"
|
|
277366
|
-
}
|
|
277367
|
-
],
|
|
277368
|
-
"value": "StencilModifierReturn<M, V>"
|
|
277369
|
-
}
|
|
277370
|
-
},
|
|
277371
|
-
"description": "",
|
|
277372
|
-
"declarations": [
|
|
277373
|
-
{
|
|
277374
|
-
"name": "modifiers",
|
|
277375
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
277376
|
-
}
|
|
277377
|
-
],
|
|
277378
|
-
"tags": {}
|
|
277379
|
-
},
|
|
277380
|
-
{
|
|
277381
|
-
"kind": "property",
|
|
277382
|
-
"name": "defaultModifiers",
|
|
277383
|
-
"required": true,
|
|
277384
|
-
"type": {
|
|
277385
|
-
"kind": "conditional",
|
|
277386
|
-
"check": {
|
|
277387
|
-
"kind": "tuple",
|
|
277388
|
-
"value": [
|
|
277389
|
-
{
|
|
277390
|
-
"kind": "symbol",
|
|
277391
|
-
"name": "E",
|
|
277392
|
-
"value": "E"
|
|
277393
|
-
}
|
|
277394
|
-
]
|
|
277395
|
-
},
|
|
277396
|
-
"extends": {
|
|
277397
|
-
"kind": "tuple",
|
|
277398
|
-
"value": [
|
|
277399
|
-
{
|
|
277400
|
-
"kind": "symbol",
|
|
277401
|
-
"name": "BaseStencil",
|
|
277402
|
-
"typeParameters": [
|
|
277403
|
-
{
|
|
277404
|
-
"kind": "infer",
|
|
277405
|
-
"value": {
|
|
277406
|
-
"kind": "typeParameter",
|
|
277407
|
-
"name": "ME",
|
|
277408
|
-
"required": true
|
|
277409
|
-
}
|
|
277410
|
-
},
|
|
277411
|
-
{
|
|
277412
|
-
"kind": "primitive",
|
|
277413
|
-
"value": "any"
|
|
277414
|
-
},
|
|
277415
|
-
{
|
|
277416
|
-
"kind": "primitive",
|
|
277417
|
-
"value": "any"
|
|
277418
|
-
},
|
|
277419
|
-
{
|
|
277420
|
-
"kind": "primitive",
|
|
277421
|
-
"value": "any"
|
|
277422
|
-
}
|
|
277423
|
-
],
|
|
277424
|
-
"value": "BaseStencil<M, V, E, ID>"
|
|
277425
|
-
}
|
|
277426
|
-
]
|
|
277427
|
-
},
|
|
277428
|
-
"trueType": {
|
|
277429
|
-
"kind": "symbol",
|
|
277430
|
-
"name": "StencilDefaultModifierReturn",
|
|
277431
|
-
"typeParameters": [
|
|
277432
|
-
{
|
|
277433
|
-
"kind": "intersection",
|
|
277434
|
-
"value": [
|
|
277435
|
-
{
|
|
277436
|
-
"kind": "symbol",
|
|
277437
|
-
"name": "ME",
|
|
277438
|
-
"value": "ME"
|
|
277439
|
-
},
|
|
277440
|
-
{
|
|
277441
|
-
"kind": "symbol",
|
|
277442
|
-
"name": "M",
|
|
277443
|
-
"value": "M"
|
|
277444
|
-
}
|
|
277445
|
-
]
|
|
277446
|
-
}
|
|
277447
|
-
],
|
|
277448
|
-
"value": "StencilDefaultModifierReturn<M>"
|
|
277449
|
-
},
|
|
277450
|
-
"falseType": {
|
|
277451
|
-
"kind": "symbol",
|
|
277452
|
-
"name": "StencilDefaultModifierReturn",
|
|
277453
|
-
"typeParameters": [
|
|
277454
|
-
{
|
|
277455
|
-
"kind": "symbol",
|
|
277456
|
-
"name": "M",
|
|
277457
|
-
"value": "M"
|
|
277458
|
-
}
|
|
277459
|
-
],
|
|
277460
|
-
"value": "StencilDefaultModifierReturn<M>"
|
|
277461
|
-
}
|
|
277462
|
-
},
|
|
277463
|
-
"description": "",
|
|
277464
|
-
"declarations": [
|
|
277465
|
-
{
|
|
277466
|
-
"name": "defaultModifiers",
|
|
277467
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
277468
|
-
}
|
|
277469
|
-
],
|
|
277470
|
-
"tags": {}
|
|
277471
|
-
},
|
|
277472
|
-
{
|
|
277473
|
-
"kind": "property",
|
|
277474
|
-
"name": "__extends",
|
|
277475
|
-
"required": false,
|
|
277476
|
-
"type": {
|
|
277477
|
-
"kind": "symbol",
|
|
277478
|
-
"name": "E",
|
|
277479
|
-
"value": "E"
|
|
277480
|
-
},
|
|
277481
|
-
"description": "",
|
|
277482
|
-
"declarations": [
|
|
277483
|
-
{
|
|
277484
|
-
"name": "__extends",
|
|
277485
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
277486
|
-
}
|
|
277487
|
-
],
|
|
277488
|
-
"tags": {}
|
|
277489
|
-
},
|
|
277490
|
-
{
|
|
277491
|
-
"kind": "property",
|
|
277492
|
-
"name": "__vars",
|
|
277493
|
-
"required": true,
|
|
277494
|
-
"type": {
|
|
277495
|
-
"kind": "symbol",
|
|
277496
|
-
"name": "V",
|
|
277497
|
-
"value": "V"
|
|
277498
|
-
},
|
|
277499
|
-
"description": "",
|
|
277500
|
-
"declarations": [
|
|
277501
|
-
{
|
|
277502
|
-
"name": "__vars",
|
|
277503
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
277504
|
-
}
|
|
277505
|
-
],
|
|
277506
|
-
"tags": {}
|
|
277507
|
-
},
|
|
277508
|
-
{
|
|
277509
|
-
"kind": "property",
|
|
277510
|
-
"name": "__modifiers",
|
|
277511
|
-
"required": true,
|
|
277512
|
-
"type": {
|
|
277513
|
-
"kind": "symbol",
|
|
277514
|
-
"name": "M",
|
|
277515
|
-
"value": "M"
|
|
277516
|
-
},
|
|
277517
|
-
"description": "",
|
|
277518
|
-
"declarations": [
|
|
277519
|
-
{
|
|
277520
|
-
"name": "__modifiers",
|
|
277521
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
277522
|
-
}
|
|
277523
|
-
],
|
|
277524
|
-
"tags": {}
|
|
277525
|
-
},
|
|
277526
|
-
{
|
|
277527
|
-
"kind": "property",
|
|
277528
|
-
"name": "__id",
|
|
277529
|
-
"required": true,
|
|
277530
|
-
"type": {
|
|
277531
|
-
"kind": "symbol",
|
|
277532
|
-
"name": "ID",
|
|
277533
|
-
"value": "ID"
|
|
277534
|
-
},
|
|
277535
|
-
"description": "",
|
|
277536
|
-
"declarations": [
|
|
277537
|
-
{
|
|
277538
|
-
"name": "__id",
|
|
277539
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
277540
|
-
}
|
|
277541
|
-
],
|
|
277542
|
-
"tags": {}
|
|
277543
|
-
}
|
|
277544
|
-
],
|
|
277545
|
-
"returnType": {
|
|
277546
|
-
"kind": "object",
|
|
277547
|
-
"properties": [
|
|
277548
|
-
{
|
|
277549
|
-
"kind": "property",
|
|
277550
|
-
"name": "className",
|
|
277551
|
-
"required": true,
|
|
277552
|
-
"type": {
|
|
277553
|
-
"kind": "primitive",
|
|
277554
|
-
"value": "string"
|
|
277555
|
-
},
|
|
277556
|
-
"description": "",
|
|
277557
|
-
"declarations": [
|
|
277558
|
-
{
|
|
277559
|
-
"name": "className",
|
|
277560
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
277561
|
-
}
|
|
277562
|
-
],
|
|
277563
|
-
"tags": {}
|
|
277564
|
-
},
|
|
277565
|
-
{
|
|
277566
|
-
"kind": "property",
|
|
277567
|
-
"name": "style",
|
|
277568
|
-
"required": false,
|
|
277569
|
-
"type": {
|
|
277570
|
-
"kind": "external",
|
|
277571
|
-
"name": "Record",
|
|
277572
|
-
"url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
|
|
277573
|
-
"typeParameters": [
|
|
277574
|
-
{
|
|
277575
|
-
"kind": "primitive",
|
|
277576
|
-
"value": "string"
|
|
277577
|
-
},
|
|
277578
|
-
{
|
|
277579
|
-
"kind": "primitive",
|
|
277580
|
-
"value": "string"
|
|
277581
|
-
}
|
|
277582
|
-
]
|
|
277583
|
-
},
|
|
277584
|
-
"description": "",
|
|
277585
|
-
"declarations": [
|
|
277586
|
-
{
|
|
277587
|
-
"name": "style",
|
|
277588
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
277589
|
-
}
|
|
277590
|
-
],
|
|
277591
|
-
"tags": {}
|
|
277592
|
-
}
|
|
277593
|
-
]
|
|
277594
|
-
}
|
|
277595
|
-
}
|
|
277596
|
-
},
|
|
277597
|
-
{
|
|
277598
|
-
"name": "Text",
|
|
277599
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/Text.tsx",
|
|
277600
|
-
"description": "This is a generic base component intended to render any text.\nIt has `typeLevel` and `variant` style props that simplify navigating\nour type hierarchy and using [Canvas type tokens](https://canvas.workday.com/tokens/type#type-styles).\nBy default, it renders a semantic `span` element,\nbut you can adjust this as needed with the `as` prop.\n\nThe type hierarchy is organized into four levels, which correspond to our [Canvas type\nlevels](https://canvas.workday.com/tokens/type#type-styles).\n\n- `title`: Intended to be used for large page titles.\n- `heading`: Intended to be used for headings and large text.\n- `body`: Intended to be used for standard body text.\n- `subtext`: Intended to be used for small subtext content or in tight spaces.\n\nEach level has three sizes: `large`, `medium`, and `small`.\n\nYou can provide any level and size to the `typeLevel` prop, and it will apply the correct styles\naccordingly. In the example below we're providing the `subtext` level and `small` size to the\ncomponent with the value `subtext.small`.\n\n```tsx\nimport { Text } from '@workday/canvas-kit-react/text';\n\nconst CustomErrorText = () => (\n <Text typeLevel=\"subtext.small\" variant=\"error\">\n Error Text\n </Text>\n);\n```",
|
|
277601
|
-
"declarations": [
|
|
277602
|
-
{
|
|
277603
|
-
"name": "Text",
|
|
277604
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/Text.tsx"
|
|
277605
|
-
}
|
|
277606
|
-
],
|
|
277607
|
-
"tags": {},
|
|
277608
|
-
"type": {
|
|
277609
|
-
"kind": "enhancedComponent",
|
|
277610
|
-
"componentType": "regular",
|
|
277611
|
-
"displayName": "Text",
|
|
277612
|
-
"props": [
|
|
277613
|
-
{
|
|
277614
|
-
"kind": "property",
|
|
277615
|
-
"name": "typeLevel",
|
|
277616
|
-
"required": false,
|
|
277617
|
-
"type": {
|
|
277618
|
-
"kind": "union",
|
|
277619
|
-
"value": [
|
|
277620
|
-
{
|
|
277621
|
-
"kind": "string",
|
|
277622
|
-
"value": "body.medium"
|
|
277623
|
-
},
|
|
277624
|
-
{
|
|
277625
|
-
"kind": "string",
|
|
277626
|
-
"value": "body.large"
|
|
277627
|
-
},
|
|
277628
|
-
{
|
|
277629
|
-
"kind": "string",
|
|
277630
|
-
"value": "body.small"
|
|
277631
|
-
},
|
|
277632
|
-
{
|
|
277633
|
-
"kind": "string",
|
|
277634
|
-
"value": "title.medium"
|
|
277635
|
-
},
|
|
277636
|
-
{
|
|
277637
|
-
"kind": "string",
|
|
277638
|
-
"value": "title.large"
|
|
277639
|
-
},
|
|
277640
|
-
{
|
|
277641
|
-
"kind": "string",
|
|
277642
|
-
"value": "title.small"
|
|
277643
278537
|
},
|
|
277644
278538
|
{
|
|
277645
278539
|
"kind": "string",
|
|
@@ -277652,18 +278546,803 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
277652
278546
|
{
|
|
277653
278547
|
"kind": "string",
|
|
277654
278548
|
"value": "heading.small"
|
|
277655
|
-
}
|
|
277656
|
-
|
|
277657
|
-
|
|
277658
|
-
|
|
277659
|
-
|
|
277660
|
-
|
|
277661
|
-
|
|
277662
|
-
|
|
277663
|
-
|
|
277664
|
-
|
|
277665
|
-
|
|
277666
|
-
|
|
278549
|
+
}
|
|
278550
|
+
]
|
|
278551
|
+
},
|
|
278552
|
+
"description": "",
|
|
278553
|
+
"declarations": [
|
|
278554
|
+
{
|
|
278555
|
+
"name": "typeLevel",
|
|
278556
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/LabelText.tsx"
|
|
278557
|
+
}
|
|
278558
|
+
],
|
|
278559
|
+
"tags": {}
|
|
278560
|
+
},
|
|
278561
|
+
{
|
|
278562
|
+
"kind": "property",
|
|
278563
|
+
"name": "disabled",
|
|
278564
|
+
"required": false,
|
|
278565
|
+
"type": {
|
|
278566
|
+
"kind": "primitive",
|
|
278567
|
+
"value": "boolean"
|
|
278568
|
+
},
|
|
278569
|
+
"description": "Disabled state as a boolean\n\n```tsx\n<LabelText disabled={true}>Error text</LabelText>\n```",
|
|
278570
|
+
"declarations": [
|
|
278571
|
+
{
|
|
278572
|
+
"name": "disabled",
|
|
278573
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/LabelText.tsx"
|
|
278574
|
+
}
|
|
278575
|
+
],
|
|
278576
|
+
"tags": {}
|
|
278577
|
+
},
|
|
278578
|
+
{
|
|
278579
|
+
"kind": "property",
|
|
278580
|
+
"name": "variant",
|
|
278581
|
+
"required": false,
|
|
278582
|
+
"type": {
|
|
278583
|
+
"kind": "union",
|
|
278584
|
+
"value": [
|
|
278585
|
+
{
|
|
278586
|
+
"kind": "string",
|
|
278587
|
+
"value": "error"
|
|
278588
|
+
},
|
|
278589
|
+
{
|
|
278590
|
+
"kind": "string",
|
|
278591
|
+
"value": "hint"
|
|
278592
|
+
},
|
|
278593
|
+
{
|
|
278594
|
+
"kind": "string",
|
|
278595
|
+
"value": "inverse"
|
|
278596
|
+
}
|
|
278597
|
+
]
|
|
278598
|
+
},
|
|
278599
|
+
"description": "Type variant token names: `error`, `hint` or `inverse`.\n\n```tsx\n<LabelText variant=\"error\">Error text</LabelText>\n```",
|
|
278600
|
+
"declarations": [
|
|
278601
|
+
{
|
|
278602
|
+
"name": "variant",
|
|
278603
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/LabelText.tsx"
|
|
278604
|
+
}
|
|
278605
|
+
],
|
|
278606
|
+
"tags": {}
|
|
278607
|
+
},
|
|
278608
|
+
{
|
|
278609
|
+
"kind": "property",
|
|
278610
|
+
"name": "cs",
|
|
278611
|
+
"required": false,
|
|
278612
|
+
"type": {
|
|
278613
|
+
"kind": "symbol",
|
|
278614
|
+
"name": "CSToPropsInput",
|
|
278615
|
+
"value": "CSToPropsInput"
|
|
278616
|
+
},
|
|
278617
|
+
"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```",
|
|
278618
|
+
"declarations": [
|
|
278619
|
+
{
|
|
278620
|
+
"name": "cs",
|
|
278621
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
278622
|
+
}
|
|
278623
|
+
],
|
|
278624
|
+
"tags": {}
|
|
278625
|
+
},
|
|
278626
|
+
{
|
|
278627
|
+
"kind": "property",
|
|
278628
|
+
"name": "children",
|
|
278629
|
+
"required": false,
|
|
278630
|
+
"type": {
|
|
278631
|
+
"kind": "external",
|
|
278632
|
+
"name": "ReactNode",
|
|
278633
|
+
"url": "https://reactjs.org/docs/rendering-elements.html"
|
|
278634
|
+
},
|
|
278635
|
+
"description": "",
|
|
278636
|
+
"declarations": [
|
|
278637
|
+
{
|
|
278638
|
+
"name": "children",
|
|
278639
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/layout/lib/Box.tsx"
|
|
278640
|
+
}
|
|
278641
|
+
],
|
|
278642
|
+
"tags": {}
|
|
278643
|
+
},
|
|
278644
|
+
{
|
|
278645
|
+
"kind": "property",
|
|
278646
|
+
"name": "as",
|
|
278647
|
+
"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.",
|
|
278648
|
+
"tags": {},
|
|
278649
|
+
"declarations": [],
|
|
278650
|
+
"type": {
|
|
278651
|
+
"kind": "external",
|
|
278652
|
+
"name": "React.ElementType",
|
|
278653
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
|
|
278654
|
+
},
|
|
278655
|
+
"defaultValue": {
|
|
278656
|
+
"kind": "external",
|
|
278657
|
+
"name": "label",
|
|
278658
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/label"
|
|
278659
|
+
}
|
|
278660
|
+
},
|
|
278661
|
+
{
|
|
278662
|
+
"kind": "property",
|
|
278663
|
+
"name": "ref",
|
|
278664
|
+
"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`).",
|
|
278665
|
+
"tags": {},
|
|
278666
|
+
"declarations": [],
|
|
278667
|
+
"type": {
|
|
278668
|
+
"kind": "external",
|
|
278669
|
+
"name": "React.Ref",
|
|
278670
|
+
"url": "https://reactjs.org/docs/refs-and-the-dom.html",
|
|
278671
|
+
"typeParameters": [
|
|
278672
|
+
{
|
|
278673
|
+
"kind": "typeParameter",
|
|
278674
|
+
"name": "R",
|
|
278675
|
+
"required": true,
|
|
278676
|
+
"defaultValue": {
|
|
278677
|
+
"kind": "external",
|
|
278678
|
+
"name": "label",
|
|
278679
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/label"
|
|
278680
|
+
}
|
|
278681
|
+
}
|
|
278682
|
+
]
|
|
278683
|
+
}
|
|
278684
|
+
}
|
|
278685
|
+
],
|
|
278686
|
+
"baseElement": {
|
|
278687
|
+
"kind": "external",
|
|
278688
|
+
"name": "label",
|
|
278689
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/label"
|
|
278690
|
+
},
|
|
278691
|
+
"styleComponent": {
|
|
278692
|
+
"kind": "symbol",
|
|
278693
|
+
"name": "Box"
|
|
278694
|
+
}
|
|
278695
|
+
}
|
|
278696
|
+
},
|
|
278697
|
+
{
|
|
278698
|
+
"name": "TextProps",
|
|
278699
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/Text.tsx",
|
|
278700
|
+
"description": "",
|
|
278701
|
+
"declarations": [
|
|
278702
|
+
{
|
|
278703
|
+
"name": "TextProps",
|
|
278704
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/Text.tsx"
|
|
278705
|
+
}
|
|
278706
|
+
],
|
|
278707
|
+
"tags": {},
|
|
278708
|
+
"type": {
|
|
278709
|
+
"kind": "alias",
|
|
278710
|
+
"name": "Text"
|
|
278711
|
+
}
|
|
278712
|
+
},
|
|
278713
|
+
{
|
|
278714
|
+
"name": "textStencil",
|
|
278715
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/Text.tsx",
|
|
278716
|
+
"description": "",
|
|
278717
|
+
"declarations": [
|
|
278718
|
+
{
|
|
278719
|
+
"name": "textStencil",
|
|
278720
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/Text.tsx"
|
|
278721
|
+
}
|
|
278722
|
+
],
|
|
278723
|
+
"tags": {},
|
|
278724
|
+
"type": {
|
|
278725
|
+
"kind": "function",
|
|
278726
|
+
"parameters": [
|
|
278727
|
+
{
|
|
278728
|
+
"kind": "parameter",
|
|
278729
|
+
"name": "options",
|
|
278730
|
+
"type": {
|
|
278731
|
+
"kind": "conditional",
|
|
278732
|
+
"check": {
|
|
278733
|
+
"kind": "tuple",
|
|
278734
|
+
"value": [
|
|
278735
|
+
{
|
|
278736
|
+
"kind": "symbol",
|
|
278737
|
+
"name": "E",
|
|
278738
|
+
"value": "E"
|
|
278739
|
+
}
|
|
278740
|
+
]
|
|
278741
|
+
},
|
|
278742
|
+
"extends": {
|
|
278743
|
+
"kind": "tuple",
|
|
278744
|
+
"value": [
|
|
278745
|
+
{
|
|
278746
|
+
"kind": "primitive",
|
|
278747
|
+
"value": "never"
|
|
278748
|
+
}
|
|
278749
|
+
]
|
|
278750
|
+
},
|
|
278751
|
+
"trueType": {
|
|
278752
|
+
"kind": "intersection",
|
|
278753
|
+
"value": [
|
|
278754
|
+
{
|
|
278755
|
+
"kind": "symbol",
|
|
278756
|
+
"name": "ModifierValuesStencil",
|
|
278757
|
+
"typeParameters": [
|
|
278758
|
+
{
|
|
278759
|
+
"kind": "symbol",
|
|
278760
|
+
"name": "M",
|
|
278761
|
+
"value": "M"
|
|
278762
|
+
},
|
|
278763
|
+
{
|
|
278764
|
+
"kind": "symbol",
|
|
278765
|
+
"name": "V",
|
|
278766
|
+
"value": "V"
|
|
278767
|
+
}
|
|
278768
|
+
],
|
|
278769
|
+
"value": "ModifierValuesStencil<M, V>"
|
|
278770
|
+
},
|
|
278771
|
+
{
|
|
278772
|
+
"kind": "symbol",
|
|
278773
|
+
"name": "VariableValuesStencil",
|
|
278774
|
+
"typeParameters": [
|
|
278775
|
+
{
|
|
278776
|
+
"kind": "symbol",
|
|
278777
|
+
"name": "V",
|
|
278778
|
+
"value": "V"
|
|
278779
|
+
}
|
|
278780
|
+
],
|
|
278781
|
+
"value": "VariableValuesStencil<V>"
|
|
278782
|
+
}
|
|
278783
|
+
]
|
|
278784
|
+
},
|
|
278785
|
+
"falseType": {
|
|
278786
|
+
"kind": "conditional",
|
|
278787
|
+
"check": {
|
|
278788
|
+
"kind": "symbol",
|
|
278789
|
+
"name": "E",
|
|
278790
|
+
"value": "E"
|
|
278791
|
+
},
|
|
278792
|
+
"extends": {
|
|
278793
|
+
"kind": "symbol",
|
|
278794
|
+
"name": "BaseStencil",
|
|
278795
|
+
"typeParameters": [
|
|
278796
|
+
{
|
|
278797
|
+
"kind": "infer",
|
|
278798
|
+
"value": {
|
|
278799
|
+
"kind": "typeParameter",
|
|
278800
|
+
"name": "ME",
|
|
278801
|
+
"required": true
|
|
278802
|
+
}
|
|
278803
|
+
},
|
|
278804
|
+
{
|
|
278805
|
+
"kind": "infer",
|
|
278806
|
+
"value": {
|
|
278807
|
+
"kind": "typeParameter",
|
|
278808
|
+
"name": "VE",
|
|
278809
|
+
"required": true
|
|
278810
|
+
}
|
|
278811
|
+
},
|
|
278812
|
+
{
|
|
278813
|
+
"kind": "primitive",
|
|
278814
|
+
"value": "any"
|
|
278815
|
+
},
|
|
278816
|
+
{
|
|
278817
|
+
"kind": "primitive",
|
|
278818
|
+
"value": "any"
|
|
278819
|
+
}
|
|
278820
|
+
],
|
|
278821
|
+
"value": "BaseStencil<M, V, E, ID>"
|
|
278822
|
+
},
|
|
278823
|
+
"trueType": {
|
|
278824
|
+
"kind": "intersection",
|
|
278825
|
+
"value": [
|
|
278826
|
+
{
|
|
278827
|
+
"kind": "symbol",
|
|
278828
|
+
"name": "ModifierValuesStencil",
|
|
278829
|
+
"typeParameters": [
|
|
278830
|
+
{
|
|
278831
|
+
"kind": "intersection",
|
|
278832
|
+
"value": [
|
|
278833
|
+
{
|
|
278834
|
+
"kind": "symbol",
|
|
278835
|
+
"name": "ME",
|
|
278836
|
+
"value": "ME"
|
|
278837
|
+
},
|
|
278838
|
+
{
|
|
278839
|
+
"kind": "symbol",
|
|
278840
|
+
"name": "M",
|
|
278841
|
+
"value": "M"
|
|
278842
|
+
}
|
|
278843
|
+
]
|
|
278844
|
+
}
|
|
278845
|
+
],
|
|
278846
|
+
"value": "ModifierValuesStencil<M, V>"
|
|
278847
|
+
},
|
|
278848
|
+
{
|
|
278849
|
+
"kind": "symbol",
|
|
278850
|
+
"name": "VariableValuesStencil",
|
|
278851
|
+
"typeParameters": [
|
|
278852
|
+
{
|
|
278853
|
+
"kind": "intersection",
|
|
278854
|
+
"value": [
|
|
278855
|
+
{
|
|
278856
|
+
"kind": "symbol",
|
|
278857
|
+
"name": "VE",
|
|
278858
|
+
"value": "VE"
|
|
278859
|
+
},
|
|
278860
|
+
{
|
|
278861
|
+
"kind": "symbol",
|
|
278862
|
+
"name": "V",
|
|
278863
|
+
"value": "V"
|
|
278864
|
+
}
|
|
278865
|
+
]
|
|
278866
|
+
}
|
|
278867
|
+
],
|
|
278868
|
+
"value": "VariableValuesStencil<V>"
|
|
278869
|
+
}
|
|
278870
|
+
]
|
|
278871
|
+
},
|
|
278872
|
+
"falseType": {
|
|
278873
|
+
"kind": "primitive",
|
|
278874
|
+
"value": "never"
|
|
278875
|
+
}
|
|
278876
|
+
}
|
|
278877
|
+
},
|
|
278878
|
+
"required": false,
|
|
278879
|
+
"rest": false,
|
|
278880
|
+
"description": "",
|
|
278881
|
+
"declarations": [
|
|
278882
|
+
{
|
|
278883
|
+
"name": "options",
|
|
278884
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
278885
|
+
}
|
|
278886
|
+
],
|
|
278887
|
+
"tags": {}
|
|
278888
|
+
}
|
|
278889
|
+
],
|
|
278890
|
+
"members": [
|
|
278891
|
+
{
|
|
278892
|
+
"kind": "property",
|
|
278893
|
+
"name": "vars",
|
|
278894
|
+
"required": true,
|
|
278895
|
+
"type": {
|
|
278896
|
+
"kind": "symbol",
|
|
278897
|
+
"name": "StencilDefaultVars",
|
|
278898
|
+
"typeParameters": [
|
|
278899
|
+
{
|
|
278900
|
+
"kind": "symbol",
|
|
278901
|
+
"name": "V",
|
|
278902
|
+
"value": "V"
|
|
278903
|
+
},
|
|
278904
|
+
{
|
|
278905
|
+
"kind": "symbol",
|
|
278906
|
+
"name": "E",
|
|
278907
|
+
"value": "E"
|
|
278908
|
+
},
|
|
278909
|
+
{
|
|
278910
|
+
"kind": "symbol",
|
|
278911
|
+
"name": "ID",
|
|
278912
|
+
"value": "ID"
|
|
278913
|
+
}
|
|
278914
|
+
],
|
|
278915
|
+
"value": "StencilDefaultVars<V, E, ID>"
|
|
278916
|
+
},
|
|
278917
|
+
"description": "",
|
|
278918
|
+
"declarations": [
|
|
278919
|
+
{
|
|
278920
|
+
"name": "vars",
|
|
278921
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
278922
|
+
}
|
|
278923
|
+
],
|
|
278924
|
+
"tags": {}
|
|
278925
|
+
},
|
|
278926
|
+
{
|
|
278927
|
+
"kind": "property",
|
|
278928
|
+
"name": "base",
|
|
278929
|
+
"required": true,
|
|
278930
|
+
"type": {
|
|
278931
|
+
"kind": "primitive",
|
|
278932
|
+
"value": "string"
|
|
278933
|
+
},
|
|
278934
|
+
"description": "",
|
|
278935
|
+
"declarations": [
|
|
278936
|
+
{
|
|
278937
|
+
"name": "base",
|
|
278938
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
278939
|
+
}
|
|
278940
|
+
],
|
|
278941
|
+
"tags": {}
|
|
278942
|
+
},
|
|
278943
|
+
{
|
|
278944
|
+
"kind": "property",
|
|
278945
|
+
"name": "modifiers",
|
|
278946
|
+
"required": true,
|
|
278947
|
+
"type": {
|
|
278948
|
+
"kind": "conditional",
|
|
278949
|
+
"check": {
|
|
278950
|
+
"kind": "tuple",
|
|
278951
|
+
"value": [
|
|
278952
|
+
{
|
|
278953
|
+
"kind": "symbol",
|
|
278954
|
+
"name": "E",
|
|
278955
|
+
"value": "E"
|
|
278956
|
+
}
|
|
278957
|
+
]
|
|
278958
|
+
},
|
|
278959
|
+
"extends": {
|
|
278960
|
+
"kind": "tuple",
|
|
278961
|
+
"value": [
|
|
278962
|
+
{
|
|
278963
|
+
"kind": "symbol",
|
|
278964
|
+
"name": "BaseStencil",
|
|
278965
|
+
"typeParameters": [
|
|
278966
|
+
{
|
|
278967
|
+
"kind": "infer",
|
|
278968
|
+
"value": {
|
|
278969
|
+
"kind": "typeParameter",
|
|
278970
|
+
"name": "ME",
|
|
278971
|
+
"required": true
|
|
278972
|
+
}
|
|
278973
|
+
},
|
|
278974
|
+
{
|
|
278975
|
+
"kind": "infer",
|
|
278976
|
+
"value": {
|
|
278977
|
+
"kind": "typeParameter",
|
|
278978
|
+
"name": "VE",
|
|
278979
|
+
"required": true
|
|
278980
|
+
}
|
|
278981
|
+
},
|
|
278982
|
+
{
|
|
278983
|
+
"kind": "primitive",
|
|
278984
|
+
"value": "any"
|
|
278985
|
+
},
|
|
278986
|
+
{
|
|
278987
|
+
"kind": "primitive",
|
|
278988
|
+
"value": "any"
|
|
278989
|
+
}
|
|
278990
|
+
],
|
|
278991
|
+
"value": "BaseStencil<M, V, E, ID>"
|
|
278992
|
+
}
|
|
278993
|
+
]
|
|
278994
|
+
},
|
|
278995
|
+
"trueType": {
|
|
278996
|
+
"kind": "symbol",
|
|
278997
|
+
"name": "StencilModifierReturn",
|
|
278998
|
+
"typeParameters": [
|
|
278999
|
+
{
|
|
279000
|
+
"kind": "intersection",
|
|
279001
|
+
"value": [
|
|
279002
|
+
{
|
|
279003
|
+
"kind": "symbol",
|
|
279004
|
+
"name": "ME",
|
|
279005
|
+
"value": "ME"
|
|
279006
|
+
},
|
|
279007
|
+
{
|
|
279008
|
+
"kind": "symbol",
|
|
279009
|
+
"name": "M",
|
|
279010
|
+
"value": "M"
|
|
279011
|
+
}
|
|
279012
|
+
]
|
|
279013
|
+
},
|
|
279014
|
+
{
|
|
279015
|
+
"kind": "intersection",
|
|
279016
|
+
"value": [
|
|
279017
|
+
{
|
|
279018
|
+
"kind": "symbol",
|
|
279019
|
+
"name": "VE",
|
|
279020
|
+
"value": "VE"
|
|
279021
|
+
},
|
|
279022
|
+
{
|
|
279023
|
+
"kind": "symbol",
|
|
279024
|
+
"name": "V",
|
|
279025
|
+
"value": "V"
|
|
279026
|
+
}
|
|
279027
|
+
]
|
|
279028
|
+
}
|
|
279029
|
+
],
|
|
279030
|
+
"value": "StencilModifierReturn<M, V>"
|
|
279031
|
+
},
|
|
279032
|
+
"falseType": {
|
|
279033
|
+
"kind": "symbol",
|
|
279034
|
+
"name": "StencilModifierReturn",
|
|
279035
|
+
"typeParameters": [
|
|
279036
|
+
{
|
|
279037
|
+
"kind": "symbol",
|
|
279038
|
+
"name": "M",
|
|
279039
|
+
"value": "M"
|
|
279040
|
+
},
|
|
279041
|
+
{
|
|
279042
|
+
"kind": "symbol",
|
|
279043
|
+
"name": "V",
|
|
279044
|
+
"value": "V"
|
|
279045
|
+
}
|
|
279046
|
+
],
|
|
279047
|
+
"value": "StencilModifierReturn<M, V>"
|
|
279048
|
+
}
|
|
279049
|
+
},
|
|
279050
|
+
"description": "",
|
|
279051
|
+
"declarations": [
|
|
279052
|
+
{
|
|
279053
|
+
"name": "modifiers",
|
|
279054
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
279055
|
+
}
|
|
279056
|
+
],
|
|
279057
|
+
"tags": {}
|
|
279058
|
+
},
|
|
279059
|
+
{
|
|
279060
|
+
"kind": "property",
|
|
279061
|
+
"name": "defaultModifiers",
|
|
279062
|
+
"required": true,
|
|
279063
|
+
"type": {
|
|
279064
|
+
"kind": "conditional",
|
|
279065
|
+
"check": {
|
|
279066
|
+
"kind": "tuple",
|
|
279067
|
+
"value": [
|
|
279068
|
+
{
|
|
279069
|
+
"kind": "symbol",
|
|
279070
|
+
"name": "E",
|
|
279071
|
+
"value": "E"
|
|
279072
|
+
}
|
|
279073
|
+
]
|
|
279074
|
+
},
|
|
279075
|
+
"extends": {
|
|
279076
|
+
"kind": "tuple",
|
|
279077
|
+
"value": [
|
|
279078
|
+
{
|
|
279079
|
+
"kind": "symbol",
|
|
279080
|
+
"name": "BaseStencil",
|
|
279081
|
+
"typeParameters": [
|
|
279082
|
+
{
|
|
279083
|
+
"kind": "infer",
|
|
279084
|
+
"value": {
|
|
279085
|
+
"kind": "typeParameter",
|
|
279086
|
+
"name": "ME",
|
|
279087
|
+
"required": true
|
|
279088
|
+
}
|
|
279089
|
+
},
|
|
279090
|
+
{
|
|
279091
|
+
"kind": "primitive",
|
|
279092
|
+
"value": "any"
|
|
279093
|
+
},
|
|
279094
|
+
{
|
|
279095
|
+
"kind": "primitive",
|
|
279096
|
+
"value": "any"
|
|
279097
|
+
},
|
|
279098
|
+
{
|
|
279099
|
+
"kind": "primitive",
|
|
279100
|
+
"value": "any"
|
|
279101
|
+
}
|
|
279102
|
+
],
|
|
279103
|
+
"value": "BaseStencil<M, V, E, ID>"
|
|
279104
|
+
}
|
|
279105
|
+
]
|
|
279106
|
+
},
|
|
279107
|
+
"trueType": {
|
|
279108
|
+
"kind": "symbol",
|
|
279109
|
+
"name": "StencilDefaultModifierReturn",
|
|
279110
|
+
"typeParameters": [
|
|
279111
|
+
{
|
|
279112
|
+
"kind": "intersection",
|
|
279113
|
+
"value": [
|
|
279114
|
+
{
|
|
279115
|
+
"kind": "symbol",
|
|
279116
|
+
"name": "ME",
|
|
279117
|
+
"value": "ME"
|
|
279118
|
+
},
|
|
279119
|
+
{
|
|
279120
|
+
"kind": "symbol",
|
|
279121
|
+
"name": "M",
|
|
279122
|
+
"value": "M"
|
|
279123
|
+
}
|
|
279124
|
+
]
|
|
279125
|
+
}
|
|
279126
|
+
],
|
|
279127
|
+
"value": "StencilDefaultModifierReturn<M>"
|
|
279128
|
+
},
|
|
279129
|
+
"falseType": {
|
|
279130
|
+
"kind": "symbol",
|
|
279131
|
+
"name": "StencilDefaultModifierReturn",
|
|
279132
|
+
"typeParameters": [
|
|
279133
|
+
{
|
|
279134
|
+
"kind": "symbol",
|
|
279135
|
+
"name": "M",
|
|
279136
|
+
"value": "M"
|
|
279137
|
+
}
|
|
279138
|
+
],
|
|
279139
|
+
"value": "StencilDefaultModifierReturn<M>"
|
|
279140
|
+
}
|
|
279141
|
+
},
|
|
279142
|
+
"description": "",
|
|
279143
|
+
"declarations": [
|
|
279144
|
+
{
|
|
279145
|
+
"name": "defaultModifiers",
|
|
279146
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
279147
|
+
}
|
|
279148
|
+
],
|
|
279149
|
+
"tags": {}
|
|
279150
|
+
},
|
|
279151
|
+
{
|
|
279152
|
+
"kind": "property",
|
|
279153
|
+
"name": "__extends",
|
|
279154
|
+
"required": false,
|
|
279155
|
+
"type": {
|
|
279156
|
+
"kind": "symbol",
|
|
279157
|
+
"name": "E",
|
|
279158
|
+
"value": "E"
|
|
279159
|
+
},
|
|
279160
|
+
"description": "",
|
|
279161
|
+
"declarations": [
|
|
279162
|
+
{
|
|
279163
|
+
"name": "__extends",
|
|
279164
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
279165
|
+
}
|
|
279166
|
+
],
|
|
279167
|
+
"tags": {}
|
|
279168
|
+
},
|
|
279169
|
+
{
|
|
279170
|
+
"kind": "property",
|
|
279171
|
+
"name": "__vars",
|
|
279172
|
+
"required": true,
|
|
279173
|
+
"type": {
|
|
279174
|
+
"kind": "symbol",
|
|
279175
|
+
"name": "V",
|
|
279176
|
+
"value": "V"
|
|
279177
|
+
},
|
|
279178
|
+
"description": "",
|
|
279179
|
+
"declarations": [
|
|
279180
|
+
{
|
|
279181
|
+
"name": "__vars",
|
|
279182
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
279183
|
+
}
|
|
279184
|
+
],
|
|
279185
|
+
"tags": {}
|
|
279186
|
+
},
|
|
279187
|
+
{
|
|
279188
|
+
"kind": "property",
|
|
279189
|
+
"name": "__modifiers",
|
|
279190
|
+
"required": true,
|
|
279191
|
+
"type": {
|
|
279192
|
+
"kind": "symbol",
|
|
279193
|
+
"name": "M",
|
|
279194
|
+
"value": "M"
|
|
279195
|
+
},
|
|
279196
|
+
"description": "",
|
|
279197
|
+
"declarations": [
|
|
279198
|
+
{
|
|
279199
|
+
"name": "__modifiers",
|
|
279200
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
279201
|
+
}
|
|
279202
|
+
],
|
|
279203
|
+
"tags": {}
|
|
279204
|
+
},
|
|
279205
|
+
{
|
|
279206
|
+
"kind": "property",
|
|
279207
|
+
"name": "__id",
|
|
279208
|
+
"required": true,
|
|
279209
|
+
"type": {
|
|
279210
|
+
"kind": "symbol",
|
|
279211
|
+
"name": "ID",
|
|
279212
|
+
"value": "ID"
|
|
279213
|
+
},
|
|
279214
|
+
"description": "",
|
|
279215
|
+
"declarations": [
|
|
279216
|
+
{
|
|
279217
|
+
"name": "__id",
|
|
279218
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
279219
|
+
}
|
|
279220
|
+
],
|
|
279221
|
+
"tags": {}
|
|
279222
|
+
}
|
|
279223
|
+
],
|
|
279224
|
+
"returnType": {
|
|
279225
|
+
"kind": "object",
|
|
279226
|
+
"properties": [
|
|
279227
|
+
{
|
|
279228
|
+
"kind": "property",
|
|
279229
|
+
"name": "className",
|
|
279230
|
+
"required": true,
|
|
279231
|
+
"type": {
|
|
279232
|
+
"kind": "primitive",
|
|
279233
|
+
"value": "string"
|
|
279234
|
+
},
|
|
279235
|
+
"description": "",
|
|
279236
|
+
"declarations": [
|
|
279237
|
+
{
|
|
279238
|
+
"name": "className",
|
|
279239
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
279240
|
+
}
|
|
279241
|
+
],
|
|
279242
|
+
"tags": {}
|
|
279243
|
+
},
|
|
279244
|
+
{
|
|
279245
|
+
"kind": "property",
|
|
279246
|
+
"name": "style",
|
|
279247
|
+
"required": false,
|
|
279248
|
+
"type": {
|
|
279249
|
+
"kind": "external",
|
|
279250
|
+
"name": "Record",
|
|
279251
|
+
"url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
|
|
279252
|
+
"typeParameters": [
|
|
279253
|
+
{
|
|
279254
|
+
"kind": "primitive",
|
|
279255
|
+
"value": "string"
|
|
279256
|
+
},
|
|
279257
|
+
{
|
|
279258
|
+
"kind": "primitive",
|
|
279259
|
+
"value": "string"
|
|
279260
|
+
}
|
|
279261
|
+
]
|
|
279262
|
+
},
|
|
279263
|
+
"description": "",
|
|
279264
|
+
"declarations": [
|
|
279265
|
+
{
|
|
279266
|
+
"name": "style",
|
|
279267
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
279268
|
+
}
|
|
279269
|
+
],
|
|
279270
|
+
"tags": {}
|
|
279271
|
+
}
|
|
279272
|
+
]
|
|
279273
|
+
}
|
|
279274
|
+
}
|
|
279275
|
+
},
|
|
279276
|
+
{
|
|
279277
|
+
"name": "Text",
|
|
279278
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/Text.tsx",
|
|
279279
|
+
"description": "This is a generic base component intended to render any text.\nIt has `typeLevel` and `variant` style props that simplify navigating\nour type hierarchy and using [Canvas type tokens](https://canvas.workday.com/tokens/type#type-styles).\nBy default, it renders a semantic `span` element,\nbut you can adjust this as needed with the `as` prop.\n\nThe type hierarchy is organized into four levels, which correspond to our [Canvas type\nlevels](https://canvas.workday.com/tokens/type#type-styles).\n\n- `title`: Intended to be used for large page titles.\n- `heading`: Intended to be used for headings and large text.\n- `body`: Intended to be used for standard body text.\n- `subtext`: Intended to be used for small subtext content or in tight spaces.\n\nEach level has three sizes: `large`, `medium`, and `small`.\n\nYou can provide any level and size to the `typeLevel` prop, and it will apply the correct styles\naccordingly. In the example below we're providing the `subtext` level and `small` size to the\ncomponent with the value `subtext.small`.\n\n```tsx\nimport { Text } from '@workday/canvas-kit-react/text';\n\nconst CustomErrorText = () => (\n <Text typeLevel=\"subtext.small\" variant=\"error\">\n Error Text\n </Text>\n);\n```",
|
|
279280
|
+
"declarations": [
|
|
279281
|
+
{
|
|
279282
|
+
"name": "Text",
|
|
279283
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/Text.tsx"
|
|
279284
|
+
}
|
|
279285
|
+
],
|
|
279286
|
+
"tags": {},
|
|
279287
|
+
"type": {
|
|
279288
|
+
"kind": "enhancedComponent",
|
|
279289
|
+
"componentType": "regular",
|
|
279290
|
+
"displayName": "Text",
|
|
279291
|
+
"props": [
|
|
279292
|
+
{
|
|
279293
|
+
"kind": "property",
|
|
279294
|
+
"name": "typeLevel",
|
|
279295
|
+
"required": false,
|
|
279296
|
+
"type": {
|
|
279297
|
+
"kind": "union",
|
|
279298
|
+
"value": [
|
|
279299
|
+
{
|
|
279300
|
+
"kind": "string",
|
|
279301
|
+
"value": "body.medium"
|
|
279302
|
+
},
|
|
279303
|
+
{
|
|
279304
|
+
"kind": "string",
|
|
279305
|
+
"value": "body.large"
|
|
279306
|
+
},
|
|
279307
|
+
{
|
|
279308
|
+
"kind": "string",
|
|
279309
|
+
"value": "body.small"
|
|
279310
|
+
},
|
|
279311
|
+
{
|
|
279312
|
+
"kind": "string",
|
|
279313
|
+
"value": "title.medium"
|
|
279314
|
+
},
|
|
279315
|
+
{
|
|
279316
|
+
"kind": "string",
|
|
279317
|
+
"value": "title.large"
|
|
279318
|
+
},
|
|
279319
|
+
{
|
|
279320
|
+
"kind": "string",
|
|
279321
|
+
"value": "title.small"
|
|
279322
|
+
},
|
|
279323
|
+
{
|
|
279324
|
+
"kind": "string",
|
|
279325
|
+
"value": "subtext.medium"
|
|
279326
|
+
},
|
|
279327
|
+
{
|
|
279328
|
+
"kind": "string",
|
|
279329
|
+
"value": "subtext.large"
|
|
279330
|
+
},
|
|
279331
|
+
{
|
|
279332
|
+
"kind": "string",
|
|
279333
|
+
"value": "subtext.small"
|
|
279334
|
+
},
|
|
279335
|
+
{
|
|
279336
|
+
"kind": "string",
|
|
279337
|
+
"value": "heading.medium"
|
|
279338
|
+
},
|
|
279339
|
+
{
|
|
279340
|
+
"kind": "string",
|
|
279341
|
+
"value": "heading.large"
|
|
279342
|
+
},
|
|
279343
|
+
{
|
|
279344
|
+
"kind": "string",
|
|
279345
|
+
"value": "heading.small"
|
|
277667
279346
|
}
|
|
277668
279347
|
]
|
|
277669
279348
|
},
|
|
@@ -286443,6 +288122,24 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
286443
288122
|
],
|
|
286444
288123
|
"tags": {}
|
|
286445
288124
|
},
|
|
288125
|
+
{
|
|
288126
|
+
"kind": "property",
|
|
288127
|
+
"name": "cs",
|
|
288128
|
+
"required": false,
|
|
288129
|
+
"type": {
|
|
288130
|
+
"kind": "symbol",
|
|
288131
|
+
"name": "CSToPropsInput",
|
|
288132
|
+
"value": "CSToPropsInput"
|
|
288133
|
+
},
|
|
288134
|
+
"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```",
|
|
288135
|
+
"declarations": [
|
|
288136
|
+
{
|
|
288137
|
+
"name": "cs",
|
|
288138
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
288139
|
+
}
|
|
288140
|
+
],
|
|
288141
|
+
"tags": {}
|
|
288142
|
+
},
|
|
286446
288143
|
{
|
|
286447
288144
|
"kind": "property",
|
|
286448
288145
|
"name": "as",
|