-
Notifications
You must be signed in to change notification settings - Fork 239
/
Copy pathguide.md
445 lines (346 loc) · 11.4 KB
/
guide.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
---
layout: has_navigation
title: Sass Basics
introduction: >
Before you can use Sass, you need to set it up on your project. If you want to
just browse here, go ahead, but we recommend you go install Sass first. [Go
here](/install) if you want to learn how to get everything set up.
navigation: |
<h3>Topics</h3>
<nav class="sl-c-list-navigation-wrapper">
- [Preprocessing](#preprocessing)
- [Variables](#variables)
- [Nesting](#nesting)
- [Partials](#partials)
- [Modules](#modules)
- [Mixins](#mixins)
- [Inheritance](#inheritance)
- [Operators](#operators)
</nav>
---
<section id="preprocessing">
{%- # retain older link -%}
<span id="topic-1"></span>
## Preprocessing
CSS on its own can be fun, but stylesheets are getting larger, more complex, and
harder to maintain. This is where a preprocessor can help. Sass has features
that don't exist in CSS yet like nesting, mixins, inheritance, and other nifty
goodies that help you write robust, maintainable CSS.
Once you start tinkering with Sass, it will take your preprocessed Sass file and
save it as a normal CSS file that you can use in your website.
The most direct way to make this happen is in your terminal. Once Sass is
installed, you can compile your Sass to CSS using the `sass` command. You'll
need to tell Sass which file to build from, and where to output CSS to. For
example, running `sass input.scss output.css` from your terminal would take a
single Sass file, `input.scss`, and compile that file to `output.css`.
You can also watch individual files or directories with the `--watch` flag. The
watch flag tells Sass to watch your source files for changes, and re-compile CSS
each time you save your Sass. If you wanted to watch (instead of manually build)
your `input.scss` file, you'd just add the watch flag to your command, like so:
```shellsession
sass --watch input.scss output.css
```
You can watch and output to directories by using folder paths as your input and
output, and separating them with a colon. In this example:
```shellsession
sass --watch app/sass:public/stylesheets
```
Sass would watch all files in the `app/sass` folder for changes, and compile CSS
to the `public/stylesheets` folder.
{% funFact %}
Sass has two syntaxes! The SCSS syntax (`.scss`) is used most commonly. It's
a superset of CSS, which means all valid CSS is also valid SCSS. The
indented syntax (`.sass`) is more unusual: it uses indentation rather than
curly braces to nest statements, and newlines instead of semicolons to
separate them. All our examples are available in both syntaxes.
{% endfunFact %}
</section>
<hr>
<section id="variables">
{%- # retain older link -%}
<span id="topic-2"></span>
## Variables
Think of variables as a way to store information that you want to reuse
throughout your stylesheet. You can store things like colors, font stacks, or
any CSS value you think you'll want to reuse. Sass uses the `$` symbol to make
something a variable. Here's an example:
{% codeExample 'variables' %}
$font-stack: Helvetica, sans-serif;
$primary-color: #333;
body {
font: 100% $font-stack;
color: $primary-color;
}
===
$font-stack: Helvetica, sans-serif
$primary-color: #333
body
font: 100% $font-stack
color: $primary-color
{% endcodeExample %}
When the Sass is processed, it takes the variables we define for the
`$font-stack` and `$primary-color` and outputs normal CSS with our variable
values placed in the CSS. This can be extremely powerful when working with brand
colors and keeping them consistent throughout the site.
</section>
<hr>
<section id="nesting">
{%- # retain older link -%}
<span id="topic-3"></span>
## Nesting
When writing HTML you've probably noticed that it has a clear nested and visual
hierarchy. CSS, on the other hand, doesn't.
Sass will let you nest your CSS selectors in a way that follows the same visual
hierarchy of your HTML. Be aware that overly nested rules will result in
over-qualified CSS that could prove hard to maintain and is generally considered
bad practice.
With that in mind, here's an example of some typical styles for a site's
navigation:
{% codeExample 'nesting' %}
nav {
ul {
margin: 0;
padding: 0;
list-style: none;
}
li { display: inline-block; }
a {
display: block;
padding: 6px 12px;
text-decoration: none;
}
}
===
nav
ul
margin: 0
padding: 0
list-style: none
li
display: inline-block
a
display: block
padding: 6px 12px
text-decoration: none
{% endcodeExample %}
You'll notice that the `ul`, `li`, and `a` selectors are nested inside the `nav`
selector. This is a great way to organize your CSS and make it more readable.
</section>
<hr>
<section id="partials">
{%- # retain older link -%}
<span id="topic-4"></span>
## Partials
You can create partial Sass files that contain little snippets of CSS that you
can include in other Sass files. This is a great way to modularize your CSS and
help keep things easier to maintain. A partial is a Sass file named with a
leading underscore. You might name it something like `_partial.scss`. The
underscore lets Sass know that the file is only a partial file and that it
should not be generated into a CSS file. Sass partials are used with the `@use`
rule.
</section>
<hr>
<section id="modules">
{%- # retain older link -%}
<span id="topic-5"></span>
## Modules
{% render 'doc_snippets/module-system-status' %}
You don't have to write all your Sass in a single file. You can split it up
however you want with the `@use` rule. This rule loads another Sass file as a
*module*, which means you can refer to its variables, [mixins][], and
[functions][] in your Sass file with a namespace based on the filename. Using a
file will also include the CSS it generates in your compiled output!
[mixins]: #mixins
[functions]: /documentation/at-rules/function
{% codeExample 'modules' %}
// _base.scss
$font-stack: Helvetica, sans-serif;
$primary-color: #333;
body {
font: 100% $font-stack;
color: $primary-color;
}
---
// styles.scss
@use 'base';
.inverse {
background-color: base.$primary-color;
color: white;
}
===
// _base.sass
$font-stack: Helvetica, sans-serif
$primary-color: #333
body
font: 100% $font-stack
color: $primary-color
---
// styles.sass
@use 'base'
.inverse
background-color: base.$primary-color
color: white
===
body {
font: 100% Helvetica, sans-serif;
color: #333;
}
.inverse {
background-color: #333;
color: white;
}
{% endcodeExample %}
Notice we're using `@use 'base';` in the `styles.scss` file. When you use a file
you don't need to include the file extension. Sass is smart and will figure it
out for you.
</section>
<hr>
<section id="mixins">
{%- # retain older link -%}
<span id="topic-6"></span>
## Mixins
Some things in CSS are a bit tedious to write, especially with CSS3 and the many
vendor prefixes that exist. A mixin lets you make groups of CSS declarations
that you want to reuse throughout your site. It helps keep your Sass very DRY.
You can even pass in values to make your mixin more flexible. Here's an example
for `theme`.
{% codeExample 'mixins' %}
@mixin theme($theme: DarkGray) {
background: $theme;
box-shadow: 0 0 1px rgba($theme, .25);
color: #fff;
}
.info {
@include theme;
}
.alert {
@include theme($theme: DarkRed);
}
.success {
@include theme($theme: DarkGreen);
}
===
@mixin theme($theme: DarkGray)
background: $theme
box-shadow: 0 0 1px rgba($theme, .25)
color: #fff
.info
@include theme
.alert
@include theme($theme: DarkRed)
.success
@include theme($theme: DarkGreen)
{% endcodeExample %}
To create a mixin you use the `@mixin` directive and give it a name. We've named
our mixin `theme`. We're also using the variable `$theme` inside the parentheses
so we can pass in a `theme` of whatever we want. After you create your mixin,
you can then use it as a CSS declaration starting with `@include` followed by
the name of the mixin.
</section>
<hr>
<section id="inheritance">
{%- # retain older link -%}
<span id="topic-7"></span>
## Extend/Inheritance
Using `@extend` lets you share a set of CSS properties from one selector to
another. In our example we're going to create a simple series of messaging for
errors, warnings and successes using another feature which goes hand in hand
with extend, placeholder classes. A placeholder class is a special type of class
that only prints when it is extended, and can help keep your compiled CSS neat
and clean.
{% codeExample 'extend-inheritance' %}
/* This CSS will print because %message-shared is extended. */
%message-shared {
border: 1px solid #ccc;
padding: 10px;
color: #333;
}
// This CSS won't print because %equal-heights is never extended.
%equal-heights {
display: flex;
flex-wrap: wrap;
}
.message {
@extend %message-shared;
}
.success {
@extend %message-shared;
border-color: green;
}
.error {
@extend %message-shared;
border-color: red;
}
.warning {
@extend %message-shared;
border-color: yellow;
}
===
/* This CSS will print because %message-shared is extended. */
%message-shared
border: 1px solid #ccc
padding: 10px
color: #333
// This CSS won't print because %equal-heights is never extended.
%equal-heights
display: flex
flex-wrap: wrap
.message
@extend %message-shared
.success
@extend %message-shared
border-color: green
.error
@extend %message-shared
border-color: red
.warning
@extend %message-shared
border-color: yellow
{% endcodeExample %}
What the above code does is tells `.message`, `.success`, `.error`, and
`.warning` to behave just like `%message-shared`. That means anywhere that
`%message-shared` shows up, `.message`, `.success`, `.error`, & `.warning` will
too. The magic happens in the generated CSS, where each of these classes will
get the same CSS properties as `%message-shared`. This helps you avoid having to
write multiple class names on HTML elements.
You can extend most simple CSS selectors in addition to placeholder classes in
Sass, but using placeholders is the easiest way to make sure you aren't
extending a class that's nested elsewhere in your styles, which can result in
unintended selectors in your CSS.
Note that the CSS in `%equal-heights` isn't generated, because `%equal-heights`
is never extended.
</section>
<hr>
<section id="operators">
{%- # retain older link -%}
<span id="topic-8"></span>
## Operators
Doing math in your CSS is very helpful. Sass has a handful of standard math
operators like `+`, `-`, `*`, `math.div()`, and `%`. In our example we're going
to do some simple math to calculate widths for an `article` and `aside`.
{% codeExample 'operators' %}
@use "sass:math";
.container {
display: flex;
}
article[role="main"] {
width: math.div(600px, 960px) * 100%;
}
aside[role="complementary"] {
width: math.div(300px, 960px) * 100%;
margin-left: auto;
}
===
@use "sass:math"
.container
display: flex
article[role="main"]
width: math.div(600px, 960px) * 100%
aside[role="complementary"]
width: math.div(300px, 960px) * 100%
margin-left: auto
{% endcodeExample %}
We've created a very simple fluid grid, based on 960px. Operations in Sass let
us do something like take pixel values and convert them to percentages without
much hassle.
</section>