You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Nov 3, 2023. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+94-11Lines changed: 94 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,17 +1,14 @@
1
-
<h1align="center">Lightning Design System UI Kit</h1>
2
-
3
1
<palign="center">
4
-
<ahref="https://github.com/salesforce-ux/design-system-ui-kit/archive/master.zip"><imgsrc="https://cloud.githubusercontent.com/assets/85783/15560157/af4a1abc-229d-11e6-9a3d-6c3f4b81220b.png"alt="Design System UI Kit" /></a>
5
-
<br />
6
-
<br />
7
-
A <ahref="https://www.sketchapp.com/">Sketch</a> file of common design patterns from the <ahref="https://www.lightningdesignsystem.com">Lightning Design System</a>.
2
+
<ahref="https://github.com/salesforce-ux/design-system-ui-kit/archive/master.zip"><imgsrc="https://user-images.githubusercontent.com/1750832/41082861-8013ecba-69e4-11e8-8149-7eaa94825b19.png"alt="Design System UI Kit" /></a>
3
+
</p>
8
4
<br />
5
+
<h1align="center"style="border-bottom:none;">Lightning Design System UI Kit</h1>
6
+
<palign="center">
7
+
A Sketch document of <ahref="https://www.lightningdesignsystem.com">Lightning Design System</a> components.
9
8
</p>
10
-
<h3align="center"><ahref="https://github.com/salesforce-ux/design-system-ui-kit/archive/master.zip">» Download the latest version «</a></h3>
9
+
<h3align="center"><ahref="https://github.com/salesforce-ux/design-system-ui-kit/archive/master.zip">» Download the latest version now «</a></h3>
@@ -27,7 +24,86 @@ Download the most recent version of [Sketch](https://www.sketchapp.com/).
27
24
2. Find the fonts located in the `/assets/fonts` directory
28
25
3. Install the fonts on your system
29
26
30
-
----
27
+
## Getting Started
28
+
29
+
**Welcome to the Summer ’18 Sketch Library document**
30
+
31
+
The Salesforce UX team has made quite a few changes to this document since the last release. We made optimizations so you can more efficiently create Salesforce Lightning interfaces. In the instructions below, we’ll cover the basics and some tips for you to get started with this Sketch Library document. You can still use this document just like you have in previous releases, but the Salesforce UX team believes this file is best used as a Sketch Library. What does that mean and why should you use it that way? We’ll answer those questions below.
32
+
<br />
33
+
<br />
34
+
35
+
**Why use this file as a Sketch Library?**
36
+
37
+
Sketch has released a feature that allowed any Sketch file’s symbols to be accessed and used across all of your Sketch documents. They called this feature Sketch Libraries. You can now have all SLDS components available from Sketch’s symbols menu in any file you open. Another powerful feature is that Sketch Libraries will automatically update your designs when the Library is updated. Your designs will never be out of date if they’re linked to this Sketch Library document.
38
+
<br />
39
+
<br />
40
+
41
+
**How to use this document as a Sketch Library in two quick steps**
42
+
43
+
1.**Save this file to your local computer**. To use this as a Sketch Library, first you’ll need to place this document somewhere permanent. Try saving it to, `Users/[YourName]/Documents/SLDS/` .
44
+
2.**“Add as Library” in the Sketch menu**. Next you’ll want to open the SLDS Component Library document and select `File > Add as Library` . Boom! Now you’re all set. All SLDS components are available in your Sketch Symbols menu to use in any Sketch document you work in. You can close SLDS Component Library document.
45
+
46
+
47
+
<br />
48
+
<br />
49
+
50
+
**Artboards Everywhere**
51
+
52
+
Another big change we’ve made with this Sketch Library document is we moved all components to their own artboards. This makes finding the component symbol you want to use a breeze by mapping the lightningdesignsystem.com website’s menu, which you should be familiar with, to match the left hand artboard menu in Sketch.
Sketch Symbols allow you to use and reuse a self-contained design element across a Sketch document. Any changes made to a symbol will update across your whole document. It’s really handy! Nested symbols allow for even more customization, without breaking the symbol from its source, by adding symbols in symbols. Nested symbols are used throughout this Sketch file so that you can customize your designs as much as possible without detaching your Symbol.
62
+
63
+
There is a backlog of SLDS component symbols that are not yet nested, but we’re actively working on getting 100% of symbols in a place where you can customize them without detaching. Once a symbol is detached, then you won’t receive automatic updates when a new SLDS Component Library document is released.
64
+
65
+
Most nested symbols are denoted in this document’s structure under the folders called “z-embedded”. You should never need to add a symbol from those folders. Please ignore them. They contain symbols that are nested in the parent component symbol.
66
+
67
+
To see nested symbols in action, add a symbol from the SLDS Component Library to your Sketch document. In Sketch’s right side panel you’ll see all the symbol overrides or customizations you can make to that symbol without having to detach it and keeping the automatic update feature in tact.
68
+
69
+
70
+
71
+
<br />
72
+
<br />
73
+
74
+
**Color Token Symbols**
75
+
76
+
Salesforce Lightning Design System uses design tokens as named entities that store visual design attributes. This Sketch document uses color symbols to mimic [Lightning Design System design tokens](https://www.lightningdesignsystem.com/design-tokens/) with color values. This allows the structure of a symbol to use the equivalent of a design token.
77
+
78
+
In symbols, like icons, that contain solid color backgrounds, you’ll find the background is a mask which reveals the color symbol as if it was a shape fill. This allows us to easily make file-wide changes to colors when new visual styles are introduced in SLDS. Instead of changing fill colors in hundreds of shapes in this document, we can just update a color symbol or point the shape to another color symbol.
79
+
<br />
80
+
<br />
81
+
82
+
## How to use the icon symbols
83
+
84
+
**Across Salesforce, you'll frequently see [Lightning Design System icons](https://www.lightningdesignsystem.com/icons/). We’ve constructed them to be easily used individually and as nested symbols. The steps below cover how to place icon symbols individually.**
85
+
86
+
1.**Choose an icon type**. SLDS has four types of icons. Utility icons are used for everything except Salesforce object icons. Utility icons are what you’ll want to use 95% of the time. Action icons are primarily used in mobile applications. Custom icons are to be used for custom Salesforce objects. Standard icons are used for standard Salesforce objects.
87
+
2.**Place your icon type symbol**. Once you’ve chosen the type of icon you’d like to use (Utility, right?) place that symbol where you’d like in your Sketch document.
88
+
3.**Choose your icon glyph**. In Sketch’s right overrides panel, choose the icon glyph you’d like to use from the dropdown menu.
89
+
4.**(Optional) Choose an icon glyph color**. In Sketch’s right overrides panel, choose the icon glyph color you’d like to use from the dropdown menu.
90
+
5.**(Optional, for Action, Custom and Standard Icon Types) Choose an icon background color**. In Sketch’s right overrides panel, choose the icon background color you’d like to use from the dropdown menu.
91
+
<br />
92
+
<br />
93
+
94
+
## Recommended Sketch Plugins
95
+
96
+
**Paddy**
97
+
98
+
Paddy allows you to add automated padding and spacing for Sketch layers. Paddy is used throughout this Sketch document. It is not required, but is extremely helpful when adding text overrides in a symbol and having the symbol adjust to your customization with perfect padding and spacing without having to detach the symbol from this Sketch Library.
99
+
https://github.com/DWilliames/paddy-sketch-plugin
100
+
101
+
**Runner**
102
+
103
+
Sketch Runner helps you to get around Sketch quicker by giving you an intuitive interface to run commands directly from your keyboard. Runner allows you to skip Sketch navigation, buttons or menus and quickly type the action you want to take like, “insert desktop tab” to add a tab component symbol to your artboard.
@@ -42,7 +118,14 @@ Here are a few of the kinds of contributions we are looking for:
42
118
### Got something to add?
43
119
44
120
Great! Please take a look at our [contribution guidelines](https://github.com/salesforce-ux/design-system-ui-kit/blob/master/CONTRIBUTING.md) for instructions on how to proceed.
121
+
<br />
122
+
<br />
45
123
46
124
## License
47
125
48
126
All icons and images are licensed under [Creative Commons Attribution-NoDerivatives 4.0](https://github.com/salesforce-ux/licenses/blob/master/LICENSE-icons-images.txt)
127
+
<br />
128
+
<br />
129
+
<palign="center">
130
+
<ahref="https://github.com/salesforce-ux/design-system-ui-kit/archive/master.zip"><imgsrc="https://user-images.githubusercontent.com/1750832/41082860-7ffe3c1c-69e4-11e8-9b0f-813cf9be1395.png"alt="Design System UI Kit" /></a>
0 commit comments