@synergy-design-system/tokens 2.13.0 → 2.15.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +14 -0
- package/dist/js/index.d.ts +1 -1
- package/dist/js/index.js +1 -1
- package/dist/scss/_tokens.scss +1 -1
- package/dist/themes/dark.css +2 -2
- package/dist/themes/light.css +2 -2
- package/package.json +2 -2
- package/src/figma-tokens/_docs.json +264 -124
package/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,17 @@
|
|
|
1
|
+
# [@synergy-design-system/tokens-v2.15.0](https://github.com/synergy-design-system/synergy-design-system/compare/tokens/2.14.0...tokens/2.15.0) (2024-11-27)
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
### Features
|
|
5
|
+
|
|
6
|
+
* ✨ Create styles for a syn-link-list ([#678](https://github.com/synergy-design-system/synergy-design-system/issues/678)) ([ca3b99a](https://github.com/synergy-design-system/synergy-design-system/commit/ca3b99a828e2a078b538881f74324d0bee8fde66))
|
|
7
|
+
|
|
8
|
+
# [@synergy-design-system/tokens-v2.14.0](https://github.com/synergy-design-system/synergy-design-system/compare/tokens/2.13.0...tokens/2.14.0) (2024-11-21)
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
### Features
|
|
12
|
+
|
|
13
|
+
* ✨ provide accessible solution for validation ([#599](https://github.com/synergy-design-system/synergy-design-system/issues/599)) ([f8ef81a](https://github.com/synergy-design-system/synergy-design-system/commit/f8ef81a4a61af27fcb6de2c03ce13ef502fcb732))
|
|
14
|
+
|
|
1
15
|
# [@synergy-design-system/tokens-v2.13.0](https://github.com/synergy-design-system/synergy-design-system/compare/tokens/2.12.1...tokens/2.13.0) (2024-10-11)
|
|
2
16
|
|
|
3
17
|
|
package/dist/js/index.d.ts
CHANGED
package/dist/js/index.js
CHANGED
package/dist/scss/_tokens.scss
CHANGED
package/dist/themes/dark.css
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* @synergy-design-system/tokens version 2.
|
|
2
|
+
* @synergy-design-system/tokens version 2.14.0
|
|
3
3
|
* SICK Global UX Foundation
|
|
4
4
|
* Do not edit directly
|
|
5
|
-
* Generated on
|
|
5
|
+
* Generated on Wed, 27 Nov 2024 10:49:18 GMT
|
|
6
6
|
*/
|
|
7
7
|
|
|
8
8
|
:root, .syn-theme-dark {
|
package/dist/themes/light.css
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* @synergy-design-system/tokens version 2.
|
|
2
|
+
* @synergy-design-system/tokens version 2.14.0
|
|
3
3
|
* SICK Global UX Foundation
|
|
4
4
|
* Do not edit directly
|
|
5
|
-
* Generated on
|
|
5
|
+
* Generated on Wed, 27 Nov 2024 10:49:18 GMT
|
|
6
6
|
*/
|
|
7
7
|
|
|
8
8
|
:root, .syn-theme-light {
|
package/package.json
CHANGED
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
"semantic-release": "^19.0.5",
|
|
18
18
|
"semantic-release-monorepo": "7.0.5",
|
|
19
19
|
"style-dictionary": "^3.9.2",
|
|
20
|
-
"stylelint": "^16.
|
|
20
|
+
"stylelint": "^16.10.0",
|
|
21
21
|
"@synergy-design-system/stylelint-config-syn": "0.1.0",
|
|
22
22
|
"@synergy-design-system/eslint-config-syn": "0.1.0"
|
|
23
23
|
},
|
|
@@ -101,7 +101,7 @@
|
|
|
101
101
|
},
|
|
102
102
|
"type": "module",
|
|
103
103
|
"types": "./dist/js/index.d.ts",
|
|
104
|
-
"version": "2.
|
|
104
|
+
"version": "2.15.0",
|
|
105
105
|
"scripts": {
|
|
106
106
|
"build": "pnpm clean && node scripts/build.js",
|
|
107
107
|
"clean": "rimraf build",
|
|
@@ -114,7 +114,7 @@
|
|
|
114
114
|
}
|
|
115
115
|
},
|
|
116
116
|
"toast-notifications": {
|
|
117
|
-
"
|
|
117
|
+
"title": {
|
|
118
118
|
"value": "Toast Notifications",
|
|
119
119
|
"type": "text"
|
|
120
120
|
},
|
|
@@ -485,24 +485,24 @@
|
|
|
485
485
|
}
|
|
486
486
|
},
|
|
487
487
|
"carousel": {
|
|
488
|
-
"description": {
|
|
489
|
-
"value": "Carousels display an arbitrary number of content slides along a horizontal or vertical axis.",
|
|
490
|
-
"type": "text"
|
|
491
|
-
},
|
|
492
488
|
"title": {
|
|
493
489
|
"value": "Carousel",
|
|
494
490
|
"type": "text"
|
|
491
|
+
},
|
|
492
|
+
"description": {
|
|
493
|
+
"value": "Carousels display an arbitrary number of content slides along a horizontal or vertical axis.",
|
|
494
|
+
"type": "text"
|
|
495
495
|
}
|
|
496
496
|
},
|
|
497
497
|
"checkbox": {
|
|
498
498
|
"default": {
|
|
499
|
-
"description": {
|
|
500
|
-
"value": "Checkboxes allow the user to toggle an option on or off.",
|
|
501
|
-
"type": "text"
|
|
502
|
-
},
|
|
503
499
|
"title": {
|
|
504
500
|
"value": "Checkbox",
|
|
505
501
|
"type": "text"
|
|
502
|
+
},
|
|
503
|
+
"description": {
|
|
504
|
+
"value": "Checkboxes allow the user to toggle an option on or off.",
|
|
505
|
+
"type": "text"
|
|
506
506
|
}
|
|
507
507
|
},
|
|
508
508
|
"checked": {
|
|
@@ -581,40 +581,40 @@
|
|
|
581
581
|
"type": "text"
|
|
582
582
|
},
|
|
583
583
|
"description": {
|
|
584
|
-
"value": "Add descriptive help text to a switch with the
|
|
584
|
+
"value": "Add descriptive help text to a switch with the help-text attribute. For help texts that contain HTML, use the help-text slot instead.\nThe help-text attribute should not be used to display error messages. To handle validation and error messaging, use syn-validate for proper error management.",
|
|
585
585
|
"type": "text"
|
|
586
586
|
}
|
|
587
587
|
}
|
|
588
588
|
},
|
|
589
589
|
"color-picker": {
|
|
590
|
-
"description": {
|
|
591
|
-
"value": "Color pickers allow the user to select a color.",
|
|
592
|
-
"type": "text"
|
|
593
|
-
},
|
|
594
590
|
"title": {
|
|
595
591
|
"value": "Color Picker",
|
|
596
592
|
"type": "text"
|
|
593
|
+
},
|
|
594
|
+
"description": {
|
|
595
|
+
"value": "Color pickers allow the user to select a color.",
|
|
596
|
+
"type": "text"
|
|
597
597
|
}
|
|
598
598
|
},
|
|
599
599
|
"copy-button": {
|
|
600
|
-
"description": {
|
|
601
|
-
"value": "Copies data to the clipboard when the user clicks the button.",
|
|
602
|
-
"type": "text"
|
|
603
|
-
},
|
|
604
600
|
"title": {
|
|
605
601
|
"value": "Copy Button",
|
|
606
602
|
"type": "text"
|
|
603
|
+
},
|
|
604
|
+
"description": {
|
|
605
|
+
"value": "Copies data to the clipboard when the user clicks the button.",
|
|
606
|
+
"type": "text"
|
|
607
607
|
}
|
|
608
608
|
},
|
|
609
609
|
"details": {
|
|
610
610
|
"default": {
|
|
611
|
-
"description": {
|
|
612
|
-
"value": "Details show a brief summary and expand to show additional content. If you want to group the details, we recommend that you use the syn-accordion component.",
|
|
613
|
-
"type": "text"
|
|
614
|
-
},
|
|
615
611
|
"title": {
|
|
616
612
|
"value": "Details",
|
|
617
613
|
"type": "text"
|
|
614
|
+
},
|
|
615
|
+
"description": {
|
|
616
|
+
"value": "Details show a brief summary and expand to show additional content. If you want to group the details, we recommend that you use the syn-accordion component.",
|
|
617
|
+
"type": "text"
|
|
618
618
|
}
|
|
619
619
|
},
|
|
620
620
|
"disabled": {
|
|
@@ -987,7 +987,7 @@
|
|
|
987
987
|
"type": "text"
|
|
988
988
|
},
|
|
989
989
|
"description": {
|
|
990
|
-
"value": "Add descriptive help text to a
|
|
990
|
+
"value": "Add descriptive help text to a switch with the help-text attribute. For help texts that contain HTML, use the help-text slot instead.\nThe help-text attribute should not be used to display error messages. To handle validation and error messaging, use syn-validate for proper error management.",
|
|
991
991
|
"type": "text"
|
|
992
992
|
}
|
|
993
993
|
},
|
|
@@ -1176,7 +1176,7 @@
|
|
|
1176
1176
|
}
|
|
1177
1177
|
},
|
|
1178
1178
|
"label": {
|
|
1179
|
-
"
|
|
1179
|
+
"title": {
|
|
1180
1180
|
"value": "Accessibility Label",
|
|
1181
1181
|
"type": "text"
|
|
1182
1182
|
},
|
|
@@ -1253,7 +1253,7 @@
|
|
|
1253
1253
|
"type": "text"
|
|
1254
1254
|
},
|
|
1255
1255
|
"description": {
|
|
1256
|
-
"value": "Add descriptive help text to
|
|
1256
|
+
"value": "Add descriptive help text to a switch with the help-text attribute. For help texts that contain HTML, use the help-text slot instead.\nThe help-text attribute should not be used to display error messages. To handle validation and error messaging, use syn-validate for proper error management.",
|
|
1257
1257
|
"type": "text"
|
|
1258
1258
|
}
|
|
1259
1259
|
},
|
|
@@ -1440,6 +1440,38 @@
|
|
|
1440
1440
|
}
|
|
1441
1441
|
}
|
|
1442
1442
|
},
|
|
1443
|
+
"link-list": {
|
|
1444
|
+
"horizontal": {
|
|
1445
|
+
"title": {
|
|
1446
|
+
"value": "Horizontal",
|
|
1447
|
+
"type": "text"
|
|
1448
|
+
},
|
|
1449
|
+
"description": {
|
|
1450
|
+
"value": "Use the horizontal attribute to indicate that it is used as a horizontal link list.",
|
|
1451
|
+
"type": "text"
|
|
1452
|
+
}
|
|
1453
|
+
},
|
|
1454
|
+
"multiline": {
|
|
1455
|
+
"title": {
|
|
1456
|
+
"value": "Multiline",
|
|
1457
|
+
"type": "text"
|
|
1458
|
+
},
|
|
1459
|
+
"description": {
|
|
1460
|
+
"value": "The horizontal link list automatically wraps into a new line if there is not enough space available.",
|
|
1461
|
+
"type": "text"
|
|
1462
|
+
}
|
|
1463
|
+
},
|
|
1464
|
+
"size": {
|
|
1465
|
+
"title": {
|
|
1466
|
+
"value": "Size",
|
|
1467
|
+
"type": "text"
|
|
1468
|
+
},
|
|
1469
|
+
"description": {
|
|
1470
|
+
"value": "Use the size attribute to change the link list size.",
|
|
1471
|
+
"type": "text"
|
|
1472
|
+
}
|
|
1473
|
+
}
|
|
1474
|
+
},
|
|
1443
1475
|
"menu-item": {
|
|
1444
1476
|
"default": {
|
|
1445
1477
|
"description": {
|
|
@@ -1781,7 +1813,7 @@
|
|
|
1781
1813
|
"type": "text"
|
|
1782
1814
|
},
|
|
1783
1815
|
"description": {
|
|
1784
|
-
"value": "Add descriptive help text to a
|
|
1816
|
+
"value": "Add descriptive help text to a switch with the help-text attribute. For help texts that contain HTML, use the help-text slot instead.\nThe help-text attribute should not be used to display error messages. To handle validation and error messaging, use syn-validate for proper error management.",
|
|
1785
1817
|
"type": "text"
|
|
1786
1818
|
}
|
|
1787
1819
|
},
|
|
@@ -1848,33 +1880,33 @@
|
|
|
1848
1880
|
},
|
|
1849
1881
|
"range": {
|
|
1850
1882
|
"default": {
|
|
1851
|
-
"description": {
|
|
1852
|
-
"value": "Ranges allow the user to select values within a given range using a thumb.",
|
|
1853
|
-
"type": "text"
|
|
1854
|
-
},
|
|
1855
1883
|
"title": {
|
|
1856
1884
|
"value": "Range",
|
|
1857
1885
|
"type": "text"
|
|
1886
|
+
},
|
|
1887
|
+
"description": {
|
|
1888
|
+
"value": "Ranges allow the user to select values within a given range using a thumb.",
|
|
1889
|
+
"type": "text"
|
|
1858
1890
|
}
|
|
1859
1891
|
},
|
|
1860
1892
|
"labels": {
|
|
1861
|
-
"description": {
|
|
1862
|
-
"value": "Use the label attribute to give the range an accessible label. For labels that contain HTML, use the label slot instead.",
|
|
1863
|
-
"type": "text"
|
|
1864
|
-
},
|
|
1865
1893
|
"title": {
|
|
1866
1894
|
"value": "Labels",
|
|
1867
1895
|
"type": "text"
|
|
1896
|
+
},
|
|
1897
|
+
"description": {
|
|
1898
|
+
"value": "Use the label attribute to give the range an accessible label. For labels that contain HTML, use the label slot instead.",
|
|
1899
|
+
"type": "text"
|
|
1868
1900
|
}
|
|
1869
1901
|
},
|
|
1870
1902
|
"help-text": {
|
|
1871
|
-
"description": {
|
|
1872
|
-
"value": "Add descriptive help text to a range with the help-text attribute. For help texts that contain HTML, use the help-text slot instead.",
|
|
1873
|
-
"type": "text"
|
|
1874
|
-
},
|
|
1875
1903
|
"title": {
|
|
1876
1904
|
"value": "Help Text",
|
|
1877
1905
|
"type": "text"
|
|
1906
|
+
},
|
|
1907
|
+
"description": {
|
|
1908
|
+
"value": "Add descriptive help text to a switch with the help-text attribute. For help texts that contain HTML, use the help-text slot instead.\nThe help-text attribute should not be used to display error messages. To handle validation and error messaging, use syn-validate for proper error management.",
|
|
1909
|
+
"type": "text"
|
|
1878
1910
|
}
|
|
1879
1911
|
},
|
|
1880
1912
|
"focus": {
|
|
@@ -1908,23 +1940,23 @@
|
|
|
1908
1940
|
}
|
|
1909
1941
|
},
|
|
1910
1942
|
"disabled": {
|
|
1911
|
-
"description": {
|
|
1912
|
-
"value": "Use the disabled attribute to disable a range.",
|
|
1913
|
-
"type": "text"
|
|
1914
|
-
},
|
|
1915
1943
|
"title": {
|
|
1916
1944
|
"value": "Disabled",
|
|
1917
1945
|
"type": "text"
|
|
1946
|
+
},
|
|
1947
|
+
"description": {
|
|
1948
|
+
"value": "Use the disabled attribute to disable a range.",
|
|
1949
|
+
"type": "text"
|
|
1918
1950
|
}
|
|
1919
1951
|
},
|
|
1920
1952
|
"prefix-suffix": {
|
|
1921
|
-
"description": {
|
|
1922
|
-
"value": "Add any element to the start and end of range items using the prefix and suffix slots.",
|
|
1923
|
-
"type": "text"
|
|
1924
|
-
},
|
|
1925
1953
|
"title": {
|
|
1926
1954
|
"value": "Prefix and Suffix",
|
|
1927
1955
|
"type": "text"
|
|
1956
|
+
},
|
|
1957
|
+
"description": {
|
|
1958
|
+
"value": "Add any element to the start and end of range items using the prefix and suffix slots.",
|
|
1959
|
+
"type": "text"
|
|
1928
1960
|
}
|
|
1929
1961
|
},
|
|
1930
1962
|
"custom-track-colors": {
|
|
@@ -1938,44 +1970,44 @@
|
|
|
1938
1970
|
}
|
|
1939
1971
|
},
|
|
1940
1972
|
"custom-track-offset": {
|
|
1941
|
-
"description": {
|
|
1942
|
-
"value": "You can customize the initial offset of the active track using the --track-active-offset custom property.",
|
|
1943
|
-
"type": "text"
|
|
1944
|
-
},
|
|
1945
1973
|
"title": {
|
|
1946
1974
|
"value": "Custom Track Offset",
|
|
1947
1975
|
"type": "text"
|
|
1976
|
+
},
|
|
1977
|
+
"description": {
|
|
1978
|
+
"value": "You can customize the initial offset of the active track using the --track-active-offset custom property.",
|
|
1979
|
+
"type": "text"
|
|
1948
1980
|
}
|
|
1949
1981
|
},
|
|
1950
1982
|
"multi-knob": {
|
|
1951
|
-
"description": {
|
|
1952
|
-
"value": "You can add multiple range-thumbs to your range.",
|
|
1953
|
-
"type": "text"
|
|
1954
|
-
},
|
|
1955
1983
|
"title": {
|
|
1956
1984
|
"value": "Multi thumb",
|
|
1957
1985
|
"type": "text"
|
|
1986
|
+
},
|
|
1987
|
+
"description": {
|
|
1988
|
+
"value": "You can add multiple range-thumbs to your range.",
|
|
1989
|
+
"type": "text"
|
|
1958
1990
|
}
|
|
1959
1991
|
},
|
|
1960
1992
|
"multi-knob-restrict-movement": {
|
|
1961
|
-
"description": {
|
|
1962
|
-
"value": "You can prevent the thumbs from overlapping by listening to the provided `syn-move` event.",
|
|
1963
|
-
"type": "text"
|
|
1964
|
-
},
|
|
1965
1993
|
"title": {
|
|
1966
1994
|
"value": "Multi thumb with restricted movement",
|
|
1967
1995
|
"type": "text"
|
|
1996
|
+
},
|
|
1997
|
+
"description": {
|
|
1998
|
+
"value": "You can prevent the thumbs from overlapping by listening to the provided `syn-move` event.",
|
|
1999
|
+
"type": "text"
|
|
1968
2000
|
}
|
|
1969
2001
|
},
|
|
1970
2002
|
"ticks": {
|
|
1971
2003
|
"default": {
|
|
1972
|
-
"description": {
|
|
1973
|
-
"value": "Use the ticks slot to insert ticks or groups with ticks to improve positioning.",
|
|
1974
|
-
"type": "text"
|
|
1975
|
-
},
|
|
1976
2004
|
"title": {
|
|
1977
2005
|
"value": "Ticks",
|
|
1978
2006
|
"type": "text"
|
|
2007
|
+
},
|
|
2008
|
+
"description": {
|
|
2009
|
+
"value": "Use the ticks slot to insert ticks or groups with ticks to improve positioning.",
|
|
2010
|
+
"type": "text"
|
|
1979
2011
|
}
|
|
1980
2012
|
},
|
|
1981
2013
|
"label": {
|
|
@@ -2010,33 +2042,33 @@
|
|
|
2010
2042
|
}
|
|
2011
2043
|
},
|
|
2012
2044
|
"tooltip-placement": {
|
|
2013
|
-
"description": {
|
|
2014
|
-
"value": "By default, the tooltip is shown on top. Set tooltip-placement to bottom to show it below the range.",
|
|
2015
|
-
"type": "text"
|
|
2016
|
-
},
|
|
2017
2045
|
"title": {
|
|
2018
2046
|
"value": "Tooltip Placement",
|
|
2019
2047
|
"type": "text"
|
|
2048
|
+
},
|
|
2049
|
+
"description": {
|
|
2050
|
+
"value": "By default, the tooltip is shown on top. Set tooltip-placement to bottom to show it below the range.",
|
|
2051
|
+
"type": "text"
|
|
2020
2052
|
}
|
|
2021
2053
|
},
|
|
2022
2054
|
"tooltip-disabled": {
|
|
2023
|
-
"description": {
|
|
2024
|
-
"value": "To disable the tooltip, set tooltip-placement to none.",
|
|
2025
|
-
"type": "text"
|
|
2026
|
-
},
|
|
2027
2055
|
"title": {
|
|
2028
2056
|
"value": "Disable the Tooltip",
|
|
2029
2057
|
"type": "text"
|
|
2058
|
+
},
|
|
2059
|
+
"description": {
|
|
2060
|
+
"value": "To disable the tooltip, set tooltip-placement to none.",
|
|
2061
|
+
"type": "text"
|
|
2030
2062
|
}
|
|
2031
2063
|
},
|
|
2032
2064
|
"tooltip-formatter": {
|
|
2033
|
-
"description": {
|
|
2034
|
-
"value": "You can change the tooltip’s content by setting the tooltipFormatter property to a function that accepts the range’s value as an argument.",
|
|
2035
|
-
"type": "text"
|
|
2036
|
-
},
|
|
2037
2065
|
"title": {
|
|
2038
2066
|
"value": "Custom Tooltip Formatter",
|
|
2039
2067
|
"type": "text"
|
|
2068
|
+
},
|
|
2069
|
+
"description": {
|
|
2070
|
+
"value": "You can change the tooltip’s content by setting the tooltipFormatter property to a function that accepts the range’s value as an argument.",
|
|
2071
|
+
"type": "text"
|
|
2040
2072
|
}
|
|
2041
2073
|
}
|
|
2042
2074
|
},
|
|
@@ -2072,13 +2104,13 @@
|
|
|
2072
2104
|
},
|
|
2073
2105
|
"select": {
|
|
2074
2106
|
"default": {
|
|
2075
|
-
"description": {
|
|
2076
|
-
"value": "Selects allow you to choose items from a menu of predefined options.",
|
|
2077
|
-
"type": "text"
|
|
2078
|
-
},
|
|
2079
2107
|
"title": {
|
|
2080
2108
|
"value": "Select",
|
|
2081
2109
|
"type": "text"
|
|
2110
|
+
},
|
|
2111
|
+
"description": {
|
|
2112
|
+
"value": "Selects allow you to choose items from a menu of predefined options.",
|
|
2113
|
+
"type": "text"
|
|
2082
2114
|
}
|
|
2083
2115
|
},
|
|
2084
2116
|
"labels": {
|
|
@@ -2097,7 +2129,7 @@
|
|
|
2097
2129
|
"type": "text"
|
|
2098
2130
|
},
|
|
2099
2131
|
"description": {
|
|
2100
|
-
"value": "Add descriptive help text to a
|
|
2132
|
+
"value": "Add descriptive help text to a switch with the help-text attribute. For help texts that contain HTML, use the help-text slot instead.\nThe help-text attribute should not be used to display error messages. To handle validation and error messaging, use syn-validate for proper error management.",
|
|
2101
2133
|
"type": "text"
|
|
2102
2134
|
}
|
|
2103
2135
|
},
|
|
@@ -2213,24 +2245,24 @@
|
|
|
2213
2245
|
}
|
|
2214
2246
|
},
|
|
2215
2247
|
"skeleton": {
|
|
2216
|
-
"description": {
|
|
2217
|
-
"value": "Skeletons are used to provide a visual representation of where content will eventually be drawn.",
|
|
2218
|
-
"type": "text"
|
|
2219
|
-
},
|
|
2220
2248
|
"title": {
|
|
2221
2249
|
"value": "Skeleton",
|
|
2222
2250
|
"type": "text"
|
|
2251
|
+
},
|
|
2252
|
+
"description": {
|
|
2253
|
+
"value": "Skeletons are used to provide a visual representation of where content will eventually be drawn.",
|
|
2254
|
+
"type": "text"
|
|
2223
2255
|
}
|
|
2224
2256
|
},
|
|
2225
2257
|
"spinner": {
|
|
2226
2258
|
"default": {
|
|
2227
|
-
"description": {
|
|
2228
|
-
"value": "Spinners are used to show the progress of an indeterminate operation.",
|
|
2229
|
-
"type": "text"
|
|
2230
|
-
},
|
|
2231
2259
|
"title": {
|
|
2232
2260
|
"value": "Spinner",
|
|
2233
2261
|
"type": "text"
|
|
2262
|
+
},
|
|
2263
|
+
"description": {
|
|
2264
|
+
"value": "Spinners are used to show the progress of an indeterminate operation.",
|
|
2265
|
+
"type": "text"
|
|
2234
2266
|
}
|
|
2235
2267
|
},
|
|
2236
2268
|
"size": {
|
|
@@ -2265,13 +2297,13 @@
|
|
|
2265
2297
|
}
|
|
2266
2298
|
},
|
|
2267
2299
|
"split-panel": {
|
|
2268
|
-
"description": {
|
|
2269
|
-
"value": "Split panels display two adjacent panels, allowing the user to reposition them.",
|
|
2270
|
-
"type": "text"
|
|
2271
|
-
},
|
|
2272
2300
|
"title": {
|
|
2273
2301
|
"value": "Split Panel",
|
|
2274
2302
|
"type": "text"
|
|
2303
|
+
},
|
|
2304
|
+
"description": {
|
|
2305
|
+
"value": "Split panels display two adjacent panels, allowing the user to reposition them.",
|
|
2306
|
+
"type": "text"
|
|
2275
2307
|
}
|
|
2276
2308
|
},
|
|
2277
2309
|
"switch": {
|
|
@@ -2341,7 +2373,7 @@
|
|
|
2341
2373
|
"type": "text"
|
|
2342
2374
|
},
|
|
2343
2375
|
"description": {
|
|
2344
|
-
"value": "Add descriptive help text to a switch with the
|
|
2376
|
+
"value": "Add descriptive help text to a switch with the help-text attribute. For help texts that contain HTML, use the help-text slot instead.\nThe help-text attribute should not be used to display error messages. To handle validation and error messaging, use syn-validate for proper error management.",
|
|
2345
2377
|
"type": "text"
|
|
2346
2378
|
}
|
|
2347
2379
|
}
|
|
@@ -2509,7 +2541,7 @@
|
|
|
2509
2541
|
"type": "text"
|
|
2510
2542
|
},
|
|
2511
2543
|
"description": {
|
|
2512
|
-
"value": "Add descriptive help text to a
|
|
2544
|
+
"value": "Add descriptive help text to a switch with the help-text attribute. For help texts that contain HTML, use the help-text slot instead.\nThe help-text attribute should not be used to display error messages. To handle validation and error messaging, use syn-validate for proper error management.",
|
|
2513
2545
|
"type": "text"
|
|
2514
2546
|
}
|
|
2515
2547
|
},
|
|
@@ -2687,44 +2719,44 @@
|
|
|
2687
2719
|
}
|
|
2688
2720
|
},
|
|
2689
2721
|
"tree-item": {
|
|
2690
|
-
"description": {
|
|
2691
|
-
"value": "A tree item serves as a hierarchical node that lives inside a tree.",
|
|
2692
|
-
"type": "text"
|
|
2693
|
-
},
|
|
2694
2722
|
"title": {
|
|
2695
2723
|
"value": "Tree Item",
|
|
2696
2724
|
"type": "text"
|
|
2725
|
+
},
|
|
2726
|
+
"description": {
|
|
2727
|
+
"value": "A tree item serves as a hierarchical node that lives inside a tree.",
|
|
2728
|
+
"type": "text"
|
|
2697
2729
|
}
|
|
2698
2730
|
},
|
|
2699
2731
|
"tree": {
|
|
2700
|
-
"description": {
|
|
2701
|
-
"value": "Trees allow you to display a hierarchical list of selectable tree items. Items with children can be expanded and collapsed as desired by the user.",
|
|
2702
|
-
"type": "text"
|
|
2703
|
-
},
|
|
2704
2732
|
"title": {
|
|
2705
2733
|
"value": "Tree",
|
|
2706
2734
|
"type": "text"
|
|
2735
|
+
},
|
|
2736
|
+
"description": {
|
|
2737
|
+
"value": "Trees allow you to display a hierarchical list of selectable tree items. Items with children can be expanded and collapsed as desired by the user.",
|
|
2738
|
+
"type": "text"
|
|
2707
2739
|
}
|
|
2708
2740
|
},
|
|
2709
2741
|
"visually-hidden": {
|
|
2710
|
-
"description": {
|
|
2711
|
-
"value": "The visually hidden utility makes content accessible to assistive devices without displaying it on the screen.",
|
|
2712
|
-
"type": "text"
|
|
2713
|
-
},
|
|
2714
2742
|
"title": {
|
|
2715
2743
|
"value": "Visually Hidden",
|
|
2716
2744
|
"type": "text"
|
|
2745
|
+
},
|
|
2746
|
+
"description": {
|
|
2747
|
+
"value": "The visually hidden utility makes content accessible to assistive devices without displaying it on the screen.",
|
|
2748
|
+
"type": "text"
|
|
2717
2749
|
}
|
|
2718
2750
|
},
|
|
2719
2751
|
"radio": {
|
|
2720
2752
|
"default": {
|
|
2721
|
-
"description": {
|
|
2722
|
-
"value": "Radios allow the user to select a single option from a group. \\nRadios are designed to be used with radio groups.",
|
|
2723
|
-
"type": "text"
|
|
2724
|
-
},
|
|
2725
2753
|
"title": {
|
|
2726
2754
|
"value": "Radio",
|
|
2727
2755
|
"type": "text"
|
|
2756
|
+
},
|
|
2757
|
+
"description": {
|
|
2758
|
+
"value": "Radios allow the user to select a single option from a group. \\nRadios are designed to be used with radio groups.",
|
|
2759
|
+
"type": "text"
|
|
2728
2760
|
}
|
|
2729
2761
|
},
|
|
2730
2762
|
"focus": {
|
|
@@ -2812,42 +2844,52 @@
|
|
|
2812
2844
|
},
|
|
2813
2845
|
"styles": {
|
|
2814
2846
|
"body": {
|
|
2815
|
-
"description": {
|
|
2816
|
-
"value": "Body text is used for long-form content where a paragraph or multiple lines of text are required. Body text styles are optimized for reading as a large chunk of information through line height and paragraph spacing. Inline links sit within body text styles and inherit the same font values.\nUI text is text used in UI components and uses the same text stylings.\n\nThe default font size is medium (16 px). Synergy supports three additional font sizes for body copy.\n\nIt is also possible to format the text bold or semibold for certain text passages and UI elements such as label.",
|
|
2817
|
-
"type": "text"
|
|
2818
|
-
},
|
|
2819
2847
|
"title": {
|
|
2820
2848
|
"value": "Body and UI text",
|
|
2821
2849
|
"type": "text"
|
|
2850
|
+
},
|
|
2851
|
+
"description": {
|
|
2852
|
+
"value": "Body text is used for long-form content where a paragraph or multiple lines of text are required. Body text styles are optimized for reading as a large chunk of information through line height and paragraph spacing. Inline links sit within body text styles and inherit the same font values.\nUI text is text used in UI components and uses the same text stylings.\n\nThe default font size is medium (16 px). Synergy supports three additional font sizes for body copy.\n\nIt is also possible to format the text bold or semibold for certain text passages and UI elements such as label.",
|
|
2853
|
+
"type": "text"
|
|
2822
2854
|
}
|
|
2823
2855
|
},
|
|
2824
2856
|
"headings": {
|
|
2825
|
-
"description": {
|
|
2826
|
-
"value": "Heading styles come in a range of sizes, and can be used in a range of contexts, such as:\n- building page hierarchy,\n- helping users scan large chunks of text,\n- providing a title to a page or piece of content,\n-as subheadings or eyebrow headings, where there is still only one H1 tag per page (as per Accessibility requirements).\n\nOur heading styles are consistently bold, to better address the visual hierarchy.",
|
|
2827
|
-
"type": "text"
|
|
2828
|
-
},
|
|
2829
2857
|
"title": {
|
|
2830
2858
|
"value": "Headings",
|
|
2831
2859
|
"type": "text"
|
|
2860
|
+
},
|
|
2861
|
+
"description": {
|
|
2862
|
+
"value": "Heading styles come in a range of sizes, and can be used in a range of contexts, such as:\n- building page hierarchy,\n- helping users scan large chunks of text,\n- providing a title to a page or piece of content,\n-as subheadings or eyebrow headings, where there is still only one H1 tag per page (as per Accessibility requirements).\n\nOur heading styles are consistently bold, to better address the visual hierarchy.",
|
|
2863
|
+
"type": "text"
|
|
2832
2864
|
}
|
|
2833
2865
|
},
|
|
2834
2866
|
"weight": {
|
|
2835
|
-
"description": {
|
|
2836
|
-
"value": "Supported font weights",
|
|
2837
|
-
"type": "text"
|
|
2838
|
-
},
|
|
2839
2867
|
"title": {
|
|
2840
2868
|
"value": "Font-Weights",
|
|
2841
2869
|
"type": "text"
|
|
2870
|
+
},
|
|
2871
|
+
"description": {
|
|
2872
|
+
"value": "Supported font weights",
|
|
2873
|
+
"type": "text"
|
|
2842
2874
|
}
|
|
2843
2875
|
},
|
|
2844
2876
|
"link": {
|
|
2877
|
+
"title": {
|
|
2878
|
+
"value": "Link",
|
|
2879
|
+
"type": "text"
|
|
2880
|
+
},
|
|
2845
2881
|
"description": {
|
|
2846
2882
|
"value": "Links can be used to display a link to other pages.",
|
|
2847
2883
|
"type": "text"
|
|
2884
|
+
}
|
|
2885
|
+
},
|
|
2886
|
+
"link-list": {
|
|
2887
|
+
"description": {
|
|
2888
|
+
"value": "Links can be grouped horizontally or vertically.",
|
|
2889
|
+
"type": "text"
|
|
2848
2890
|
},
|
|
2849
2891
|
"title": {
|
|
2850
|
-
"value": "Link",
|
|
2892
|
+
"value": "Link list",
|
|
2851
2893
|
"type": "text"
|
|
2852
2894
|
}
|
|
2853
2895
|
}
|
|
@@ -2899,7 +2941,7 @@
|
|
|
2899
2941
|
"type": "text"
|
|
2900
2942
|
},
|
|
2901
2943
|
"description": {
|
|
2902
|
-
"value": "The footer is the area located at the bottom of the application window, below the content area.\n\nThe
|
|
2944
|
+
"value": "The footer is the area located at the bottom of the application window, below the content area.\n\nThe footer may contain one or more links pointing to legal information items as well as a copyright symbol and current year. The standard links can include things like:\n- Imprint (e.g. https://www.sick.com/imprint)\n- Terms and conditions (e.g. https://www.sick.com/tac)\n- Terms of use (e.g. https://www.sick.com/terms-of-use)\n- Data protection (e.g. https://www.sick.com/dataprotection)\n\nIf a footer is not required or desired, ensure that all legally required links are placed elsewhere in your application, depending on legal requirements.\n\nFor example, you can: add an info icon (or similar element) to your header and display the necessary information in a dropdown menu. Alternatively, create a dedicated navigation entry to house the required legal links.\n\nThe footer links can be placed on any background color. If you need a more compact version of the footer, adjust the top and bottom margins from spacing.large (24px) to spacing.medium (16px).",
|
|
2903
2945
|
"type": "text"
|
|
2904
2946
|
}
|
|
2905
2947
|
},
|
|
@@ -3239,7 +3281,7 @@
|
|
|
3239
3281
|
"type": "text"
|
|
3240
3282
|
},
|
|
3241
3283
|
"description": {
|
|
3242
|
-
"value": "Add descriptive help text to a
|
|
3284
|
+
"value": "Add descriptive help text to a switch with the help-text attribute. For help texts that contain HTML, use the help-text slot instead.\nThe help-text attribute should not be used to display error messages. To handle validation and error messaging, use syn-validate for proper error management.",
|
|
3243
3285
|
"type": "text"
|
|
3244
3286
|
}
|
|
3245
3287
|
},
|
|
@@ -3373,6 +3415,104 @@
|
|
|
3373
3415
|
"type": "text"
|
|
3374
3416
|
}
|
|
3375
3417
|
}
|
|
3418
|
+
},
|
|
3419
|
+
"validate": {
|
|
3420
|
+
"default": {
|
|
3421
|
+
"title": {
|
|
3422
|
+
"value": "Validate",
|
|
3423
|
+
"type": "text"
|
|
3424
|
+
},
|
|
3425
|
+
"description": {
|
|
3426
|
+
"value": "Validate offers options for convenient error handling in form elements.",
|
|
3427
|
+
"type": "text"
|
|
3428
|
+
}
|
|
3429
|
+
},
|
|
3430
|
+
"inline": {
|
|
3431
|
+
"title": {
|
|
3432
|
+
"value": "Inline variant",
|
|
3433
|
+
"type": "text"
|
|
3434
|
+
},
|
|
3435
|
+
"description": {
|
|
3436
|
+
"value": "Set the variant attribute to `inline` to show the invalid message below the selected element.",
|
|
3437
|
+
"type": "text"
|
|
3438
|
+
},
|
|
3439
|
+
"note": {
|
|
3440
|
+
"value": "Per default, syn-validate uses the browser’s built-in validation. This shows only one error at a time and is optimized for accessbility.\nWhen using the inline variant, you have to ensure accessibility on your side and have to have in mind it most likely will lead to layout shifts.",
|
|
3441
|
+
"type": "text"
|
|
3442
|
+
}
|
|
3443
|
+
},
|
|
3444
|
+
"hide-icon": {
|
|
3445
|
+
"title": {
|
|
3446
|
+
"value": "Hide Icon",
|
|
3447
|
+
"type": "text"
|
|
3448
|
+
},
|
|
3449
|
+
"description": {
|
|
3450
|
+
"value": "Use hide-icon to hide the icon in inline style. This is especially useful when showing more than one error at a time.",
|
|
3451
|
+
"type": "text"
|
|
3452
|
+
}
|
|
3453
|
+
},
|
|
3454
|
+
"live": {
|
|
3455
|
+
"title": {
|
|
3456
|
+
"value": "Live",
|
|
3457
|
+
"type": "text"
|
|
3458
|
+
},
|
|
3459
|
+
"description": {
|
|
3460
|
+
"value": "Use the live value for the on attribute to validate on every input change (e. g. typing a character or checking a checkbox.) instead of form submit. This will automatically bind to the input and blur events.",
|
|
3461
|
+
"type": "text"
|
|
3462
|
+
},
|
|
3463
|
+
"note": {
|
|
3464
|
+
"value": "Please ensure, that you really need live validation for your use case as this can have implications on accessibility.",
|
|
3465
|
+
"type": "text"
|
|
3466
|
+
}
|
|
3467
|
+
},
|
|
3468
|
+
"custom-validation": {
|
|
3469
|
+
"title": {
|
|
3470
|
+
"value": "Custom Validation",
|
|
3471
|
+
"type": "text"
|
|
3472
|
+
},
|
|
3473
|
+
"description": {
|
|
3474
|
+
"value": "Use the custom-validation-message attribute to use whichever error you need as text, overriding the default browser errors.",
|
|
3475
|
+
"type": "text"
|
|
3476
|
+
},
|
|
3477
|
+
"note": {
|
|
3478
|
+
"value": "By using the custom-validation-message attribute, you can override the default browser error messages with custom text. However, please note that applying this attribute disables the browser’s native validation functionality. This means the standard error messages will not be displayed until the custom-validation attribute is removed, at which point the native functionality will be restored.",
|
|
3479
|
+
"type": "text"
|
|
3480
|
+
}
|
|
3481
|
+
},
|
|
3482
|
+
"custom-form-field": {
|
|
3483
|
+
"title": {
|
|
3484
|
+
"value": "Custom Form Field",
|
|
3485
|
+
"type": "text"
|
|
3486
|
+
},
|
|
3487
|
+
"description": {
|
|
3488
|
+
"value": "Wrap the element around any other form field, that follows browser standards to use all features.",
|
|
3489
|
+
"type": "text"
|
|
3490
|
+
}
|
|
3491
|
+
},
|
|
3492
|
+
"custom-event-names": {
|
|
3493
|
+
"title": {
|
|
3494
|
+
"value": "Binding To Custom Event Names",
|
|
3495
|
+
"type": "text"
|
|
3496
|
+
},
|
|
3497
|
+
"description": {
|
|
3498
|
+
"value": "Use the `on` attribute to listen for one or many custom events. This may be useful if you want to validate on keypress or custom events that may be fired by third party web-components.",
|
|
3499
|
+
"type": "text"
|
|
3500
|
+
},
|
|
3501
|
+
"note": {
|
|
3502
|
+
"value": "You can provide one or multiple events in the `on` property. Please use a whitespace separated list of DOM event names. `<syn-validate>` will make sure to automatically use Synergies custom events. This means `<syn-validate on=\"change click\">` will bind to the `syn-change` and `click` events for a `<syn-input>` __or__ `change` and `click` events for a regular `<input>` element.",
|
|
3503
|
+
"type": "text"
|
|
3504
|
+
}
|
|
3505
|
+
},
|
|
3506
|
+
"eager": {
|
|
3507
|
+
"title": {
|
|
3508
|
+
"value": "Eager validation",
|
|
3509
|
+
"type": "text"
|
|
3510
|
+
},
|
|
3511
|
+
"description": {
|
|
3512
|
+
"value": "Use the eager attribute to validate the field when the component is mounted. This may be used to prefill validation messages, e.g. during page loads. Please be aware that when mixed with a `variant` of `native`, this will display the error of the last eager element in your `<form>` only!",
|
|
3513
|
+
"type": "text"
|
|
3514
|
+
}
|
|
3515
|
+
}
|
|
3376
3516
|
}
|
|
3377
3517
|
},
|
|
3378
3518
|
"assets": {
|