@shopify/polaris-types 1.1.0-rc.0 → 1.1.0-rc.1
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/custom-elements.json +672 -618
- package/dist/polaris.d.ts +109 -10
- package/package.json +1 -1
|
@@ -1213,6 +1213,15 @@
|
|
|
1213
1213
|
},
|
|
1214
1214
|
"description": "The value used in form data when the checkbox is checked."
|
|
1215
1215
|
},
|
|
1216
|
+
{
|
|
1217
|
+
"kind": "field",
|
|
1218
|
+
"name": "disabled",
|
|
1219
|
+
"type": {
|
|
1220
|
+
"text": "boolean"
|
|
1221
|
+
},
|
|
1222
|
+
"default": "false",
|
|
1223
|
+
"description": "Disables the control, disallowing any interaction."
|
|
1224
|
+
},
|
|
1216
1225
|
{
|
|
1217
1226
|
"kind": "field",
|
|
1218
1227
|
"name": "accessibilityLabel",
|
|
@@ -1223,20 +1232,21 @@
|
|
|
1223
1232
|
},
|
|
1224
1233
|
{
|
|
1225
1234
|
"kind": "field",
|
|
1226
|
-
"name": "
|
|
1235
|
+
"name": "checked",
|
|
1227
1236
|
"type": {
|
|
1228
1237
|
"text": "boolean"
|
|
1229
1238
|
},
|
|
1230
1239
|
"default": "false",
|
|
1231
|
-
"description": "
|
|
1240
|
+
"description": "Whether the control is active."
|
|
1232
1241
|
},
|
|
1233
1242
|
{
|
|
1234
1243
|
"kind": "field",
|
|
1235
|
-
"name": "
|
|
1244
|
+
"name": "defaultChecked",
|
|
1236
1245
|
"type": {
|
|
1237
|
-
"text": "
|
|
1246
|
+
"text": "boolean"
|
|
1238
1247
|
},
|
|
1239
|
-
"
|
|
1248
|
+
"default": "false",
|
|
1249
|
+
"description": "Whether the control is active by default."
|
|
1240
1250
|
},
|
|
1241
1251
|
{
|
|
1242
1252
|
"kind": "field",
|
|
@@ -1264,21 +1274,11 @@
|
|
|
1264
1274
|
},
|
|
1265
1275
|
{
|
|
1266
1276
|
"kind": "field",
|
|
1267
|
-
"name": "
|
|
1268
|
-
"type": {
|
|
1269
|
-
"text": "boolean"
|
|
1270
|
-
},
|
|
1271
|
-
"default": "false",
|
|
1272
|
-
"description": "Whether the control is active."
|
|
1273
|
-
},
|
|
1274
|
-
{
|
|
1275
|
-
"kind": "field",
|
|
1276
|
-
"name": "defaultChecked",
|
|
1277
|
+
"name": "name",
|
|
1277
1278
|
"type": {
|
|
1278
|
-
"text": "
|
|
1279
|
+
"text": "string"
|
|
1279
1280
|
},
|
|
1280
|
-
"
|
|
1281
|
-
"description": "Whether the control is active by default."
|
|
1281
|
+
"description": "An identifier for the control that is unique within the nearest containing `Form` component."
|
|
1282
1282
|
}
|
|
1283
1283
|
],
|
|
1284
1284
|
"events": [
|
|
@@ -1347,6 +1347,15 @@
|
|
|
1347
1347
|
},
|
|
1348
1348
|
"description": "The value used in form data when the checkbox is checked."
|
|
1349
1349
|
},
|
|
1350
|
+
{
|
|
1351
|
+
"name": "disabled",
|
|
1352
|
+
"fieldName": "disabled",
|
|
1353
|
+
"type": {
|
|
1354
|
+
"text": "boolean"
|
|
1355
|
+
},
|
|
1356
|
+
"default": "false",
|
|
1357
|
+
"description": "Disables the control, disallowing any interaction."
|
|
1358
|
+
},
|
|
1350
1359
|
{
|
|
1351
1360
|
"name": "accessibilitylabel",
|
|
1352
1361
|
"fieldName": "accessibilityLabel",
|
|
@@ -1356,21 +1365,22 @@
|
|
|
1356
1365
|
"description": "A label used for users using assistive technologies like screen readers. When set, any children or `label` supplied will not be announced. This can also be used to display a control without a visual label, while still providing context to users using screen readers."
|
|
1357
1366
|
},
|
|
1358
1367
|
{
|
|
1359
|
-
"name": "
|
|
1360
|
-
"fieldName": "
|
|
1368
|
+
"name": "checked",
|
|
1369
|
+
"fieldName": "checked",
|
|
1361
1370
|
"type": {
|
|
1362
1371
|
"text": "boolean"
|
|
1363
1372
|
},
|
|
1364
1373
|
"default": "false",
|
|
1365
|
-
"description": "
|
|
1374
|
+
"description": "Whether the control is active."
|
|
1366
1375
|
},
|
|
1367
1376
|
{
|
|
1368
|
-
"name": "
|
|
1369
|
-
"fieldName": "
|
|
1377
|
+
"name": "checked",
|
|
1378
|
+
"fieldName": "defaultChecked",
|
|
1370
1379
|
"type": {
|
|
1371
|
-
"text": "
|
|
1380
|
+
"text": "boolean"
|
|
1372
1381
|
},
|
|
1373
|
-
"
|
|
1382
|
+
"default": "false",
|
|
1383
|
+
"description": "Whether the control is active by default."
|
|
1374
1384
|
},
|
|
1375
1385
|
{
|
|
1376
1386
|
"name": "details",
|
|
@@ -1397,22 +1407,12 @@
|
|
|
1397
1407
|
"description": "Visual content to use as the control label."
|
|
1398
1408
|
},
|
|
1399
1409
|
{
|
|
1400
|
-
"name": "
|
|
1401
|
-
"fieldName": "
|
|
1402
|
-
"type": {
|
|
1403
|
-
"text": "boolean"
|
|
1404
|
-
},
|
|
1405
|
-
"default": "false",
|
|
1406
|
-
"description": "Whether the control is active."
|
|
1407
|
-
},
|
|
1408
|
-
{
|
|
1409
|
-
"name": "checked",
|
|
1410
|
-
"fieldName": "defaultChecked",
|
|
1410
|
+
"name": "name",
|
|
1411
|
+
"fieldName": "name",
|
|
1411
1412
|
"type": {
|
|
1412
|
-
"text": "
|
|
1413
|
+
"text": "string"
|
|
1413
1414
|
},
|
|
1414
|
-
"
|
|
1415
|
-
"description": "Whether the control is active by default."
|
|
1415
|
+
"description": "An identifier for the control that is unique within the nearest containing `Form` component."
|
|
1416
1416
|
}
|
|
1417
1417
|
],
|
|
1418
1418
|
"superclass": {
|
|
@@ -1540,20 +1540,20 @@
|
|
|
1540
1540
|
"members": [
|
|
1541
1541
|
{
|
|
1542
1542
|
"kind": "field",
|
|
1543
|
-
"name": "
|
|
1543
|
+
"name": "disabled",
|
|
1544
1544
|
"type": {
|
|
1545
|
-
"text": "
|
|
1545
|
+
"text": "boolean"
|
|
1546
1546
|
},
|
|
1547
|
-
"
|
|
1547
|
+
"default": "false",
|
|
1548
|
+
"description": "Disables the control, disallowing any interaction."
|
|
1548
1549
|
},
|
|
1549
1550
|
{
|
|
1550
1551
|
"kind": "field",
|
|
1551
|
-
"name": "
|
|
1552
|
+
"name": "accessibilityLabel",
|
|
1552
1553
|
"type": {
|
|
1553
|
-
"text": "
|
|
1554
|
+
"text": "string"
|
|
1554
1555
|
},
|
|
1555
|
-
"
|
|
1556
|
-
"description": "Disables the control, disallowing any interaction."
|
|
1556
|
+
"description": "A label used for users using assistive technologies like screen readers. When set, any children or `label` supplied will not be announced. This can also be used to display a control without a visual label, while still providing context to users using screen readers."
|
|
1557
1557
|
},
|
|
1558
1558
|
{
|
|
1559
1559
|
"kind": "field",
|
|
@@ -1583,14 +1583,6 @@
|
|
|
1583
1583
|
}
|
|
1584
1584
|
],
|
|
1585
1585
|
"attributes": [
|
|
1586
|
-
{
|
|
1587
|
-
"name": "accessibilitylabel",
|
|
1588
|
-
"fieldName": "accessibilityLabel",
|
|
1589
|
-
"type": {
|
|
1590
|
-
"text": "string"
|
|
1591
|
-
},
|
|
1592
|
-
"description": "A label used for users using assistive technologies like screen readers. When set, any children or `label` supplied will not be announced. This can also be used to display a control without a visual label, while still providing context to users using screen readers."
|
|
1593
|
-
},
|
|
1594
1586
|
{
|
|
1595
1587
|
"name": "disabled",
|
|
1596
1588
|
"fieldName": "disabled",
|
|
@@ -1600,6 +1592,14 @@
|
|
|
1600
1592
|
"default": "false",
|
|
1601
1593
|
"description": "Disables the control, disallowing any interaction."
|
|
1602
1594
|
},
|
|
1595
|
+
{
|
|
1596
|
+
"name": "accessibilitylabel",
|
|
1597
|
+
"fieldName": "accessibilityLabel",
|
|
1598
|
+
"type": {
|
|
1599
|
+
"text": "string"
|
|
1600
|
+
},
|
|
1601
|
+
"description": "A label used for users using assistive technologies like screen readers. When set, any children or `label` supplied will not be announced. This can also be used to display a control without a visual label, while still providing context to users using screen readers."
|
|
1602
|
+
},
|
|
1603
1603
|
{
|
|
1604
1604
|
"name": "value",
|
|
1605
1605
|
"fieldName": "value",
|
|
@@ -1669,14 +1669,6 @@
|
|
|
1669
1669
|
"default": "false",
|
|
1670
1670
|
"description": "Whether multiple choices can be selected."
|
|
1671
1671
|
},
|
|
1672
|
-
{
|
|
1673
|
-
"kind": "field",
|
|
1674
|
-
"name": "name",
|
|
1675
|
-
"type": {
|
|
1676
|
-
"text": "string"
|
|
1677
|
-
},
|
|
1678
|
-
"description": "An identifier for the field that is unique within the nearest containing form."
|
|
1679
|
-
},
|
|
1680
1672
|
{
|
|
1681
1673
|
"kind": "field",
|
|
1682
1674
|
"name": "details",
|
|
@@ -1701,6 +1693,14 @@
|
|
|
1701
1693
|
},
|
|
1702
1694
|
"description": "Content to use as the field label."
|
|
1703
1695
|
},
|
|
1696
|
+
{
|
|
1697
|
+
"kind": "field",
|
|
1698
|
+
"name": "name",
|
|
1699
|
+
"type": {
|
|
1700
|
+
"text": "string"
|
|
1701
|
+
},
|
|
1702
|
+
"description": "An identifier for the field that is unique within the nearest containing form."
|
|
1703
|
+
},
|
|
1704
1704
|
{
|
|
1705
1705
|
"kind": "field",
|
|
1706
1706
|
"name": "labelAccessibilityVisibility",
|
|
@@ -1786,14 +1786,6 @@
|
|
|
1786
1786
|
"default": "false",
|
|
1787
1787
|
"description": "Whether multiple choices can be selected."
|
|
1788
1788
|
},
|
|
1789
|
-
{
|
|
1790
|
-
"name": "name",
|
|
1791
|
-
"fieldName": "name",
|
|
1792
|
-
"type": {
|
|
1793
|
-
"text": "string"
|
|
1794
|
-
},
|
|
1795
|
-
"description": "An identifier for the field that is unique within the nearest containing form."
|
|
1796
|
-
},
|
|
1797
1789
|
{
|
|
1798
1790
|
"name": "details",
|
|
1799
1791
|
"fieldName": "details",
|
|
@@ -1818,6 +1810,14 @@
|
|
|
1818
1810
|
},
|
|
1819
1811
|
"description": "Content to use as the field label."
|
|
1820
1812
|
},
|
|
1813
|
+
{
|
|
1814
|
+
"name": "name",
|
|
1815
|
+
"fieldName": "name",
|
|
1816
|
+
"type": {
|
|
1817
|
+
"text": "string"
|
|
1818
|
+
},
|
|
1819
|
+
"description": "An identifier for the field that is unique within the nearest containing form."
|
|
1820
|
+
},
|
|
1821
1821
|
{
|
|
1822
1822
|
"name": "labelaccessibilityvisibility",
|
|
1823
1823
|
"fieldName": "labelAccessibilityVisibility",
|
|
@@ -2757,14 +2757,6 @@
|
|
|
2757
2757
|
},
|
|
2758
2758
|
"description": "The current value for the field. If omitted, the field will be empty."
|
|
2759
2759
|
},
|
|
2760
|
-
{
|
|
2761
|
-
"kind": "field",
|
|
2762
|
-
"name": "defaultValue",
|
|
2763
|
-
"type": {
|
|
2764
|
-
"text": "string"
|
|
2765
|
-
},
|
|
2766
|
-
"description": "The default value for the field."
|
|
2767
|
-
},
|
|
2768
2760
|
{
|
|
2769
2761
|
"kind": "field",
|
|
2770
2762
|
"name": "details",
|
|
@@ -2789,6 +2781,15 @@
|
|
|
2789
2781
|
},
|
|
2790
2782
|
"description": "Content to use as the field label."
|
|
2791
2783
|
},
|
|
2784
|
+
{
|
|
2785
|
+
"kind": "field",
|
|
2786
|
+
"name": "required",
|
|
2787
|
+
"type": {
|
|
2788
|
+
"text": "boolean"
|
|
2789
|
+
},
|
|
2790
|
+
"default": "false",
|
|
2791
|
+
"description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property."
|
|
2792
|
+
},
|
|
2792
2793
|
{
|
|
2793
2794
|
"kind": "field",
|
|
2794
2795
|
"name": "labelAccessibilityVisibility",
|
|
@@ -2800,29 +2801,28 @@
|
|
|
2800
2801
|
},
|
|
2801
2802
|
{
|
|
2802
2803
|
"kind": "field",
|
|
2803
|
-
"name": "
|
|
2804
|
+
"name": "defaultValue",
|
|
2804
2805
|
"type": {
|
|
2805
2806
|
"text": "string"
|
|
2806
2807
|
},
|
|
2807
|
-
"description": "
|
|
2808
|
+
"description": "The default value for the field."
|
|
2808
2809
|
},
|
|
2809
2810
|
{
|
|
2810
2811
|
"kind": "field",
|
|
2811
|
-
"name": "
|
|
2812
|
+
"name": "placeholder",
|
|
2812
2813
|
"type": {
|
|
2813
|
-
"text": "
|
|
2814
|
+
"text": "string"
|
|
2814
2815
|
},
|
|
2815
|
-
"
|
|
2816
|
-
"description": "The field cannot be edited by the user. It is focusable will be announced by screen readers."
|
|
2816
|
+
"description": "A short hint that describes the expected value of the field."
|
|
2817
2817
|
},
|
|
2818
2818
|
{
|
|
2819
2819
|
"kind": "field",
|
|
2820
|
-
"name": "
|
|
2820
|
+
"name": "readOnly",
|
|
2821
2821
|
"type": {
|
|
2822
2822
|
"text": "boolean"
|
|
2823
2823
|
},
|
|
2824
2824
|
"default": "false",
|
|
2825
|
-
"description": "
|
|
2825
|
+
"description": "The field cannot be edited by the user. It is focusable will be announced by screen readers."
|
|
2826
2826
|
},
|
|
2827
2827
|
{
|
|
2828
2828
|
"kind": "field",
|
|
@@ -2907,14 +2907,6 @@
|
|
|
2907
2907
|
},
|
|
2908
2908
|
"description": "The current value for the field. If omitted, the field will be empty."
|
|
2909
2909
|
},
|
|
2910
|
-
{
|
|
2911
|
-
"name": "value",
|
|
2912
|
-
"fieldName": "defaultValue",
|
|
2913
|
-
"type": {
|
|
2914
|
-
"text": "string"
|
|
2915
|
-
},
|
|
2916
|
-
"description": "The default value for the field."
|
|
2917
|
-
},
|
|
2918
2910
|
{
|
|
2919
2911
|
"name": "details",
|
|
2920
2912
|
"fieldName": "details",
|
|
@@ -2939,6 +2931,15 @@
|
|
|
2939
2931
|
},
|
|
2940
2932
|
"description": "Content to use as the field label."
|
|
2941
2933
|
},
|
|
2934
|
+
{
|
|
2935
|
+
"name": "required",
|
|
2936
|
+
"fieldName": "required",
|
|
2937
|
+
"type": {
|
|
2938
|
+
"text": "boolean"
|
|
2939
|
+
},
|
|
2940
|
+
"default": "false",
|
|
2941
|
+
"description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property."
|
|
2942
|
+
},
|
|
2942
2943
|
{
|
|
2943
2944
|
"name": "labelaccessibilityvisibility",
|
|
2944
2945
|
"fieldName": "labelAccessibilityVisibility",
|
|
@@ -2948,6 +2949,14 @@
|
|
|
2948
2949
|
"default": "'visible'",
|
|
2949
2950
|
"description": "Changes the visibility of the component's label. - `visible`: the label is visible to all users. - `exclusive`: the label is visually hidden but remains in the accessibility tree."
|
|
2950
2951
|
},
|
|
2952
|
+
{
|
|
2953
|
+
"name": "value",
|
|
2954
|
+
"fieldName": "defaultValue",
|
|
2955
|
+
"type": {
|
|
2956
|
+
"text": "string"
|
|
2957
|
+
},
|
|
2958
|
+
"description": "The default value for the field."
|
|
2959
|
+
},
|
|
2951
2960
|
{
|
|
2952
2961
|
"name": "placeholder",
|
|
2953
2962
|
"fieldName": "placeholder",
|
|
@@ -2965,15 +2974,6 @@
|
|
|
2965
2974
|
"default": "false",
|
|
2966
2975
|
"description": "The field cannot be edited by the user. It is focusable will be announced by screen readers."
|
|
2967
2976
|
},
|
|
2968
|
-
{
|
|
2969
|
-
"name": "required",
|
|
2970
|
-
"fieldName": "required",
|
|
2971
|
-
"type": {
|
|
2972
|
-
"text": "boolean"
|
|
2973
|
-
},
|
|
2974
|
-
"default": "false",
|
|
2975
|
-
"description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property."
|
|
2976
|
-
},
|
|
2977
2977
|
{
|
|
2978
2978
|
"name": "autocomplete",
|
|
2979
2979
|
"fieldName": "autocomplete",
|
|
@@ -3235,6 +3235,15 @@
|
|
|
3235
3235
|
},
|
|
3236
3236
|
"description": "Content to use as the field label."
|
|
3237
3237
|
},
|
|
3238
|
+
{
|
|
3239
|
+
"kind": "field",
|
|
3240
|
+
"name": "required",
|
|
3241
|
+
"type": {
|
|
3242
|
+
"text": "boolean"
|
|
3243
|
+
},
|
|
3244
|
+
"default": "false",
|
|
3245
|
+
"description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property."
|
|
3246
|
+
},
|
|
3238
3247
|
{
|
|
3239
3248
|
"kind": "field",
|
|
3240
3249
|
"name": "labelAccessibilityVisibility",
|
|
@@ -3261,15 +3270,6 @@
|
|
|
3261
3270
|
"default": "false",
|
|
3262
3271
|
"description": "The field cannot be edited by the user. It is focusable will be announced by screen readers."
|
|
3263
3272
|
},
|
|
3264
|
-
{
|
|
3265
|
-
"kind": "field",
|
|
3266
|
-
"name": "required",
|
|
3267
|
-
"type": {
|
|
3268
|
-
"text": "boolean"
|
|
3269
|
-
},
|
|
3270
|
-
"default": "false",
|
|
3271
|
-
"description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property."
|
|
3272
|
-
},
|
|
3273
3273
|
{
|
|
3274
3274
|
"kind": "field",
|
|
3275
3275
|
"name": "autocomplete",
|
|
@@ -3444,6 +3444,15 @@
|
|
|
3444
3444
|
},
|
|
3445
3445
|
"description": "Content to use as the field label."
|
|
3446
3446
|
},
|
|
3447
|
+
{
|
|
3448
|
+
"name": "required",
|
|
3449
|
+
"fieldName": "required",
|
|
3450
|
+
"type": {
|
|
3451
|
+
"text": "boolean"
|
|
3452
|
+
},
|
|
3453
|
+
"default": "false",
|
|
3454
|
+
"description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property."
|
|
3455
|
+
},
|
|
3447
3456
|
{
|
|
3448
3457
|
"name": "labelaccessibilityvisibility",
|
|
3449
3458
|
"fieldName": "labelAccessibilityVisibility",
|
|
@@ -3470,15 +3479,6 @@
|
|
|
3470
3479
|
"default": "false",
|
|
3471
3480
|
"description": "The field cannot be edited by the user. It is focusable will be announced by screen readers."
|
|
3472
3481
|
},
|
|
3473
|
-
{
|
|
3474
|
-
"name": "required",
|
|
3475
|
-
"fieldName": "required",
|
|
3476
|
-
"type": {
|
|
3477
|
-
"text": "boolean"
|
|
3478
|
-
},
|
|
3479
|
-
"default": "false",
|
|
3480
|
-
"description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property."
|
|
3481
|
-
},
|
|
3482
3482
|
{
|
|
3483
3483
|
"name": "autocomplete",
|
|
3484
3484
|
"fieldName": "autocomplete",
|
|
@@ -3909,36 +3909,36 @@
|
|
|
3909
3909
|
},
|
|
3910
3910
|
{
|
|
3911
3911
|
"kind": "field",
|
|
3912
|
-
"name": "
|
|
3912
|
+
"name": "error",
|
|
3913
3913
|
"type": {
|
|
3914
|
-
"text": "
|
|
3914
|
+
"text": "any"
|
|
3915
3915
|
},
|
|
3916
|
-
"description": "
|
|
3916
|
+
"description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately."
|
|
3917
3917
|
},
|
|
3918
3918
|
{
|
|
3919
3919
|
"kind": "field",
|
|
3920
|
-
"name": "
|
|
3920
|
+
"name": "label",
|
|
3921
3921
|
"type": {
|
|
3922
|
-
"text": "
|
|
3922
|
+
"text": "any"
|
|
3923
3923
|
},
|
|
3924
|
-
"
|
|
3925
|
-
"description": "A string that represents the path to the selected file(s). If no file is selected yet, the value is an empty string (\"\"). When the user selected multiple files, the value represents the first file in the list of files they selected. The value is always the file's name prefixed with \"C:\\fakepath\\\", which isn't the real path of the file."
|
|
3924
|
+
"description": "Content to use as the field label."
|
|
3926
3925
|
},
|
|
3927
3926
|
{
|
|
3928
3927
|
"kind": "field",
|
|
3929
|
-
"name": "
|
|
3928
|
+
"name": "required",
|
|
3930
3929
|
"type": {
|
|
3931
|
-
"text": "
|
|
3930
|
+
"text": "boolean"
|
|
3932
3931
|
},
|
|
3933
|
-
"
|
|
3932
|
+
"default": "false",
|
|
3933
|
+
"description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property."
|
|
3934
3934
|
},
|
|
3935
3935
|
{
|
|
3936
3936
|
"kind": "field",
|
|
3937
|
-
"name": "
|
|
3937
|
+
"name": "name",
|
|
3938
3938
|
"type": {
|
|
3939
|
-
"text": "
|
|
3939
|
+
"text": "string"
|
|
3940
3940
|
},
|
|
3941
|
-
"description": "
|
|
3941
|
+
"description": "An identifier for the field that is unique within the nearest containing form."
|
|
3942
3942
|
},
|
|
3943
3943
|
{
|
|
3944
3944
|
"kind": "field",
|
|
@@ -3951,12 +3951,12 @@
|
|
|
3951
3951
|
},
|
|
3952
3952
|
{
|
|
3953
3953
|
"kind": "field",
|
|
3954
|
-
"name": "
|
|
3954
|
+
"name": "value",
|
|
3955
3955
|
"type": {
|
|
3956
|
-
"text": "
|
|
3956
|
+
"text": "string"
|
|
3957
3957
|
},
|
|
3958
|
-
"default": "
|
|
3959
|
-
"description": "
|
|
3958
|
+
"default": "''",
|
|
3959
|
+
"description": "A string that represents the path to the selected file(s). If no file is selected yet, the value is an empty string (\"\"). When the user selected multiple files, the value represents the first file in the list of files they selected. The value is always the file's name prefixed with \"C:\\fakepath\\\", which isn't the real path of the file."
|
|
3960
3960
|
},
|
|
3961
3961
|
{
|
|
3962
3962
|
"kind": "field",
|
|
@@ -4027,23 +4027,6 @@
|
|
|
4027
4027
|
"default": "false",
|
|
4028
4028
|
"description": "Disables the field, disallowing any interaction."
|
|
4029
4029
|
},
|
|
4030
|
-
{
|
|
4031
|
-
"name": "name",
|
|
4032
|
-
"fieldName": "name",
|
|
4033
|
-
"type": {
|
|
4034
|
-
"text": "string"
|
|
4035
|
-
},
|
|
4036
|
-
"description": "An identifier for the field that is unique within the nearest containing form."
|
|
4037
|
-
},
|
|
4038
|
-
{
|
|
4039
|
-
"name": "value",
|
|
4040
|
-
"fieldName": "value",
|
|
4041
|
-
"type": {
|
|
4042
|
-
"text": "string"
|
|
4043
|
-
},
|
|
4044
|
-
"default": "''",
|
|
4045
|
-
"description": "A string that represents the path to the selected file(s). If no file is selected yet, the value is an empty string (\"\"). When the user selected multiple files, the value represents the first file in the list of files they selected. The value is always the file's name prefixed with \"C:\\fakepath\\\", which isn't the real path of the file."
|
|
4046
|
-
},
|
|
4047
4030
|
{
|
|
4048
4031
|
"name": "error",
|
|
4049
4032
|
"fieldName": "error",
|
|
@@ -4060,6 +4043,23 @@
|
|
|
4060
4043
|
},
|
|
4061
4044
|
"description": "Content to use as the field label."
|
|
4062
4045
|
},
|
|
4046
|
+
{
|
|
4047
|
+
"name": "required",
|
|
4048
|
+
"fieldName": "required",
|
|
4049
|
+
"type": {
|
|
4050
|
+
"text": "boolean"
|
|
4051
|
+
},
|
|
4052
|
+
"default": "false",
|
|
4053
|
+
"description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property."
|
|
4054
|
+
},
|
|
4055
|
+
{
|
|
4056
|
+
"name": "name",
|
|
4057
|
+
"fieldName": "name",
|
|
4058
|
+
"type": {
|
|
4059
|
+
"text": "string"
|
|
4060
|
+
},
|
|
4061
|
+
"description": "An identifier for the field that is unique within the nearest containing form."
|
|
4062
|
+
},
|
|
4063
4063
|
{
|
|
4064
4064
|
"name": "labelaccessibilityvisibility",
|
|
4065
4065
|
"fieldName": "labelAccessibilityVisibility",
|
|
@@ -4070,13 +4070,13 @@
|
|
|
4070
4070
|
"description": "Changes the visibility of the component's label. - `visible`: the label is visible to all users. - `exclusive`: the label is visually hidden but remains in the accessibility tree."
|
|
4071
4071
|
},
|
|
4072
4072
|
{
|
|
4073
|
-
"name": "
|
|
4074
|
-
"fieldName": "
|
|
4073
|
+
"name": "value",
|
|
4074
|
+
"fieldName": "value",
|
|
4075
4075
|
"type": {
|
|
4076
|
-
"text": "
|
|
4076
|
+
"text": "string"
|
|
4077
4077
|
},
|
|
4078
|
-
"default": "
|
|
4079
|
-
"description": "
|
|
4078
|
+
"default": "''",
|
|
4079
|
+
"description": "A string that represents the path to the selected file(s). If no file is selected yet, the value is an empty string (\"\"). When the user selected multiple files, the value represents the first file in the list of files they selected. The value is always the file's name prefixed with \"C:\\fakepath\\\", which isn't the real path of the file."
|
|
4080
4080
|
},
|
|
4081
4081
|
{
|
|
4082
4082
|
"name": "files",
|
|
@@ -4147,14 +4147,6 @@
|
|
|
4147
4147
|
},
|
|
4148
4148
|
"description": "The current value for the field. If omitted, the field will be empty."
|
|
4149
4149
|
},
|
|
4150
|
-
{
|
|
4151
|
-
"kind": "field",
|
|
4152
|
-
"name": "defaultValue",
|
|
4153
|
-
"type": {
|
|
4154
|
-
"text": "string"
|
|
4155
|
-
},
|
|
4156
|
-
"description": "The default value for the field."
|
|
4157
|
-
},
|
|
4158
4150
|
{
|
|
4159
4151
|
"kind": "field",
|
|
4160
4152
|
"name": "details",
|
|
@@ -4179,6 +4171,15 @@
|
|
|
4179
4171
|
},
|
|
4180
4172
|
"description": "Content to use as the field label."
|
|
4181
4173
|
},
|
|
4174
|
+
{
|
|
4175
|
+
"kind": "field",
|
|
4176
|
+
"name": "required",
|
|
4177
|
+
"type": {
|
|
4178
|
+
"text": "boolean"
|
|
4179
|
+
},
|
|
4180
|
+
"default": "false",
|
|
4181
|
+
"description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property."
|
|
4182
|
+
},
|
|
4182
4183
|
{
|
|
4183
4184
|
"kind": "field",
|
|
4184
4185
|
"name": "labelAccessibilityVisibility",
|
|
@@ -4190,29 +4191,28 @@
|
|
|
4190
4191
|
},
|
|
4191
4192
|
{
|
|
4192
4193
|
"kind": "field",
|
|
4193
|
-
"name": "
|
|
4194
|
+
"name": "defaultValue",
|
|
4194
4195
|
"type": {
|
|
4195
4196
|
"text": "string"
|
|
4196
4197
|
},
|
|
4197
|
-
"description": "
|
|
4198
|
+
"description": "The default value for the field."
|
|
4198
4199
|
},
|
|
4199
4200
|
{
|
|
4200
4201
|
"kind": "field",
|
|
4201
|
-
"name": "
|
|
4202
|
+
"name": "placeholder",
|
|
4202
4203
|
"type": {
|
|
4203
|
-
"text": "
|
|
4204
|
+
"text": "string"
|
|
4204
4205
|
},
|
|
4205
|
-
"
|
|
4206
|
-
"description": "The field cannot be edited by the user. It is focusable will be announced by screen readers."
|
|
4206
|
+
"description": "A short hint that describes the expected value of the field."
|
|
4207
4207
|
},
|
|
4208
4208
|
{
|
|
4209
4209
|
"kind": "field",
|
|
4210
|
-
"name": "
|
|
4210
|
+
"name": "readOnly",
|
|
4211
4211
|
"type": {
|
|
4212
4212
|
"text": "boolean"
|
|
4213
4213
|
},
|
|
4214
4214
|
"default": "false",
|
|
4215
|
-
"description": "
|
|
4215
|
+
"description": "The field cannot be edited by the user. It is focusable will be announced by screen readers."
|
|
4216
4216
|
},
|
|
4217
4217
|
{
|
|
4218
4218
|
"kind": "field",
|
|
@@ -4306,14 +4306,6 @@
|
|
|
4306
4306
|
},
|
|
4307
4307
|
"description": "The current value for the field. If omitted, the field will be empty."
|
|
4308
4308
|
},
|
|
4309
|
-
{
|
|
4310
|
-
"name": "value",
|
|
4311
|
-
"fieldName": "defaultValue",
|
|
4312
|
-
"type": {
|
|
4313
|
-
"text": "string"
|
|
4314
|
-
},
|
|
4315
|
-
"description": "The default value for the field."
|
|
4316
|
-
},
|
|
4317
4309
|
{
|
|
4318
4310
|
"name": "details",
|
|
4319
4311
|
"fieldName": "details",
|
|
@@ -4338,6 +4330,15 @@
|
|
|
4338
4330
|
},
|
|
4339
4331
|
"description": "Content to use as the field label."
|
|
4340
4332
|
},
|
|
4333
|
+
{
|
|
4334
|
+
"name": "required",
|
|
4335
|
+
"fieldName": "required",
|
|
4336
|
+
"type": {
|
|
4337
|
+
"text": "boolean"
|
|
4338
|
+
},
|
|
4339
|
+
"default": "false",
|
|
4340
|
+
"description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property."
|
|
4341
|
+
},
|
|
4341
4342
|
{
|
|
4342
4343
|
"name": "labelaccessibilityvisibility",
|
|
4343
4344
|
"fieldName": "labelAccessibilityVisibility",
|
|
@@ -4347,6 +4348,14 @@
|
|
|
4347
4348
|
"default": "'visible'",
|
|
4348
4349
|
"description": "Changes the visibility of the component's label. - `visible`: the label is visible to all users. - `exclusive`: the label is visually hidden but remains in the accessibility tree."
|
|
4349
4350
|
},
|
|
4351
|
+
{
|
|
4352
|
+
"name": "value",
|
|
4353
|
+
"fieldName": "defaultValue",
|
|
4354
|
+
"type": {
|
|
4355
|
+
"text": "string"
|
|
4356
|
+
},
|
|
4357
|
+
"description": "The default value for the field."
|
|
4358
|
+
},
|
|
4350
4359
|
{
|
|
4351
4360
|
"name": "placeholder",
|
|
4352
4361
|
"fieldName": "placeholder",
|
|
@@ -4364,15 +4373,6 @@
|
|
|
4364
4373
|
"default": "false",
|
|
4365
4374
|
"description": "The field cannot be edited by the user. It is focusable will be announced by screen readers."
|
|
4366
4375
|
},
|
|
4367
|
-
{
|
|
4368
|
-
"name": "required",
|
|
4369
|
-
"fieldName": "required",
|
|
4370
|
-
"type": {
|
|
4371
|
-
"text": "boolean"
|
|
4372
|
-
},
|
|
4373
|
-
"default": "false",
|
|
4374
|
-
"description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property."
|
|
4375
|
-
},
|
|
4376
4376
|
{
|
|
4377
4377
|
"name": "autocomplete",
|
|
4378
4378
|
"fieldName": "autocomplete",
|
|
@@ -4416,20 +4416,24 @@
|
|
|
4416
4416
|
"declarations": [
|
|
4417
4417
|
{
|
|
4418
4418
|
"kind": "class",
|
|
4419
|
-
"description": "",
|
|
4419
|
+
"description": "Configure the following properties on the empty state component.",
|
|
4420
4420
|
"name": "EmptyState",
|
|
4421
4421
|
"slots": [
|
|
4422
4422
|
{
|
|
4423
|
-
"name": "primary-action"
|
|
4423
|
+
"name": "primary-action",
|
|
4424
|
+
"description": "The main call to action, rendered below the text content. Accepts a single `Button` with a `variant` of `primary`; anything else is ignored with a development warning."
|
|
4424
4425
|
},
|
|
4425
4426
|
{
|
|
4426
|
-
"name": "secondary-actions"
|
|
4427
|
+
"name": "secondary-actions",
|
|
4428
|
+
"description": "An alternative action, rendered beside the primary one. Accepts a single `Button` with a `variant` of `secondary` or `auto` — despite the plural name, only one is rendered."
|
|
4427
4429
|
},
|
|
4428
4430
|
{
|
|
4429
|
-
"name": "graphic"
|
|
4431
|
+
"name": "graphic",
|
|
4432
|
+
"description": "An illustration or symbol shown above the heading. Accepts a single `Image` or `Icon`, either directly or as the only child of a wrapping element."
|
|
4430
4433
|
},
|
|
4431
4434
|
{
|
|
4432
|
-
"name": "subheading"
|
|
4435
|
+
"name": "subheading",
|
|
4436
|
+
"description": "Supporting text below the heading, explaining what's missing or what to do next. Accepts `Text` and `Link` components."
|
|
4433
4437
|
}
|
|
4434
4438
|
],
|
|
4435
4439
|
"members": [
|
|
@@ -5869,20 +5873,20 @@
|
|
|
5869
5873
|
},
|
|
5870
5874
|
{
|
|
5871
5875
|
"kind": "field",
|
|
5872
|
-
"name": "
|
|
5876
|
+
"name": "src",
|
|
5873
5877
|
"type": {
|
|
5874
5878
|
"text": "string"
|
|
5875
5879
|
},
|
|
5876
|
-
"
|
|
5877
|
-
"description": "An alternative text description that describe the image for the reader to understand what it is about. It is extremely useful for both users using assistive technology and sighted users. A well written description provides people with visual impairments the ability to participate in consuming non-text content. When a screen readers encounters an `s-image`, the description is read and announced aloud. If an image fails to load, potentially due to a poor connection, the `alt` is displayed on screen instead. This has the benefit of letting a sighted buyer know an image was meant to load here, but as an alternative, they’re still able to consume the text content. Read [considerations when writing alternative text](https://www.shopify.com/ca/blog/image-alt-text#4) to learn more."
|
|
5880
|
+
"description": "The image source (either a remote URL or a local file resource). When the image is loading or no `src` is provided, a placeholder will be rendered."
|
|
5878
5881
|
},
|
|
5879
5882
|
{
|
|
5880
5883
|
"kind": "field",
|
|
5881
|
-
"name": "
|
|
5884
|
+
"name": "alt",
|
|
5882
5885
|
"type": {
|
|
5883
5886
|
"text": "string"
|
|
5884
5887
|
},
|
|
5885
|
-
"
|
|
5888
|
+
"default": "`''`",
|
|
5889
|
+
"description": "An alternative text description that describe the image for the reader to understand what it is about. It is extremely useful for both users using assistive technology and sighted users. A well written description provides people with visual impairments the ability to participate in consuming non-text content. When a screen readers encounters an `s-image`, the description is read and announced aloud. If an image fails to load, potentially due to a poor connection, the `alt` is displayed on screen instead. This has the benefit of letting a sighted buyer know an image was meant to load here, but as an alternative, they’re still able to consume the text content. Read [considerations when writing alternative text](https://www.shopify.com/ca/blog/image-alt-text#4) to learn more."
|
|
5886
5890
|
},
|
|
5887
5891
|
{
|
|
5888
5892
|
"kind": "field",
|
|
@@ -6009,21 +6013,21 @@
|
|
|
6009
6013
|
"description": "The image resizing behavior to fit within its container. - `contain`: Scales the image to fit within the container while maintaining its aspect ratio. The entire image is visible, but might leave empty space. - `cover`: Scales the image to fill the entire container while maintaining its aspect ratio. The image might be cropped to fit. The image is always positioned in the center of the container. Learn more about the [object-fit property](https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit)."
|
|
6010
6014
|
},
|
|
6011
6015
|
{
|
|
6012
|
-
"name": "
|
|
6013
|
-
"fieldName": "
|
|
6016
|
+
"name": "src",
|
|
6017
|
+
"fieldName": "src",
|
|
6014
6018
|
"type": {
|
|
6015
6019
|
"text": "string"
|
|
6016
6020
|
},
|
|
6017
|
-
"
|
|
6018
|
-
"description": "An alternative text description that describe the image for the reader to understand what it is about. It is extremely useful for both users using assistive technology and sighted users. A well written description provides people with visual impairments the ability to participate in consuming non-text content. When a screen readers encounters an `s-image`, the description is read and announced aloud. If an image fails to load, potentially due to a poor connection, the `alt` is displayed on screen instead. This has the benefit of letting a sighted buyer know an image was meant to load here, but as an alternative, they’re still able to consume the text content. Read [considerations when writing alternative text](https://www.shopify.com/ca/blog/image-alt-text#4) to learn more."
|
|
6021
|
+
"description": "The image source (either a remote URL or a local file resource). When the image is loading or no `src` is provided, a placeholder will be rendered."
|
|
6019
6022
|
},
|
|
6020
6023
|
{
|
|
6021
|
-
"name": "
|
|
6022
|
-
"fieldName": "
|
|
6024
|
+
"name": "alt",
|
|
6025
|
+
"fieldName": "alt",
|
|
6023
6026
|
"type": {
|
|
6024
6027
|
"text": "string"
|
|
6025
6028
|
},
|
|
6026
|
-
"
|
|
6029
|
+
"default": "`''`",
|
|
6030
|
+
"description": "An alternative text description that describe the image for the reader to understand what it is about. It is extremely useful for both users using assistive technology and sighted users. A well written description provides people with visual impairments the ability to participate in consuming non-text content. When a screen readers encounters an `s-image`, the description is read and announced aloud. If an image fails to load, potentially due to a poor connection, the `alt` is displayed on screen instead. This has the benefit of letting a sighted buyer know an image was meant to load here, but as an alternative, they’re still able to consume the text content. Read [considerations when writing alternative text](https://www.shopify.com/ca/blog/image-alt-text#4) to learn more."
|
|
6027
6031
|
},
|
|
6028
6032
|
{
|
|
6029
6033
|
"name": "srcset",
|
|
@@ -6622,43 +6626,44 @@
|
|
|
6622
6626
|
},
|
|
6623
6627
|
{
|
|
6624
6628
|
"kind": "field",
|
|
6625
|
-
"name": "
|
|
6629
|
+
"name": "details",
|
|
6626
6630
|
"type": {
|
|
6627
|
-
"text": "
|
|
6631
|
+
"text": "any"
|
|
6628
6632
|
},
|
|
6629
|
-
"description": "
|
|
6633
|
+
"description": "Additional text to provide context or guidance for the field. This text is displayed along with the field and its label to offer more information or instructions to the user. This will also be exposed to screen reader users."
|
|
6630
6634
|
},
|
|
6631
6635
|
{
|
|
6632
6636
|
"kind": "field",
|
|
6633
|
-
"name": "
|
|
6637
|
+
"name": "error",
|
|
6634
6638
|
"type": {
|
|
6635
|
-
"text": "
|
|
6639
|
+
"text": "any"
|
|
6636
6640
|
},
|
|
6637
|
-
"description": "
|
|
6641
|
+
"description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately."
|
|
6638
6642
|
},
|
|
6639
6643
|
{
|
|
6640
6644
|
"kind": "field",
|
|
6641
|
-
"name": "
|
|
6645
|
+
"name": "label",
|
|
6642
6646
|
"type": {
|
|
6643
6647
|
"text": "any"
|
|
6644
6648
|
},
|
|
6645
|
-
"description": "
|
|
6649
|
+
"description": "Content to use as the field label."
|
|
6646
6650
|
},
|
|
6647
6651
|
{
|
|
6648
6652
|
"kind": "field",
|
|
6649
|
-
"name": "
|
|
6653
|
+
"name": "required",
|
|
6650
6654
|
"type": {
|
|
6651
|
-
"text": "
|
|
6655
|
+
"text": "boolean"
|
|
6652
6656
|
},
|
|
6653
|
-
"
|
|
6657
|
+
"default": "false",
|
|
6658
|
+
"description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property."
|
|
6654
6659
|
},
|
|
6655
6660
|
{
|
|
6656
6661
|
"kind": "field",
|
|
6657
|
-
"name": "
|
|
6662
|
+
"name": "name",
|
|
6658
6663
|
"type": {
|
|
6659
|
-
"text": "
|
|
6664
|
+
"text": "string"
|
|
6660
6665
|
},
|
|
6661
|
-
"description": "
|
|
6666
|
+
"description": "An identifier for the field that is unique within the nearest containing form."
|
|
6662
6667
|
},
|
|
6663
6668
|
{
|
|
6664
6669
|
"kind": "field",
|
|
@@ -6671,29 +6676,28 @@
|
|
|
6671
6676
|
},
|
|
6672
6677
|
{
|
|
6673
6678
|
"kind": "field",
|
|
6674
|
-
"name": "
|
|
6679
|
+
"name": "defaultValue",
|
|
6675
6680
|
"type": {
|
|
6676
6681
|
"text": "string"
|
|
6677
6682
|
},
|
|
6678
|
-
"description": "
|
|
6683
|
+
"description": "The default value for the field."
|
|
6679
6684
|
},
|
|
6680
6685
|
{
|
|
6681
6686
|
"kind": "field",
|
|
6682
|
-
"name": "
|
|
6687
|
+
"name": "placeholder",
|
|
6683
6688
|
"type": {
|
|
6684
|
-
"text": "
|
|
6689
|
+
"text": "string"
|
|
6685
6690
|
},
|
|
6686
|
-
"
|
|
6687
|
-
"description": "The field cannot be edited by the user. It is focusable will be announced by screen readers."
|
|
6691
|
+
"description": "A short hint that describes the expected value of the field."
|
|
6688
6692
|
},
|
|
6689
6693
|
{
|
|
6690
6694
|
"kind": "field",
|
|
6691
|
-
"name": "
|
|
6695
|
+
"name": "readOnly",
|
|
6692
6696
|
"type": {
|
|
6693
6697
|
"text": "boolean"
|
|
6694
6698
|
},
|
|
6695
6699
|
"default": "false",
|
|
6696
|
-
"description": "
|
|
6700
|
+
"description": "The field cannot be edited by the user. It is focusable will be announced by screen readers."
|
|
6697
6701
|
},
|
|
6698
6702
|
{
|
|
6699
6703
|
"kind": "field",
|
|
@@ -6787,22 +6791,6 @@
|
|
|
6787
6791
|
"default": "false",
|
|
6788
6792
|
"description": "Disables the field, disallowing any interaction."
|
|
6789
6793
|
},
|
|
6790
|
-
{
|
|
6791
|
-
"name": "name",
|
|
6792
|
-
"fieldName": "name",
|
|
6793
|
-
"type": {
|
|
6794
|
-
"text": "string"
|
|
6795
|
-
},
|
|
6796
|
-
"description": "An identifier for the field that is unique within the nearest containing form."
|
|
6797
|
-
},
|
|
6798
|
-
{
|
|
6799
|
-
"name": "value",
|
|
6800
|
-
"fieldName": "defaultValue",
|
|
6801
|
-
"type": {
|
|
6802
|
-
"text": "string"
|
|
6803
|
-
},
|
|
6804
|
-
"description": "The default value for the field."
|
|
6805
|
-
},
|
|
6806
6794
|
{
|
|
6807
6795
|
"name": "details",
|
|
6808
6796
|
"fieldName": "details",
|
|
@@ -6827,6 +6815,23 @@
|
|
|
6827
6815
|
},
|
|
6828
6816
|
"description": "Content to use as the field label."
|
|
6829
6817
|
},
|
|
6818
|
+
{
|
|
6819
|
+
"name": "required",
|
|
6820
|
+
"fieldName": "required",
|
|
6821
|
+
"type": {
|
|
6822
|
+
"text": "boolean"
|
|
6823
|
+
},
|
|
6824
|
+
"default": "false",
|
|
6825
|
+
"description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property."
|
|
6826
|
+
},
|
|
6827
|
+
{
|
|
6828
|
+
"name": "name",
|
|
6829
|
+
"fieldName": "name",
|
|
6830
|
+
"type": {
|
|
6831
|
+
"text": "string"
|
|
6832
|
+
},
|
|
6833
|
+
"description": "An identifier for the field that is unique within the nearest containing form."
|
|
6834
|
+
},
|
|
6830
6835
|
{
|
|
6831
6836
|
"name": "labelaccessibilityvisibility",
|
|
6832
6837
|
"fieldName": "labelAccessibilityVisibility",
|
|
@@ -6836,6 +6841,14 @@
|
|
|
6836
6841
|
"default": "'visible'",
|
|
6837
6842
|
"description": "Changes the visibility of the component's label. - `visible`: the label is visible to all users. - `exclusive`: the label is visually hidden but remains in the accessibility tree."
|
|
6838
6843
|
},
|
|
6844
|
+
{
|
|
6845
|
+
"name": "value",
|
|
6846
|
+
"fieldName": "defaultValue",
|
|
6847
|
+
"type": {
|
|
6848
|
+
"text": "string"
|
|
6849
|
+
},
|
|
6850
|
+
"description": "The default value for the field."
|
|
6851
|
+
},
|
|
6839
6852
|
{
|
|
6840
6853
|
"name": "placeholder",
|
|
6841
6854
|
"fieldName": "placeholder",
|
|
@@ -6853,15 +6866,6 @@
|
|
|
6853
6866
|
"default": "false",
|
|
6854
6867
|
"description": "The field cannot be edited by the user. It is focusable will be announced by screen readers."
|
|
6855
6868
|
},
|
|
6856
|
-
{
|
|
6857
|
-
"name": "required",
|
|
6858
|
-
"fieldName": "required",
|
|
6859
|
-
"type": {
|
|
6860
|
-
"text": "boolean"
|
|
6861
|
-
},
|
|
6862
|
-
"default": "false",
|
|
6863
|
-
"description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property."
|
|
6864
|
-
},
|
|
6865
6869
|
{
|
|
6866
6870
|
"name": "autocomplete",
|
|
6867
6871
|
"fieldName": "autocomplete",
|
|
@@ -6914,22 +6918,32 @@
|
|
|
6914
6918
|
"declarations": [
|
|
6915
6919
|
{
|
|
6916
6920
|
"kind": "class",
|
|
6917
|
-
"description": "",
|
|
6921
|
+
"description": "Configure the following properties on the number component.",
|
|
6918
6922
|
"name": "Number",
|
|
6919
|
-
"
|
|
6923
|
+
"slots": [
|
|
6920
6924
|
{
|
|
6921
|
-
"
|
|
6925
|
+
"name": "",
|
|
6926
|
+
"description": "The number to display. The component styles the value you pass in — typography, tone, and color — and renders it as given, so format and localize it yourself."
|
|
6927
|
+
}
|
|
6928
|
+
],
|
|
6929
|
+
"members": [
|
|
6930
|
+
{
|
|
6931
|
+
"kind": "field",
|
|
6922
6932
|
"name": "tone",
|
|
6923
6933
|
"type": {
|
|
6924
6934
|
"text": "\"auto\" | \"neutral\" | \"info\" | \"success\" | \"caution\" | \"warning\" | \"critical\""
|
|
6925
|
-
}
|
|
6935
|
+
},
|
|
6936
|
+
"default": "'auto'",
|
|
6937
|
+
"description": "The semantic tone that's applied to the number, which changes its color to convey meaning. - `info`: Informational content or helpful tips (blue). - `success`: Positive outcomes or successful states (green). - `warning`: Important warnings about potential issues (orange). - `critical`: Urgent problems or destructive actions (red). - `auto`: Automatically determined based on context. - `neutral`: General information without specific intent (gray). - `caution`: Advisory notices that need attention (yellow)."
|
|
6926
6938
|
},
|
|
6927
6939
|
{
|
|
6928
6940
|
"kind": "field",
|
|
6929
6941
|
"name": "color",
|
|
6930
6942
|
"type": {
|
|
6931
6943
|
"text": "\"subdued\" | \"base\""
|
|
6932
|
-
}
|
|
6944
|
+
},
|
|
6945
|
+
"default": "'base'",
|
|
6946
|
+
"description": "The color emphasis applied to the number. - `base`: Standard emphasis for numeric content. - `subdued`: Deemphasized color for secondary or supporting numeric content."
|
|
6933
6947
|
},
|
|
6934
6948
|
{
|
|
6935
6949
|
"kind": "field",
|
|
@@ -6974,14 +6988,18 @@
|
|
|
6974
6988
|
"fieldName": "tone",
|
|
6975
6989
|
"type": {
|
|
6976
6990
|
"text": "\"auto\" | \"neutral\" | \"info\" | \"success\" | \"caution\" | \"warning\" | \"critical\""
|
|
6977
|
-
}
|
|
6991
|
+
},
|
|
6992
|
+
"default": "'auto'",
|
|
6993
|
+
"description": "The semantic tone that's applied to the number, which changes its color to convey meaning. - `info`: Informational content or helpful tips (blue). - `success`: Positive outcomes or successful states (green). - `warning`: Important warnings about potential issues (orange). - `critical`: Urgent problems or destructive actions (red). - `auto`: Automatically determined based on context. - `neutral`: General information without specific intent (gray). - `caution`: Advisory notices that need attention (yellow)."
|
|
6978
6994
|
},
|
|
6979
6995
|
{
|
|
6980
6996
|
"name": "color",
|
|
6981
6997
|
"fieldName": "color",
|
|
6982
6998
|
"type": {
|
|
6983
6999
|
"text": "\"subdued\" | \"base\""
|
|
6984
|
-
}
|
|
7000
|
+
},
|
|
7001
|
+
"default": "'base'",
|
|
7002
|
+
"description": "The color emphasis applied to the number. - `base`: Standard emphasis for numeric content. - `subdued`: Deemphasized color for secondary or supporting numeric content."
|
|
6985
7003
|
},
|
|
6986
7004
|
{
|
|
6987
7005
|
"name": "fontsize",
|
|
@@ -7081,43 +7099,44 @@
|
|
|
7081
7099
|
},
|
|
7082
7100
|
{
|
|
7083
7101
|
"kind": "field",
|
|
7084
|
-
"name": "
|
|
7102
|
+
"name": "details",
|
|
7085
7103
|
"type": {
|
|
7086
|
-
"text": "
|
|
7104
|
+
"text": "any"
|
|
7087
7105
|
},
|
|
7088
|
-
"description": "
|
|
7106
|
+
"description": "Additional text to provide context or guidance for the field. This text is displayed along with the field and its label to offer more information or instructions to the user. This will also be exposed to screen reader users."
|
|
7089
7107
|
},
|
|
7090
7108
|
{
|
|
7091
7109
|
"kind": "field",
|
|
7092
|
-
"name": "
|
|
7110
|
+
"name": "error",
|
|
7093
7111
|
"type": {
|
|
7094
|
-
"text": "
|
|
7112
|
+
"text": "any"
|
|
7095
7113
|
},
|
|
7096
|
-
"description": "
|
|
7114
|
+
"description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately."
|
|
7097
7115
|
},
|
|
7098
7116
|
{
|
|
7099
7117
|
"kind": "field",
|
|
7100
|
-
"name": "
|
|
7118
|
+
"name": "label",
|
|
7101
7119
|
"type": {
|
|
7102
7120
|
"text": "any"
|
|
7103
7121
|
},
|
|
7104
|
-
"description": "
|
|
7122
|
+
"description": "Content to use as the field label."
|
|
7105
7123
|
},
|
|
7106
7124
|
{
|
|
7107
7125
|
"kind": "field",
|
|
7108
|
-
"name": "
|
|
7126
|
+
"name": "required",
|
|
7109
7127
|
"type": {
|
|
7110
|
-
"text": "
|
|
7128
|
+
"text": "boolean"
|
|
7111
7129
|
},
|
|
7112
|
-
"
|
|
7130
|
+
"default": "false",
|
|
7131
|
+
"description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property."
|
|
7113
7132
|
},
|
|
7114
7133
|
{
|
|
7115
7134
|
"kind": "field",
|
|
7116
|
-
"name": "
|
|
7135
|
+
"name": "name",
|
|
7117
7136
|
"type": {
|
|
7118
|
-
"text": "
|
|
7137
|
+
"text": "string"
|
|
7119
7138
|
},
|
|
7120
|
-
"description": "
|
|
7139
|
+
"description": "An identifier for the field that is unique within the nearest containing form."
|
|
7121
7140
|
},
|
|
7122
7141
|
{
|
|
7123
7142
|
"kind": "field",
|
|
@@ -7130,29 +7149,28 @@
|
|
|
7130
7149
|
},
|
|
7131
7150
|
{
|
|
7132
7151
|
"kind": "field",
|
|
7133
|
-
"name": "
|
|
7152
|
+
"name": "defaultValue",
|
|
7134
7153
|
"type": {
|
|
7135
7154
|
"text": "string"
|
|
7136
7155
|
},
|
|
7137
|
-
"description": "
|
|
7156
|
+
"description": "The default value for the field."
|
|
7138
7157
|
},
|
|
7139
7158
|
{
|
|
7140
7159
|
"kind": "field",
|
|
7141
|
-
"name": "
|
|
7160
|
+
"name": "placeholder",
|
|
7142
7161
|
"type": {
|
|
7143
|
-
"text": "
|
|
7162
|
+
"text": "string"
|
|
7144
7163
|
},
|
|
7145
|
-
"
|
|
7146
|
-
"description": "The field cannot be edited by the user. It is focusable will be announced by screen readers."
|
|
7164
|
+
"description": "A short hint that describes the expected value of the field."
|
|
7147
7165
|
},
|
|
7148
7166
|
{
|
|
7149
7167
|
"kind": "field",
|
|
7150
|
-
"name": "
|
|
7168
|
+
"name": "readOnly",
|
|
7151
7169
|
"type": {
|
|
7152
7170
|
"text": "boolean"
|
|
7153
7171
|
},
|
|
7154
7172
|
"default": "false",
|
|
7155
|
-
"description": "
|
|
7173
|
+
"description": "The field cannot be edited by the user. It is focusable will be announced by screen readers."
|
|
7156
7174
|
},
|
|
7157
7175
|
{
|
|
7158
7176
|
"kind": "field",
|
|
@@ -7163,6 +7181,15 @@
|
|
|
7163
7181
|
"default": "'tel' for PhoneField",
|
|
7164
7182
|
"description": "A hint as to the intended content of the field. When set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents. When set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes. Alternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill."
|
|
7165
7183
|
},
|
|
7184
|
+
{
|
|
7185
|
+
"kind": "field",
|
|
7186
|
+
"name": "max",
|
|
7187
|
+
"type": {
|
|
7188
|
+
"text": "number"
|
|
7189
|
+
},
|
|
7190
|
+
"default": "Infinity",
|
|
7191
|
+
"description": "The highest decimal or integer to be accepted for the field. When used with `step` the value will round down to the max number. Note: a user will still be able to use the keyboard to input a number higher than the max. It is up to the developer to add appropriate validation."
|
|
7192
|
+
},
|
|
7166
7193
|
{
|
|
7167
7194
|
"kind": "field",
|
|
7168
7195
|
"name": "suffix",
|
|
@@ -7181,15 +7208,6 @@
|
|
|
7181
7208
|
"default": "''",
|
|
7182
7209
|
"description": "A value to be displayed immediately before the editable portion of the field. This is useful for displaying an implied part of the value, such as \"https://\" or \"+353\". This cannot be edited by the user, and it isn't included in the value of the field. It may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input."
|
|
7183
7210
|
},
|
|
7184
|
-
{
|
|
7185
|
-
"kind": "field",
|
|
7186
|
-
"name": "max",
|
|
7187
|
-
"type": {
|
|
7188
|
-
"text": "number"
|
|
7189
|
-
},
|
|
7190
|
-
"default": "Infinity",
|
|
7191
|
-
"description": "The highest decimal or integer to be accepted for the field. When used with `step` the value will round down to the max number. Note: a user will still be able to use the keyboard to input a number higher than the max. It is up to the developer to add appropriate validation."
|
|
7192
|
-
},
|
|
7193
7211
|
{
|
|
7194
7212
|
"kind": "field",
|
|
7195
7213
|
"name": "min",
|
|
@@ -7273,22 +7291,6 @@
|
|
|
7273
7291
|
"default": "false",
|
|
7274
7292
|
"description": "Disables the field, disallowing any interaction."
|
|
7275
7293
|
},
|
|
7276
|
-
{
|
|
7277
|
-
"name": "name",
|
|
7278
|
-
"fieldName": "name",
|
|
7279
|
-
"type": {
|
|
7280
|
-
"text": "string"
|
|
7281
|
-
},
|
|
7282
|
-
"description": "An identifier for the field that is unique within the nearest containing form."
|
|
7283
|
-
},
|
|
7284
|
-
{
|
|
7285
|
-
"name": "value",
|
|
7286
|
-
"fieldName": "defaultValue",
|
|
7287
|
-
"type": {
|
|
7288
|
-
"text": "string"
|
|
7289
|
-
},
|
|
7290
|
-
"description": "The default value for the field."
|
|
7291
|
-
},
|
|
7292
7294
|
{
|
|
7293
7295
|
"name": "details",
|
|
7294
7296
|
"fieldName": "details",
|
|
@@ -7313,6 +7315,23 @@
|
|
|
7313
7315
|
},
|
|
7314
7316
|
"description": "Content to use as the field label."
|
|
7315
7317
|
},
|
|
7318
|
+
{
|
|
7319
|
+
"name": "required",
|
|
7320
|
+
"fieldName": "required",
|
|
7321
|
+
"type": {
|
|
7322
|
+
"text": "boolean"
|
|
7323
|
+
},
|
|
7324
|
+
"default": "false",
|
|
7325
|
+
"description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property."
|
|
7326
|
+
},
|
|
7327
|
+
{
|
|
7328
|
+
"name": "name",
|
|
7329
|
+
"fieldName": "name",
|
|
7330
|
+
"type": {
|
|
7331
|
+
"text": "string"
|
|
7332
|
+
},
|
|
7333
|
+
"description": "An identifier for the field that is unique within the nearest containing form."
|
|
7334
|
+
},
|
|
7316
7335
|
{
|
|
7317
7336
|
"name": "labelaccessibilityvisibility",
|
|
7318
7337
|
"fieldName": "labelAccessibilityVisibility",
|
|
@@ -7322,6 +7341,14 @@
|
|
|
7322
7341
|
"default": "'visible'",
|
|
7323
7342
|
"description": "Changes the visibility of the component's label. - `visible`: the label is visible to all users. - `exclusive`: the label is visually hidden but remains in the accessibility tree."
|
|
7324
7343
|
},
|
|
7344
|
+
{
|
|
7345
|
+
"name": "value",
|
|
7346
|
+
"fieldName": "defaultValue",
|
|
7347
|
+
"type": {
|
|
7348
|
+
"text": "string"
|
|
7349
|
+
},
|
|
7350
|
+
"description": "The default value for the field."
|
|
7351
|
+
},
|
|
7325
7352
|
{
|
|
7326
7353
|
"name": "placeholder",
|
|
7327
7354
|
"fieldName": "placeholder",
|
|
@@ -7339,15 +7366,6 @@
|
|
|
7339
7366
|
"default": "false",
|
|
7340
7367
|
"description": "The field cannot be edited by the user. It is focusable will be announced by screen readers."
|
|
7341
7368
|
},
|
|
7342
|
-
{
|
|
7343
|
-
"name": "required",
|
|
7344
|
-
"fieldName": "required",
|
|
7345
|
-
"type": {
|
|
7346
|
-
"text": "boolean"
|
|
7347
|
-
},
|
|
7348
|
-
"default": "false",
|
|
7349
|
-
"description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property."
|
|
7350
|
-
},
|
|
7351
7369
|
{
|
|
7352
7370
|
"name": "autocomplete",
|
|
7353
7371
|
"fieldName": "autocomplete",
|
|
@@ -7357,6 +7375,15 @@
|
|
|
7357
7375
|
"default": "'tel' for PhoneField",
|
|
7358
7376
|
"description": "A hint as to the intended content of the field. When set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents. When set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes. Alternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill."
|
|
7359
7377
|
},
|
|
7378
|
+
{
|
|
7379
|
+
"name": "max",
|
|
7380
|
+
"fieldName": "max",
|
|
7381
|
+
"type": {
|
|
7382
|
+
"text": "number"
|
|
7383
|
+
},
|
|
7384
|
+
"default": "Infinity",
|
|
7385
|
+
"description": "The highest decimal or integer to be accepted for the field. When used with `step` the value will round down to the max number. Note: a user will still be able to use the keyboard to input a number higher than the max. It is up to the developer to add appropriate validation."
|
|
7386
|
+
},
|
|
7360
7387
|
{
|
|
7361
7388
|
"name": "suffix",
|
|
7362
7389
|
"fieldName": "suffix",
|
|
@@ -7375,15 +7402,6 @@
|
|
|
7375
7402
|
"default": "''",
|
|
7376
7403
|
"description": "A value to be displayed immediately before the editable portion of the field. This is useful for displaying an implied part of the value, such as \"https://\" or \"+353\". This cannot be edited by the user, and it isn't included in the value of the field. It may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input."
|
|
7377
7404
|
},
|
|
7378
|
-
{
|
|
7379
|
-
"name": "max",
|
|
7380
|
-
"fieldName": "max",
|
|
7381
|
-
"type": {
|
|
7382
|
-
"text": "number"
|
|
7383
|
-
},
|
|
7384
|
-
"default": "Infinity",
|
|
7385
|
-
"description": "The highest decimal or integer to be accepted for the field. When used with `step` the value will round down to the max number. Note: a user will still be able to use the keyboard to input a number higher than the max. It is up to the developer to add appropriate validation."
|
|
7386
|
-
},
|
|
7387
7405
|
{
|
|
7388
7406
|
"name": "min",
|
|
7389
7407
|
"fieldName": "min",
|
|
@@ -7925,14 +7943,6 @@
|
|
|
7925
7943
|
},
|
|
7926
7944
|
"description": "The current value for the field. If omitted, the field will be empty."
|
|
7927
7945
|
},
|
|
7928
|
-
{
|
|
7929
|
-
"kind": "field",
|
|
7930
|
-
"name": "defaultValue",
|
|
7931
|
-
"type": {
|
|
7932
|
-
"text": "string"
|
|
7933
|
-
},
|
|
7934
|
-
"description": "The default value for the field."
|
|
7935
|
-
},
|
|
7936
7946
|
{
|
|
7937
7947
|
"kind": "field",
|
|
7938
7948
|
"name": "details",
|
|
@@ -7957,6 +7967,15 @@
|
|
|
7957
7967
|
},
|
|
7958
7968
|
"description": "Content to use as the field label."
|
|
7959
7969
|
},
|
|
7970
|
+
{
|
|
7971
|
+
"kind": "field",
|
|
7972
|
+
"name": "required",
|
|
7973
|
+
"type": {
|
|
7974
|
+
"text": "boolean"
|
|
7975
|
+
},
|
|
7976
|
+
"default": "false",
|
|
7977
|
+
"description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property."
|
|
7978
|
+
},
|
|
7960
7979
|
{
|
|
7961
7980
|
"kind": "field",
|
|
7962
7981
|
"name": "labelAccessibilityVisibility",
|
|
@@ -7968,29 +7987,28 @@
|
|
|
7968
7987
|
},
|
|
7969
7988
|
{
|
|
7970
7989
|
"kind": "field",
|
|
7971
|
-
"name": "
|
|
7990
|
+
"name": "defaultValue",
|
|
7972
7991
|
"type": {
|
|
7973
7992
|
"text": "string"
|
|
7974
7993
|
},
|
|
7975
|
-
"description": "
|
|
7994
|
+
"description": "The default value for the field."
|
|
7976
7995
|
},
|
|
7977
7996
|
{
|
|
7978
7997
|
"kind": "field",
|
|
7979
|
-
"name": "
|
|
7998
|
+
"name": "placeholder",
|
|
7980
7999
|
"type": {
|
|
7981
|
-
"text": "
|
|
8000
|
+
"text": "string"
|
|
7982
8001
|
},
|
|
7983
|
-
"
|
|
7984
|
-
"description": "The field cannot be edited by the user. It is focusable will be announced by screen readers."
|
|
8002
|
+
"description": "A short hint that describes the expected value of the field."
|
|
7985
8003
|
},
|
|
7986
8004
|
{
|
|
7987
8005
|
"kind": "field",
|
|
7988
|
-
"name": "
|
|
8006
|
+
"name": "readOnly",
|
|
7989
8007
|
"type": {
|
|
7990
8008
|
"text": "boolean"
|
|
7991
8009
|
},
|
|
7992
8010
|
"default": "false",
|
|
7993
|
-
"description": "
|
|
8011
|
+
"description": "The field cannot be edited by the user. It is focusable will be announced by screen readers."
|
|
7994
8012
|
},
|
|
7995
8013
|
{
|
|
7996
8014
|
"kind": "field",
|
|
@@ -8084,14 +8102,6 @@
|
|
|
8084
8102
|
},
|
|
8085
8103
|
"description": "The current value for the field. If omitted, the field will be empty."
|
|
8086
8104
|
},
|
|
8087
|
-
{
|
|
8088
|
-
"name": "value",
|
|
8089
|
-
"fieldName": "defaultValue",
|
|
8090
|
-
"type": {
|
|
8091
|
-
"text": "string"
|
|
8092
|
-
},
|
|
8093
|
-
"description": "The default value for the field."
|
|
8094
|
-
},
|
|
8095
8105
|
{
|
|
8096
8106
|
"name": "details",
|
|
8097
8107
|
"fieldName": "details",
|
|
@@ -8116,6 +8126,15 @@
|
|
|
8116
8126
|
},
|
|
8117
8127
|
"description": "Content to use as the field label."
|
|
8118
8128
|
},
|
|
8129
|
+
{
|
|
8130
|
+
"name": "required",
|
|
8131
|
+
"fieldName": "required",
|
|
8132
|
+
"type": {
|
|
8133
|
+
"text": "boolean"
|
|
8134
|
+
},
|
|
8135
|
+
"default": "false",
|
|
8136
|
+
"description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property."
|
|
8137
|
+
},
|
|
8119
8138
|
{
|
|
8120
8139
|
"name": "labelaccessibilityvisibility",
|
|
8121
8140
|
"fieldName": "labelAccessibilityVisibility",
|
|
@@ -8125,6 +8144,14 @@
|
|
|
8125
8144
|
"default": "'visible'",
|
|
8126
8145
|
"description": "Changes the visibility of the component's label. - `visible`: the label is visible to all users. - `exclusive`: the label is visually hidden but remains in the accessibility tree."
|
|
8127
8146
|
},
|
|
8147
|
+
{
|
|
8148
|
+
"name": "value",
|
|
8149
|
+
"fieldName": "defaultValue",
|
|
8150
|
+
"type": {
|
|
8151
|
+
"text": "string"
|
|
8152
|
+
},
|
|
8153
|
+
"description": "The default value for the field."
|
|
8154
|
+
},
|
|
8128
8155
|
{
|
|
8129
8156
|
"name": "placeholder",
|
|
8130
8157
|
"fieldName": "placeholder",
|
|
@@ -8142,15 +8169,6 @@
|
|
|
8142
8169
|
"default": "false",
|
|
8143
8170
|
"description": "The field cannot be edited by the user. It is focusable will be announced by screen readers."
|
|
8144
8171
|
},
|
|
8145
|
-
{
|
|
8146
|
-
"name": "required",
|
|
8147
|
-
"fieldName": "required",
|
|
8148
|
-
"type": {
|
|
8149
|
-
"text": "boolean"
|
|
8150
|
-
},
|
|
8151
|
-
"default": "false",
|
|
8152
|
-
"description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property."
|
|
8153
|
-
},
|
|
8154
8172
|
{
|
|
8155
8173
|
"name": "autocomplete",
|
|
8156
8174
|
"fieldName": "autocomplete",
|
|
@@ -8408,20 +8426,20 @@
|
|
|
8408
8426
|
},
|
|
8409
8427
|
{
|
|
8410
8428
|
"kind": "field",
|
|
8411
|
-
"name": "
|
|
8429
|
+
"name": "disabled",
|
|
8412
8430
|
"type": {
|
|
8413
|
-
"text": "
|
|
8431
|
+
"text": "boolean"
|
|
8414
8432
|
},
|
|
8415
|
-
"
|
|
8433
|
+
"default": "false",
|
|
8434
|
+
"description": "Disables the Button meaning it cannot be clicked or receive focus."
|
|
8416
8435
|
},
|
|
8417
8436
|
{
|
|
8418
8437
|
"kind": "field",
|
|
8419
|
-
"name": "
|
|
8438
|
+
"name": "accessibilityLabel",
|
|
8420
8439
|
"type": {
|
|
8421
|
-
"text": "
|
|
8440
|
+
"text": "string"
|
|
8422
8441
|
},
|
|
8423
|
-
"
|
|
8424
|
-
"description": "Disables the Button meaning it cannot be clicked or receive focus."
|
|
8442
|
+
"description": "A label that describes the purpose or contents of the Button. It will be read to users using assistive technologies such as screen readers. Use this when using only an icon or the Button text is not enough context for users using assistive technologies."
|
|
8425
8443
|
},
|
|
8426
8444
|
{
|
|
8427
8445
|
"kind": "field",
|
|
@@ -8513,14 +8531,6 @@
|
|
|
8513
8531
|
},
|
|
8514
8532
|
"description": "Changes the visual appearance of the Button."
|
|
8515
8533
|
},
|
|
8516
|
-
{
|
|
8517
|
-
"name": "accessibilitylabel",
|
|
8518
|
-
"fieldName": "accessibilityLabel",
|
|
8519
|
-
"type": {
|
|
8520
|
-
"text": "string"
|
|
8521
|
-
},
|
|
8522
|
-
"description": "A label that describes the purpose or contents of the Button. It will be read to users using assistive technologies such as screen readers. Use this when using only an icon or the Button text is not enough context for users using assistive technologies."
|
|
8523
|
-
},
|
|
8524
8534
|
{
|
|
8525
8535
|
"name": "disabled",
|
|
8526
8536
|
"fieldName": "disabled",
|
|
@@ -8530,6 +8540,14 @@
|
|
|
8530
8540
|
"default": "false",
|
|
8531
8541
|
"description": "Disables the Button meaning it cannot be clicked or receive focus."
|
|
8532
8542
|
},
|
|
8543
|
+
{
|
|
8544
|
+
"name": "accessibilitylabel",
|
|
8545
|
+
"fieldName": "accessibilityLabel",
|
|
8546
|
+
"type": {
|
|
8547
|
+
"text": "string"
|
|
8548
|
+
},
|
|
8549
|
+
"description": "A label that describes the purpose or contents of the Button. It will be read to users using assistive technologies such as screen readers. Use this when using only an icon or the Button text is not enough context for users using assistive technologies."
|
|
8550
|
+
},
|
|
8533
8551
|
{
|
|
8534
8552
|
"name": "inlinesize",
|
|
8535
8553
|
"fieldName": "inlineSize",
|
|
@@ -8722,15 +8740,6 @@
|
|
|
8722
8740
|
"default": "'visible'",
|
|
8723
8741
|
"description": "Changes the visibility of the element. - `visible`: the element is visible to all users. - `hidden`: the element is removed from the accessibility tree but remains visible. - `exclusive`: the element is visually hidden but remains in the accessibility tree."
|
|
8724
8742
|
},
|
|
8725
|
-
{
|
|
8726
|
-
"kind": "field",
|
|
8727
|
-
"name": "padding",
|
|
8728
|
-
"type": {
|
|
8729
|
-
"text": "MaybeResponsive<MaybeAllValuesShorthandProperty<PaddingKeyword>>"
|
|
8730
|
-
},
|
|
8731
|
-
"default": "'none'",
|
|
8732
|
-
"description": "The padding applied to all edges of the component. Supports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values: - 1 value applies to all sides - 2 values apply to block (top/bottom) and inline (left/right) - 3 values apply to block-start (top), inline (left/right), and block-end (bottom) - 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) *Examples:** `base`, `large none`, `base large-100 base small` Use `auto` to inherit padding from the nearest container with removed padding. Also accepts a [responsive value](/docs/api/polaris/using-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value."
|
|
8733
|
-
},
|
|
8734
8743
|
{
|
|
8735
8744
|
"kind": "field",
|
|
8736
8745
|
"name": "background",
|
|
@@ -8850,9 +8859,18 @@
|
|
|
8850
8859
|
},
|
|
8851
8860
|
{
|
|
8852
8861
|
"kind": "field",
|
|
8853
|
-
"name": "
|
|
8862
|
+
"name": "padding",
|
|
8854
8863
|
"type": {
|
|
8855
|
-
"text": "MaybeResponsive
|
|
8864
|
+
"text": "MaybeResponsive<MaybeAllValuesShorthandProperty<PaddingKeyword>>"
|
|
8865
|
+
},
|
|
8866
|
+
"default": "'none'",
|
|
8867
|
+
"description": "The padding applied to all edges of the component. Supports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values: - 1 value applies to all sides - 2 values apply to block (top/bottom) and inline (left/right) - 3 values apply to block-start (top), inline (left/right), and block-end (bottom) - 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) *Examples:** `base`, `large none`, `base large-100 base small` Use `auto` to inherit padding from the nearest container with removed padding. Also accepts a [responsive value](/docs/api/polaris/using-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value."
|
|
8868
|
+
},
|
|
8869
|
+
{
|
|
8870
|
+
"kind": "field",
|
|
8871
|
+
"name": "paddingBlock",
|
|
8872
|
+
"type": {
|
|
8873
|
+
"text": "MaybeResponsive<\"\" | MaybeTwoValuesShorthandProperty<PaddingKeyword>>"
|
|
8856
8874
|
},
|
|
8857
8875
|
"default": "'' - meaning no override",
|
|
8858
8876
|
"description": "The block-direction padding (top and bottom in horizontal writing modes). Accepts a single value for both sides or two space-separated values for block-start and block-end. *Example:** `large none` applies `large` to the top and `none` to the bottom. Overrides the block value from `padding`. Also accepts a [responsive value](/docs/api/polaris/using-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value."
|
|
@@ -8982,15 +9000,6 @@
|
|
|
8982
9000
|
"default": "'visible'",
|
|
8983
9001
|
"description": "Changes the visibility of the element. - `visible`: the element is visible to all users. - `hidden`: the element is removed from the accessibility tree but remains visible. - `exclusive`: the element is visually hidden but remains in the accessibility tree."
|
|
8984
9002
|
},
|
|
8985
|
-
{
|
|
8986
|
-
"name": "padding",
|
|
8987
|
-
"fieldName": "padding",
|
|
8988
|
-
"type": {
|
|
8989
|
-
"text": "MaybeResponsive<MaybeAllValuesShorthandProperty<PaddingKeyword>>"
|
|
8990
|
-
},
|
|
8991
|
-
"default": "'none'",
|
|
8992
|
-
"description": "The padding applied to all edges of the component. Supports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values: - 1 value applies to all sides - 2 values apply to block (top/bottom) and inline (left/right) - 3 values apply to block-start (top), inline (left/right), and block-end (bottom) - 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) *Examples:** `base`, `large none`, `base large-100 base small` Use `auto` to inherit padding from the nearest container with removed padding. Also accepts a [responsive value](/docs/api/polaris/using-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value."
|
|
8993
|
-
},
|
|
8994
9003
|
{
|
|
8995
9004
|
"name": "background",
|
|
8996
9005
|
"fieldName": "background",
|
|
@@ -9108,6 +9117,15 @@
|
|
|
9108
9117
|
"default": "'auto'",
|
|
9109
9118
|
"description": "The outer [display](https://developer.mozilla.org/en-US/docs/Web/CSS/display) type of the component. The outer type sets a component's participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout). - `auto` the component's initial value. The actual value depends on the component and context. - `none` hides the component from display and removes it from the accessibility tree, making it invisible to screen readers."
|
|
9110
9119
|
},
|
|
9120
|
+
{
|
|
9121
|
+
"name": "padding",
|
|
9122
|
+
"fieldName": "padding",
|
|
9123
|
+
"type": {
|
|
9124
|
+
"text": "MaybeResponsive<MaybeAllValuesShorthandProperty<PaddingKeyword>>"
|
|
9125
|
+
},
|
|
9126
|
+
"default": "'none'",
|
|
9127
|
+
"description": "The padding applied to all edges of the component. Supports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values: - 1 value applies to all sides - 2 values apply to block (top/bottom) and inline (left/right) - 3 values apply to block-start (top), inline (left/right), and block-end (bottom) - 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) *Examples:** `base`, `large none`, `base large-100 base small` Use `auto` to inherit padding from the nearest container with removed padding. Also accepts a [responsive value](/docs/api/polaris/using-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value."
|
|
9128
|
+
},
|
|
9111
9129
|
{
|
|
9112
9130
|
"name": "paddingblock",
|
|
9113
9131
|
"fieldName": "paddingBlock",
|
|
@@ -9222,14 +9240,6 @@
|
|
|
9222
9240
|
},
|
|
9223
9241
|
"description": "The current value for the field. If omitted, the field will be empty."
|
|
9224
9242
|
},
|
|
9225
|
-
{
|
|
9226
|
-
"kind": "field",
|
|
9227
|
-
"name": "defaultValue",
|
|
9228
|
-
"type": {
|
|
9229
|
-
"text": "string"
|
|
9230
|
-
},
|
|
9231
|
-
"description": "The default value for the field."
|
|
9232
|
-
},
|
|
9233
9243
|
{
|
|
9234
9244
|
"kind": "field",
|
|
9235
9245
|
"name": "details",
|
|
@@ -9254,6 +9264,15 @@
|
|
|
9254
9264
|
},
|
|
9255
9265
|
"description": "Content to use as the field label."
|
|
9256
9266
|
},
|
|
9267
|
+
{
|
|
9268
|
+
"kind": "field",
|
|
9269
|
+
"name": "required",
|
|
9270
|
+
"type": {
|
|
9271
|
+
"text": "boolean"
|
|
9272
|
+
},
|
|
9273
|
+
"default": "false",
|
|
9274
|
+
"description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property."
|
|
9275
|
+
},
|
|
9257
9276
|
{
|
|
9258
9277
|
"kind": "field",
|
|
9259
9278
|
"name": "labelAccessibilityVisibility",
|
|
@@ -9265,29 +9284,28 @@
|
|
|
9265
9284
|
},
|
|
9266
9285
|
{
|
|
9267
9286
|
"kind": "field",
|
|
9268
|
-
"name": "
|
|
9287
|
+
"name": "defaultValue",
|
|
9269
9288
|
"type": {
|
|
9270
9289
|
"text": "string"
|
|
9271
9290
|
},
|
|
9272
|
-
"description": "
|
|
9291
|
+
"description": "The default value for the field."
|
|
9273
9292
|
},
|
|
9274
9293
|
{
|
|
9275
9294
|
"kind": "field",
|
|
9276
|
-
"name": "
|
|
9295
|
+
"name": "placeholder",
|
|
9277
9296
|
"type": {
|
|
9278
|
-
"text": "
|
|
9297
|
+
"text": "string"
|
|
9279
9298
|
},
|
|
9280
|
-
"
|
|
9281
|
-
"description": "The field cannot be edited by the user. It is focusable will be announced by screen readers."
|
|
9299
|
+
"description": "A short hint that describes the expected value of the field."
|
|
9282
9300
|
},
|
|
9283
9301
|
{
|
|
9284
9302
|
"kind": "field",
|
|
9285
|
-
"name": "
|
|
9303
|
+
"name": "readOnly",
|
|
9286
9304
|
"type": {
|
|
9287
9305
|
"text": "boolean"
|
|
9288
9306
|
},
|
|
9289
9307
|
"default": "false",
|
|
9290
|
-
"description": "
|
|
9308
|
+
"description": "The field cannot be edited by the user. It is focusable will be announced by screen readers."
|
|
9291
9309
|
},
|
|
9292
9310
|
{
|
|
9293
9311
|
"kind": "field",
|
|
@@ -9381,14 +9399,6 @@
|
|
|
9381
9399
|
},
|
|
9382
9400
|
"description": "The current value for the field. If omitted, the field will be empty."
|
|
9383
9401
|
},
|
|
9384
|
-
{
|
|
9385
|
-
"name": "value",
|
|
9386
|
-
"fieldName": "defaultValue",
|
|
9387
|
-
"type": {
|
|
9388
|
-
"text": "string"
|
|
9389
|
-
},
|
|
9390
|
-
"description": "The default value for the field."
|
|
9391
|
-
},
|
|
9392
9402
|
{
|
|
9393
9403
|
"name": "details",
|
|
9394
9404
|
"fieldName": "details",
|
|
@@ -9413,6 +9423,15 @@
|
|
|
9413
9423
|
},
|
|
9414
9424
|
"description": "Content to use as the field label."
|
|
9415
9425
|
},
|
|
9426
|
+
{
|
|
9427
|
+
"name": "required",
|
|
9428
|
+
"fieldName": "required",
|
|
9429
|
+
"type": {
|
|
9430
|
+
"text": "boolean"
|
|
9431
|
+
},
|
|
9432
|
+
"default": "false",
|
|
9433
|
+
"description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property."
|
|
9434
|
+
},
|
|
9416
9435
|
{
|
|
9417
9436
|
"name": "labelaccessibilityvisibility",
|
|
9418
9437
|
"fieldName": "labelAccessibilityVisibility",
|
|
@@ -9422,6 +9441,14 @@
|
|
|
9422
9441
|
"default": "'visible'",
|
|
9423
9442
|
"description": "Changes the visibility of the component's label. - `visible`: the label is visible to all users. - `exclusive`: the label is visually hidden but remains in the accessibility tree."
|
|
9424
9443
|
},
|
|
9444
|
+
{
|
|
9445
|
+
"name": "value",
|
|
9446
|
+
"fieldName": "defaultValue",
|
|
9447
|
+
"type": {
|
|
9448
|
+
"text": "string"
|
|
9449
|
+
},
|
|
9450
|
+
"description": "The default value for the field."
|
|
9451
|
+
},
|
|
9425
9452
|
{
|
|
9426
9453
|
"name": "placeholder",
|
|
9427
9454
|
"fieldName": "placeholder",
|
|
@@ -9439,15 +9466,6 @@
|
|
|
9439
9466
|
"default": "false",
|
|
9440
9467
|
"description": "The field cannot be edited by the user. It is focusable will be announced by screen readers."
|
|
9441
9468
|
},
|
|
9442
|
-
{
|
|
9443
|
-
"name": "required",
|
|
9444
|
-
"fieldName": "required",
|
|
9445
|
-
"type": {
|
|
9446
|
-
"text": "boolean"
|
|
9447
|
-
},
|
|
9448
|
-
"default": "false",
|
|
9449
|
-
"description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property."
|
|
9450
|
-
},
|
|
9451
9469
|
{
|
|
9452
9470
|
"name": "autocomplete",
|
|
9453
9471
|
"fieldName": "autocomplete",
|
|
@@ -9497,6 +9515,26 @@
|
|
|
9497
9515
|
{
|
|
9498
9516
|
"name": "",
|
|
9499
9517
|
"description": "The content displayed within the section component, which groups related elements together in a logical unit with an optional heading."
|
|
9518
|
+
},
|
|
9519
|
+
{
|
|
9520
|
+
"name": "primary-action",
|
|
9521
|
+
"description": "The primary action button or link, representing the main or most important action available in this context. Typically displayed with higher visual prominence than secondary actions to establish clear hierarchy."
|
|
9522
|
+
},
|
|
9523
|
+
{
|
|
9524
|
+
"name": "secondary-actions",
|
|
9525
|
+
"description": "Additional action buttons or links that provide alternative or supporting actions. Visually de-emphasized compared to the primary action. A ButtonGroup holding an action and the icon-only activator for its Menu renders as one segmented group with a chevron activator. The group needs an `accessibilityLabel`, and must hold exactly one Button with text followed by one Button with no text that has an `accessibilityLabel` and a `commandFor` opening a Menu, both with a `variant` of `secondary` or `auto`."
|
|
9526
|
+
},
|
|
9527
|
+
{
|
|
9528
|
+
"name": "graphic",
|
|
9529
|
+
"description": "A decorative visual that reinforces the heading, rendered before it. Accepts a single icon-only Badge (`icon` set, no text content) with a `size` of `large`. The heading identifies the section, so this content is not announced by assistive technologies, and it is not rendered at all when the section has no `heading`."
|
|
9530
|
+
},
|
|
9531
|
+
{
|
|
9532
|
+
"name": "accessory",
|
|
9533
|
+
"description": "Additional contextual information that qualifies the heading, rendered inline beside the heading text. Only accepts Badge, Icon, Button, Menu, Text, Avatar, and Thumbnail elements. Text must use `tone`, `fontSize`, and `fontWeight` of `auto`; Icon, Avatar, and Thumbnail must use `size=\"base\"`; Badge must use `size=\"base\"` and `color=\"base\"`; Button must use `inlineSize=\"auto\"`."
|
|
9534
|
+
},
|
|
9535
|
+
{
|
|
9536
|
+
"name": "supplemental",
|
|
9537
|
+
"description": "Status or metadata that describes the section as a whole rather than qualifying its heading, rendered at the inline-end of the header before any actions. This is not an action. Only accepts Badge, Avatar, Text, Icon, and Thumbnail elements, under the same prop constraints as `accessory`."
|
|
9500
9538
|
}
|
|
9501
9539
|
],
|
|
9502
9540
|
"members": [
|
|
@@ -9516,6 +9554,14 @@
|
|
|
9516
9554
|
},
|
|
9517
9555
|
"description": "The heading text displayed at the top of the section. This heading provides a title for the section's content and automatically uses the appropriate semantic heading level (h2, h3, h4) based on nesting depth to maintain proper document structure."
|
|
9518
9556
|
},
|
|
9557
|
+
{
|
|
9558
|
+
"kind": "field",
|
|
9559
|
+
"name": "subheading",
|
|
9560
|
+
"type": {
|
|
9561
|
+
"text": "string"
|
|
9562
|
+
},
|
|
9563
|
+
"description": "Supporting text that expands on the heading, rendered beneath it in a subdued treatment. This is not a heading: it adds no entry to the document outline, doesn't change the heading level of the section's children, and isn't announced as part of the heading. Keep whatever distinguishes this section from another in `heading`, since that is what someone navigating by heading hears."
|
|
9564
|
+
},
|
|
9519
9565
|
{
|
|
9520
9566
|
"kind": "field",
|
|
9521
9567
|
"name": "padding",
|
|
@@ -9523,7 +9569,7 @@
|
|
|
9523
9569
|
"text": "\"base\" | \"none\""
|
|
9524
9570
|
},
|
|
9525
9571
|
"default": "'base'",
|
|
9526
|
-
"description": "The padding applied to all edges of the element. - `base`: applies padding that is appropriate for the element. Note that it might result in no padding if this is the right design decision in a particular context. - `none`: removes all padding from the element. This can be useful when elements inside the section need to span to the edge of the section. For example, a full-width image. In this case, rely on `s-box` with a padding of 'base' to bring back the desired padding for the rest of the content."
|
|
9572
|
+
"description": "The padding applied to all edges of the element's content. - `base`: applies padding that is appropriate for the element. Note that it might result in no padding if this is the right design decision in a particular context. - `none`: removes all padding from the element's content. This can be useful when elements inside the section need to span to the edge of the section. For example, a full-width image. In this case, rely on `s-box` with a padding of 'base' to bring back the desired padding for the rest of the content. The `heading` and header actions keep their padding, so they can be combined with `none`."
|
|
9527
9573
|
}
|
|
9528
9574
|
],
|
|
9529
9575
|
"attributes": [
|
|
@@ -9543,6 +9589,14 @@
|
|
|
9543
9589
|
},
|
|
9544
9590
|
"description": "The heading text displayed at the top of the section. This heading provides a title for the section's content and automatically uses the appropriate semantic heading level (h2, h3, h4) based on nesting depth to maintain proper document structure."
|
|
9545
9591
|
},
|
|
9592
|
+
{
|
|
9593
|
+
"name": "subheading",
|
|
9594
|
+
"fieldName": "subheading",
|
|
9595
|
+
"type": {
|
|
9596
|
+
"text": "string"
|
|
9597
|
+
},
|
|
9598
|
+
"description": "Supporting text that expands on the heading, rendered beneath it in a subdued treatment. This is not a heading: it adds no entry to the document outline, doesn't change the heading level of the section's children, and isn't announced as part of the heading. Keep whatever distinguishes this section from another in `heading`, since that is what someone navigating by heading hears."
|
|
9599
|
+
},
|
|
9546
9600
|
{
|
|
9547
9601
|
"name": "padding",
|
|
9548
9602
|
"fieldName": "padding",
|
|
@@ -9550,7 +9604,7 @@
|
|
|
9550
9604
|
"text": "\"base\" | \"none\""
|
|
9551
9605
|
},
|
|
9552
9606
|
"default": "'base'",
|
|
9553
|
-
"description": "The padding applied to all edges of the element. - `base`: applies padding that is appropriate for the element. Note that it might result in no padding if this is the right design decision in a particular context. - `none`: removes all padding from the element. This can be useful when elements inside the section need to span to the edge of the section. For example, a full-width image. In this case, rely on `s-box` with a padding of 'base' to bring back the desired padding for the rest of the content."
|
|
9607
|
+
"description": "The padding applied to all edges of the element's content. - `base`: applies padding that is appropriate for the element. Note that it might result in no padding if this is the right design decision in a particular context. - `none`: removes all padding from the element's content. This can be useful when elements inside the section need to span to the edge of the section. For example, a full-width image. In this case, rely on `s-box` with a padding of 'base' to bring back the desired padding for the rest of the content. The `heading` and header actions keep their padding, so they can be combined with `none`."
|
|
9554
9608
|
}
|
|
9555
9609
|
],
|
|
9556
9610
|
"superclass": {
|
|
@@ -9647,6 +9701,15 @@
|
|
|
9647
9701
|
},
|
|
9648
9702
|
"description": "Content to use as the field label."
|
|
9649
9703
|
},
|
|
9704
|
+
{
|
|
9705
|
+
"kind": "field",
|
|
9706
|
+
"name": "required",
|
|
9707
|
+
"type": {
|
|
9708
|
+
"text": "boolean"
|
|
9709
|
+
},
|
|
9710
|
+
"default": "false",
|
|
9711
|
+
"description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property."
|
|
9712
|
+
},
|
|
9650
9713
|
{
|
|
9651
9714
|
"kind": "field",
|
|
9652
9715
|
"name": "labelAccessibilityVisibility",
|
|
@@ -9663,15 +9726,6 @@
|
|
|
9663
9726
|
"text": "string"
|
|
9664
9727
|
},
|
|
9665
9728
|
"description": "A short hint that describes the expected value of the field."
|
|
9666
|
-
},
|
|
9667
|
-
{
|
|
9668
|
-
"kind": "field",
|
|
9669
|
-
"name": "required",
|
|
9670
|
-
"type": {
|
|
9671
|
-
"text": "boolean"
|
|
9672
|
-
},
|
|
9673
|
-
"default": "false",
|
|
9674
|
-
"description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property."
|
|
9675
9729
|
}
|
|
9676
9730
|
],
|
|
9677
9731
|
"events": [
|
|
@@ -9765,6 +9819,15 @@
|
|
|
9765
9819
|
},
|
|
9766
9820
|
"description": "Content to use as the field label."
|
|
9767
9821
|
},
|
|
9822
|
+
{
|
|
9823
|
+
"name": "required",
|
|
9824
|
+
"fieldName": "required",
|
|
9825
|
+
"type": {
|
|
9826
|
+
"text": "boolean"
|
|
9827
|
+
},
|
|
9828
|
+
"default": "false",
|
|
9829
|
+
"description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property."
|
|
9830
|
+
},
|
|
9768
9831
|
{
|
|
9769
9832
|
"name": "labelaccessibilityvisibility",
|
|
9770
9833
|
"fieldName": "labelAccessibilityVisibility",
|
|
@@ -9781,15 +9844,6 @@
|
|
|
9781
9844
|
"text": "string"
|
|
9782
9845
|
},
|
|
9783
9846
|
"description": "A short hint that describes the expected value of the field."
|
|
9784
|
-
},
|
|
9785
|
-
{
|
|
9786
|
-
"name": "required",
|
|
9787
|
-
"fieldName": "required",
|
|
9788
|
-
"type": {
|
|
9789
|
-
"text": "boolean"
|
|
9790
|
-
},
|
|
9791
|
-
"default": "false",
|
|
9792
|
-
"description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property."
|
|
9793
9847
|
}
|
|
9794
9848
|
],
|
|
9795
9849
|
"superclass": {
|
|
@@ -10454,6 +10508,15 @@
|
|
|
10454
10508
|
},
|
|
10455
10509
|
"description": "The value used in form data when the checkbox is checked."
|
|
10456
10510
|
},
|
|
10511
|
+
{
|
|
10512
|
+
"kind": "field",
|
|
10513
|
+
"name": "disabled",
|
|
10514
|
+
"type": {
|
|
10515
|
+
"text": "boolean"
|
|
10516
|
+
},
|
|
10517
|
+
"default": "false",
|
|
10518
|
+
"description": "Disables the control, disallowing any interaction."
|
|
10519
|
+
},
|
|
10457
10520
|
{
|
|
10458
10521
|
"kind": "field",
|
|
10459
10522
|
"name": "accessibilityLabel",
|
|
@@ -10464,20 +10527,21 @@
|
|
|
10464
10527
|
},
|
|
10465
10528
|
{
|
|
10466
10529
|
"kind": "field",
|
|
10467
|
-
"name": "
|
|
10530
|
+
"name": "checked",
|
|
10468
10531
|
"type": {
|
|
10469
10532
|
"text": "boolean"
|
|
10470
10533
|
},
|
|
10471
10534
|
"default": "false",
|
|
10472
|
-
"description": "
|
|
10535
|
+
"description": "Whether the control is active."
|
|
10473
10536
|
},
|
|
10474
10537
|
{
|
|
10475
10538
|
"kind": "field",
|
|
10476
|
-
"name": "
|
|
10539
|
+
"name": "defaultChecked",
|
|
10477
10540
|
"type": {
|
|
10478
|
-
"text": "
|
|
10541
|
+
"text": "boolean"
|
|
10479
10542
|
},
|
|
10480
|
-
"
|
|
10543
|
+
"default": "false",
|
|
10544
|
+
"description": "Whether the control is active by default."
|
|
10481
10545
|
},
|
|
10482
10546
|
{
|
|
10483
10547
|
"kind": "field",
|
|
@@ -10514,21 +10578,11 @@
|
|
|
10514
10578
|
},
|
|
10515
10579
|
{
|
|
10516
10580
|
"kind": "field",
|
|
10517
|
-
"name": "
|
|
10518
|
-
"type": {
|
|
10519
|
-
"text": "boolean"
|
|
10520
|
-
},
|
|
10521
|
-
"default": "false",
|
|
10522
|
-
"description": "Whether the control is active."
|
|
10523
|
-
},
|
|
10524
|
-
{
|
|
10525
|
-
"kind": "field",
|
|
10526
|
-
"name": "defaultChecked",
|
|
10581
|
+
"name": "name",
|
|
10527
10582
|
"type": {
|
|
10528
|
-
"text": "
|
|
10583
|
+
"text": "string"
|
|
10529
10584
|
},
|
|
10530
|
-
"
|
|
10531
|
-
"description": "Whether the control is active by default."
|
|
10585
|
+
"description": "An identifier for the control that is unique within the nearest containing `Form` component."
|
|
10532
10586
|
},
|
|
10533
10587
|
{
|
|
10534
10588
|
"kind": "field",
|
|
@@ -10571,6 +10625,15 @@
|
|
|
10571
10625
|
},
|
|
10572
10626
|
"description": "The value used in form data when the checkbox is checked."
|
|
10573
10627
|
},
|
|
10628
|
+
{
|
|
10629
|
+
"name": "disabled",
|
|
10630
|
+
"fieldName": "disabled",
|
|
10631
|
+
"type": {
|
|
10632
|
+
"text": "boolean"
|
|
10633
|
+
},
|
|
10634
|
+
"default": "false",
|
|
10635
|
+
"description": "Disables the control, disallowing any interaction."
|
|
10636
|
+
},
|
|
10574
10637
|
{
|
|
10575
10638
|
"name": "accessibilitylabel",
|
|
10576
10639
|
"fieldName": "accessibilityLabel",
|
|
@@ -10580,21 +10643,22 @@
|
|
|
10580
10643
|
"description": "A label used for users using assistive technologies like screen readers. When set, any children or `label` supplied will not be announced. This can also be used to display a control without a visual label, while still providing context to users using screen readers."
|
|
10581
10644
|
},
|
|
10582
10645
|
{
|
|
10583
|
-
"name": "
|
|
10584
|
-
"fieldName": "
|
|
10646
|
+
"name": "checked",
|
|
10647
|
+
"fieldName": "checked",
|
|
10585
10648
|
"type": {
|
|
10586
10649
|
"text": "boolean"
|
|
10587
10650
|
},
|
|
10588
10651
|
"default": "false",
|
|
10589
|
-
"description": "
|
|
10652
|
+
"description": "Whether the control is active."
|
|
10590
10653
|
},
|
|
10591
10654
|
{
|
|
10592
|
-
"name": "
|
|
10593
|
-
"fieldName": "
|
|
10655
|
+
"name": "checked",
|
|
10656
|
+
"fieldName": "defaultChecked",
|
|
10594
10657
|
"type": {
|
|
10595
|
-
"text": "
|
|
10658
|
+
"text": "boolean"
|
|
10596
10659
|
},
|
|
10597
|
-
"
|
|
10660
|
+
"default": "false",
|
|
10661
|
+
"description": "Whether the control is active by default."
|
|
10598
10662
|
},
|
|
10599
10663
|
{
|
|
10600
10664
|
"name": "details",
|
|
@@ -10630,22 +10694,12 @@
|
|
|
10630
10694
|
"description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property."
|
|
10631
10695
|
},
|
|
10632
10696
|
{
|
|
10633
|
-
"name": "
|
|
10634
|
-
"fieldName": "
|
|
10635
|
-
"type": {
|
|
10636
|
-
"text": "boolean"
|
|
10637
|
-
},
|
|
10638
|
-
"default": "false",
|
|
10639
|
-
"description": "Whether the control is active."
|
|
10640
|
-
},
|
|
10641
|
-
{
|
|
10642
|
-
"name": "checked",
|
|
10643
|
-
"fieldName": "defaultChecked",
|
|
10697
|
+
"name": "name",
|
|
10698
|
+
"fieldName": "name",
|
|
10644
10699
|
"type": {
|
|
10645
|
-
"text": "
|
|
10700
|
+
"text": "string"
|
|
10646
10701
|
},
|
|
10647
|
-
"
|
|
10648
|
-
"description": "Whether the control is active by default."
|
|
10702
|
+
"description": "An identifier for the control that is unique within the nearest containing `Form` component."
|
|
10649
10703
|
},
|
|
10650
10704
|
{
|
|
10651
10705
|
"name": "labelaccessibilityvisibility",
|
|
@@ -11335,14 +11389,6 @@
|
|
|
11335
11389
|
},
|
|
11336
11390
|
"description": "The current value for the field. If omitted, the field will be empty."
|
|
11337
11391
|
},
|
|
11338
|
-
{
|
|
11339
|
-
"kind": "field",
|
|
11340
|
-
"name": "defaultValue",
|
|
11341
|
-
"type": {
|
|
11342
|
-
"text": "string"
|
|
11343
|
-
},
|
|
11344
|
-
"description": "The default value for the field."
|
|
11345
|
-
},
|
|
11346
11392
|
{
|
|
11347
11393
|
"kind": "field",
|
|
11348
11394
|
"name": "details",
|
|
@@ -11367,6 +11413,15 @@
|
|
|
11367
11413
|
},
|
|
11368
11414
|
"description": "Content to use as the field label."
|
|
11369
11415
|
},
|
|
11416
|
+
{
|
|
11417
|
+
"kind": "field",
|
|
11418
|
+
"name": "required",
|
|
11419
|
+
"type": {
|
|
11420
|
+
"text": "boolean"
|
|
11421
|
+
},
|
|
11422
|
+
"default": "false",
|
|
11423
|
+
"description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property."
|
|
11424
|
+
},
|
|
11370
11425
|
{
|
|
11371
11426
|
"kind": "field",
|
|
11372
11427
|
"name": "labelAccessibilityVisibility",
|
|
@@ -11378,29 +11433,28 @@
|
|
|
11378
11433
|
},
|
|
11379
11434
|
{
|
|
11380
11435
|
"kind": "field",
|
|
11381
|
-
"name": "
|
|
11436
|
+
"name": "defaultValue",
|
|
11382
11437
|
"type": {
|
|
11383
11438
|
"text": "string"
|
|
11384
11439
|
},
|
|
11385
|
-
"description": "
|
|
11440
|
+
"description": "The default value for the field."
|
|
11386
11441
|
},
|
|
11387
11442
|
{
|
|
11388
11443
|
"kind": "field",
|
|
11389
|
-
"name": "
|
|
11444
|
+
"name": "placeholder",
|
|
11390
11445
|
"type": {
|
|
11391
|
-
"text": "
|
|
11446
|
+
"text": "string"
|
|
11392
11447
|
},
|
|
11393
|
-
"
|
|
11394
|
-
"description": "The field cannot be edited by the user. It is focusable will be announced by screen readers."
|
|
11448
|
+
"description": "A short hint that describes the expected value of the field."
|
|
11395
11449
|
},
|
|
11396
11450
|
{
|
|
11397
11451
|
"kind": "field",
|
|
11398
|
-
"name": "
|
|
11452
|
+
"name": "readOnly",
|
|
11399
11453
|
"type": {
|
|
11400
11454
|
"text": "boolean"
|
|
11401
11455
|
},
|
|
11402
11456
|
"default": "false",
|
|
11403
|
-
"description": "
|
|
11457
|
+
"description": "The field cannot be edited by the user. It is focusable will be announced by screen readers."
|
|
11404
11458
|
},
|
|
11405
11459
|
{
|
|
11406
11460
|
"kind": "field",
|
|
@@ -11503,14 +11557,6 @@
|
|
|
11503
11557
|
},
|
|
11504
11558
|
"description": "The current value for the field. If omitted, the field will be empty."
|
|
11505
11559
|
},
|
|
11506
|
-
{
|
|
11507
|
-
"name": "value",
|
|
11508
|
-
"fieldName": "defaultValue",
|
|
11509
|
-
"type": {
|
|
11510
|
-
"text": "string"
|
|
11511
|
-
},
|
|
11512
|
-
"description": "The default value for the field."
|
|
11513
|
-
},
|
|
11514
11560
|
{
|
|
11515
11561
|
"name": "details",
|
|
11516
11562
|
"fieldName": "details",
|
|
@@ -11535,6 +11581,15 @@
|
|
|
11535
11581
|
},
|
|
11536
11582
|
"description": "Content to use as the field label."
|
|
11537
11583
|
},
|
|
11584
|
+
{
|
|
11585
|
+
"name": "required",
|
|
11586
|
+
"fieldName": "required",
|
|
11587
|
+
"type": {
|
|
11588
|
+
"text": "boolean"
|
|
11589
|
+
},
|
|
11590
|
+
"default": "false",
|
|
11591
|
+
"description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property."
|
|
11592
|
+
},
|
|
11538
11593
|
{
|
|
11539
11594
|
"name": "labelaccessibilityvisibility",
|
|
11540
11595
|
"fieldName": "labelAccessibilityVisibility",
|
|
@@ -11544,6 +11599,14 @@
|
|
|
11544
11599
|
"default": "'visible'",
|
|
11545
11600
|
"description": "Changes the visibility of the component's label. - `visible`: the label is visible to all users. - `exclusive`: the label is visually hidden but remains in the accessibility tree."
|
|
11546
11601
|
},
|
|
11602
|
+
{
|
|
11603
|
+
"name": "value",
|
|
11604
|
+
"fieldName": "defaultValue",
|
|
11605
|
+
"type": {
|
|
11606
|
+
"text": "string"
|
|
11607
|
+
},
|
|
11608
|
+
"description": "The default value for the field."
|
|
11609
|
+
},
|
|
11547
11610
|
{
|
|
11548
11611
|
"name": "placeholder",
|
|
11549
11612
|
"fieldName": "placeholder",
|
|
@@ -11561,15 +11624,6 @@
|
|
|
11561
11624
|
"default": "false",
|
|
11562
11625
|
"description": "The field cannot be edited by the user. It is focusable will be announced by screen readers."
|
|
11563
11626
|
},
|
|
11564
|
-
{
|
|
11565
|
-
"name": "required",
|
|
11566
|
-
"fieldName": "required",
|
|
11567
|
-
"type": {
|
|
11568
|
-
"text": "boolean"
|
|
11569
|
-
},
|
|
11570
|
-
"default": "false",
|
|
11571
|
-
"description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property."
|
|
11572
|
-
},
|
|
11573
11627
|
{
|
|
11574
11628
|
"name": "autocomplete",
|
|
11575
11629
|
"fieldName": "autocomplete",
|
|
@@ -11670,14 +11724,6 @@
|
|
|
11670
11724
|
},
|
|
11671
11725
|
"description": "The current value for the field. If omitted, the field will be empty."
|
|
11672
11726
|
},
|
|
11673
|
-
{
|
|
11674
|
-
"kind": "field",
|
|
11675
|
-
"name": "defaultValue",
|
|
11676
|
-
"type": {
|
|
11677
|
-
"text": "string"
|
|
11678
|
-
},
|
|
11679
|
-
"description": "The default value for the field."
|
|
11680
|
-
},
|
|
11681
11727
|
{
|
|
11682
11728
|
"kind": "field",
|
|
11683
11729
|
"name": "details",
|
|
@@ -11702,6 +11748,15 @@
|
|
|
11702
11748
|
},
|
|
11703
11749
|
"description": "Content to use as the field label."
|
|
11704
11750
|
},
|
|
11751
|
+
{
|
|
11752
|
+
"kind": "field",
|
|
11753
|
+
"name": "required",
|
|
11754
|
+
"type": {
|
|
11755
|
+
"text": "boolean"
|
|
11756
|
+
},
|
|
11757
|
+
"default": "false",
|
|
11758
|
+
"description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property."
|
|
11759
|
+
},
|
|
11705
11760
|
{
|
|
11706
11761
|
"kind": "field",
|
|
11707
11762
|
"name": "labelAccessibilityVisibility",
|
|
@@ -11713,29 +11768,28 @@
|
|
|
11713
11768
|
},
|
|
11714
11769
|
{
|
|
11715
11770
|
"kind": "field",
|
|
11716
|
-
"name": "
|
|
11771
|
+
"name": "defaultValue",
|
|
11717
11772
|
"type": {
|
|
11718
11773
|
"text": "string"
|
|
11719
11774
|
},
|
|
11720
|
-
"description": "
|
|
11775
|
+
"description": "The default value for the field."
|
|
11721
11776
|
},
|
|
11722
11777
|
{
|
|
11723
11778
|
"kind": "field",
|
|
11724
|
-
"name": "
|
|
11779
|
+
"name": "placeholder",
|
|
11725
11780
|
"type": {
|
|
11726
|
-
"text": "
|
|
11781
|
+
"text": "string"
|
|
11727
11782
|
},
|
|
11728
|
-
"
|
|
11729
|
-
"description": "The field cannot be edited by the user. It is focusable will be announced by screen readers."
|
|
11783
|
+
"description": "A short hint that describes the expected value of the field."
|
|
11730
11784
|
},
|
|
11731
11785
|
{
|
|
11732
11786
|
"kind": "field",
|
|
11733
|
-
"name": "
|
|
11787
|
+
"name": "readOnly",
|
|
11734
11788
|
"type": {
|
|
11735
11789
|
"text": "boolean"
|
|
11736
11790
|
},
|
|
11737
11791
|
"default": "false",
|
|
11738
|
-
"description": "
|
|
11792
|
+
"description": "The field cannot be edited by the user. It is focusable will be announced by screen readers."
|
|
11739
11793
|
},
|
|
11740
11794
|
{
|
|
11741
11795
|
"kind": "field",
|
|
@@ -11746,6 +11800,15 @@
|
|
|
11746
11800
|
"default": "'tel' for PhoneField",
|
|
11747
11801
|
"description": "A hint as to the intended content of the field. When set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents. When set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes. Alternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill."
|
|
11748
11802
|
},
|
|
11803
|
+
{
|
|
11804
|
+
"kind": "field",
|
|
11805
|
+
"name": "icon",
|
|
11806
|
+
"type": {
|
|
11807
|
+
"text": "\"cart-filled\" | \"channels-filled\" | \"home-filled\" | \"order-filled\" | \"person-filled\" | \"product-filled\" | \"color\" | \"info\" | \"status\" | \"adjust\" | \"affiliate\" | \"airplane\" | \"alert-bubble\" | \"alert-circle\" | \"alert-diamond\" | \"alert-location\" | \"alert-octagon\" | \"alert-octagon-filled\" | \"alert-triangle\" | \"align-horizontal-centers\" | \"app-extension\" | \"apps\" | \"archive\" | \"arrow-down\" | \"arrow-down-circle\" | \"arrow-left\" | \"arrow-left-circle\" | \"arrow-right\" | \"arrow-right-circle\" | \"arrow-up\" | \"arrow-up-circle\" | \"arrow-up-right\" | \"arrows-in-horizontal\" | \"arrows-out-horizontal\" | \"asterisk\" | \"attachment\" | \"automation\" | \"backspace\" | \"bag\" | \"bank\" | \"barcode\" | \"bill\" | \"blank\" | \"blog\" | \"bolt\" | \"bolt-filled\" | \"book\" | \"book-open\" | \"brain\" | \"bug\" | \"bullet\" | \"business-entity\" | \"button\" | \"button-press\" | \"calculator\" | \"calendar\" | \"calendar-check\" | \"calendar-compare\" | \"calendar-list\" | \"calendar-time\" | \"camera\" | \"camera-flip\" | \"caret-down\" | \"caret-left\" | \"caret-right\" | \"caret-up\" | \"cart\" | \"cart-abandoned\" | \"cart-discount\" | \"cart-down\" | \"cart-sale\" | \"cart-up\" | \"cash-dollar\" | \"cash-euro\" | \"cash-pound\" | \"cash-rupee\" | \"cash-yen\" | \"catalog-product\" | \"categories\" | \"channels\" | \"chart-cohort\" | \"chart-donut\" | \"chart-funnel\" | \"chart-histogram-first\" | \"chart-histogram-first-last\" | \"chart-histogram-flat\" | \"chart-histogram-full\" | \"chart-histogram-growth\" | \"chart-histogram-last\" | \"chart-histogram-second-last\" | \"chart-horizontal\" | \"chart-line\" | \"chart-popular\" | \"chart-stacked\" | \"chart-vertical\" | \"chat\" | \"chat-new\" | \"chat-referral\" | \"check\" | \"check-circle\" | \"check-circle-filled\" | \"checkbox\" | \"chevron-down\" | \"chevron-down-circle\" | \"chevron-left\" | \"chevron-left-circle\" | \"chevron-right\" | \"chevron-right-circle\" | \"chevron-up\" | \"chevron-up-circle\" | \"circle\" | \"circle-dashed\" | \"clipboard\" | \"clipboard-check\" | \"clipboard-checklist\" | \"clock\" | \"clock-list\" | \"clock-revert\" | \"code\" | \"code-add\" | \"collection\" | \"collection-featured\" | \"collection-list\" | \"collection-reference\" | \"color-none\" | \"compass\" | \"compose\" | \"confetti\" | \"connect\" | \"content\" | \"contract\" | \"corner-pill\" | \"corner-round\" | \"corner-square\" | \"credit-card\" | \"credit-card-cancel\" | \"credit-card-percent\" | \"credit-card-reader\" | \"credit-card-reader-chip\" | \"credit-card-reader-tap\" | \"credit-card-secure\" | \"credit-card-tap-chip\" | \"crop\" | \"currency-convert\" | \"cursor\" | \"cursor-banner\" | \"cursor-option\" | \"data-presentation\" | \"data-table\" | \"database\" | \"database-add\" | \"database-connect\" | \"delete\" | \"delivery\" | \"desktop\" | \"disabled\" | \"discount\" | \"discount-add\" | \"discount-code\" | \"dns-settings\" | \"dock-floating\" | \"dock-side\" | \"domain\" | \"domain-landing-page\" | \"domain-new\" | \"domain-redirect\" | \"download\" | \"drag-drop\" | \"drag-handle\" | \"duplicate\" | \"edit\" | \"email\" | \"email-follow-up\" | \"email-newsletter\" | \"enabled\" | \"enter\" | \"envelope\" | \"envelope-soft-pack\" | \"eraser\" | \"exchange\" | \"exit\" | \"export\" | \"external\" | \"eye-check-mark\" | \"eye-dropper\" | \"eye-dropper-list\" | \"eye-first\" | \"eyeglasses\" | \"favicon\" | \"file\" | \"file-list\" | \"filter\" | \"filter-active\" | \"flag\" | \"flip-horizontal\" | \"flip-vertical\" | \"flower\" | \"folder\" | \"folder-add\" | \"folder-down\" | \"folder-remove\" | \"folder-up\" | \"food\" | \"foreground\" | \"forklift\" | \"forms\" | \"games\" | \"gauge\" | \"gift-card\" | \"git-branch\" | \"git-commit\" | \"git-repository\" | \"globe\" | \"globe-asia\" | \"globe-europe\" | \"globe-lines\" | \"globe-list\" | \"grid\" | \"hashtag\" | \"hashtag-decimal\" | \"hashtag-list\" | \"heart\" | \"hide\" | \"hide-filled\" | \"home\" | \"icons\" | \"identity-card\" | \"image\" | \"image-add\" | \"image-alt\" | \"image-explore\" | \"image-magic\" | \"image-none\" | \"image-with-text-overlay\" | \"images\" | \"import\" | \"in-progress\" | \"incentive\" | \"incoming\" | \"incomplete\" | \"inheritance\" | \"inventory\" | \"inventory-updated\" | \"iq\" | \"key\" | \"keyboard\" | \"keyboard-filled\" | \"keyboard-hide\" | \"label-printer\" | \"language\" | \"language-translate\" | \"layer\" | \"layout-block\" | \"layout-buy-button\" | \"layout-buy-button-horizontal\" | \"layout-buy-button-vertical\" | \"layout-column-1\" | \"layout-columns-2\" | \"layout-columns-3\" | \"layout-footer\" | \"layout-header\" | \"layout-logo-block\" | \"layout-popup\" | \"layout-rows-2\" | \"layout-section\" | \"layout-sidebar-left\" | \"layout-sidebar-right\" | \"lightbulb\" | \"link\" | \"link-list\" | \"list-bulleted\" | \"list-bulleted-filled\" | \"list-numbered\" | \"live\" | \"location\" | \"location-none\" | \"lock\" | \"map\" | \"markets\" | \"markets-euro\" | \"markets-rupee\" | \"markets-yen\" | \"maximize\" | \"measurement-size\" | \"measurement-size-list\" | \"measurement-volume\" | \"measurement-volume-list\" | \"measurement-weight\" | \"measurement-weight-list\" | \"media-receiver\" | \"megaphone\" | \"mention\" | \"menu\" | \"menu-horizontal\" | \"menu-vertical\" | \"merge\" | \"metafields\" | \"metaobject\" | \"metaobject-list\" | \"metaobject-reference\" | \"microphone\" | \"microphone-muted\" | \"minimize\" | \"minus\" | \"minus-circle\" | \"mobile\" | \"money\" | \"money-none\" | \"moon\" | \"nature\" | \"note\" | \"note-add\" | \"notification\" | \"number-one\" | \"order\" | \"order-batches\" | \"order-draft\" | \"order-first\" | \"order-fulfilled\" | \"order-repeat\" | \"order-unfulfilled\" | \"orders-status\" | \"organization\" | \"outdent\" | \"outgoing\" | \"package\" | \"package-fulfilled\" | \"package-on-hold\" | \"package-returned\" | \"page\" | \"page-add\" | \"page-attachment\" | \"page-clock\" | \"page-down\" | \"page-heart\" | \"page-list\" | \"page-reference\" | \"page-remove\" | \"page-report\" | \"page-up\" | \"pagination-end\" | \"pagination-start\" | \"paint-brush-flat\" | \"paint-brush-round\" | \"paper-check\" | \"passkey\" | \"paste\" | \"pause-circle\" | \"payment\" | \"payment-capture\" | \"payout\" | \"payout-dollar\" | \"payout-euro\" | \"payout-pound\" | \"payout-rupee\" | \"payout-yen\" | \"person\" | \"person-add\" | \"person-exit\" | \"person-list\" | \"person-lock\" | \"person-remove\" | \"person-segment\" | \"personalized-text\" | \"phone\" | \"phone-down\" | \"phone-down-filled\" | \"phone-in\" | \"phone-out\" | \"pin\" | \"pin-remove\" | \"plan\" | \"play\" | \"play-circle\" | \"plus\" | \"plus-circle\" | \"plus-circle-down\" | \"plus-circle-filled\" | \"plus-circle-up\" | \"point-of-sale\" | \"price-list\" | \"print\" | \"product\" | \"product-add\" | \"product-cost\" | \"product-list\" | \"product-reference\" | \"product-remove\" | \"product-return\" | \"product-unavailable\" | \"profile\" | \"profile-filled\" | \"question-circle\" | \"question-circle-filled\" | \"radio-control\" | \"receipt\" | \"receipt-dollar\" | \"receipt-euro\" | \"receipt-paid\" | \"receipt-pound\" | \"receipt-refund\" | \"receipt-rupee\" | \"receipt-yen\" | \"receivables\" | \"redo\" | \"referral-code\" | \"refresh\" | \"remove-background\" | \"replace\" | \"replay\" | \"reset\" | \"return\" | \"reward\" | \"rocket\" | \"rotate-left\" | \"rotate-right\" | \"sandbox\" | \"save\" | \"search\" | \"search-add\" | \"search-list\" | \"search-recent\" | \"search-resource\" | \"select\" | \"send\" | \"settings\" | \"share\" | \"shield-check-mark\" | \"shield-none\" | \"shield-pending\" | \"shield-person\" | \"shipping-label\" | \"shopcodes\" | \"slideshow\" | \"smiley-happy\" | \"smiley-joy\" | \"smiley-neutral\" | \"smiley-sad\" | \"social-ad\" | \"social-post\" | \"sort\" | \"sort-ascending\" | \"sort-descending\" | \"sound\" | \"split\" | \"sports\" | \"star\" | \"star-filled\" | \"star-list\" | \"status-active\" | \"stop-circle\" | \"store\" | \"store-import\" | \"store-managed\" | \"store-online\" | \"sun\" | \"table\" | \"table-masonry\" | \"tablet\" | \"target\" | \"tax\" | \"team\" | \"text\" | \"text-align-center\" | \"text-align-left\" | \"text-align-right\" | \"text-block\" | \"text-bold\" | \"text-color\" | \"text-font\" | \"text-font-list\" | \"text-grammar\" | \"text-in-columns\" | \"text-in-rows\" | \"text-indent\" | \"text-italic\" | \"text-quote\" | \"text-title\" | \"text-underline\" | \"text-with-image\" | \"theme\" | \"theme-cart\" | \"theme-edit\" | \"theme-store\" | \"theme-template\" | \"three-d-environment\" | \"thumbs-down\" | \"thumbs-up\" | \"tip-jar\" | \"toggle-off\" | \"toggle-on\" | \"transaction\" | \"transaction-fee-dollar\" | \"transaction-fee-euro\" | \"transaction-fee-pound\" | \"transaction-fee-rupee\" | \"transaction-fee-yen\" | \"transfer\" | \"transfer-in\" | \"transfer-internal\" | \"transfer-out\" | \"undo\" | \"unknown-device\" | \"unlock\" | \"upload\" | \"variant\" | \"variant-list\" | \"video\" | \"video-list\" | \"view\" | \"viewport-narrow\" | \"viewport-short\" | \"viewport-tall\" | \"viewport-wide\" | \"wallet\" | \"wand\" | \"watch\" | \"wifi\" | \"work\" | \"work-list\" | \"wrench\" | \"x\" | \"x-circle\" | \"empty\" | \"alert-triangle-filled\" | \"arrow-down-right\" | \"battery-low\" | \"broom\" | \"cart-send\" | \"complete\" | \"delivered\" | \"disabled-filled\" | \"discount-automatic\" | \"discount-remove\" | \"drawer\" | \"fav\" | \"geolocation\" | \"gift\" | \"graduation-hat\" | \"info-filled\" | \"inventory-edit\" | \"inventory-list\" | \"inventory-transfer\" | \"keypad\" | \"live-critical\" | \"live-none\" | \"menu-filled\" | \"money-split\" | \"package-cancel\" | \"package-reassign\" | \"partially-complete\" | \"phablet\" | \"point-of-sale-register\" | \"receipt-folded\" | \"reorder\" | \"savings\" | \"scan-qr-code\" | \"shipping-label-cancel\" | \"star-circle\" | \"star-half\" | \"text-indent-remove\" | \"transaction-fee-add\" | \"truck\" | \"x-circle-filled\""
|
|
11808
|
+
},
|
|
11809
|
+
"default": "''",
|
|
11810
|
+
"description": "The type of icon to be displayed in the field."
|
|
11811
|
+
},
|
|
11749
11812
|
{
|
|
11750
11813
|
"kind": "field",
|
|
11751
11814
|
"name": "maxLength",
|
|
@@ -11781,15 +11844,6 @@
|
|
|
11781
11844
|
},
|
|
11782
11845
|
"default": "''",
|
|
11783
11846
|
"description": "A value to be displayed immediately before the editable portion of the field. This is useful for displaying an implied part of the value, such as \"https://\" or \"+353\". This cannot be edited by the user, and it isn't included in the value of the field. It may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input."
|
|
11784
|
-
},
|
|
11785
|
-
{
|
|
11786
|
-
"kind": "field",
|
|
11787
|
-
"name": "icon",
|
|
11788
|
-
"type": {
|
|
11789
|
-
"text": "\"cart-filled\" | \"channels-filled\" | \"home-filled\" | \"order-filled\" | \"person-filled\" | \"product-filled\" | \"color\" | \"info\" | \"status\" | \"adjust\" | \"affiliate\" | \"airplane\" | \"alert-bubble\" | \"alert-circle\" | \"alert-diamond\" | \"alert-location\" | \"alert-octagon\" | \"alert-octagon-filled\" | \"alert-triangle\" | \"align-horizontal-centers\" | \"app-extension\" | \"apps\" | \"archive\" | \"arrow-down\" | \"arrow-down-circle\" | \"arrow-left\" | \"arrow-left-circle\" | \"arrow-right\" | \"arrow-right-circle\" | \"arrow-up\" | \"arrow-up-circle\" | \"arrow-up-right\" | \"arrows-in-horizontal\" | \"arrows-out-horizontal\" | \"asterisk\" | \"attachment\" | \"automation\" | \"backspace\" | \"bag\" | \"bank\" | \"barcode\" | \"bill\" | \"blank\" | \"blog\" | \"bolt\" | \"bolt-filled\" | \"book\" | \"book-open\" | \"brain\" | \"bug\" | \"bullet\" | \"business-entity\" | \"button\" | \"button-press\" | \"calculator\" | \"calendar\" | \"calendar-check\" | \"calendar-compare\" | \"calendar-list\" | \"calendar-time\" | \"camera\" | \"camera-flip\" | \"caret-down\" | \"caret-left\" | \"caret-right\" | \"caret-up\" | \"cart\" | \"cart-abandoned\" | \"cart-discount\" | \"cart-down\" | \"cart-sale\" | \"cart-up\" | \"cash-dollar\" | \"cash-euro\" | \"cash-pound\" | \"cash-rupee\" | \"cash-yen\" | \"catalog-product\" | \"categories\" | \"channels\" | \"chart-cohort\" | \"chart-donut\" | \"chart-funnel\" | \"chart-histogram-first\" | \"chart-histogram-first-last\" | \"chart-histogram-flat\" | \"chart-histogram-full\" | \"chart-histogram-growth\" | \"chart-histogram-last\" | \"chart-histogram-second-last\" | \"chart-horizontal\" | \"chart-line\" | \"chart-popular\" | \"chart-stacked\" | \"chart-vertical\" | \"chat\" | \"chat-new\" | \"chat-referral\" | \"check\" | \"check-circle\" | \"check-circle-filled\" | \"checkbox\" | \"chevron-down\" | \"chevron-down-circle\" | \"chevron-left\" | \"chevron-left-circle\" | \"chevron-right\" | \"chevron-right-circle\" | \"chevron-up\" | \"chevron-up-circle\" | \"circle\" | \"circle-dashed\" | \"clipboard\" | \"clipboard-check\" | \"clipboard-checklist\" | \"clock\" | \"clock-list\" | \"clock-revert\" | \"code\" | \"code-add\" | \"collection\" | \"collection-featured\" | \"collection-list\" | \"collection-reference\" | \"color-none\" | \"compass\" | \"compose\" | \"confetti\" | \"connect\" | \"content\" | \"contract\" | \"corner-pill\" | \"corner-round\" | \"corner-square\" | \"credit-card\" | \"credit-card-cancel\" | \"credit-card-percent\" | \"credit-card-reader\" | \"credit-card-reader-chip\" | \"credit-card-reader-tap\" | \"credit-card-secure\" | \"credit-card-tap-chip\" | \"crop\" | \"currency-convert\" | \"cursor\" | \"cursor-banner\" | \"cursor-option\" | \"data-presentation\" | \"data-table\" | \"database\" | \"database-add\" | \"database-connect\" | \"delete\" | \"delivery\" | \"desktop\" | \"disabled\" | \"discount\" | \"discount-add\" | \"discount-code\" | \"dns-settings\" | \"dock-floating\" | \"dock-side\" | \"domain\" | \"domain-landing-page\" | \"domain-new\" | \"domain-redirect\" | \"download\" | \"drag-drop\" | \"drag-handle\" | \"duplicate\" | \"edit\" | \"email\" | \"email-follow-up\" | \"email-newsletter\" | \"enabled\" | \"enter\" | \"envelope\" | \"envelope-soft-pack\" | \"eraser\" | \"exchange\" | \"exit\" | \"export\" | \"external\" | \"eye-check-mark\" | \"eye-dropper\" | \"eye-dropper-list\" | \"eye-first\" | \"eyeglasses\" | \"favicon\" | \"file\" | \"file-list\" | \"filter\" | \"filter-active\" | \"flag\" | \"flip-horizontal\" | \"flip-vertical\" | \"flower\" | \"folder\" | \"folder-add\" | \"folder-down\" | \"folder-remove\" | \"folder-up\" | \"food\" | \"foreground\" | \"forklift\" | \"forms\" | \"games\" | \"gauge\" | \"gift-card\" | \"git-branch\" | \"git-commit\" | \"git-repository\" | \"globe\" | \"globe-asia\" | \"globe-europe\" | \"globe-lines\" | \"globe-list\" | \"grid\" | \"hashtag\" | \"hashtag-decimal\" | \"hashtag-list\" | \"heart\" | \"hide\" | \"hide-filled\" | \"home\" | \"icons\" | \"identity-card\" | \"image\" | \"image-add\" | \"image-alt\" | \"image-explore\" | \"image-magic\" | \"image-none\" | \"image-with-text-overlay\" | \"images\" | \"import\" | \"in-progress\" | \"incentive\" | \"incoming\" | \"incomplete\" | \"inheritance\" | \"inventory\" | \"inventory-updated\" | \"iq\" | \"key\" | \"keyboard\" | \"keyboard-filled\" | \"keyboard-hide\" | \"label-printer\" | \"language\" | \"language-translate\" | \"layer\" | \"layout-block\" | \"layout-buy-button\" | \"layout-buy-button-horizontal\" | \"layout-buy-button-vertical\" | \"layout-column-1\" | \"layout-columns-2\" | \"layout-columns-3\" | \"layout-footer\" | \"layout-header\" | \"layout-logo-block\" | \"layout-popup\" | \"layout-rows-2\" | \"layout-section\" | \"layout-sidebar-left\" | \"layout-sidebar-right\" | \"lightbulb\" | \"link\" | \"link-list\" | \"list-bulleted\" | \"list-bulleted-filled\" | \"list-numbered\" | \"live\" | \"location\" | \"location-none\" | \"lock\" | \"map\" | \"markets\" | \"markets-euro\" | \"markets-rupee\" | \"markets-yen\" | \"maximize\" | \"measurement-size\" | \"measurement-size-list\" | \"measurement-volume\" | \"measurement-volume-list\" | \"measurement-weight\" | \"measurement-weight-list\" | \"media-receiver\" | \"megaphone\" | \"mention\" | \"menu\" | \"menu-horizontal\" | \"menu-vertical\" | \"merge\" | \"metafields\" | \"metaobject\" | \"metaobject-list\" | \"metaobject-reference\" | \"microphone\" | \"microphone-muted\" | \"minimize\" | \"minus\" | \"minus-circle\" | \"mobile\" | \"money\" | \"money-none\" | \"moon\" | \"nature\" | \"note\" | \"note-add\" | \"notification\" | \"number-one\" | \"order\" | \"order-batches\" | \"order-draft\" | \"order-first\" | \"order-fulfilled\" | \"order-repeat\" | \"order-unfulfilled\" | \"orders-status\" | \"organization\" | \"outdent\" | \"outgoing\" | \"package\" | \"package-fulfilled\" | \"package-on-hold\" | \"package-returned\" | \"page\" | \"page-add\" | \"page-attachment\" | \"page-clock\" | \"page-down\" | \"page-heart\" | \"page-list\" | \"page-reference\" | \"page-remove\" | \"page-report\" | \"page-up\" | \"pagination-end\" | \"pagination-start\" | \"paint-brush-flat\" | \"paint-brush-round\" | \"paper-check\" | \"passkey\" | \"paste\" | \"pause-circle\" | \"payment\" | \"payment-capture\" | \"payout\" | \"payout-dollar\" | \"payout-euro\" | \"payout-pound\" | \"payout-rupee\" | \"payout-yen\" | \"person\" | \"person-add\" | \"person-exit\" | \"person-list\" | \"person-lock\" | \"person-remove\" | \"person-segment\" | \"personalized-text\" | \"phone\" | \"phone-down\" | \"phone-down-filled\" | \"phone-in\" | \"phone-out\" | \"pin\" | \"pin-remove\" | \"plan\" | \"play\" | \"play-circle\" | \"plus\" | \"plus-circle\" | \"plus-circle-down\" | \"plus-circle-filled\" | \"plus-circle-up\" | \"point-of-sale\" | \"price-list\" | \"print\" | \"product\" | \"product-add\" | \"product-cost\" | \"product-list\" | \"product-reference\" | \"product-remove\" | \"product-return\" | \"product-unavailable\" | \"profile\" | \"profile-filled\" | \"question-circle\" | \"question-circle-filled\" | \"radio-control\" | \"receipt\" | \"receipt-dollar\" | \"receipt-euro\" | \"receipt-paid\" | \"receipt-pound\" | \"receipt-refund\" | \"receipt-rupee\" | \"receipt-yen\" | \"receivables\" | \"redo\" | \"referral-code\" | \"refresh\" | \"remove-background\" | \"replace\" | \"replay\" | \"reset\" | \"return\" | \"reward\" | \"rocket\" | \"rotate-left\" | \"rotate-right\" | \"sandbox\" | \"save\" | \"search\" | \"search-add\" | \"search-list\" | \"search-recent\" | \"search-resource\" | \"select\" | \"send\" | \"settings\" | \"share\" | \"shield-check-mark\" | \"shield-none\" | \"shield-pending\" | \"shield-person\" | \"shipping-label\" | \"shopcodes\" | \"slideshow\" | \"smiley-happy\" | \"smiley-joy\" | \"smiley-neutral\" | \"smiley-sad\" | \"social-ad\" | \"social-post\" | \"sort\" | \"sort-ascending\" | \"sort-descending\" | \"sound\" | \"split\" | \"sports\" | \"star\" | \"star-filled\" | \"star-list\" | \"status-active\" | \"stop-circle\" | \"store\" | \"store-import\" | \"store-managed\" | \"store-online\" | \"sun\" | \"table\" | \"table-masonry\" | \"tablet\" | \"target\" | \"tax\" | \"team\" | \"text\" | \"text-align-center\" | \"text-align-left\" | \"text-align-right\" | \"text-block\" | \"text-bold\" | \"text-color\" | \"text-font\" | \"text-font-list\" | \"text-grammar\" | \"text-in-columns\" | \"text-in-rows\" | \"text-indent\" | \"text-italic\" | \"text-quote\" | \"text-title\" | \"text-underline\" | \"text-with-image\" | \"theme\" | \"theme-cart\" | \"theme-edit\" | \"theme-store\" | \"theme-template\" | \"three-d-environment\" | \"thumbs-down\" | \"thumbs-up\" | \"tip-jar\" | \"toggle-off\" | \"toggle-on\" | \"transaction\" | \"transaction-fee-dollar\" | \"transaction-fee-euro\" | \"transaction-fee-pound\" | \"transaction-fee-rupee\" | \"transaction-fee-yen\" | \"transfer\" | \"transfer-in\" | \"transfer-internal\" | \"transfer-out\" | \"undo\" | \"unknown-device\" | \"unlock\" | \"upload\" | \"variant\" | \"variant-list\" | \"video\" | \"video-list\" | \"view\" | \"viewport-narrow\" | \"viewport-short\" | \"viewport-tall\" | \"viewport-wide\" | \"wallet\" | \"wand\" | \"watch\" | \"wifi\" | \"work\" | \"work-list\" | \"wrench\" | \"x\" | \"x-circle\" | \"empty\" | \"alert-triangle-filled\" | \"arrow-down-right\" | \"battery-low\" | \"cart-send\" | \"complete\" | \"delivered\" | \"disabled-filled\" | \"discount-automatic\" | \"discount-remove\" | \"drawer\" | \"fav\" | \"geolocation\" | \"gift\" | \"graduation-hat\" | \"info-filled\" | \"inventory-edit\" | \"inventory-list\" | \"inventory-transfer\" | \"keypad\" | \"live-critical\" | \"live-none\" | \"menu-filled\" | \"money-split\" | \"package-cancel\" | \"package-reassign\" | \"partially-complete\" | \"phablet\" | \"point-of-sale-register\" | \"receipt-folded\" | \"reorder\" | \"savings\" | \"scan-qr-code\" | \"shipping-label-cancel\" | \"star-circle\" | \"star-half\" | \"text-indent-remove\" | \"transaction-fee-add\" | \"truck\" | \"x-circle-filled\""
|
|
11790
|
-
},
|
|
11791
|
-
"default": "''",
|
|
11792
|
-
"description": "The type of icon to be displayed in the field."
|
|
11793
11847
|
}
|
|
11794
11848
|
],
|
|
11795
11849
|
"events": [
|
|
@@ -11856,14 +11910,6 @@
|
|
|
11856
11910
|
},
|
|
11857
11911
|
"description": "The current value for the field. If omitted, the field will be empty."
|
|
11858
11912
|
},
|
|
11859
|
-
{
|
|
11860
|
-
"name": "value",
|
|
11861
|
-
"fieldName": "defaultValue",
|
|
11862
|
-
"type": {
|
|
11863
|
-
"text": "string"
|
|
11864
|
-
},
|
|
11865
|
-
"description": "The default value for the field."
|
|
11866
|
-
},
|
|
11867
11913
|
{
|
|
11868
11914
|
"name": "details",
|
|
11869
11915
|
"fieldName": "details",
|
|
@@ -11888,6 +11934,15 @@
|
|
|
11888
11934
|
},
|
|
11889
11935
|
"description": "Content to use as the field label."
|
|
11890
11936
|
},
|
|
11937
|
+
{
|
|
11938
|
+
"name": "required",
|
|
11939
|
+
"fieldName": "required",
|
|
11940
|
+
"type": {
|
|
11941
|
+
"text": "boolean"
|
|
11942
|
+
},
|
|
11943
|
+
"default": "false",
|
|
11944
|
+
"description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property."
|
|
11945
|
+
},
|
|
11891
11946
|
{
|
|
11892
11947
|
"name": "labelaccessibilityvisibility",
|
|
11893
11948
|
"fieldName": "labelAccessibilityVisibility",
|
|
@@ -11897,6 +11952,14 @@
|
|
|
11897
11952
|
"default": "'visible'",
|
|
11898
11953
|
"description": "Changes the visibility of the component's label. - `visible`: the label is visible to all users. - `exclusive`: the label is visually hidden but remains in the accessibility tree."
|
|
11899
11954
|
},
|
|
11955
|
+
{
|
|
11956
|
+
"name": "value",
|
|
11957
|
+
"fieldName": "defaultValue",
|
|
11958
|
+
"type": {
|
|
11959
|
+
"text": "string"
|
|
11960
|
+
},
|
|
11961
|
+
"description": "The default value for the field."
|
|
11962
|
+
},
|
|
11900
11963
|
{
|
|
11901
11964
|
"name": "placeholder",
|
|
11902
11965
|
"fieldName": "placeholder",
|
|
@@ -11914,15 +11977,6 @@
|
|
|
11914
11977
|
"default": "false",
|
|
11915
11978
|
"description": "The field cannot be edited by the user. It is focusable will be announced by screen readers."
|
|
11916
11979
|
},
|
|
11917
|
-
{
|
|
11918
|
-
"name": "required",
|
|
11919
|
-
"fieldName": "required",
|
|
11920
|
-
"type": {
|
|
11921
|
-
"text": "boolean"
|
|
11922
|
-
},
|
|
11923
|
-
"default": "false",
|
|
11924
|
-
"description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property."
|
|
11925
|
-
},
|
|
11926
11980
|
{
|
|
11927
11981
|
"name": "autocomplete",
|
|
11928
11982
|
"fieldName": "autocomplete",
|
|
@@ -11932,6 +11986,15 @@
|
|
|
11932
11986
|
"default": "'tel' for PhoneField",
|
|
11933
11987
|
"description": "A hint as to the intended content of the field. When set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents. When set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes. Alternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill."
|
|
11934
11988
|
},
|
|
11989
|
+
{
|
|
11990
|
+
"name": "icon",
|
|
11991
|
+
"fieldName": "icon",
|
|
11992
|
+
"type": {
|
|
11993
|
+
"text": "\"cart-filled\" | \"channels-filled\" | \"home-filled\" | \"order-filled\" | \"person-filled\" | \"product-filled\" | \"color\" | \"info\" | \"status\" | \"adjust\" | \"affiliate\" | \"airplane\" | \"alert-bubble\" | \"alert-circle\" | \"alert-diamond\" | \"alert-location\" | \"alert-octagon\" | \"alert-octagon-filled\" | \"alert-triangle\" | \"align-horizontal-centers\" | \"app-extension\" | \"apps\" | \"archive\" | \"arrow-down\" | \"arrow-down-circle\" | \"arrow-left\" | \"arrow-left-circle\" | \"arrow-right\" | \"arrow-right-circle\" | \"arrow-up\" | \"arrow-up-circle\" | \"arrow-up-right\" | \"arrows-in-horizontal\" | \"arrows-out-horizontal\" | \"asterisk\" | \"attachment\" | \"automation\" | \"backspace\" | \"bag\" | \"bank\" | \"barcode\" | \"bill\" | \"blank\" | \"blog\" | \"bolt\" | \"bolt-filled\" | \"book\" | \"book-open\" | \"brain\" | \"bug\" | \"bullet\" | \"business-entity\" | \"button\" | \"button-press\" | \"calculator\" | \"calendar\" | \"calendar-check\" | \"calendar-compare\" | \"calendar-list\" | \"calendar-time\" | \"camera\" | \"camera-flip\" | \"caret-down\" | \"caret-left\" | \"caret-right\" | \"caret-up\" | \"cart\" | \"cart-abandoned\" | \"cart-discount\" | \"cart-down\" | \"cart-sale\" | \"cart-up\" | \"cash-dollar\" | \"cash-euro\" | \"cash-pound\" | \"cash-rupee\" | \"cash-yen\" | \"catalog-product\" | \"categories\" | \"channels\" | \"chart-cohort\" | \"chart-donut\" | \"chart-funnel\" | \"chart-histogram-first\" | \"chart-histogram-first-last\" | \"chart-histogram-flat\" | \"chart-histogram-full\" | \"chart-histogram-growth\" | \"chart-histogram-last\" | \"chart-histogram-second-last\" | \"chart-horizontal\" | \"chart-line\" | \"chart-popular\" | \"chart-stacked\" | \"chart-vertical\" | \"chat\" | \"chat-new\" | \"chat-referral\" | \"check\" | \"check-circle\" | \"check-circle-filled\" | \"checkbox\" | \"chevron-down\" | \"chevron-down-circle\" | \"chevron-left\" | \"chevron-left-circle\" | \"chevron-right\" | \"chevron-right-circle\" | \"chevron-up\" | \"chevron-up-circle\" | \"circle\" | \"circle-dashed\" | \"clipboard\" | \"clipboard-check\" | \"clipboard-checklist\" | \"clock\" | \"clock-list\" | \"clock-revert\" | \"code\" | \"code-add\" | \"collection\" | \"collection-featured\" | \"collection-list\" | \"collection-reference\" | \"color-none\" | \"compass\" | \"compose\" | \"confetti\" | \"connect\" | \"content\" | \"contract\" | \"corner-pill\" | \"corner-round\" | \"corner-square\" | \"credit-card\" | \"credit-card-cancel\" | \"credit-card-percent\" | \"credit-card-reader\" | \"credit-card-reader-chip\" | \"credit-card-reader-tap\" | \"credit-card-secure\" | \"credit-card-tap-chip\" | \"crop\" | \"currency-convert\" | \"cursor\" | \"cursor-banner\" | \"cursor-option\" | \"data-presentation\" | \"data-table\" | \"database\" | \"database-add\" | \"database-connect\" | \"delete\" | \"delivery\" | \"desktop\" | \"disabled\" | \"discount\" | \"discount-add\" | \"discount-code\" | \"dns-settings\" | \"dock-floating\" | \"dock-side\" | \"domain\" | \"domain-landing-page\" | \"domain-new\" | \"domain-redirect\" | \"download\" | \"drag-drop\" | \"drag-handle\" | \"duplicate\" | \"edit\" | \"email\" | \"email-follow-up\" | \"email-newsletter\" | \"enabled\" | \"enter\" | \"envelope\" | \"envelope-soft-pack\" | \"eraser\" | \"exchange\" | \"exit\" | \"export\" | \"external\" | \"eye-check-mark\" | \"eye-dropper\" | \"eye-dropper-list\" | \"eye-first\" | \"eyeglasses\" | \"favicon\" | \"file\" | \"file-list\" | \"filter\" | \"filter-active\" | \"flag\" | \"flip-horizontal\" | \"flip-vertical\" | \"flower\" | \"folder\" | \"folder-add\" | \"folder-down\" | \"folder-remove\" | \"folder-up\" | \"food\" | \"foreground\" | \"forklift\" | \"forms\" | \"games\" | \"gauge\" | \"gift-card\" | \"git-branch\" | \"git-commit\" | \"git-repository\" | \"globe\" | \"globe-asia\" | \"globe-europe\" | \"globe-lines\" | \"globe-list\" | \"grid\" | \"hashtag\" | \"hashtag-decimal\" | \"hashtag-list\" | \"heart\" | \"hide\" | \"hide-filled\" | \"home\" | \"icons\" | \"identity-card\" | \"image\" | \"image-add\" | \"image-alt\" | \"image-explore\" | \"image-magic\" | \"image-none\" | \"image-with-text-overlay\" | \"images\" | \"import\" | \"in-progress\" | \"incentive\" | \"incoming\" | \"incomplete\" | \"inheritance\" | \"inventory\" | \"inventory-updated\" | \"iq\" | \"key\" | \"keyboard\" | \"keyboard-filled\" | \"keyboard-hide\" | \"label-printer\" | \"language\" | \"language-translate\" | \"layer\" | \"layout-block\" | \"layout-buy-button\" | \"layout-buy-button-horizontal\" | \"layout-buy-button-vertical\" | \"layout-column-1\" | \"layout-columns-2\" | \"layout-columns-3\" | \"layout-footer\" | \"layout-header\" | \"layout-logo-block\" | \"layout-popup\" | \"layout-rows-2\" | \"layout-section\" | \"layout-sidebar-left\" | \"layout-sidebar-right\" | \"lightbulb\" | \"link\" | \"link-list\" | \"list-bulleted\" | \"list-bulleted-filled\" | \"list-numbered\" | \"live\" | \"location\" | \"location-none\" | \"lock\" | \"map\" | \"markets\" | \"markets-euro\" | \"markets-rupee\" | \"markets-yen\" | \"maximize\" | \"measurement-size\" | \"measurement-size-list\" | \"measurement-volume\" | \"measurement-volume-list\" | \"measurement-weight\" | \"measurement-weight-list\" | \"media-receiver\" | \"megaphone\" | \"mention\" | \"menu\" | \"menu-horizontal\" | \"menu-vertical\" | \"merge\" | \"metafields\" | \"metaobject\" | \"metaobject-list\" | \"metaobject-reference\" | \"microphone\" | \"microphone-muted\" | \"minimize\" | \"minus\" | \"minus-circle\" | \"mobile\" | \"money\" | \"money-none\" | \"moon\" | \"nature\" | \"note\" | \"note-add\" | \"notification\" | \"number-one\" | \"order\" | \"order-batches\" | \"order-draft\" | \"order-first\" | \"order-fulfilled\" | \"order-repeat\" | \"order-unfulfilled\" | \"orders-status\" | \"organization\" | \"outdent\" | \"outgoing\" | \"package\" | \"package-fulfilled\" | \"package-on-hold\" | \"package-returned\" | \"page\" | \"page-add\" | \"page-attachment\" | \"page-clock\" | \"page-down\" | \"page-heart\" | \"page-list\" | \"page-reference\" | \"page-remove\" | \"page-report\" | \"page-up\" | \"pagination-end\" | \"pagination-start\" | \"paint-brush-flat\" | \"paint-brush-round\" | \"paper-check\" | \"passkey\" | \"paste\" | \"pause-circle\" | \"payment\" | \"payment-capture\" | \"payout\" | \"payout-dollar\" | \"payout-euro\" | \"payout-pound\" | \"payout-rupee\" | \"payout-yen\" | \"person\" | \"person-add\" | \"person-exit\" | \"person-list\" | \"person-lock\" | \"person-remove\" | \"person-segment\" | \"personalized-text\" | \"phone\" | \"phone-down\" | \"phone-down-filled\" | \"phone-in\" | \"phone-out\" | \"pin\" | \"pin-remove\" | \"plan\" | \"play\" | \"play-circle\" | \"plus\" | \"plus-circle\" | \"plus-circle-down\" | \"plus-circle-filled\" | \"plus-circle-up\" | \"point-of-sale\" | \"price-list\" | \"print\" | \"product\" | \"product-add\" | \"product-cost\" | \"product-list\" | \"product-reference\" | \"product-remove\" | \"product-return\" | \"product-unavailable\" | \"profile\" | \"profile-filled\" | \"question-circle\" | \"question-circle-filled\" | \"radio-control\" | \"receipt\" | \"receipt-dollar\" | \"receipt-euro\" | \"receipt-paid\" | \"receipt-pound\" | \"receipt-refund\" | \"receipt-rupee\" | \"receipt-yen\" | \"receivables\" | \"redo\" | \"referral-code\" | \"refresh\" | \"remove-background\" | \"replace\" | \"replay\" | \"reset\" | \"return\" | \"reward\" | \"rocket\" | \"rotate-left\" | \"rotate-right\" | \"sandbox\" | \"save\" | \"search\" | \"search-add\" | \"search-list\" | \"search-recent\" | \"search-resource\" | \"select\" | \"send\" | \"settings\" | \"share\" | \"shield-check-mark\" | \"shield-none\" | \"shield-pending\" | \"shield-person\" | \"shipping-label\" | \"shopcodes\" | \"slideshow\" | \"smiley-happy\" | \"smiley-joy\" | \"smiley-neutral\" | \"smiley-sad\" | \"social-ad\" | \"social-post\" | \"sort\" | \"sort-ascending\" | \"sort-descending\" | \"sound\" | \"split\" | \"sports\" | \"star\" | \"star-filled\" | \"star-list\" | \"status-active\" | \"stop-circle\" | \"store\" | \"store-import\" | \"store-managed\" | \"store-online\" | \"sun\" | \"table\" | \"table-masonry\" | \"tablet\" | \"target\" | \"tax\" | \"team\" | \"text\" | \"text-align-center\" | \"text-align-left\" | \"text-align-right\" | \"text-block\" | \"text-bold\" | \"text-color\" | \"text-font\" | \"text-font-list\" | \"text-grammar\" | \"text-in-columns\" | \"text-in-rows\" | \"text-indent\" | \"text-italic\" | \"text-quote\" | \"text-title\" | \"text-underline\" | \"text-with-image\" | \"theme\" | \"theme-cart\" | \"theme-edit\" | \"theme-store\" | \"theme-template\" | \"three-d-environment\" | \"thumbs-down\" | \"thumbs-up\" | \"tip-jar\" | \"toggle-off\" | \"toggle-on\" | \"transaction\" | \"transaction-fee-dollar\" | \"transaction-fee-euro\" | \"transaction-fee-pound\" | \"transaction-fee-rupee\" | \"transaction-fee-yen\" | \"transfer\" | \"transfer-in\" | \"transfer-internal\" | \"transfer-out\" | \"undo\" | \"unknown-device\" | \"unlock\" | \"upload\" | \"variant\" | \"variant-list\" | \"video\" | \"video-list\" | \"view\" | \"viewport-narrow\" | \"viewport-short\" | \"viewport-tall\" | \"viewport-wide\" | \"wallet\" | \"wand\" | \"watch\" | \"wifi\" | \"work\" | \"work-list\" | \"wrench\" | \"x\" | \"x-circle\" | \"empty\" | \"alert-triangle-filled\" | \"arrow-down-right\" | \"battery-low\" | \"broom\" | \"cart-send\" | \"complete\" | \"delivered\" | \"disabled-filled\" | \"discount-automatic\" | \"discount-remove\" | \"drawer\" | \"fav\" | \"geolocation\" | \"gift\" | \"graduation-hat\" | \"info-filled\" | \"inventory-edit\" | \"inventory-list\" | \"inventory-transfer\" | \"keypad\" | \"live-critical\" | \"live-none\" | \"menu-filled\" | \"money-split\" | \"package-cancel\" | \"package-reassign\" | \"partially-complete\" | \"phablet\" | \"point-of-sale-register\" | \"receipt-folded\" | \"reorder\" | \"savings\" | \"scan-qr-code\" | \"shipping-label-cancel\" | \"star-circle\" | \"star-half\" | \"text-indent-remove\" | \"transaction-fee-add\" | \"truck\" | \"x-circle-filled\""
|
|
11994
|
+
},
|
|
11995
|
+
"default": "''",
|
|
11996
|
+
"description": "The type of icon to be displayed in the field."
|
|
11997
|
+
},
|
|
11935
11998
|
{
|
|
11936
11999
|
"name": "maxlength",
|
|
11937
12000
|
"fieldName": "maxLength",
|
|
@@ -11967,15 +12030,6 @@
|
|
|
11967
12030
|
},
|
|
11968
12031
|
"default": "''",
|
|
11969
12032
|
"description": "A value to be displayed immediately before the editable portion of the field. This is useful for displaying an implied part of the value, such as \"https://\" or \"+353\". This cannot be edited by the user, and it isn't included in the value of the field. It may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input."
|
|
11970
|
-
},
|
|
11971
|
-
{
|
|
11972
|
-
"name": "icon",
|
|
11973
|
-
"fieldName": "icon",
|
|
11974
|
-
"type": {
|
|
11975
|
-
"text": "\"cart-filled\" | \"channels-filled\" | \"home-filled\" | \"order-filled\" | \"person-filled\" | \"product-filled\" | \"color\" | \"info\" | \"status\" | \"adjust\" | \"affiliate\" | \"airplane\" | \"alert-bubble\" | \"alert-circle\" | \"alert-diamond\" | \"alert-location\" | \"alert-octagon\" | \"alert-octagon-filled\" | \"alert-triangle\" | \"align-horizontal-centers\" | \"app-extension\" | \"apps\" | \"archive\" | \"arrow-down\" | \"arrow-down-circle\" | \"arrow-left\" | \"arrow-left-circle\" | \"arrow-right\" | \"arrow-right-circle\" | \"arrow-up\" | \"arrow-up-circle\" | \"arrow-up-right\" | \"arrows-in-horizontal\" | \"arrows-out-horizontal\" | \"asterisk\" | \"attachment\" | \"automation\" | \"backspace\" | \"bag\" | \"bank\" | \"barcode\" | \"bill\" | \"blank\" | \"blog\" | \"bolt\" | \"bolt-filled\" | \"book\" | \"book-open\" | \"brain\" | \"bug\" | \"bullet\" | \"business-entity\" | \"button\" | \"button-press\" | \"calculator\" | \"calendar\" | \"calendar-check\" | \"calendar-compare\" | \"calendar-list\" | \"calendar-time\" | \"camera\" | \"camera-flip\" | \"caret-down\" | \"caret-left\" | \"caret-right\" | \"caret-up\" | \"cart\" | \"cart-abandoned\" | \"cart-discount\" | \"cart-down\" | \"cart-sale\" | \"cart-up\" | \"cash-dollar\" | \"cash-euro\" | \"cash-pound\" | \"cash-rupee\" | \"cash-yen\" | \"catalog-product\" | \"categories\" | \"channels\" | \"chart-cohort\" | \"chart-donut\" | \"chart-funnel\" | \"chart-histogram-first\" | \"chart-histogram-first-last\" | \"chart-histogram-flat\" | \"chart-histogram-full\" | \"chart-histogram-growth\" | \"chart-histogram-last\" | \"chart-histogram-second-last\" | \"chart-horizontal\" | \"chart-line\" | \"chart-popular\" | \"chart-stacked\" | \"chart-vertical\" | \"chat\" | \"chat-new\" | \"chat-referral\" | \"check\" | \"check-circle\" | \"check-circle-filled\" | \"checkbox\" | \"chevron-down\" | \"chevron-down-circle\" | \"chevron-left\" | \"chevron-left-circle\" | \"chevron-right\" | \"chevron-right-circle\" | \"chevron-up\" | \"chevron-up-circle\" | \"circle\" | \"circle-dashed\" | \"clipboard\" | \"clipboard-check\" | \"clipboard-checklist\" | \"clock\" | \"clock-list\" | \"clock-revert\" | \"code\" | \"code-add\" | \"collection\" | \"collection-featured\" | \"collection-list\" | \"collection-reference\" | \"color-none\" | \"compass\" | \"compose\" | \"confetti\" | \"connect\" | \"content\" | \"contract\" | \"corner-pill\" | \"corner-round\" | \"corner-square\" | \"credit-card\" | \"credit-card-cancel\" | \"credit-card-percent\" | \"credit-card-reader\" | \"credit-card-reader-chip\" | \"credit-card-reader-tap\" | \"credit-card-secure\" | \"credit-card-tap-chip\" | \"crop\" | \"currency-convert\" | \"cursor\" | \"cursor-banner\" | \"cursor-option\" | \"data-presentation\" | \"data-table\" | \"database\" | \"database-add\" | \"database-connect\" | \"delete\" | \"delivery\" | \"desktop\" | \"disabled\" | \"discount\" | \"discount-add\" | \"discount-code\" | \"dns-settings\" | \"dock-floating\" | \"dock-side\" | \"domain\" | \"domain-landing-page\" | \"domain-new\" | \"domain-redirect\" | \"download\" | \"drag-drop\" | \"drag-handle\" | \"duplicate\" | \"edit\" | \"email\" | \"email-follow-up\" | \"email-newsletter\" | \"enabled\" | \"enter\" | \"envelope\" | \"envelope-soft-pack\" | \"eraser\" | \"exchange\" | \"exit\" | \"export\" | \"external\" | \"eye-check-mark\" | \"eye-dropper\" | \"eye-dropper-list\" | \"eye-first\" | \"eyeglasses\" | \"favicon\" | \"file\" | \"file-list\" | \"filter\" | \"filter-active\" | \"flag\" | \"flip-horizontal\" | \"flip-vertical\" | \"flower\" | \"folder\" | \"folder-add\" | \"folder-down\" | \"folder-remove\" | \"folder-up\" | \"food\" | \"foreground\" | \"forklift\" | \"forms\" | \"games\" | \"gauge\" | \"gift-card\" | \"git-branch\" | \"git-commit\" | \"git-repository\" | \"globe\" | \"globe-asia\" | \"globe-europe\" | \"globe-lines\" | \"globe-list\" | \"grid\" | \"hashtag\" | \"hashtag-decimal\" | \"hashtag-list\" | \"heart\" | \"hide\" | \"hide-filled\" | \"home\" | \"icons\" | \"identity-card\" | \"image\" | \"image-add\" | \"image-alt\" | \"image-explore\" | \"image-magic\" | \"image-none\" | \"image-with-text-overlay\" | \"images\" | \"import\" | \"in-progress\" | \"incentive\" | \"incoming\" | \"incomplete\" | \"inheritance\" | \"inventory\" | \"inventory-updated\" | \"iq\" | \"key\" | \"keyboard\" | \"keyboard-filled\" | \"keyboard-hide\" | \"label-printer\" | \"language\" | \"language-translate\" | \"layer\" | \"layout-block\" | \"layout-buy-button\" | \"layout-buy-button-horizontal\" | \"layout-buy-button-vertical\" | \"layout-column-1\" | \"layout-columns-2\" | \"layout-columns-3\" | \"layout-footer\" | \"layout-header\" | \"layout-logo-block\" | \"layout-popup\" | \"layout-rows-2\" | \"layout-section\" | \"layout-sidebar-left\" | \"layout-sidebar-right\" | \"lightbulb\" | \"link\" | \"link-list\" | \"list-bulleted\" | \"list-bulleted-filled\" | \"list-numbered\" | \"live\" | \"location\" | \"location-none\" | \"lock\" | \"map\" | \"markets\" | \"markets-euro\" | \"markets-rupee\" | \"markets-yen\" | \"maximize\" | \"measurement-size\" | \"measurement-size-list\" | \"measurement-volume\" | \"measurement-volume-list\" | \"measurement-weight\" | \"measurement-weight-list\" | \"media-receiver\" | \"megaphone\" | \"mention\" | \"menu\" | \"menu-horizontal\" | \"menu-vertical\" | \"merge\" | \"metafields\" | \"metaobject\" | \"metaobject-list\" | \"metaobject-reference\" | \"microphone\" | \"microphone-muted\" | \"minimize\" | \"minus\" | \"minus-circle\" | \"mobile\" | \"money\" | \"money-none\" | \"moon\" | \"nature\" | \"note\" | \"note-add\" | \"notification\" | \"number-one\" | \"order\" | \"order-batches\" | \"order-draft\" | \"order-first\" | \"order-fulfilled\" | \"order-repeat\" | \"order-unfulfilled\" | \"orders-status\" | \"organization\" | \"outdent\" | \"outgoing\" | \"package\" | \"package-fulfilled\" | \"package-on-hold\" | \"package-returned\" | \"page\" | \"page-add\" | \"page-attachment\" | \"page-clock\" | \"page-down\" | \"page-heart\" | \"page-list\" | \"page-reference\" | \"page-remove\" | \"page-report\" | \"page-up\" | \"pagination-end\" | \"pagination-start\" | \"paint-brush-flat\" | \"paint-brush-round\" | \"paper-check\" | \"passkey\" | \"paste\" | \"pause-circle\" | \"payment\" | \"payment-capture\" | \"payout\" | \"payout-dollar\" | \"payout-euro\" | \"payout-pound\" | \"payout-rupee\" | \"payout-yen\" | \"person\" | \"person-add\" | \"person-exit\" | \"person-list\" | \"person-lock\" | \"person-remove\" | \"person-segment\" | \"personalized-text\" | \"phone\" | \"phone-down\" | \"phone-down-filled\" | \"phone-in\" | \"phone-out\" | \"pin\" | \"pin-remove\" | \"plan\" | \"play\" | \"play-circle\" | \"plus\" | \"plus-circle\" | \"plus-circle-down\" | \"plus-circle-filled\" | \"plus-circle-up\" | \"point-of-sale\" | \"price-list\" | \"print\" | \"product\" | \"product-add\" | \"product-cost\" | \"product-list\" | \"product-reference\" | \"product-remove\" | \"product-return\" | \"product-unavailable\" | \"profile\" | \"profile-filled\" | \"question-circle\" | \"question-circle-filled\" | \"radio-control\" | \"receipt\" | \"receipt-dollar\" | \"receipt-euro\" | \"receipt-paid\" | \"receipt-pound\" | \"receipt-refund\" | \"receipt-rupee\" | \"receipt-yen\" | \"receivables\" | \"redo\" | \"referral-code\" | \"refresh\" | \"remove-background\" | \"replace\" | \"replay\" | \"reset\" | \"return\" | \"reward\" | \"rocket\" | \"rotate-left\" | \"rotate-right\" | \"sandbox\" | \"save\" | \"search\" | \"search-add\" | \"search-list\" | \"search-recent\" | \"search-resource\" | \"select\" | \"send\" | \"settings\" | \"share\" | \"shield-check-mark\" | \"shield-none\" | \"shield-pending\" | \"shield-person\" | \"shipping-label\" | \"shopcodes\" | \"slideshow\" | \"smiley-happy\" | \"smiley-joy\" | \"smiley-neutral\" | \"smiley-sad\" | \"social-ad\" | \"social-post\" | \"sort\" | \"sort-ascending\" | \"sort-descending\" | \"sound\" | \"split\" | \"sports\" | \"star\" | \"star-filled\" | \"star-list\" | \"status-active\" | \"stop-circle\" | \"store\" | \"store-import\" | \"store-managed\" | \"store-online\" | \"sun\" | \"table\" | \"table-masonry\" | \"tablet\" | \"target\" | \"tax\" | \"team\" | \"text\" | \"text-align-center\" | \"text-align-left\" | \"text-align-right\" | \"text-block\" | \"text-bold\" | \"text-color\" | \"text-font\" | \"text-font-list\" | \"text-grammar\" | \"text-in-columns\" | \"text-in-rows\" | \"text-indent\" | \"text-italic\" | \"text-quote\" | \"text-title\" | \"text-underline\" | \"text-with-image\" | \"theme\" | \"theme-cart\" | \"theme-edit\" | \"theme-store\" | \"theme-template\" | \"three-d-environment\" | \"thumbs-down\" | \"thumbs-up\" | \"tip-jar\" | \"toggle-off\" | \"toggle-on\" | \"transaction\" | \"transaction-fee-dollar\" | \"transaction-fee-euro\" | \"transaction-fee-pound\" | \"transaction-fee-rupee\" | \"transaction-fee-yen\" | \"transfer\" | \"transfer-in\" | \"transfer-internal\" | \"transfer-out\" | \"undo\" | \"unknown-device\" | \"unlock\" | \"upload\" | \"variant\" | \"variant-list\" | \"video\" | \"video-list\" | \"view\" | \"viewport-narrow\" | \"viewport-short\" | \"viewport-tall\" | \"viewport-wide\" | \"wallet\" | \"wand\" | \"watch\" | \"wifi\" | \"work\" | \"work-list\" | \"wrench\" | \"x\" | \"x-circle\" | \"empty\" | \"alert-triangle-filled\" | \"arrow-down-right\" | \"battery-low\" | \"cart-send\" | \"complete\" | \"delivered\" | \"disabled-filled\" | \"discount-automatic\" | \"discount-remove\" | \"drawer\" | \"fav\" | \"geolocation\" | \"gift\" | \"graduation-hat\" | \"info-filled\" | \"inventory-edit\" | \"inventory-list\" | \"inventory-transfer\" | \"keypad\" | \"live-critical\" | \"live-none\" | \"menu-filled\" | \"money-split\" | \"package-cancel\" | \"package-reassign\" | \"partially-complete\" | \"phablet\" | \"point-of-sale-register\" | \"receipt-folded\" | \"reorder\" | \"savings\" | \"scan-qr-code\" | \"shipping-label-cancel\" | \"star-circle\" | \"star-half\" | \"text-indent-remove\" | \"transaction-fee-add\" | \"truck\" | \"x-circle-filled\""
|
|
11976
|
-
},
|
|
11977
|
-
"default": "''",
|
|
11978
|
-
"description": "The type of icon to be displayed in the field."
|
|
11979
12033
|
}
|
|
11980
12034
|
],
|
|
11981
12035
|
"superclass": {
|
|
@@ -12006,20 +12060,20 @@
|
|
|
12006
12060
|
},
|
|
12007
12061
|
{
|
|
12008
12062
|
"kind": "field",
|
|
12009
|
-
"name": "
|
|
12063
|
+
"name": "src",
|
|
12010
12064
|
"type": {
|
|
12011
12065
|
"text": "string"
|
|
12012
12066
|
},
|
|
12013
|
-
"
|
|
12014
|
-
"description": "An alternative text description that describe the image for the reader to understand what it is about. It is extremely useful for both users using assistive technology and sighted users. A well written description provides people with visual impairments the ability to participate in consuming non-text content. When a screen readers encounters an `s-image`, the description is read and announced aloud. If an image fails to load, potentially due to a poor connection, the `alt` is displayed on screen instead. This has the benefit of letting a sighted buyer know an image was meant to load here, but as an alternative, they’re still able to consume the text content. Read [considerations when writing alternative text](https://www.shopify.com/ca/blog/image-alt-text#4) to learn more."
|
|
12067
|
+
"description": "The image source (either a remote URL or a local file resource). When the image is loading or no `src` is provided, a placeholder will be rendered."
|
|
12015
12068
|
},
|
|
12016
12069
|
{
|
|
12017
12070
|
"kind": "field",
|
|
12018
|
-
"name": "
|
|
12071
|
+
"name": "alt",
|
|
12019
12072
|
"type": {
|
|
12020
12073
|
"text": "string"
|
|
12021
12074
|
},
|
|
12022
|
-
"
|
|
12075
|
+
"default": "`''`",
|
|
12076
|
+
"description": "An alternative text description that describe the image for the reader to understand what it is about. It is extremely useful for both users using assistive technology and sighted users. A well written description provides people with visual impairments the ability to participate in consuming non-text content. When a screen readers encounters an `s-image`, the description is read and announced aloud. If an image fails to load, potentially due to a poor connection, the `alt` is displayed on screen instead. This has the benefit of letting a sighted buyer know an image was meant to load here, but as an alternative, they’re still able to consume the text content. Read [considerations when writing alternative text](https://www.shopify.com/ca/blog/image-alt-text#4) to learn more."
|
|
12023
12077
|
}
|
|
12024
12078
|
],
|
|
12025
12079
|
"events": [
|
|
@@ -12048,21 +12102,21 @@
|
|
|
12048
12102
|
"description": "The size of the product thumbnail image. - `small-200`: Smallest thumbnail size, ideal for compact product lists or tables. - `small-100`: Very small thumbnail, suitable for dense layouts. - `small`: Small thumbnail for space-constrained contexts. - `base`: Default size that balances visibility and space efficiency. - `large`: Larger thumbnail for featured products or detailed views. - `large-100`: Extra large thumbnail for prominent product display."
|
|
12049
12103
|
},
|
|
12050
12104
|
{
|
|
12051
|
-
"name": "
|
|
12052
|
-
"fieldName": "
|
|
12105
|
+
"name": "src",
|
|
12106
|
+
"fieldName": "src",
|
|
12053
12107
|
"type": {
|
|
12054
12108
|
"text": "string"
|
|
12055
12109
|
},
|
|
12056
|
-
"
|
|
12057
|
-
"description": "An alternative text description that describe the image for the reader to understand what it is about. It is extremely useful for both users using assistive technology and sighted users. A well written description provides people with visual impairments the ability to participate in consuming non-text content. When a screen readers encounters an `s-image`, the description is read and announced aloud. If an image fails to load, potentially due to a poor connection, the `alt` is displayed on screen instead. This has the benefit of letting a sighted buyer know an image was meant to load here, but as an alternative, they’re still able to consume the text content. Read [considerations when writing alternative text](https://www.shopify.com/ca/blog/image-alt-text#4) to learn more."
|
|
12110
|
+
"description": "The image source (either a remote URL or a local file resource). When the image is loading or no `src` is provided, a placeholder will be rendered."
|
|
12058
12111
|
},
|
|
12059
12112
|
{
|
|
12060
|
-
"name": "
|
|
12061
|
-
"fieldName": "
|
|
12113
|
+
"name": "alt",
|
|
12114
|
+
"fieldName": "alt",
|
|
12062
12115
|
"type": {
|
|
12063
12116
|
"text": "string"
|
|
12064
12117
|
},
|
|
12065
|
-
"
|
|
12118
|
+
"default": "`''`",
|
|
12119
|
+
"description": "An alternative text description that describe the image for the reader to understand what it is about. It is extremely useful for both users using assistive technology and sighted users. A well written description provides people with visual impairments the ability to participate in consuming non-text content. When a screen readers encounters an `s-image`, the description is read and announced aloud. If an image fails to load, potentially due to a poor connection, the `alt` is displayed on screen instead. This has the benefit of letting a sighted buyer know an image was meant to load here, but as an alternative, they’re still able to consume the text content. Read [considerations when writing alternative text](https://www.shopify.com/ca/blog/image-alt-text#4) to learn more."
|
|
12066
12120
|
}
|
|
12067
12121
|
],
|
|
12068
12122
|
"superclass": {
|
|
@@ -12226,14 +12280,6 @@
|
|
|
12226
12280
|
},
|
|
12227
12281
|
"description": "The current value for the field. If omitted, the field will be empty."
|
|
12228
12282
|
},
|
|
12229
|
-
{
|
|
12230
|
-
"kind": "field",
|
|
12231
|
-
"name": "defaultValue",
|
|
12232
|
-
"type": {
|
|
12233
|
-
"text": "string"
|
|
12234
|
-
},
|
|
12235
|
-
"description": "The default value for the field."
|
|
12236
|
-
},
|
|
12237
12283
|
{
|
|
12238
12284
|
"kind": "field",
|
|
12239
12285
|
"name": "details",
|
|
@@ -12258,6 +12304,15 @@
|
|
|
12258
12304
|
},
|
|
12259
12305
|
"description": "Content to use as the field label."
|
|
12260
12306
|
},
|
|
12307
|
+
{
|
|
12308
|
+
"kind": "field",
|
|
12309
|
+
"name": "required",
|
|
12310
|
+
"type": {
|
|
12311
|
+
"text": "boolean"
|
|
12312
|
+
},
|
|
12313
|
+
"default": "false",
|
|
12314
|
+
"description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property."
|
|
12315
|
+
},
|
|
12261
12316
|
{
|
|
12262
12317
|
"kind": "field",
|
|
12263
12318
|
"name": "labelAccessibilityVisibility",
|
|
@@ -12269,29 +12324,28 @@
|
|
|
12269
12324
|
},
|
|
12270
12325
|
{
|
|
12271
12326
|
"kind": "field",
|
|
12272
|
-
"name": "
|
|
12327
|
+
"name": "defaultValue",
|
|
12273
12328
|
"type": {
|
|
12274
12329
|
"text": "string"
|
|
12275
12330
|
},
|
|
12276
|
-
"description": "
|
|
12331
|
+
"description": "The default value for the field."
|
|
12277
12332
|
},
|
|
12278
12333
|
{
|
|
12279
12334
|
"kind": "field",
|
|
12280
|
-
"name": "
|
|
12335
|
+
"name": "placeholder",
|
|
12281
12336
|
"type": {
|
|
12282
|
-
"text": "
|
|
12337
|
+
"text": "string"
|
|
12283
12338
|
},
|
|
12284
|
-
"
|
|
12285
|
-
"description": "The field cannot be edited by the user. It is focusable will be announced by screen readers."
|
|
12339
|
+
"description": "A short hint that describes the expected value of the field."
|
|
12286
12340
|
},
|
|
12287
12341
|
{
|
|
12288
12342
|
"kind": "field",
|
|
12289
|
-
"name": "
|
|
12343
|
+
"name": "readOnly",
|
|
12290
12344
|
"type": {
|
|
12291
12345
|
"text": "boolean"
|
|
12292
12346
|
},
|
|
12293
12347
|
"default": "false",
|
|
12294
|
-
"description": "
|
|
12348
|
+
"description": "The field cannot be edited by the user. It is focusable will be announced by screen readers."
|
|
12295
12349
|
},
|
|
12296
12350
|
{
|
|
12297
12351
|
"kind": "field",
|
|
@@ -12385,14 +12439,6 @@
|
|
|
12385
12439
|
},
|
|
12386
12440
|
"description": "The current value for the field. If omitted, the field will be empty."
|
|
12387
12441
|
},
|
|
12388
|
-
{
|
|
12389
|
-
"name": "value",
|
|
12390
|
-
"fieldName": "defaultValue",
|
|
12391
|
-
"type": {
|
|
12392
|
-
"text": "string"
|
|
12393
|
-
},
|
|
12394
|
-
"description": "The default value for the field."
|
|
12395
|
-
},
|
|
12396
12442
|
{
|
|
12397
12443
|
"name": "details",
|
|
12398
12444
|
"fieldName": "details",
|
|
@@ -12417,6 +12463,15 @@
|
|
|
12417
12463
|
},
|
|
12418
12464
|
"description": "Content to use as the field label."
|
|
12419
12465
|
},
|
|
12466
|
+
{
|
|
12467
|
+
"name": "required",
|
|
12468
|
+
"fieldName": "required",
|
|
12469
|
+
"type": {
|
|
12470
|
+
"text": "boolean"
|
|
12471
|
+
},
|
|
12472
|
+
"default": "false",
|
|
12473
|
+
"description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property."
|
|
12474
|
+
},
|
|
12420
12475
|
{
|
|
12421
12476
|
"name": "labelaccessibilityvisibility",
|
|
12422
12477
|
"fieldName": "labelAccessibilityVisibility",
|
|
@@ -12426,6 +12481,14 @@
|
|
|
12426
12481
|
"default": "'visible'",
|
|
12427
12482
|
"description": "Changes the visibility of the component's label. - `visible`: the label is visible to all users. - `exclusive`: the label is visually hidden but remains in the accessibility tree."
|
|
12428
12483
|
},
|
|
12484
|
+
{
|
|
12485
|
+
"name": "value",
|
|
12486
|
+
"fieldName": "defaultValue",
|
|
12487
|
+
"type": {
|
|
12488
|
+
"text": "string"
|
|
12489
|
+
},
|
|
12490
|
+
"description": "The default value for the field."
|
|
12491
|
+
},
|
|
12429
12492
|
{
|
|
12430
12493
|
"name": "placeholder",
|
|
12431
12494
|
"fieldName": "placeholder",
|
|
@@ -12443,15 +12506,6 @@
|
|
|
12443
12506
|
"default": "false",
|
|
12444
12507
|
"description": "The field cannot be edited by the user. It is focusable will be announced by screen readers."
|
|
12445
12508
|
},
|
|
12446
|
-
{
|
|
12447
|
-
"name": "required",
|
|
12448
|
-
"fieldName": "required",
|
|
12449
|
-
"type": {
|
|
12450
|
-
"text": "boolean"
|
|
12451
|
-
},
|
|
12452
|
-
"default": "false",
|
|
12453
|
-
"description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property."
|
|
12454
|
-
},
|
|
12455
12509
|
{
|
|
12456
12510
|
"name": "autocomplete",
|
|
12457
12511
|
"fieldName": "autocomplete",
|