@synergy-design-system/tokens 1.7.1 → 1.9.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,17 @@
1
+ # [@synergy-design-system/tokens-v1.9.0](https://github.com/synergy-design-system/synergy-design-system/compare/tokens/1.8.0...tokens/1.9.0) (2024-03-18)
2
+
3
+
4
+ ### Features
5
+
6
+ * ✨ drop-down ([#367](https://github.com/synergy-design-system/synergy-design-system/issues/367)) ([562daf8](https://github.com/synergy-design-system/synergy-design-system/commit/562daf8b06627b7d44a3f06210b3202c7eee9540))
7
+
8
+ # [@synergy-design-system/tokens-v1.8.0](https://github.com/synergy-design-system/synergy-design-system/compare/tokens/1.7.1...tokens/1.8.0) (2024-02-28)
9
+
10
+
11
+ ### Features
12
+
13
+ * ✨ Create syn-header ([#331](https://github.com/synergy-design-system/synergy-design-system/issues/331)) ([acde61d](https://github.com/synergy-design-system/synergy-design-system/commit/acde61d762dd4123aae553227f3af2015e824208))
14
+
1
15
  # [@synergy-design-system/tokens-v1.7.1](https://github.com/synergy-design-system/synergy-design-system/compare/tokens/1.7.0...tokens/1.7.1) (2024-02-27)
2
16
 
3
17
 
@@ -1,5 +1,5 @@
1
1
  /**
2
- * @synergy-design-system/tokens version 1.7.0
2
+ * @synergy-design-system/tokens version 1.8.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 1.7.0
2
+ * @synergy-design-system/tokens version 1.8.0
3
3
  * SICK Global UX Foundation
4
4
  */
5
5
 
@@ -1,5 +1,5 @@
1
1
  /**
2
- * @synergy-design-system/tokens version 1.7.0
2
+ * @synergy-design-system/tokens version 1.8.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 1.7.0
2
+ * @synergy-design-system/tokens version 1.8.0
3
3
  * SICK Global UX Foundation
4
4
  * Do not edit directly
5
- * Generated on Tue, 27 Feb 2024 14:13:18 GMT
5
+ * Generated on Mon, 18 Mar 2024 10:36:36 GMT
6
6
  */
7
7
 
8
8
  :root, .syn-theme-dark {
@@ -1,8 +1,8 @@
1
1
  /**
2
- * @synergy-design-system/tokens version 1.7.0
2
+ * @synergy-design-system/tokens version 1.8.0
3
3
  * SICK Global UX Foundation
4
4
  * Do not edit directly
5
- * Generated on Tue, 27 Feb 2024 14:13:18 GMT
5
+ * Generated on Mon, 18 Mar 2024 10:36:36 GMT
6
6
  */
7
7
 
8
8
  :root, .syn-theme-light {
package/package.json CHANGED
@@ -101,7 +101,7 @@
101
101
  },
102
102
  "type": "module",
103
103
  "types": "./dist/js/index.d.ts",
104
- "version": "1.7.1",
104
+ "version": "1.9.0",
105
105
  "scripts": {
106
106
  "build": "pnpm clean && node scripts/build.js",
107
107
  "clean": "rimraf build",
@@ -473,7 +473,7 @@
473
473
  "type": "text"
474
474
  },
475
475
  "description": {
476
- "value": "By default, drawers will close when the user clicks the close button, clicks the overlay, or presses the Escape key. In most cases, the default behavior is the best behavior in terms of UX. However, there are situations where this may be undesirable, such as when data loss will occur.\n\nTo keep the drawer open in such cases, you can cancel the sl-request-close event. When canceled, the drawer will remain open and pulse briefly to draw the user’s attention to it.\n\nYou can use event.detail.source to determine what triggered the request to close. This example prevents the drawer from closing when the overlay is clicked, but allows the close button or Escape to dismiss it.",
476
+ "value": "By default, drawers will close when the user clicks the close button, clicks the overlay, or presses the Escape key. In most cases, the default behavior is the best behavior in terms of UX. However, there are situations where this may be undesirable, such as when data loss will occur.\n\nTo keep the drawer open in such cases, you can cancel the syn-request-close event. When canceled, the drawer will remain open and pulse briefly to draw the user’s attention to it.\n\nYou can use event.detail.source to determine what triggered the request to close. This example prevents the drawer from closing when the overlay is clicked, but allows the close button or Escape to dismiss it.",
477
477
  "type": "text"
478
478
  }
479
479
  },
@@ -489,13 +489,69 @@
489
489
  }
490
490
  },
491
491
  "dropdown": {
492
- "description": {
493
- "value": "Dropdowns expose additional content that \"drops down\" in a panel.",
494
- "type": "textDropdowns expose additional content that “drops down” in a panel.

Dropdowns consist of a trigger and a panel. By default, activating the trigger will expose the panel and interacting outside of the panel will close it.\n\nDropdowns are designed to work well with menus to provide a list of options the user can select from. However, dropdowns can also be used in lower-level applications (e.g. color picker). The API gives you complete control over showing, hiding, and positioning the panel."
492
+ "default": {
493
+ "description": {
494
+ "value": "Dropdowns expose additional content that “drops down” in a panel.

Dropdowns consist of a trigger and a panel. By default, activating the trigger will expose the panel and interacting outside of the panel will close it.\n\nDropdowns are designed to work well with menus to provide a list of options the user can select from. However, dropdowns can also be used in lower-level applications (e.g. color picker). The API gives you complete control over showing, hiding, and positioning the panel.",
495
+ "type": "text"
496
+ },
497
+ "title": {
498
+ "value": "Dropdown",
499
+ "type": "text"
500
+ }
495
501
  },
496
- "title": {
497
- "value": "Dropdown",
498
- "type": "text"
502
+ "selected": {
503
+ "title": {
504
+ "value": "Getting the Selected Item",
505
+ "type": "text"
506
+ },
507
+ "description": {
508
+ "value": "When dropdowns are used with menus, you can listen for the syn-select event to determine which menu item was selected. The menu item element will be exposed in event.detail.item. You can set value props to make it easier to identify commands. DEV: Alternatively, you can listen for the click event on individual menu items. Note that, using this approach, disabled menu items will still emit a click event.",
509
+ "type": "text"
510
+ }
511
+ },
512
+ "placement": {
513
+ "title": {
514
+ "value": "Placement",
515
+ "type": "text"
516
+ },
517
+ "description": {
518
+ "value": "The preferred placement of the dropdown can be set with the placement attribute. Note that the actual position may vary to ensure the panel remains in the viewport.",
519
+ "type": "text"
520
+ }
521
+ },
522
+ "distance": {
523
+ "title": {
524
+ "value": "Distance",
525
+ "type": "text"
526
+ },
527
+ "description": {
528
+ "value": "The distance from the panel to the trigger can be customized using the distance attribute. This value is specified in pixels.",
529
+ "type": "text"
530
+ }
531
+ },
532
+ "skidding": {
533
+ "title": {
534
+ "value": "Skidding",
535
+ "type": "text"
536
+ },
537
+ "description": {
538
+ "value": "The offset of the panel along the trigger can be customized using the skidding attribute. This value is specified in pixels.",
539
+ "type": "text"
540
+ }
541
+ },
542
+ "submenu": {
543
+ "title": {
544
+ "value": "Submenus",
545
+ "type": "text"
546
+ },
547
+ "description": {
548
+ "value": "To create a submenu, nest an <syn-menu slot=\"submenu\"> element in a menu item.",
549
+ "type": "text"
550
+ },
551
+ "warning": {
552
+ "value": "As a UX best practice, avoid using more than one level of submenus when possible.",
553
+ "type": "text"
554
+ }
499
555
  }
500
556
  },
501
557
  "format-bytes": {
@@ -783,33 +839,121 @@
783
839
  }
784
840
  },
785
841
  "menu-item": {
786
- "description": {
787
- "value": "Menu items provide options for the user to pick from in a menu.",
788
- "type": "text"
842
+ "default": {
843
+ "description": {
844
+ "value": "Menu items provide options for the user to pick from in a menu.",
845
+ "type": "text"
846
+ },
847
+ "title": {
848
+ "value": "Menu Item",
849
+ "type": "text"
850
+ }
789
851
  },
790
- "title": {
791
- "value": "Menu Item",
792
- "type": "text"
852
+ "prefixsuffix": {
853
+ "title": {
854
+ "value": "Prefix and Suffix",
855
+ "type": "text"
856
+ },
857
+ "description": {
858
+ "value": "Add content to the start and end of menu items using the prefix and suffix slots.",
859
+ "type": "text"
860
+ }
861
+ },
862
+ "disabled": {
863
+ "title": {
864
+ "value": "Disabled",
865
+ "type": "text"
866
+ },
867
+ "description": {
868
+ "value": "Use the disabled attribute to disable an option and prevent it from being selected.",
869
+ "type": "text"
870
+ }
871
+ },
872
+ "loading": {
873
+ "title": {
874
+ "value": "Loading",
875
+ "type": "text"
876
+ },
877
+ "description": {
878
+ "value": "Use the loading attribute to indicate that a menu item is busy. Like a disabled menu item, clicks will be suppressed until the loading state is removed.",
879
+ "type": "text"
880
+ }
881
+ },
882
+ "checkbox": {
883
+ "title": {
884
+ "value": "Checkbox Menu Items",
885
+ "type": "text"
886
+ },
887
+ "description": {
888
+ "value": "Set the type attribute to checkbox to create a menu item that will toggle on and off when selected. You can use the checked attribute to set the initial state.\n\nCheckbox menu items are visually indistinguishable from regular menu items. Their ability to be toggled is primarily inferred from context, much like you’d find in the menu of a native app.",
889
+ "type": "text"
890
+ }
891
+ },
892
+ "selection": {
893
+ "title": {
894
+ "value": "Value & Selection",
895
+ "type": "text"
896
+ },
897
+ "description": {
898
+ "value": "The value attribute can be used to assign a hidden value, such as a unique identifier, to a menu item. When an item is selected, the syn-select event will be emitted and a reference to the item will be available at event.detail.item. You can use this reference to access the selected item’s value, its checked state, and more.",
899
+ "type": "text"
900
+ }
793
901
  }
794
902
  },
795
903
  "menu-label": {
796
- "description": {
797
- "value": "Menu labels are used to describe a group of menu items.",
798
- "type": "text"
799
- },
800
- "title": {
801
- "value": "Menu Label",
802
- "type": "text"
904
+ "default": {
905
+ "description": {
906
+ "value": "Menu labels are used to describe a group of menu items.",
907
+ "type": "text"
908
+ },
909
+ "title": {
910
+ "value": "Menu Label",
911
+ "type": "text"
912
+ }
803
913
  }
804
914
  },
805
915
  "menu": {
806
- "description": {
807
- "value": "Menus provide a list of options for the user to choose from.",
808
- "type": "text"
916
+ "default": {
917
+ "description": {
918
+ "value": "Menus provide a list of options for the user to choose from.\n\nYou can use menu items, menu labels, and dividers to compose a menu. Menus support keyboard interactions, including type-to-select an option.",
919
+ "type": "text"
920
+ },
921
+ "title": {
922
+ "value": "Menu",
923
+ "type": "text"
924
+ },
925
+ "info": {
926
+ "value": "Menus are intended for system menus (dropdown menus, select menus, context menus, etc.). They should not be mistaken for navigation menus which serve a different purpose and have a different semantic meaning. If you’re building navigation, use <nav> and <a> elements instead.\n(Figma: syn-side-nav or syn-horizontal-nav)",
927
+ "type": "text"
928
+ },
929
+ "warning": {
930
+ "value": "Deviation between dev and design, For implementation reasons design nests the dropdown inside the menu, development the other way round",
931
+ "type": "text"
932
+ }
809
933
  },
810
- "title": {
811
- "value": "Menu",
812
- "type": "text"
934
+ "dropdown": {
935
+ "title": {
936
+ "value": "In Dropdowns",
937
+ "type": "text"
938
+ },
939
+ "description": {
940
+ "value": "Menus work really well when used inside dropdowns.",
941
+ "type": "text"
942
+ }
943
+ },
944
+ "submenu": {
945
+ "title": {
946
+ "value": "Submenus",
947
+ "type": "text"
948
+ },
949
+ "description": {
950
+ "value": "To create a submenu, nest an <syn-menu slot=\"submenu\"> in any menu item.",
951
+ "type": "text"
952
+ },
953
+ "warning": {
954
+ "value": "As a UX best practice, avoid using more than one level of submenus when possible.",
955
+ "type": "text"
956
+ }
813
957
  }
814
958
  },
815
959
  "mutation-observer": {
@@ -855,13 +999,23 @@
855
999
  }
856
1000
  },
857
1001
  "popup": {
858
- "description": {
859
- "value": "Popup is a utility that lets you declaratively anchor \"popup\" containers to another element.",
860
- "type": "text"
861
- },
862
- "title": {
863
- "value": "Popup",
864
- "type": "text"
1002
+ "default": {
1003
+ "description": {
1004
+ "value": "Popup is a utility that lets you declaratively anchor “popup” containers to another element.\nThis component’s name is inspired by <popup>. It uses Floating UI under the hood to provide a well-tested, lightweight, and fully declarative positioning utility for tooltips, dropdowns, and more.\n\nPopup doesn’t provide any styles — just positioning! The popup’s preferred placement, distance, and skidding (offset) can be configured using attributes. An arrow that points to the anchor can be shown and customized to your liking. Additional positioning options are available and described in more detail below.",
1005
+ "type": "text"
1006
+ },
1007
+ "title": {
1008
+ "value": "Popup",
1009
+ "type": "text"
1010
+ },
1011
+ "warning": {
1012
+ "value": "Popup is a low-level utility built specifically for positioning elements. Do not mistake it for a tooltip or similar because it does not facilitate an accessible experience! Almost every correct usage of <syn-popup> will involve building other components. It should rarely, if ever, occur directly in your HTML.\n\nFor all Figma Designers, please refer for this component in Storybook.",
1013
+ "type": "text"
1014
+ },
1015
+ "info": {
1016
+ "value": "A popup’s anchor should not be styled with display: contents since the coordinates will not be eligible for calculation. However, if the anchor is a <slot> element, popup will use the first assigned element as the anchor. This behavior allows other components to pass anchors through more easily via composition.",
1017
+ "type": "text"
1018
+ }
865
1019
  }
866
1020
  },
867
1021
  "progress-bar": {
@@ -1647,7 +1801,7 @@
1647
1801
  "type": "text"
1648
1802
  },
1649
1803
  "description": {
1650
- "value": "Use the horizontal attribute to indicate that an element is used in a horizontal navigation.(The example shows it in combination with the current attribute, to indicate the difference.)",
1804
+ "value": "Use the horizontal attribute to indicate that an element is used in a horizontal navigation. (The example shows it in combination with the current attribute, to indicate the difference.)",
1651
1805
  "type": "text"
1652
1806
  }
1653
1807
  },
@@ -1701,262 +1855,406 @@
1701
1855
  "type": "text"
1702
1856
  }
1703
1857
  }
1858
+ },
1859
+ "header": {
1860
+ "default": {
1861
+ "title": {
1862
+ "value": "Header",
1863
+ "type": "text"
1864
+ },
1865
+ "description": {
1866
+ "value": "The header is used to indicate the name of the app, provide important actions in a toolbar and a navigation.",
1867
+ "type": "text"
1868
+ }
1869
+ },
1870
+ "label": {
1871
+ "title": {
1872
+ "value": "Label",
1873
+ "type": "text"
1874
+ },
1875
+ "description": {
1876
+ "value": "Use the label attribute to change the app name.",
1877
+ "type": "text"
1878
+ }
1879
+ },
1880
+ "logo": {
1881
+ "title": {
1882
+ "value": "Logo",
1883
+ "type": "text"
1884
+ },
1885
+ "description": {
1886
+ "value": "Use the logo slot to change the app logo. Usually this is only needed in whitelabel solutions, when the SICK branding explicitly has to be hidden.",
1887
+ "type": "text"
1888
+ }
1889
+ },
1890
+ "focus": {
1891
+ "title": {
1892
+ "value": "Focus",
1893
+ "type": "text"
1894
+ },
1895
+ "description": {
1896
+ "value": "The focus event gives the user feedback that a link in the logo has been focused by the keyboard interaction and that the link is ready to be navigated to.",
1897
+ "type": "text"
1898
+ }
1899
+ },
1900
+ "options": {
1901
+ "title": {
1902
+ "value": "Meta Navigation",
1903
+ "type": "text"
1904
+ },
1905
+ "description": {
1906
+ "value": "Use the Meta Navigation slot to add additional functionalities to your application. Please be aware of the guidelines regarding the order of icons in the toolbar.\nImportant: The Options Menu doesn’t handle any responsive behaviour, e. g. if there is not enough space for all items in different screen sizes. You have to make sure yourself, that your app works correctly and e. g. move elements into the footer of the side navigation or inside a “more” button in the Options Menu.",
1907
+ "type": "text"
1908
+ }
1909
+ },
1910
+ "navigation": {
1911
+ "title": {
1912
+ "value": "Top Navigation",
1913
+ "type": "text"
1914
+ },
1915
+ "description": {
1916
+ "value": "Use the top navigation slot to add syn-navigation and horizontal syn-navigation-items.",
1917
+ "type": "text"
1918
+ }
1919
+ }
1704
1920
  }
1705
1921
  },
1706
- "frameworks": {
1707
- "angular": {
1922
+ "assets": {
1923
+ "sick-logo": {
1708
1924
  "description": {
1709
- "value": "Tips for using Essential in your Angular app.",
1925
+ "value": "The logo represents the company and forms the core of the brand identity. Therefore, the logo has a very special meaning in communication: It is always in a prominent position and retains its absolute independence in all applications. The logo is always used as original graphic. It may not be changed or translated.",
1710
1926
  "type": "text"
1711
1927
  },
1712
1928
  "title": {
1713
- "value": "Angular",
1929
+ "value": "SICK Logo",
1714
1930
  "type": "text"
1715
1931
  }
1716
1932
  },
1717
- "react": {
1933
+ "material-icons": {
1718
1934
  "description": {
1719
- "value": "Tips for using Essential in your React app.",
1935
+ "value": "Icons are small standard symbols that are primarily used in screen design. Due to their intended use, the icons must be recognizable min size of 16 x 16 pixels.\n\nIf you need to create a new icon, you have to follow the Material Icons Guide. Please also inform the Synergy design system team, so we can include this icon to prevent duplicates.",
1720
1936
  "type": "text"
1721
1937
  },
1722
1938
  "title": {
1723
- "value": "React",
1939
+ "value": "Material Icons",
1724
1940
  "type": "text"
1725
1941
  }
1726
1942
  },
1727
- "vue-2": {
1943
+ "system-icons": {
1728
1944
  "description": {
1729
- "value": "Tips for using Essential in your Vue 2 app.",
1945
+ "value": "The system-icons contain only a small subset of icons that are used internally by Synergy components.\nEach icon wraps the original icon in an own component.\nThe names are aligned with dev and could deviate from Material Icons.",
1730
1946
  "type": "text"
1731
1947
  },
1732
1948
  "title": {
1733
- "value": "Vue (version 2)",
1949
+ "value": "System Icons",
1950
+ "type": "text"
1951
+ }
1952
+ }
1953
+ },
1954
+ "tokens": {
1955
+ "border-radius": {
1956
+ "description": {
1957
+ "value": "Border radius tokens are used to give sharp edges a more subtle, rounded effect. In general, rounding in SICK user interfaces should be avoided and only used in carefully considered cases. The following points provide some guidance for when and how rounding may be appropriate.\n\nPurpose and usage:\n\nThe use of rounding in UI design should primarily serve a functional purpose, enhancing user experience and visual hierarchy.\nRounding should be applied judiciously, considering both aesthetic appeal and usability.\nRounding should only be applied to selected components where it enhances clarity, visual distinction, or interaction affordance.\nAvoid excessive rounding, which can compromise clarity and readability.\nRounding Tokens:\n\n4px: Suitable for compact elements typically nested within another element (e.g. tags within select component).\n8px: Ideal for container elements like cards, aiding in visually distinguishing multiple containers from one another.\nFull roundings: Reserved for status elements like badges, offering a distinct visual cue to draw attention.\n\nFor any questions or uncertainties, feel free to reach out to the team for clarification and support.",
1958
+ "type": "text"
1959
+ },
1960
+ "title": {
1961
+ "value": "Border radius",
1734
1962
  "type": "text"
1735
1963
  }
1736
1964
  },
1737
- "vue": {
1965
+ "border-width": {
1738
1966
  "description": {
1739
- "value": "Tips for using Essential in your Vue 3 app.",
1967
+ "value": "The border is primarily used to outline the frame of a component or to structure content. The border color varies depending on the component and context, but the width stays constant.",
1740
1968
  "type": "text"
1741
1969
  },
1742
1970
  "title": {
1743
- "value": "Vue",
1971
+ "value": "Border width",
1744
1972
  "type": "text"
1745
1973
  }
1746
- }
1747
- },
1748
- "getting-started": {
1749
- "customizing": {
1974
+ },
1975
+ "color": {
1750
1976
  "description": {
1751
- "value": "Learn how to customize Essential through parts and custom properties.",
1977
+ "value": "Color tokens help maintain consistent use of color throughout our products.",
1752
1978
  "type": "text"
1753
1979
  },
1754
1980
  "title": {
1755
- "value": "Customizing",
1981
+ "value": "Color Tokens",
1756
1982
  "type": "text"
1983
+ },
1984
+ "light": {
1985
+ "description": {
1986
+ "value": "Our light theme is the default theme for all applications",
1987
+ "type": "text"
1988
+ },
1989
+ "title": {
1990
+ "value": "Colors / light",
1991
+ "type": "text"
1992
+ }
1993
+ },
1994
+ "dark": {
1995
+ "description": {
1996
+ "value": "Use the dark theme as a low-light UI that displays mostly dark surfaces.",
1997
+ "type": "text"
1998
+ },
1999
+ "title": {
2000
+ "value": "Colors / dark",
2001
+ "type": "text"
2002
+ }
2003
+ },
2004
+ "semantic": {
2005
+ "description": {
2006
+ "value": "Semantic color information for general or specific components.",
2007
+ "type": "text"
2008
+ },
2009
+ "title": {
2010
+ "value": "Semantic colors",
2011
+ "type": "text"
2012
+ },
2013
+ "text": {
2014
+ "description": {
2015
+ "value": "Primary color used for text within the application",
2016
+ "type": "text"
2017
+ },
2018
+ "title": {
2019
+ "value": "Text colors",
2020
+ "type": "text"
2021
+ }
2022
+ }
1757
2023
  }
1758
2024
  },
1759
- "form-controls": {
2025
+ "shadow": {
1760
2026
  "description": {
1761
- "value": "Some things to note about Essential and forms.",
2027
+ "value": "Shadow and elevation tokens are used to give elements the appearance of being raised off the page.",
1762
2028
  "type": "text"
1763
2029
  },
1764
2030
  "title": {
1765
- "value": "Form Controls",
2031
+ "value": "Shadow and elevation",
1766
2032
  "type": "text"
1767
2033
  }
1768
2034
  },
1769
- "installation": {
2035
+ "spacing": {
1770
2036
  "description": {
1771
- "value": "Choose the installation method that works best for you.",
2037
+ "value": "Spacing tokens are used to provide consistent spacing between content in your app.",
1772
2038
  "type": "text"
1773
2039
  },
1774
2040
  "title": {
1775
- "value": "Installation",
2041
+ "value": "Spacing",
1776
2042
  "type": "text"
1777
2043
  }
1778
2044
  },
1779
- "localization": {
2045
+ "transition": {
1780
2046
  "description": {
1781
- "value": "Discover how to localize Essential with minimal effort.",
2047
+ "value": "Transition tokens are used to provide consistent transitions throughout our applications.",
1782
2048
  "type": "text"
1783
2049
  },
1784
2050
  "title": {
1785
- "value": "Localization",
2051
+ "value": "Transition Tokens",
1786
2052
  "type": "text"
1787
2053
  }
1788
2054
  },
1789
- "themes": {
2055
+ "typography": {
1790
2056
  "description": {
1791
- "value": "Everything you need to know about theming Essential.",
2057
+ "value": "Typography tokens are used to define typographic style of headings, body text, and UI components. They are used to maintain a consistent set of font styles throughout your app.",
1792
2058
  "type": "text"
1793
2059
  },
1794
2060
  "title": {
1795
- "value": "Themes",
2061
+ "value": "Typography",
1796
2062
  "type": "text"
2063
+ },
2064
+ "text-styles": {
2065
+ "description": {
2066
+ "value": "The Synergy text styles are made up of two categories to cover the range of different needs in designs: Headings and Body / UI text.\n\nUnless explicitly mentioned otherwise in a component, Synergy recommends using sentence case capitalization throughout your applications.",
2067
+ "type": "text"
2068
+ },
2069
+ "title": {
2070
+ "value": "Text styles",
2071
+ "type": "text"
2072
+ },
2073
+ "headings": {
2074
+ "description": {
2075
+ "value": "Heading styles come in a range of sizes, and can be used in a range of contexts, such as:\nbuilding page hierarchy,\nhelping users scan large chunks of text,\nproviding a title to a page or piece of content,\nas 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.",
2076
+ "type": "text"
2077
+ },
2078
+ "title": {
2079
+ "value": "Headings",
2080
+ "type": "text"
2081
+ }
2082
+ },
2083
+ "body": {
2084
+ "description": {
2085
+ "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.\nIt is also possible to format the text bold for certain text passages.",
2086
+ "type": "text"
2087
+ },
2088
+ "title": {
2089
+ "value": "Body and UI text",
2090
+ "type": "text"
2091
+ }
2092
+ }
2093
+ },
2094
+ "font-family": {
2095
+ "description": {
2096
+ "value": "Synergy uses the open source typeface Open Sans for all elements, but system fonts can also be used.",
2097
+ "type": "text"
2098
+ },
2099
+ "title": {
2100
+ "value": "Font family",
2101
+ "type": "text"
2102
+ }
1797
2103
  }
1798
2104
  },
1799
- "usage": {
2105
+ "z-index": {
1800
2106
  "description": {
1801
- "value": "Learn more about using custom elements.",
2107
+ "value": "Z-indexes are used to stack components in a logical manner.",
1802
2108
  "type": "text"
1803
2109
  },
1804
2110
  "title": {
1805
- "value": "Usage",
2111
+ "value": "Z-Index Tokens",
1806
2112
  "type": "text"
1807
2113
  }
1808
2114
  }
1809
2115
  },
1810
- "resources": {
1811
- "accessibility": {
2116
+ "frameworks": {
2117
+ "angular": {
1812
2118
  "description": {
1813
- "value": "Essential recognizes the need for all users to have undeterred access to the websites and applications that are created with it.",
2119
+ "value": "Tips for using Essential in your Angular app.",
1814
2120
  "type": "text"
1815
2121
  },
1816
2122
  "title": {
1817
- "value": "Accessibility Commitment",
2123
+ "value": "Angular",
1818
2124
  "type": "text"
1819
2125
  }
1820
2126
  },
1821
- "changelog": {
2127
+ "react": {
1822
2128
  "description": {
1823
- "value": "Changes to each version of the project are documented here.",
2129
+ "value": "Tips for using Essential in your React app.",
1824
2130
  "type": "text"
1825
2131
  },
1826
2132
  "title": {
1827
- "value": "Changelog",
2133
+ "value": "React",
1828
2134
  "type": "text"
1829
2135
  }
1830
2136
  },
1831
- "community": {
2137
+ "vue-2": {
1832
2138
  "description": {
1833
- "value": "Essential has a growing community of designers and developers that are building amazing things with web components.",
2139
+ "value": "Tips for using Essential in your Vue 2 app.",
1834
2140
  "type": "text"
1835
2141
  },
1836
2142
  "title": {
1837
- "value": "Community",
2143
+ "value": "Vue (version 2)",
1838
2144
  "type": "text"
1839
2145
  }
1840
2146
  },
1841
- "contributing": {
2147
+ "vue": {
1842
2148
  "description": {
1843
- "value": "Essential is an open source project, meaning everyone can use it and contribute to its development.",
2149
+ "value": "Tips for using Essential in your Vue 3 app.",
1844
2150
  "type": "text"
1845
2151
  },
1846
2152
  "title": {
1847
- "value": "Contributing",
2153
+ "value": "Vue",
1848
2154
  "type": "text"
1849
2155
  }
1850
2156
  }
1851
2157
  },
1852
- "tokens": {
1853
- "border-radius": {
2158
+ "getting-started": {
2159
+ "customizing": {
1854
2160
  "description": {
1855
- "value": "Border radius tokens are used to give sharp edges a more subtle, rounded effect.",
2161
+ "value": "Learn how to customize Essential through parts and custom properties.",
1856
2162
  "type": "text"
1857
2163
  },
1858
2164
  "title": {
1859
- "value": "Border Radius",
2165
+ "value": "Customizing",
1860
2166
  "type": "text"
1861
2167
  }
1862
2168
  },
1863
- "color": {
2169
+ "form-controls": {
1864
2170
  "description": {
1865
- "value": "Color tokens help maintain consistent use of color throughout your app.",
2171
+ "value": "Some things to note about Essential and forms.",
1866
2172
  "type": "text"
1867
2173
  },
1868
2174
  "title": {
1869
- "value": "Color Tokens",
2175
+ "value": "Form Controls",
1870
2176
  "type": "text"
1871
2177
  }
1872
2178
  },
1873
- "elevation": {
2179
+ "installation": {
1874
2180
  "description": {
1875
- "value": "Elevation tokens are used to give elements the appearance of being raised off the page.",
2181
+ "value": "Choose the installation method that works best for you.",
1876
2182
  "type": "text"
1877
2183
  },
1878
2184
  "title": {
1879
- "value": "Elevation",
2185
+ "value": "Installation",
1880
2186
  "type": "text"
1881
2187
  }
1882
2188
  },
1883
- "more": {
2189
+ "localization": {
1884
2190
  "description": {
1885
- "value": "Additional design tokens can be found here.",
2191
+ "value": "Discover how to localize Essential with minimal effort.",
1886
2192
  "type": "text"
1887
2193
  },
1888
2194
  "title": {
1889
- "value": "More Design Tokens",
2195
+ "value": "Localization",
1890
2196
  "type": "text"
1891
2197
  }
1892
2198
  },
1893
- "spacing": {
2199
+ "themes": {
1894
2200
  "description": {
1895
- "value": "Spacing tokens are used to provide consistent spacing between content in your app.",
2201
+ "value": "Everything you need to know about theming Essential.",
1896
2202
  "type": "text"
1897
2203
  },
1898
2204
  "title": {
1899
- "value": "Spacing Tokens",
2205
+ "value": "Themes",
1900
2206
  "type": "text"
1901
2207
  }
1902
2208
  },
1903
- "transition": {
2209
+ "usage": {
1904
2210
  "description": {
1905
- "value": "Transition tokens are used to provide consistent transitions throughout your app.",
2211
+ "value": "Learn more about using custom elements.",
1906
2212
  "type": "text"
1907
2213
  },
1908
2214
  "title": {
1909
- "value": "Transition Tokens",
2215
+ "value": "Usage",
2216
+ "type": "text"
2217
+ }
2218
+ }
2219
+ },
2220
+ "resources": {
2221
+ "accessibility": {
2222
+ "description": {
2223
+ "value": "Essential recognizes the need for all users to have undeterred access to the websites and applications that are created with it.",
2224
+ "type": "text"
2225
+ },
2226
+ "title": {
2227
+ "value": "Accessibility Commitment",
1910
2228
  "type": "text"
1911
2229
  }
1912
2230
  },
1913
- "typography": {
2231
+ "changelog": {
1914
2232
  "description": {
1915
- "value": "Typography tokens are used to define typographic style of headings, body text, and UI components. They are used to maintain a consistent set of font styles throughout your app.",
2233
+ "value": "Changes to each version of the project are documented here.",
1916
2234
  "type": "text"
1917
2235
  },
1918
2236
  "title": {
1919
- "value": "Typography",
2237
+ "value": "Changelog",
2238
+ "type": "text"
2239
+ }
2240
+ },
2241
+ "community": {
2242
+ "description": {
2243
+ "value": "Essential has a growing community of designers and developers that are building amazing things with web components.",
1920
2244
  "type": "text"
1921
2245
  },
1922
- "text-styles": {
1923
- "description": {
1924
- "value": "The Synergy text styles are made up of two categories to cover the range of different needs in designs: Headings and Body / UI text.\n\nUnless explicitly mentioned otherwise in a component, Synergy recommends using sentence case capitalization throughout your applications.",
1925
- "type": "text"
1926
- },
1927
- "title": {
1928
- "value": "Text styles",
1929
- "type": "text"
1930
- },
1931
- "headings": {
1932
- "description": {
1933
- "value": "Heading styles come in a range of sizes, and can be used in a range of contexts, such as:\nbuilding page hierarchy,\nhelping users scan large chunks of text,\nproviding a title to a page or piece of content,\nas 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.",
1934
- "type": "text"
1935
- },
1936
- "title": {
1937
- "value": "Headings",
1938
- "type": "text"
1939
- }
1940
- },
1941
- "body": {
1942
- "description": {
1943
- "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.\nIt is also possible to format the text bold for certain text passages.",
1944
- "type": "text"
1945
- },
1946
- "title": {
1947
- "value": "Body and UI text",
1948
- "type": "text"
1949
- }
1950
- }
2246
+ "title": {
2247
+ "value": "Community",
2248
+ "type": "text"
1951
2249
  }
1952
2250
  },
1953
- "z-index": {
2251
+ "contributing": {
1954
2252
  "description": {
1955
- "value": "Z-indexes are used to stack components in a logical manner.",
2253
+ "value": "Essential is an open source project, meaning everyone can use it and contribute to its development.",
1956
2254
  "type": "text"
1957
2255
  },
1958
2256
  "title": {
1959
- "value": "Z-Index Tokens",
2257
+ "value": "Contributing",
1960
2258
  "type": "text"
1961
2259
  }
1962
2260
  }
@@ -265,4 +265,4 @@
265
265
  }
266
266
  }
267
267
  }
268
- }
268
+ }
@@ -7,4 +7,4 @@
7
7
  }
8
8
  }
9
9
  }
10
- }
10
+ }