@telus-uds/components-base 1.16.0 → 1.18.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/CHANGELOG.md +32 -2
- package/component-docs.json +708 -120
- package/lib/BaseProvider/HydrationContext.js +74 -0
- package/lib/BaseProvider/index.js +14 -6
- package/lib/Button/ButtonBase.js +2 -1
- package/lib/List/List.js +11 -8
- package/lib/List/PressableListItemBase.js +5 -9
- package/lib/QuickLinks/QuickLinks.js +91 -0
- package/lib/QuickLinks/QuickLinksCard.js +47 -0
- package/lib/QuickLinks/QuickLinksItem.js +73 -0
- package/lib/QuickLinks/index.js +16 -0
- package/lib/StackView/StackWrap.js +16 -12
- package/lib/Timeline/Timeline.js +193 -0
- package/lib/Timeline/index.js +13 -0
- package/lib/ViewportProvider/useViewportListener.js +5 -18
- package/lib/index.js +28 -1
- package/lib/utils/animation/useVerticalExpandAnimation.js +3 -1
- package/lib/utils/index.js +9 -0
- package/lib/utils/useSafeLayoutEffect.js +40 -0
- package/lib-module/BaseProvider/HydrationContext.js +51 -0
- package/lib-module/BaseProvider/index.js +12 -6
- package/lib-module/Button/ButtonBase.js +2 -1
- package/lib-module/List/List.js +12 -8
- package/lib-module/List/PressableListItemBase.js +6 -10
- package/lib-module/QuickLinks/QuickLinks.js +71 -0
- package/lib-module/QuickLinks/QuickLinksCard.js +33 -0
- package/lib-module/QuickLinks/QuickLinksItem.js +50 -0
- package/lib-module/QuickLinks/index.js +4 -0
- package/lib-module/StackView/StackWrap.js +16 -13
- package/lib-module/Timeline/Timeline.js +174 -0
- package/lib-module/Timeline/index.js +2 -0
- package/lib-module/ViewportProvider/useViewportListener.js +5 -18
- package/lib-module/index.js +4 -1
- package/lib-module/utils/animation/useVerticalExpandAnimation.js +4 -3
- package/lib-module/utils/index.js +1 -0
- package/lib-module/utils/useSafeLayoutEffect.js +30 -0
- package/package.json +6 -5
- package/src/BaseProvider/HydrationContext.jsx +44 -0
- package/src/BaseProvider/index.jsx +11 -7
- package/src/Button/ButtonBase.jsx +2 -2
- package/src/List/List.jsx +9 -13
- package/src/List/PressableListItemBase.jsx +7 -9
- package/src/QuickLinks/QuickLinks.jsx +61 -0
- package/src/QuickLinks/QuickLinksCard.jsx +26 -0
- package/src/QuickLinks/QuickLinksItem.jsx +46 -0
- package/src/QuickLinks/index.js +6 -0
- package/src/StackView/StackWrap.jsx +20 -13
- package/src/Timeline/Timeline.jsx +148 -0
- package/src/Timeline/index.js +3 -0
- package/src/ViewportProvider/useViewportListener.js +4 -16
- package/src/index.js +3 -0
- package/src/utils/animation/useVerticalExpandAnimation.js +4 -2
- package/src/utils/index.js +1 -0
- package/src/utils/useSafeLayoutEffect.js +31 -0
package/component-docs.json
CHANGED
|
@@ -419,6 +419,80 @@
|
|
|
419
419
|
"outlineColor": "color",
|
|
420
420
|
"outlineWidth": "border"
|
|
421
421
|
},
|
|
422
|
+
"QuickLinks": {
|
|
423
|
+
"list": "show",
|
|
424
|
+
"card": "show",
|
|
425
|
+
"dividers": "show",
|
|
426
|
+
"stackSpace": "integer",
|
|
427
|
+
"stackGap": "integer",
|
|
428
|
+
"stackJustify": "flexJustifyContent"
|
|
429
|
+
},
|
|
430
|
+
"QuickLinksCard": {
|
|
431
|
+
"flex": "integer",
|
|
432
|
+
"backgroundColor": "color",
|
|
433
|
+
"borderColor": "color",
|
|
434
|
+
"borderRadius": "radius",
|
|
435
|
+
"borderWidth": "border",
|
|
436
|
+
"paddingBottom": "size",
|
|
437
|
+
"paddingLeft": "size",
|
|
438
|
+
"paddingRight": "size",
|
|
439
|
+
"paddingTop": "size",
|
|
440
|
+
"minWidth": "size",
|
|
441
|
+
"shadow": "shadow"
|
|
442
|
+
},
|
|
443
|
+
"QuickLinksList": {
|
|
444
|
+
"dividerColor": "color",
|
|
445
|
+
"dividerSize": "border",
|
|
446
|
+
"iconMarginTop": "size",
|
|
447
|
+
"interItemMargin": "size",
|
|
448
|
+
"interItemMarginWithDivider": "size",
|
|
449
|
+
"itemBulletColor": "color",
|
|
450
|
+
"itemBulletContainerAlign": "textAlign",
|
|
451
|
+
"itemBulletContainerWidth": "size",
|
|
452
|
+
"itemBulletHeight": "size",
|
|
453
|
+
"itemBulletWidth": "size",
|
|
454
|
+
"itemFontName": "fontName",
|
|
455
|
+
"itemFontSize": "fontSize",
|
|
456
|
+
"itemFontWeight": "fontWeight",
|
|
457
|
+
"itemIconColor": "color",
|
|
458
|
+
"itemIconSize": "size",
|
|
459
|
+
"itemLineHeight": "lineHeight",
|
|
460
|
+
"listGutter": "size",
|
|
461
|
+
"backgroundColor": "color",
|
|
462
|
+
"paddingLeft": "size",
|
|
463
|
+
"paddingRight": "size",
|
|
464
|
+
"paddingTop": "size",
|
|
465
|
+
"paddingBottom": "size"
|
|
466
|
+
},
|
|
467
|
+
"QuickLinksButton": {
|
|
468
|
+
"borderColor": "color",
|
|
469
|
+
"borderWidth": "border",
|
|
470
|
+
"borderRadius": "radius",
|
|
471
|
+
"shadow": "shadow",
|
|
472
|
+
"fontSize": "fontSize",
|
|
473
|
+
"color": "color",
|
|
474
|
+
"lineHeight": "lineHeight",
|
|
475
|
+
"textAlign": "flexJustifyContent",
|
|
476
|
+
"alignSelf": "flexAlign",
|
|
477
|
+
"fontName": "fontName",
|
|
478
|
+
"fontWeight": "fontWeight",
|
|
479
|
+
"backgroundColor": "color",
|
|
480
|
+
"opacity": "opacity",
|
|
481
|
+
"paddingLeft": "size",
|
|
482
|
+
"paddingRight": "size",
|
|
483
|
+
"paddingTop": "size",
|
|
484
|
+
"paddingBottom": "size",
|
|
485
|
+
"width": "size",
|
|
486
|
+
"minWidth": "size",
|
|
487
|
+
"outerBorderColor": "color",
|
|
488
|
+
"outerBorderWidth": "border",
|
|
489
|
+
"outerBorderGap": "size",
|
|
490
|
+
"outerBackgroundColor": "color",
|
|
491
|
+
"icon": "icon",
|
|
492
|
+
"iconColor": "color",
|
|
493
|
+
"iconSize": "size",
|
|
494
|
+
"iconSpace": "integer"
|
|
495
|
+
},
|
|
422
496
|
"Radio": {
|
|
423
497
|
"checkedBackgroundColor": "color",
|
|
424
498
|
"checkedSize": "size",
|
|
@@ -807,6 +881,24 @@
|
|
|
807
881
|
"flexGrow": "integer",
|
|
808
882
|
"flexShrink": "integer"
|
|
809
883
|
},
|
|
884
|
+
"Timeline": {
|
|
885
|
+
"dotColor": "color",
|
|
886
|
+
"dotWidth": "size",
|
|
887
|
+
"dotBorderWidth": "border",
|
|
888
|
+
"timelineContainerDirection": "direction",
|
|
889
|
+
"timelineColor": "color",
|
|
890
|
+
"connectorWidth": "size",
|
|
891
|
+
"connectorHeight": "size",
|
|
892
|
+
"lineItemContainerDirection": "direction",
|
|
893
|
+
"lineContainerFlexSize": "integer",
|
|
894
|
+
"lineItemAlign": "flexAlign",
|
|
895
|
+
"lineItemDirection": "direction",
|
|
896
|
+
"lineItemMarginRight": "size",
|
|
897
|
+
"lineItemMarginBottom": "size",
|
|
898
|
+
"itemContentFlexSize": "integer",
|
|
899
|
+
"itemContentMarginRight": "size",
|
|
900
|
+
"itemContentMarginBottom": "size"
|
|
901
|
+
},
|
|
810
902
|
"Tooltip": {
|
|
811
903
|
"backgroundColor": "color",
|
|
812
904
|
"paddingTop": "size",
|
|
@@ -1263,6 +1355,29 @@
|
|
|
1263
1355
|
"type": "state"
|
|
1264
1356
|
}
|
|
1265
1357
|
},
|
|
1358
|
+
"QuickLinksList": {
|
|
1359
|
+
"hover": {
|
|
1360
|
+
"description": "Currently web only. Applies when an interactive component's hover handler is triggered, such as on mouseover.",
|
|
1361
|
+
"values": [
|
|
1362
|
+
true
|
|
1363
|
+
],
|
|
1364
|
+
"type": "state"
|
|
1365
|
+
},
|
|
1366
|
+
"focus": {
|
|
1367
|
+
"description": "Currently only web has good support for this. Applies when an interactive component's focus handler is triggered, such as keyboard tabbing or selection.",
|
|
1368
|
+
"values": [
|
|
1369
|
+
true
|
|
1370
|
+
],
|
|
1371
|
+
"type": "state"
|
|
1372
|
+
},
|
|
1373
|
+
"pressed": {
|
|
1374
|
+
"description": "Applies while an interactive component is being physically pressed. Most visible on touchscreen taps; in React Native Web, this is visible on web mouse clicks only if the pressable is held down.",
|
|
1375
|
+
"values": [
|
|
1376
|
+
true
|
|
1377
|
+
],
|
|
1378
|
+
"type": "state"
|
|
1379
|
+
}
|
|
1380
|
+
},
|
|
1266
1381
|
"Radio": {
|
|
1267
1382
|
"checked": {
|
|
1268
1383
|
"description": "Corresponds to a selected state for a checkbox or radio",
|
|
@@ -4625,8 +4740,7 @@
|
|
|
4625
4740
|
},
|
|
4626
4741
|
"children": {
|
|
4627
4742
|
"type": {
|
|
4628
|
-
"name": "
|
|
4629
|
-
"raw": "componentPropType('ListItem')"
|
|
4743
|
+
"name": "node"
|
|
4630
4744
|
},
|
|
4631
4745
|
"required": false,
|
|
4632
4746
|
"description": ""
|
|
@@ -4797,8 +4911,7 @@
|
|
|
4797
4911
|
},
|
|
4798
4912
|
"children": {
|
|
4799
4913
|
"type": {
|
|
4800
|
-
"name": "
|
|
4801
|
-
"raw": "componentPropType('ListItem')"
|
|
4914
|
+
"name": "node"
|
|
4802
4915
|
},
|
|
4803
4916
|
"required": false,
|
|
4804
4917
|
"description": ""
|
|
@@ -5746,131 +5859,86 @@
|
|
|
5746
5859
|
}
|
|
5747
5860
|
}
|
|
5748
5861
|
},
|
|
5749
|
-
"
|
|
5862
|
+
"QuickLinks": {
|
|
5750
5863
|
"docs": {
|
|
5751
|
-
"description": "
|
|
5864
|
+
"description": "QuickLinks renders a list of interactive items. How it renders these items depends on theme options:\n - If the theme returns `list` token as true, it renders an ordered list based on List\n - If the theme returns `button` token as true and `list` as false, it renders a wrapping horizontal bar of buttons\n - If the theme returns `card` token as true, it wraps the above with a `Card`.",
|
|
5752
5865
|
"props": {
|
|
5753
|
-
"
|
|
5866
|
+
"tag": {
|
|
5754
5867
|
"defaultValue": {
|
|
5755
|
-
"value": "
|
|
5868
|
+
"value": "'ul'",
|
|
5756
5869
|
"computed": false
|
|
5757
5870
|
},
|
|
5758
|
-
"type": {
|
|
5759
|
-
"name": "bool"
|
|
5760
|
-
},
|
|
5761
|
-
"required": false,
|
|
5762
|
-
"description": "Whether the underlying input triggered a validation error or not."
|
|
5763
|
-
},
|
|
5764
|
-
"checked": {
|
|
5765
|
-
"type": {
|
|
5766
|
-
"name": "bool"
|
|
5767
|
-
},
|
|
5768
|
-
"required": false,
|
|
5769
|
-
"description": "Use `checked` for controlled Radio. For uncontrolled Radio, use the `defaultChecked` prop."
|
|
5770
|
-
},
|
|
5771
|
-
"defaultChecked": {
|
|
5772
|
-
"type": {
|
|
5773
|
-
"name": "bool"
|
|
5774
|
-
},
|
|
5775
|
-
"required": false,
|
|
5776
|
-
"description": "Use `defaultChecked` to provide the initial value for an uncontrolled Radio."
|
|
5777
|
-
},
|
|
5778
|
-
"description": {
|
|
5779
|
-
"type": {
|
|
5780
|
-
"name": "string"
|
|
5781
|
-
},
|
|
5782
|
-
"required": false,
|
|
5783
|
-
"description": "An optional radio button description."
|
|
5784
|
-
},
|
|
5785
|
-
"id": {
|
|
5786
|
-
"type": {
|
|
5787
|
-
"name": "string"
|
|
5788
|
-
},
|
|
5789
|
-
"required": false,
|
|
5790
|
-
"description": "Radio button ID."
|
|
5791
|
-
},
|
|
5792
|
-
"inactive": {
|
|
5793
|
-
"type": {
|
|
5794
|
-
"name": "bool"
|
|
5795
|
-
},
|
|
5796
|
-
"required": false,
|
|
5797
|
-
"description": "Whether the corresponding input is disabled or active."
|
|
5798
|
-
},
|
|
5799
|
-
"label": {
|
|
5800
|
-
"type": {
|
|
5801
|
-
"name": "string"
|
|
5802
|
-
},
|
|
5803
|
-
"required": false,
|
|
5804
|
-
"description": "The label."
|
|
5805
|
-
},
|
|
5806
|
-
"name": {
|
|
5807
5871
|
"type": {
|
|
5808
5872
|
"name": "string"
|
|
5809
5873
|
},
|
|
5810
5874
|
"required": false,
|
|
5811
|
-
"description": "
|
|
5875
|
+
"description": ""
|
|
5812
5876
|
},
|
|
5813
|
-
"
|
|
5877
|
+
"tokens": {
|
|
5814
5878
|
"type": {
|
|
5815
|
-
"name": "
|
|
5816
|
-
"
|
|
5817
|
-
|
|
5818
|
-
|
|
5819
|
-
|
|
5820
|
-
|
|
5821
|
-
|
|
5822
|
-
|
|
5823
|
-
|
|
5824
|
-
"name": "bool"
|
|
5825
|
-
}
|
|
5826
|
-
]
|
|
5879
|
+
"name": "custom",
|
|
5880
|
+
"raw": {
|
|
5881
|
+
"list": "show",
|
|
5882
|
+
"card": "show",
|
|
5883
|
+
"dividers": "show",
|
|
5884
|
+
"stackSpace": "integer",
|
|
5885
|
+
"stackGap": "integer",
|
|
5886
|
+
"stackJustify": "flexJustifyContent"
|
|
5887
|
+
}
|
|
5827
5888
|
},
|
|
5828
5889
|
"required": false,
|
|
5829
|
-
"description": "
|
|
5890
|
+
"description": ""
|
|
5830
5891
|
},
|
|
5831
|
-
"
|
|
5892
|
+
"cardTokens": {
|
|
5832
5893
|
"type": {
|
|
5833
|
-
"name": "
|
|
5894
|
+
"name": "custom",
|
|
5895
|
+
"raw": {
|
|
5896
|
+
"flex": "integer",
|
|
5897
|
+
"backgroundColor": "color",
|
|
5898
|
+
"borderColor": "color",
|
|
5899
|
+
"borderRadius": "radius",
|
|
5900
|
+
"borderWidth": "border",
|
|
5901
|
+
"paddingBottom": "size",
|
|
5902
|
+
"paddingLeft": "size",
|
|
5903
|
+
"paddingRight": "size",
|
|
5904
|
+
"paddingTop": "size",
|
|
5905
|
+
"minWidth": "size",
|
|
5906
|
+
"shadow": "shadow"
|
|
5907
|
+
}
|
|
5834
5908
|
},
|
|
5835
5909
|
"required": false,
|
|
5836
|
-
"description": "
|
|
5910
|
+
"description": ""
|
|
5837
5911
|
},
|
|
5838
|
-
"
|
|
5912
|
+
"listTokens": {
|
|
5839
5913
|
"type": {
|
|
5840
5914
|
"name": "custom",
|
|
5841
5915
|
"raw": {
|
|
5842
|
-
"
|
|
5843
|
-
"
|
|
5844
|
-
"
|
|
5845
|
-
"
|
|
5846
|
-
"
|
|
5847
|
-
"
|
|
5848
|
-
"
|
|
5849
|
-
"
|
|
5850
|
-
"
|
|
5851
|
-
"
|
|
5852
|
-
"
|
|
5853
|
-
"
|
|
5854
|
-
"
|
|
5855
|
-
"
|
|
5856
|
-
"
|
|
5857
|
-
"
|
|
5858
|
-
"
|
|
5859
|
-
"
|
|
5860
|
-
"
|
|
5861
|
-
"
|
|
5862
|
-
"
|
|
5863
|
-
"
|
|
5864
|
-
"labelColor": "color",
|
|
5865
|
-
"labelFontName": "fontName",
|
|
5866
|
-
"labelFontSize": "fontSize",
|
|
5867
|
-
"labelFontWeight": "fontWeight",
|
|
5868
|
-
"labelLineHeight": "lineHeight",
|
|
5869
|
-
"labelMarginLeft": "size"
|
|
5916
|
+
"dividerColor": "color",
|
|
5917
|
+
"dividerSize": "border",
|
|
5918
|
+
"iconMarginTop": "size",
|
|
5919
|
+
"interItemMargin": "size",
|
|
5920
|
+
"interItemMarginWithDivider": "size",
|
|
5921
|
+
"itemBulletColor": "color",
|
|
5922
|
+
"itemBulletContainerAlign": "textAlign",
|
|
5923
|
+
"itemBulletContainerWidth": "size",
|
|
5924
|
+
"itemBulletHeight": "size",
|
|
5925
|
+
"itemBulletWidth": "size",
|
|
5926
|
+
"itemFontName": "fontName",
|
|
5927
|
+
"itemFontSize": "fontSize",
|
|
5928
|
+
"itemFontWeight": "fontWeight",
|
|
5929
|
+
"itemIconColor": "color",
|
|
5930
|
+
"itemIconSize": "size",
|
|
5931
|
+
"itemLineHeight": "lineHeight",
|
|
5932
|
+
"listGutter": "size",
|
|
5933
|
+
"backgroundColor": "color",
|
|
5934
|
+
"paddingLeft": "size",
|
|
5935
|
+
"paddingRight": "size",
|
|
5936
|
+
"paddingTop": "size",
|
|
5937
|
+
"paddingBottom": "size"
|
|
5870
5938
|
}
|
|
5871
5939
|
},
|
|
5872
5940
|
"required": false,
|
|
5873
|
-
"description": "
|
|
5941
|
+
"description": ""
|
|
5874
5942
|
},
|
|
5875
5943
|
"variant": {
|
|
5876
5944
|
"type": {
|
|
@@ -5891,26 +5959,291 @@
|
|
|
5891
5959
|
}
|
|
5892
5960
|
},
|
|
5893
5961
|
"required": false,
|
|
5894
|
-
"description": "
|
|
5962
|
+
"description": ""
|
|
5963
|
+
},
|
|
5964
|
+
"children": {
|
|
5965
|
+
"type": {
|
|
5966
|
+
"name": "node"
|
|
5967
|
+
},
|
|
5968
|
+
"required": false,
|
|
5969
|
+
"description": ""
|
|
5895
5970
|
}
|
|
5896
5971
|
},
|
|
5897
5972
|
"attributes": {
|
|
5898
5973
|
"acceptsRNA11yProps": false
|
|
5899
5974
|
}
|
|
5900
|
-
}
|
|
5901
|
-
|
|
5902
|
-
|
|
5903
|
-
|
|
5904
|
-
|
|
5905
|
-
|
|
5906
|
-
|
|
5907
|
-
|
|
5908
|
-
|
|
5909
|
-
|
|
5910
|
-
|
|
5911
|
-
|
|
5912
|
-
|
|
5913
|
-
|
|
5975
|
+
},
|
|
5976
|
+
"Item": {
|
|
5977
|
+
"docs": {
|
|
5978
|
+
"description": "Public component exported as QuickLinks.Item, for use as children of QuickLinks.\n\nReceives props injected by QuickLinks and renders the appropriate child component.",
|
|
5979
|
+
"props": {
|
|
5980
|
+
"LinkRouter": {
|
|
5981
|
+
"type": {
|
|
5982
|
+
"name": "elementType"
|
|
5983
|
+
},
|
|
5984
|
+
"required": false,
|
|
5985
|
+
"description": ""
|
|
5986
|
+
},
|
|
5987
|
+
"linkRouterProps": {
|
|
5988
|
+
"type": {
|
|
5989
|
+
"name": "object"
|
|
5990
|
+
},
|
|
5991
|
+
"required": false,
|
|
5992
|
+
"description": ""
|
|
5993
|
+
},
|
|
5994
|
+
"tokens": {
|
|
5995
|
+
"type": {
|
|
5996
|
+
"name": "custom",
|
|
5997
|
+
"raw": {
|
|
5998
|
+
"dividerColor": "color",
|
|
5999
|
+
"dividerSize": "border",
|
|
6000
|
+
"iconMarginTop": "size",
|
|
6001
|
+
"interItemMargin": "size",
|
|
6002
|
+
"interItemMarginWithDivider": "size",
|
|
6003
|
+
"itemBulletColor": "color",
|
|
6004
|
+
"itemBulletContainerAlign": "textAlign",
|
|
6005
|
+
"itemBulletContainerWidth": "size",
|
|
6006
|
+
"itemBulletHeight": "size",
|
|
6007
|
+
"itemBulletWidth": "size",
|
|
6008
|
+
"itemFontName": "fontName",
|
|
6009
|
+
"itemFontSize": "fontSize",
|
|
6010
|
+
"itemFontWeight": "fontWeight",
|
|
6011
|
+
"itemIconColor": "color",
|
|
6012
|
+
"itemIconSize": "size",
|
|
6013
|
+
"itemLineHeight": "lineHeight",
|
|
6014
|
+
"listGutter": "size",
|
|
6015
|
+
"backgroundColor": "color",
|
|
6016
|
+
"paddingLeft": "size",
|
|
6017
|
+
"paddingRight": "size",
|
|
6018
|
+
"paddingTop": "size",
|
|
6019
|
+
"paddingBottom": "size",
|
|
6020
|
+
"borderColor": "color",
|
|
6021
|
+
"borderWidth": "border",
|
|
6022
|
+
"borderRadius": "radius",
|
|
6023
|
+
"shadow": "shadow",
|
|
6024
|
+
"fontSize": "fontSize",
|
|
6025
|
+
"color": "color",
|
|
6026
|
+
"lineHeight": "lineHeight",
|
|
6027
|
+
"textAlign": "flexJustifyContent",
|
|
6028
|
+
"alignSelf": "flexAlign",
|
|
6029
|
+
"fontName": "fontName",
|
|
6030
|
+
"fontWeight": "fontWeight",
|
|
6031
|
+
"opacity": "opacity",
|
|
6032
|
+
"width": "size",
|
|
6033
|
+
"minWidth": "size",
|
|
6034
|
+
"outerBorderColor": "color",
|
|
6035
|
+
"outerBorderWidth": "border",
|
|
6036
|
+
"outerBorderGap": "size",
|
|
6037
|
+
"outerBackgroundColor": "color",
|
|
6038
|
+
"icon": "icon",
|
|
6039
|
+
"iconColor": "color",
|
|
6040
|
+
"iconSize": "size",
|
|
6041
|
+
"iconSpace": "integer"
|
|
6042
|
+
}
|
|
6043
|
+
},
|
|
6044
|
+
"required": false,
|
|
6045
|
+
"description": ""
|
|
6046
|
+
},
|
|
6047
|
+
"variant": {
|
|
6048
|
+
"type": {
|
|
6049
|
+
"name": "objectOf",
|
|
6050
|
+
"value": {
|
|
6051
|
+
"name": "union",
|
|
6052
|
+
"value": [
|
|
6053
|
+
{
|
|
6054
|
+
"name": "string"
|
|
6055
|
+
},
|
|
6056
|
+
{
|
|
6057
|
+
"name": "number"
|
|
6058
|
+
},
|
|
6059
|
+
{
|
|
6060
|
+
"name": "bool"
|
|
6061
|
+
}
|
|
6062
|
+
]
|
|
6063
|
+
}
|
|
6064
|
+
},
|
|
6065
|
+
"required": false,
|
|
6066
|
+
"description": ""
|
|
6067
|
+
},
|
|
6068
|
+
"children": {
|
|
6069
|
+
"type": {
|
|
6070
|
+
"name": "node"
|
|
6071
|
+
},
|
|
6072
|
+
"required": false,
|
|
6073
|
+
"description": ""
|
|
6074
|
+
}
|
|
6075
|
+
},
|
|
6076
|
+
"attributes": {
|
|
6077
|
+
"acceptsRNA11yProps": false
|
|
6078
|
+
}
|
|
6079
|
+
}
|
|
6080
|
+
}
|
|
6081
|
+
},
|
|
6082
|
+
"Radio": {
|
|
6083
|
+
"docs": {
|
|
6084
|
+
"description": "Basic Radio component.\n\n## Component API\n\nUse `label` prop to provide a label for the radio button. For a disabled `Radio` set the `inactive` prop to `true`.\n\n### Controlled version\n\nIf the radio button is controlled from outside, it needs to receive `checked` and `onChange` props.\n\n### Uncontrolled version\n\nIn case of uncontrolled radio button you can use `defaultChecked` prop to provide the initial value.\nWhenever the radio button gets toggled, it calls the `onChange` callback with the new value (boolean).\n\n### Using within forms\n\nYou can pass `name` and `value` props if you need a particular radio button to be a part of a radio group\non a form.\n\n### Validation\n\nYou can mark a radio button as failing validation by setting the `error` prop to `true`.\n\n## A11y guidelines\n\nRadio component accepts all the common accessibility props, but also sets some defaults, including\naccessibility role `'radio'` and accessibility state that depends on the other props (`checked`, `inactive`)\nor the internal state in case of uncontrolled radio button.",
|
|
6085
|
+
"props": {
|
|
6086
|
+
"error": {
|
|
6087
|
+
"defaultValue": {
|
|
6088
|
+
"value": "false",
|
|
6089
|
+
"computed": false
|
|
6090
|
+
},
|
|
6091
|
+
"type": {
|
|
6092
|
+
"name": "bool"
|
|
6093
|
+
},
|
|
6094
|
+
"required": false,
|
|
6095
|
+
"description": "Whether the underlying input triggered a validation error or not."
|
|
6096
|
+
},
|
|
6097
|
+
"checked": {
|
|
6098
|
+
"type": {
|
|
6099
|
+
"name": "bool"
|
|
6100
|
+
},
|
|
6101
|
+
"required": false,
|
|
6102
|
+
"description": "Use `checked` for controlled Radio. For uncontrolled Radio, use the `defaultChecked` prop."
|
|
6103
|
+
},
|
|
6104
|
+
"defaultChecked": {
|
|
6105
|
+
"type": {
|
|
6106
|
+
"name": "bool"
|
|
6107
|
+
},
|
|
6108
|
+
"required": false,
|
|
6109
|
+
"description": "Use `defaultChecked` to provide the initial value for an uncontrolled Radio."
|
|
6110
|
+
},
|
|
6111
|
+
"description": {
|
|
6112
|
+
"type": {
|
|
6113
|
+
"name": "string"
|
|
6114
|
+
},
|
|
6115
|
+
"required": false,
|
|
6116
|
+
"description": "An optional radio button description."
|
|
6117
|
+
},
|
|
6118
|
+
"id": {
|
|
6119
|
+
"type": {
|
|
6120
|
+
"name": "string"
|
|
6121
|
+
},
|
|
6122
|
+
"required": false,
|
|
6123
|
+
"description": "Radio button ID."
|
|
6124
|
+
},
|
|
6125
|
+
"inactive": {
|
|
6126
|
+
"type": {
|
|
6127
|
+
"name": "bool"
|
|
6128
|
+
},
|
|
6129
|
+
"required": false,
|
|
6130
|
+
"description": "Whether the corresponding input is disabled or active."
|
|
6131
|
+
},
|
|
6132
|
+
"label": {
|
|
6133
|
+
"type": {
|
|
6134
|
+
"name": "string"
|
|
6135
|
+
},
|
|
6136
|
+
"required": false,
|
|
6137
|
+
"description": "The label."
|
|
6138
|
+
},
|
|
6139
|
+
"name": {
|
|
6140
|
+
"type": {
|
|
6141
|
+
"name": "string"
|
|
6142
|
+
},
|
|
6143
|
+
"required": false,
|
|
6144
|
+
"description": "Associate this radio button with a group (set as the name attribute)."
|
|
6145
|
+
},
|
|
6146
|
+
"value": {
|
|
6147
|
+
"type": {
|
|
6148
|
+
"name": "union",
|
|
6149
|
+
"value": [
|
|
6150
|
+
{
|
|
6151
|
+
"name": "string"
|
|
6152
|
+
},
|
|
6153
|
+
{
|
|
6154
|
+
"name": "number"
|
|
6155
|
+
},
|
|
6156
|
+
{
|
|
6157
|
+
"name": "bool"
|
|
6158
|
+
}
|
|
6159
|
+
]
|
|
6160
|
+
},
|
|
6161
|
+
"required": false,
|
|
6162
|
+
"description": "The value. Must be unique within the group."
|
|
6163
|
+
},
|
|
6164
|
+
"onChange": {
|
|
6165
|
+
"type": {
|
|
6166
|
+
"name": "func"
|
|
6167
|
+
},
|
|
6168
|
+
"required": false,
|
|
6169
|
+
"description": "Callback called when a controlled radio button gets interacted with."
|
|
6170
|
+
},
|
|
6171
|
+
"tokens": {
|
|
6172
|
+
"type": {
|
|
6173
|
+
"name": "custom",
|
|
6174
|
+
"raw": {
|
|
6175
|
+
"checkedBackgroundColor": "color",
|
|
6176
|
+
"checkedSize": "size",
|
|
6177
|
+
"containerBackgroundColor": "color",
|
|
6178
|
+
"containerBorderRadius": "radius",
|
|
6179
|
+
"containerOpacity": "opacity",
|
|
6180
|
+
"containerPaddingBottom": "size",
|
|
6181
|
+
"containerPaddingLeft": "size",
|
|
6182
|
+
"containerPaddingRight": "size",
|
|
6183
|
+
"containerPaddingTop": "size",
|
|
6184
|
+
"containerShadow": "shadow",
|
|
6185
|
+
"descriptionFontSize": "fontSize",
|
|
6186
|
+
"descriptionLineHeight": "lineHeight",
|
|
6187
|
+
"descriptionMarginLeft": "size",
|
|
6188
|
+
"inputBackgroundColor": "color",
|
|
6189
|
+
"inputBorderColor": "color",
|
|
6190
|
+
"inputBorderWidth": "border",
|
|
6191
|
+
"inputOutlineColor": "color",
|
|
6192
|
+
"inputOutlineWidth": "border",
|
|
6193
|
+
"inputSize": "size",
|
|
6194
|
+
"outerBorderGap": "size",
|
|
6195
|
+
"outerBorderWidth": "border",
|
|
6196
|
+
"outerBorderColor": "color",
|
|
6197
|
+
"labelColor": "color",
|
|
6198
|
+
"labelFontName": "fontName",
|
|
6199
|
+
"labelFontSize": "fontSize",
|
|
6200
|
+
"labelFontWeight": "fontWeight",
|
|
6201
|
+
"labelLineHeight": "lineHeight",
|
|
6202
|
+
"labelMarginLeft": "size"
|
|
6203
|
+
}
|
|
6204
|
+
},
|
|
6205
|
+
"required": false,
|
|
6206
|
+
"description": "Radio tokens."
|
|
6207
|
+
},
|
|
6208
|
+
"variant": {
|
|
6209
|
+
"type": {
|
|
6210
|
+
"name": "objectOf",
|
|
6211
|
+
"value": {
|
|
6212
|
+
"name": "union",
|
|
6213
|
+
"value": [
|
|
6214
|
+
{
|
|
6215
|
+
"name": "string"
|
|
6216
|
+
},
|
|
6217
|
+
{
|
|
6218
|
+
"name": "number"
|
|
6219
|
+
},
|
|
6220
|
+
{
|
|
6221
|
+
"name": "bool"
|
|
6222
|
+
}
|
|
6223
|
+
]
|
|
6224
|
+
}
|
|
6225
|
+
},
|
|
6226
|
+
"required": false,
|
|
6227
|
+
"description": "Radio variant."
|
|
6228
|
+
}
|
|
6229
|
+
},
|
|
6230
|
+
"attributes": {
|
|
6231
|
+
"acceptsRNA11yProps": false
|
|
6232
|
+
}
|
|
6233
|
+
}
|
|
6234
|
+
},
|
|
6235
|
+
"RadioCard": {
|
|
6236
|
+
"docs": {
|
|
6237
|
+
"description": "A Card that behaves like a radio button. Use when users select a single choice from mutually exclusive options\nwith need to show additional information for each option. The whole card is interactive as one item.\n\n## Component API\n\nUse `title` prop to provide a main description, and `children` for additional content. Avoid including\ninteractive elements within the RadioCard content.\n\nFor a disabled `RadioCard`, set the `inactive` prop to `true`.\n\n### Controlled version\n\nIf the radio card is controlled from outside, it needs to receive `checked` and `onChange` props.\n\n### Uncontrolled version\n\nIn case of uncontrolled radio card you can use `defaultChecked` prop to provide the initial value.\nWhenever the radio card gets toggled, it calls the `onChange` callback with the new value (boolean).\n\n### Using within forms\n\nYou can pass `name` and `value` props if you need a particular radio card to be a part of a radio group\non a form.\n\n### Validation\n\nYou can mark a radio card as failing validation by setting the `error` prop to `true`.\n\n## A11y guidelines\n\nRadio card accepts all the common accessibility props, but also sets some defaults, including\naccessibility role `'radio'` and accessibility state that depends on the other props (`checked`, `inactive`)\nor the internal state in case of uncontrolled radio button.",
|
|
6238
|
+
"props": {
|
|
6239
|
+
"title": {
|
|
6240
|
+
"type": {
|
|
6241
|
+
"name": "string"
|
|
6242
|
+
},
|
|
6243
|
+
"required": false,
|
|
6244
|
+
"description": "Content to be displayed at the top of the card alongside the radio button"
|
|
6245
|
+
},
|
|
6246
|
+
"children": {
|
|
5914
6247
|
"type": {
|
|
5915
6248
|
"name": "union",
|
|
5916
6249
|
"value": [
|
|
@@ -7704,6 +8037,261 @@
|
|
|
7704
8037
|
}
|
|
7705
8038
|
}
|
|
7706
8039
|
},
|
|
8040
|
+
"Timeline": {
|
|
8041
|
+
"docs": {
|
|
8042
|
+
"description": "Timeline is a component that displays either a horizontal or vertical list of the\nchildren components passed by props\n\n## Component API\n\n- `horizontal` In order to display the Component list horizontally\n\n\n## A11y guidelines\nTimeline link supports all the common a11y props.",
|
|
8043
|
+
"props": {
|
|
8044
|
+
"variant": {
|
|
8045
|
+
"defaultValue": {
|
|
8046
|
+
"value": "{}",
|
|
8047
|
+
"computed": false
|
|
8048
|
+
},
|
|
8049
|
+
"type": {
|
|
8050
|
+
"name": "objectOf",
|
|
8051
|
+
"value": {
|
|
8052
|
+
"name": "union",
|
|
8053
|
+
"value": [
|
|
8054
|
+
{
|
|
8055
|
+
"name": "string"
|
|
8056
|
+
},
|
|
8057
|
+
{
|
|
8058
|
+
"name": "number"
|
|
8059
|
+
},
|
|
8060
|
+
{
|
|
8061
|
+
"name": "bool"
|
|
8062
|
+
}
|
|
8063
|
+
]
|
|
8064
|
+
}
|
|
8065
|
+
},
|
|
8066
|
+
"required": false,
|
|
8067
|
+
"description": ""
|
|
8068
|
+
},
|
|
8069
|
+
"tag": {
|
|
8070
|
+
"defaultValue": {
|
|
8071
|
+
"value": "'ul'",
|
|
8072
|
+
"computed": false
|
|
8073
|
+
},
|
|
8074
|
+
"type": {
|
|
8075
|
+
"name": "enum",
|
|
8076
|
+
"value": [
|
|
8077
|
+
{
|
|
8078
|
+
"value": "'h1'",
|
|
8079
|
+
"computed": false
|
|
8080
|
+
},
|
|
8081
|
+
{
|
|
8082
|
+
"value": "'h2'",
|
|
8083
|
+
"computed": false
|
|
8084
|
+
},
|
|
8085
|
+
{
|
|
8086
|
+
"value": "'h3'",
|
|
8087
|
+
"computed": false
|
|
8088
|
+
},
|
|
8089
|
+
{
|
|
8090
|
+
"value": "'h4'",
|
|
8091
|
+
"computed": false
|
|
8092
|
+
},
|
|
8093
|
+
{
|
|
8094
|
+
"value": "'h5'",
|
|
8095
|
+
"computed": false
|
|
8096
|
+
},
|
|
8097
|
+
{
|
|
8098
|
+
"value": "'h6'",
|
|
8099
|
+
"computed": false
|
|
8100
|
+
},
|
|
8101
|
+
{
|
|
8102
|
+
"value": "'article'",
|
|
8103
|
+
"computed": false
|
|
8104
|
+
},
|
|
8105
|
+
{
|
|
8106
|
+
"value": "'aside'",
|
|
8107
|
+
"computed": false
|
|
8108
|
+
},
|
|
8109
|
+
{
|
|
8110
|
+
"value": "'blockquote'",
|
|
8111
|
+
"computed": false
|
|
8112
|
+
},
|
|
8113
|
+
{
|
|
8114
|
+
"value": "'footer'",
|
|
8115
|
+
"computed": false
|
|
8116
|
+
},
|
|
8117
|
+
{
|
|
8118
|
+
"value": "'figure'",
|
|
8119
|
+
"computed": false
|
|
8120
|
+
},
|
|
8121
|
+
{
|
|
8122
|
+
"value": "'form'",
|
|
8123
|
+
"computed": false
|
|
8124
|
+
},
|
|
8125
|
+
{
|
|
8126
|
+
"value": "'header'",
|
|
8127
|
+
"computed": false
|
|
8128
|
+
},
|
|
8129
|
+
{
|
|
8130
|
+
"value": "'ul'",
|
|
8131
|
+
"computed": false
|
|
8132
|
+
},
|
|
8133
|
+
{
|
|
8134
|
+
"value": "'li'",
|
|
8135
|
+
"computed": false
|
|
8136
|
+
},
|
|
8137
|
+
{
|
|
8138
|
+
"value": "'main'",
|
|
8139
|
+
"computed": false
|
|
8140
|
+
},
|
|
8141
|
+
{
|
|
8142
|
+
"value": "'nav'",
|
|
8143
|
+
"computed": false
|
|
8144
|
+
},
|
|
8145
|
+
{
|
|
8146
|
+
"value": "'section'",
|
|
8147
|
+
"computed": false
|
|
8148
|
+
},
|
|
8149
|
+
{
|
|
8150
|
+
"value": "'label'",
|
|
8151
|
+
"computed": false
|
|
8152
|
+
}
|
|
8153
|
+
]
|
|
8154
|
+
},
|
|
8155
|
+
"required": false,
|
|
8156
|
+
"description": "Sets the HTML tag of the outer container and the children. By default `'li'` for the children\nand `'ul'` for the container\n\nIf either `tag` or `childrenTag` is overridden, the other should be too, to avoid producing invalid HTML."
|
|
8157
|
+
},
|
|
8158
|
+
"childrenTag": {
|
|
8159
|
+
"defaultValue": {
|
|
8160
|
+
"value": "'li'",
|
|
8161
|
+
"computed": false
|
|
8162
|
+
},
|
|
8163
|
+
"type": {
|
|
8164
|
+
"name": "enum",
|
|
8165
|
+
"value": [
|
|
8166
|
+
{
|
|
8167
|
+
"value": "'h1'",
|
|
8168
|
+
"computed": false
|
|
8169
|
+
},
|
|
8170
|
+
{
|
|
8171
|
+
"value": "'h2'",
|
|
8172
|
+
"computed": false
|
|
8173
|
+
},
|
|
8174
|
+
{
|
|
8175
|
+
"value": "'h3'",
|
|
8176
|
+
"computed": false
|
|
8177
|
+
},
|
|
8178
|
+
{
|
|
8179
|
+
"value": "'h4'",
|
|
8180
|
+
"computed": false
|
|
8181
|
+
},
|
|
8182
|
+
{
|
|
8183
|
+
"value": "'h5'",
|
|
8184
|
+
"computed": false
|
|
8185
|
+
},
|
|
8186
|
+
{
|
|
8187
|
+
"value": "'h6'",
|
|
8188
|
+
"computed": false
|
|
8189
|
+
},
|
|
8190
|
+
{
|
|
8191
|
+
"value": "'article'",
|
|
8192
|
+
"computed": false
|
|
8193
|
+
},
|
|
8194
|
+
{
|
|
8195
|
+
"value": "'aside'",
|
|
8196
|
+
"computed": false
|
|
8197
|
+
},
|
|
8198
|
+
{
|
|
8199
|
+
"value": "'blockquote'",
|
|
8200
|
+
"computed": false
|
|
8201
|
+
},
|
|
8202
|
+
{
|
|
8203
|
+
"value": "'footer'",
|
|
8204
|
+
"computed": false
|
|
8205
|
+
},
|
|
8206
|
+
{
|
|
8207
|
+
"value": "'figure'",
|
|
8208
|
+
"computed": false
|
|
8209
|
+
},
|
|
8210
|
+
{
|
|
8211
|
+
"value": "'form'",
|
|
8212
|
+
"computed": false
|
|
8213
|
+
},
|
|
8214
|
+
{
|
|
8215
|
+
"value": "'header'",
|
|
8216
|
+
"computed": false
|
|
8217
|
+
},
|
|
8218
|
+
{
|
|
8219
|
+
"value": "'ul'",
|
|
8220
|
+
"computed": false
|
|
8221
|
+
},
|
|
8222
|
+
{
|
|
8223
|
+
"value": "'li'",
|
|
8224
|
+
"computed": false
|
|
8225
|
+
},
|
|
8226
|
+
{
|
|
8227
|
+
"value": "'main'",
|
|
8228
|
+
"computed": false
|
|
8229
|
+
},
|
|
8230
|
+
{
|
|
8231
|
+
"value": "'nav'",
|
|
8232
|
+
"computed": false
|
|
8233
|
+
},
|
|
8234
|
+
{
|
|
8235
|
+
"value": "'section'",
|
|
8236
|
+
"computed": false
|
|
8237
|
+
},
|
|
8238
|
+
{
|
|
8239
|
+
"value": "'label'",
|
|
8240
|
+
"computed": false
|
|
8241
|
+
}
|
|
8242
|
+
]
|
|
8243
|
+
},
|
|
8244
|
+
"required": false,
|
|
8245
|
+
"description": ""
|
|
8246
|
+
},
|
|
8247
|
+
"tokens": {
|
|
8248
|
+
"type": {
|
|
8249
|
+
"name": "custom",
|
|
8250
|
+
"raw": {
|
|
8251
|
+
"dotColor": "color",
|
|
8252
|
+
"dotWidth": "size",
|
|
8253
|
+
"dotBorderWidth": "border",
|
|
8254
|
+
"timelineContainerDirection": "direction",
|
|
8255
|
+
"timelineColor": "color",
|
|
8256
|
+
"connectorWidth": "size",
|
|
8257
|
+
"connectorHeight": "size",
|
|
8258
|
+
"lineItemContainerDirection": "direction",
|
|
8259
|
+
"lineContainerFlexSize": "integer",
|
|
8260
|
+
"lineItemAlign": "flexAlign",
|
|
8261
|
+
"lineItemDirection": "direction",
|
|
8262
|
+
"lineItemMarginRight": "size",
|
|
8263
|
+
"lineItemMarginBottom": "size",
|
|
8264
|
+
"itemContentFlexSize": "integer",
|
|
8265
|
+
"itemContentMarginRight": "size",
|
|
8266
|
+
"itemContentMarginBottom": "size"
|
|
8267
|
+
}
|
|
8268
|
+
},
|
|
8269
|
+
"required": false,
|
|
8270
|
+
"description": ""
|
|
8271
|
+
},
|
|
8272
|
+
"children": {
|
|
8273
|
+
"type": {
|
|
8274
|
+
"name": "arrayOf",
|
|
8275
|
+
"value": {
|
|
8276
|
+
"name": "node"
|
|
8277
|
+
}
|
|
8278
|
+
},
|
|
8279
|
+
"required": true,
|
|
8280
|
+
"description": "A list of components that will be rendered either horizontally or vertically"
|
|
8281
|
+
},
|
|
8282
|
+
"accessibilityLabel": {
|
|
8283
|
+
"type": {
|
|
8284
|
+
"name": "string"
|
|
8285
|
+
},
|
|
8286
|
+
"required": true,
|
|
8287
|
+
"description": "A required accessibility label that needs to be passed to be used on List\nwhich is applied as normal for a React Native accessibilityLabel prop."
|
|
8288
|
+
}
|
|
8289
|
+
},
|
|
8290
|
+
"attributes": {
|
|
8291
|
+
"acceptsRNA11yProps": false
|
|
8292
|
+
}
|
|
8293
|
+
}
|
|
8294
|
+
},
|
|
7707
8295
|
"Tooltip": {
|
|
7708
8296
|
"docs": {
|
|
7709
8297
|
"description": "Tooltip provides a descriptive and detailed explanation or instructions. It can be used next to an input label\nto help a user fill it in, or as a standalone component.\n\nBy default the TooltipButton component will be used as a control for triggering the tooltip, but you may attach\na tooltip to any other component. A render function can be used to adjust the control's styling on state changes (hover, focus, etc.).\n\n### Positioning\nBy default a Tooltip will be automatically positioned in a way that ensures it fits within the viewport.\nYou may suggest a position with a prop - it will be used, unless the tooltip would end up outside the viewport.\n\n### Usage criteria\n- You may use one when the information is useful only to a small percentage of users (ie. tech savvy people wouldn't need this info).\n- Tooltips may also be useful when vertical space is an issue.",
|