@synergy-design-system/tokens 2.13.0 → 2.14.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 CHANGED
@@ -1,3 +1,10 @@
1
+ # [@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)
2
+
3
+
4
+ ### Features
5
+
6
+ * ✨ 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))
7
+
1
8
  # [@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
9
 
3
10
 
@@ -1,5 +1,5 @@
1
1
  /**
2
- * @synergy-design-system/tokens version 2.12.1
2
+ * @synergy-design-system/tokens version 2.13.0
3
3
  * SICK Global UX Foundation
4
4
  */
5
5
 
package/dist/js/index.js CHANGED
@@ -1,5 +1,5 @@
1
1
  /**
2
- * @synergy-design-system/tokens version 2.12.1
2
+ * @synergy-design-system/tokens version 2.13.0
3
3
  * SICK Global UX Foundation
4
4
  */
5
5
 
@@ -1,5 +1,5 @@
1
1
  /**
2
- * @synergy-design-system/tokens version 2.12.1
2
+ * @synergy-design-system/tokens version 2.13.0
3
3
  * SICK Global UX Foundation
4
4
  */
5
5
  $SynFontSizeXSmall: var(--syn-font-size-x-small) !default;
@@ -1,8 +1,8 @@
1
1
  /**
2
- * @synergy-design-system/tokens version 2.12.1
2
+ * @synergy-design-system/tokens version 2.13.0
3
3
  * SICK Global UX Foundation
4
4
  * Do not edit directly
5
- * Generated on Fri, 11 Oct 2024 11:03:35 GMT
5
+ * Generated on Thu, 21 Nov 2024 12:46:27 GMT
6
6
  */
7
7
 
8
8
  :root, .syn-theme-dark {
@@ -1,8 +1,8 @@
1
1
  /**
2
- * @synergy-design-system/tokens version 2.12.1
2
+ * @synergy-design-system/tokens version 2.13.0
3
3
  * SICK Global UX Foundation
4
4
  * Do not edit directly
5
- * Generated on Fri, 11 Oct 2024 11:03:35 GMT
5
+ * Generated on Thu, 21 Nov 2024 12:46:27 GMT
6
6
  */
7
7
 
8
8
  :root, .syn-theme-light {
package/package.json CHANGED
@@ -17,9 +17,9 @@
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.9.0",
21
- "@synergy-design-system/stylelint-config-syn": "0.1.0",
22
- "@synergy-design-system/eslint-config-syn": "0.1.0"
20
+ "stylelint": "^16.10.0",
21
+ "@synergy-design-system/eslint-config-syn": "0.1.0",
22
+ "@synergy-design-system/stylelint-config-syn": "0.1.0"
23
23
  },
24
24
  "exports": {
25
25
  ".": {
@@ -101,7 +101,7 @@
101
101
  },
102
102
  "type": "module",
103
103
  "types": "./dist/js/index.d.ts",
104
- "version": "2.13.0",
104
+ "version": "2.14.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
- "titel": {
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 help-text attribute. For help texts that contain HTML, use the help-text slot instead.",
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 file selector with the help-text attribute. For help texts that contain HTML, use the help-text slot instead.",
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
- "titel": {
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 an input with the help-text attribute. For help texts that contain HTML, use the help-text slot instead.",
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
  },
@@ -1781,7 +1781,7 @@
1781
1781
  "type": "text"
1782
1782
  },
1783
1783
  "description": {
1784
- "value": "Add descriptive help text to a radio group with the help-text attribute. For help texts that contain HTML, use the help-text slot instead.",
1784
+ "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
1785
  "type": "text"
1786
1786
  }
1787
1787
  },
@@ -1848,33 +1848,33 @@
1848
1848
  },
1849
1849
  "range": {
1850
1850
  "default": {
1851
- "description": {
1852
- "value": "Ranges allow the user to select values within a given range using a thumb.",
1853
- "type": "text"
1854
- },
1855
1851
  "title": {
1856
1852
  "value": "Range",
1857
1853
  "type": "text"
1854
+ },
1855
+ "description": {
1856
+ "value": "Ranges allow the user to select values within a given range using a thumb.",
1857
+ "type": "text"
1858
1858
  }
1859
1859
  },
1860
1860
  "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
1861
  "title": {
1866
1862
  "value": "Labels",
1867
1863
  "type": "text"
1864
+ },
1865
+ "description": {
1866
+ "value": "Use the label attribute to give the range an accessible label. For labels that contain HTML, use the label slot instead.",
1867
+ "type": "text"
1868
1868
  }
1869
1869
  },
1870
1870
  "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
1871
  "title": {
1876
1872
  "value": "Help Text",
1877
1873
  "type": "text"
1874
+ },
1875
+ "description": {
1876
+ "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.",
1877
+ "type": "text"
1878
1878
  }
1879
1879
  },
