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
+98-4Lines changed: 98 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,14 +2,13 @@
2
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
3
</p>
4
4
<br />
5
-
<br />
6
-
<h1align="center">Lightning Design System UI Kit</h1>
5
+
<h1align="center"style="border-bottom:none;">Lightning Design System UI Kit</h1>
7
6
<palign="center">
8
-
A <ahref="https://www.sketchapp.com/">Sketch</a> file of components from <ahref="https://www.lightningdesignsystem.com">Lightning Design System</a>.
7
+
A Sketch document of <ahref="https://www.lightningdesignsystem.com">Lightning Design System</a> components.
9
8
</p>
10
-
<br />
11
9
<h3align="center"><ahref="https://github.com/salesforce-ux/design-system-ui-kit/archive/master.zip">» Download the latest version now «</a></h3>
12
10
<br />
11
+
<br />
13
12
14
13
----
15
14
@@ -30,20 +29,81 @@ Download the most recent version of [Sketch](https://www.sketchapp.com/).
30
29
**Welcome to the Summer ’18 Sketch Library document**
31
30
32
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 />
33
34
34
35
**Why use this file as a Sketch Library?**
35
36
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 />
37
40
38
41
**How to use this document as a Sketch Library in two quick steps**
39
42
40
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/` .
41
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.
<a target="_blank" href="https://user-images.githubusercontent.com/1750832/41114414-3895b92c-6a39-11e8-81b6-cac65b112737.png" title="With the SLDS Component Library file open in Sketch, select 'Add as Library' in the Sketch menu" >
50
+
<img src="https://user-images.githubusercontent.com/1750832/41114414-3895b92c-6a39-11e8-81b6-cac65b112737.png" alt="With the SLDS Component Library file open in Sketch, select 'Add as Library' in the Sketch menu" />
<a target="_blank" href="https://user-images.githubusercontent.com/1750832/41114420-3940e2d4-6a39-11e8-8a1c-dde608b0eb5b.png" title="You can see all of your Sketch Libraries in Sketch > Preferences > Libraries">
58
+
<img src="https://user-images.githubusercontent.com/1750832/41114420-3940e2d4-6a39-11e8-8a1c-dde608b0eb5b.png" alt="You can see all of your Sketch Libraries in Sketch > Preferences > Libraries" />
<a target="_blank" href="https://user-images.githubusercontent.com/1750832/41114423-3964d928-6a39-11e8-9ec1-4a532778670f.png" title="You'll see the SLDS Sketch Library symbols available under your symbols menu no matter what Sketch document you're working in.">
66
+
<img src="https://user-images.githubusercontent.com/1750832/41114423-3964d928-6a39-11e8-9ec1-4a532778670f.png" alt="You'll see the SLDS Sketch Library symbols available under your symbols menu no matter what Sketch document you're working in." />
You'll see the SLDS Sketch Library symbols available under your symbols menu no matter what Sketch document you're working in.
70
+
</span>
71
+
</td>
72
+
</tr>
73
+
</table>
74
+
<br />
75
+
<br />
76
+
43
77
**Artboards Everywhere**
44
78
45
79
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.
@@ -54,11 +114,39 @@ Most nested symbols are denoted in this document’s structure under the folders
54
114
55
115
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.
<a target="_blank" href="https://user-images.githubusercontent.com/1750832/41114415-38c15a64-6a39-11e8-8c71-bd6d1ceaad2a.png" title="The right side overrides section allows for the tab title and state to be customized" >
121
+
<img src="https://user-images.githubusercontent.com/1750832/41114415-38c15a64-6a39-11e8-8c71-bd6d1ceaad2a.png" alt="The right side overrides section allows for the tab title and state to be customized" />
Salesforce Lightning Design System uses design tokens as named entities that store visual design attributes. This Sketch document uses color symbols to mimic SLDS design tokens with color values. This allows the structure of a symbol to use the equivalent of a design token.
60
146
61
147
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.
148
+
<br />
149
+
<br />
62
150
63
151
## How to use the icon symbols
64
152
@@ -69,6 +157,8 @@ In symbols, like icons, that contain solid color backgrounds, you’ll find the
69
157
3.**Choose your icon glyph**. In Sketch’s right overrides panel, choose the icon glyph you’d like to use from the dropdown menu.
70
158
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.
71
159
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.
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.
@@ -95,6 +187,8 @@ Here are a few of the kinds of contributions we are looking for:
95
187
### Got something to add?
96
188
97
189
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.
0 commit comments