1880
1880
  "focus": {
@@ -1908,23 +1908,23 @@
1908
1908
  }
1909
1909
  },
1910
1910
  "disabled": {
1911
- "description": {
1912
- "value": "Use the disabled attribute to disable a range.",
1913
- "type": "text"
1914
- },
1915
1911
  "title": {
1916
1912
  "value": "Disabled",
1917
1913
  "type": "text"
1914
+ },
1915
+ "description": {
1916
+ "value": "Use the disabled attribute to disable a range.",
1917
+ "type": "text"
1918
1918
  }
1919
1919
  },
1920
1920
  "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
1921
  "title": {
1926
1922
  "value": "Prefix and Suffix",
1927
1923
  "type": "text"
1924
+ },
1925
+ "description": {
1926
+ "value": "Add any element to the start and end of range items using the prefix and suffix slots.",
1927
+ "type": "text"
1928
1928
  }
1929
1929
  },
1930
1930
  "custom-track-colors": {
@@ -1938,44 +1938,44 @@
1938
1938
  }
1939
1939
  },
1940
1940
  "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
1941
  "title": {
1946
1942
  "value": "Custom Track Offset",
1947
1943
  "type": "text"
1944
+ },
1945
+ "description": {
1946
+ "value": "You can customize the initial offset of the active track using the --track-active-offset custom property.",
1947
+ "type": "text"
1948
1948
  }
1949
1949
  },
1950
1950
  "multi-knob": {
1951
- "description": {
1952
- "value": "You can add multiple range-thumbs to your range.",
1953
- "type": "text"
1954
- },
1955
1951
  "title": {
1956
1952
  "value": "Multi thumb",
1957
1953
  "type": "text"
1954
+ },
1955
+ "description": {
1956
+ "value": "You can add multiple range-thumbs to your range.",
1957
+ "type": "text"
1958
1958
  }
1959
1959
  },
1960
1960
  "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
1961
  "title": {
1966
1962
  "value": "Multi thumb with restricted movement",
1967
1963
  "type": "text"
1964
+ },
1965
+ "description": {
1966
+ "value": "You can prevent the thumbs from overlapping by listening to the provided `syn-move` event.",
1967
+ "type": "text"
1968
1968
  }
1969
1969
  },
1970
1970
  "ticks": {
1971
1971
  "default": {
1972
- "description": {
1973
- "value": "Use the ticks slot to insert ticks or groups with ticks to improve positioning.",
1974
- "type": "text"
1975
- },
1976
1972
  "title": {
1977
1973
  "value": "Ticks",
1978
1974
  "type": "text"
1975
+ },
1976
+ "description": {
1977
+ "value": "Use the ticks slot to insert ticks or groups with ticks to improve positioning.",
1978
+ "type": "text"
1979
1979
  }
1980
1980
  },
1981
1981
  "label": {
@@ -2010,33 +2010,33 @@
2010
2010
  }
2011
2011
  },
2012
2012
  "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
2013
  "title": {
2018
2014
  "value": "Tooltip Placement",
2019
2015
  "type": "text"
2016
+ },
2017
+ "description": {
2018
+ "value": "By default, the tooltip is shown on top. Set tooltip-placement to bottom to show it below the range.",
2019
+ "type": "text"
2020
2020
  }
2021
2021
  },
2022
2022
  "tooltip-disabled": {
2023
- "description": {
2024
- "value": "To disable the tooltip, set tooltip-placement to none.",
2025
- "type": "text"
2026
- },
2027
2023
  "title": {
2028
2024
  "value": "Disable the Tooltip",
2029
2025
  "type": "text"
2026
+ },
2027
+ "description": {
2028
+ "value": "To disable the tooltip, set tooltip-placement to none.",
2029
+ "type": "text"
2030
2030
  }
2031
2031
  },
2032
2032
  "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
2033
  "title": {
2038
2034
  "value": "Custom Tooltip Formatter",
2039
2035
  "type": "text"
2036
+ },
2037
+ "description": {
2038
+ "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.",
2039
+ "type": "text"
2040
2040
  }
2041
2041
  }
2042
2042
  },
@@ -2072,13 +2072,13 @@
2072
2072
  },
2073
2073
  "select": {
2074
2074
  "default": {
2075
- "description": {
2076
- "value": "Selects allow you to choose items from a menu of predefined options.",
2077
- "type": "text"
2078
- },
2079
2075
  "title": {
2080
2076
  "value": "Select",
2081
2077
  "type": "text"
2078
+ },
2079
+ "description": {
2080
+ "value": "Selects allow you to choose items from a menu of predefined options.",
2081
+ "type": "text"
2082
2082
  }
2083
2083
  },
2084
2084
  "labels": {
@@ -2097,7 +2097,7 @@
2097
2097
  "type": "text"
2098
2098
  },
2099
2099
  "description": {
2100
- "value": "Add descriptive help text to a select with the help-text attribute. For help texts that contain HTML, use the help-text slot instead.",
2100
+ "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
2101
  "type": "text"
2102
2102
  }
2103
2103
  },
@@ -2213,24 +2213,24 @@
2213
2213
  }
2214
2214
  },
2215
2215
  "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
2216
  "title": {
2221
2217
  "value": "Skeleton",
2222
2218
  "type": "text"
2219
+ },
2220
+ "description": {
2221
+ "value": "Skeletons are used to provide a visual representation of where content will eventually be drawn.",
2222
+ "type": "text"
2223
2223
  }
2224
2224
  },
2225
2225
  "spinner": {
2226
2226
  "default": {
2227
- "description": {
2228
- "value": "Spinners are used to show the progress of an indeterminate operation.",
2229
- "type": "text"
2230
- },
2231
2227
  "title": {
2232
2228
  "value": "Spinner",
2233
2229
  "type": "text"
2230
+ },
2231
+ "description": {
2232
+ "value": "Spinners are used to show the progress of an indeterminate operation.",
2233
+ "type": "text"
2234
2234
  }
2235
2235
  },
2236
2236
  "size": {
@@ -2265,13 +2265,13 @@
2265
2265
  }
2266
2266
  },
2267
2267
  "split-panel": {
2268
- "description": {
2269
- "value": "Split panels display two adjacent panels, allowing the user to reposition them.",
2270
- "type": "text"
2271
- },
2272
2268
  "title": {
2273
2269
  "value": "Split Panel",
2274
2270
  "type": "text"
2271
+ },
2272
+ "description": {
2273
+ "value": "Split panels display two adjacent panels, allowing the user to reposition them.",
2274
+ "type": "text"
2275
2275
  }
2276
2276
  },
2277
2277
  "switch": {
@@ -2341,7 +2341,7 @@
2341
2341
  "type": "text"
2342
2342
  },
2343
2343
  "description": {
2344
- "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.",
2344
+ "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
2345
  "type": "text"
2346
2346
  }
2347
2347
  }
@@ -2509,7 +2509,7 @@
2509
2509
  "type": "text"
2510
2510
  },
2511
2511
  "description": {
2512
- "value": "Add descriptive help text to a textarea with the help-text attribute. For help texts that contain HTML, use the help-text slot instead.",
2512
+ "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
2513
  "type": "text"
2514
2514
  }
2515
2515
  },
@@ -2687,44 +2687,44 @@
2687
2687
  }
2688
2688
  },
2689
2689
  "tree-item": {
2690
- "description": {
2691
- "value": "A tree item serves as a hierarchical node that lives inside a tree.",
2692
- "type": "text"
2693
- },
2694
2690
  "title": {
2695
2691
  "value": "Tree Item",
2696
2692
  "type": "text"
2693
+ },
2694
+ "description": {
2695
+ "value": "A tree item serves as a hierarchical node that lives inside a tree.",
2696
+ "type": "text"
2697
2697
  }
2698
2698
  },
2699
2699
  "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
2700
  "title": {
2705
2701
  "value": "Tree",
2706
2702
  "type": "text"
2703
+ },
2704
+ "description": {
2705
+ "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.",
2706
+ "type": "text"
2707
2707
  }
2708
2708
  },
2709
2709
  "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
2710
  "title": {
2715
2711
  "value": "Visually Hidden",
2716
2712
  "type": "text"
2713
+ },
2714
+ "description": {
2715
+ "value": "The visually hidden utility makes content accessible to assistive devices without displaying it on the screen.",
2716
+ "type": "text"
2717
2717
  }
2718
2718
  },
2719
2719
  "radio": {
2720
2720
  "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
2721
  "title": {
2726
2722
  "value": "Radio",
2727
2723
  "type": "text"
2724
+ },
2725
+ "description": {
2726
+ "value": "Radios allow the user to select a single option from a group. \\nRadios are designed to be used with radio groups.",
2727
+ "type": "text"
2728
2728
  }
2729
2729
  },
2730
2730
  "focus": {
@@ -2812,43 +2812,43 @@
2812
2812
  },
2813
2813
  "styles": {
2814
2814
  "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
2815
  "title": {
2820
2816
  "value": "Body and UI text",
2821
2817
  "type": "text"
2818
+ },
2819
+ "description": {
2820
+ "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.",
2821
+ "type": "text"
2822
2822
  }
2823
2823
  },
2824
2824
  "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
2825
  "title": {
2830
2826
  "value": "Headings",
2831
2827
  "type": "text"
2828
+ },
2829
+ "description": {
2830
+ "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.",
2831
+ "type": "text"
2832
2832
  }
2833
2833
  },
2834
2834
  "weight": {
2835
- "description": {
2836
- "value": "Supported font weights",
2837
- "type": "text"
2838
- },
2839
2835
  "title": {
2840
2836
  "value": "Font-Weights",
2841
2837
  "type": "text"
2838
+ },
2839
+ "description": {
2840
+ "value": "Supported font weights",
2841
+ "type": "text"
2842
2842
  }
2843
2843
  },
2844
2844
  "link": {
2845
- "description": {
2846
- "value": "Links can be used to display a link to other pages.",
2847
- "type": "text"
2848
- },
2849
2845
  "title": {
2850
2846
  "value": "Link",
2851
2847
  "type": "text"
2848
+ },
2849
+ "description": {
2850
+ "value": "Links can be used to display a link to other pages.",
2851
+ "type": "text"
2852
2852
  }
2853
2853
  }
2854
2854
  },
@@ -2899,7 +2899,7 @@
2899
2899
  "type": "text"
2900
2900
  },
2901
2901
  "description": {
2902
- "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 you don't want to use the links in the footer, please make sure to include the legal required links somewhere else.\n\nThe footer links can be placed on any background color. If you need a more compact version of the footer, simply adjust the top and bottom margins from spacing.large (24px) to spacing.medium (16px).",
2902
+ "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
2903
  "type": "text"
2904
2904
  }
2905
2905
  },
@@ -3239,7 +3239,7 @@
3239
3239
  "type": "text"
3240
3240
  },
3241
3241
  "description": {
3242
- "value": "Add descriptive help text to a combobox with the help-text attribute. For help texts that contain HTML, use the help-text slot instead.",
3242
+ "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
3243
  "type": "text"
3244
3244
  }
3245
3245
  },
@@ -3373,6 +3373,104 @@
3373
3373
  "type": "text"
3374
3374
  }
3375
3375
  }
3376
+ },
3377
+ "validate": {
3378
+ "default": {
3379
+ "title": {
3380
+ "value": "Validate",
3381
+ "type": "text"
3382
+ },
3383
+ "description": {
3384
+ "value": "Validate offers options for convenient error handling in form elements.",
3385
+ "type": "text"
3386
+ }
3387
+ },
3388
+ "inline": {
3389
+ "title": {
3390
+ "value": "Inline variant",
3391
+ "type": "text"
3392
+ },
3393
+ "description": {
3394
+ "value": "Set the variant attribute to `inline` to show the invalid message below the selected element.",
3395
+ "type": "text"
3396
+ },
3397
+ "note": {
3398
+ "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.",
3399
+ "type": "text"
3400
+ }
3401
+ },
3402
+ "hide-icon": {
3403
+ "title": {
3404
+ "value": "Hide Icon",
3405
+ "type": "text"
3406
+ },
3407
+ "description": {
3408
+ "value": "Use hide-icon to hide the icon in inline style. This is especially useful when showing more than one error at a time.",
3409
+ "type": "text"
3410
+ }
3411
+ },
3412
+ "live": {
3413
+ "title": {
3414
+ "value": "Live",
3415
+ "type": "text"
3416
+ },
3417
+ "description": {
3418
+ "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.",
3419
+ "type": "text"
3420
+ },
3421
+ "note": {
3422
+ "value": "Please ensure, that you really need live validation for your use case as this can have implications on accessibility.",
3423
+ "type": "text"
3424
+ }
3425
+ },
3426
+ "custom-validation": {
3427
+ "title": {
3428
+ "value": "Custom Validation",
3429
+ "type": "text"
3430
+ },
3431
+ "description": {
3432
+ "value": "Use the custom-validation-message attribute to use whichever error you need as text, overriding the default browser errors.",
3433
+ "type": "text"
3434
+ },
3435
+ "note": {
3436
+ "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.",
3437
+ "type": "text"
3438
+ }
3439
+ },
3440
+ "custom-form-field": {
3441
+ "title": {
3442
+ "value": "Custom Form Field",
3443
+ "type": "text"
3444
+ },
3445
+ "description": {
3446
+ "value": "Wrap the element around any other form field, that follows browser standards to use all features.",
3447
+ "type": "text"
3448
+ }
3449
+ },
3450
+ "custom-event-names": {
3451
+ "title": {
3452
+ "value": "Binding To Custom Event Names",
3453
+ "type": "text"
3454
+ },
3455
+ "description": {
3456
+ "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.",
3457
+ "type": "text"
3458
+ },
3459
+ "note": {
3460
+ "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.",
3461
+ "type": "text"
3462
+ }
3463
+ },
3464
+ "eager": {
3465
+ "title": {
3466
+ "value": "Eager validation",
3467
+ "type": "text"
3468
+ },
3469
+ "description": {
3470
+ "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!",
3471
+ "type": "text"
3472
+ }
3473
+ }
3376
3474
  }
3377
3475
  },
3378
3476
  "assets": {