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 Oct 1, 2024. It is now read-only.
Copy file name to clipboardExpand all lines: app/docs/css.md
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
Undernet's CSS is the backbone of the framework. It's written in a module format and precompiled using Sass.
1
+
Undernet's CSS is the backbone of the framework. It's written in a module format with [Sass](https://sass-lang.com/).
2
2
3
3
The framework adopts a few conventions which help provide a predictable workflow.
4
4
@@ -16,21 +16,21 @@ Variables, functions, mixins, and classes each follow patterns to provide better
16
16
17
17
### Variables
18
18
19
-
All Sass variables have names with a pattern of: `grouping-noun-property-value-state`. `grouping` is the only piece consistent in every variable, with a combination of the rest, and always in the same order.
19
+
All Sass variables have names with a pattern of: `grouping-noun-value-state`. `grouping` is the only piece consistent in every variable, with a combination of the rest, and always in the same order.
-`$link-text-decoration-hover`: Grouping = `link`; Noun = `text-decoration`; State = `hover`
27
+
-`$modal-dialog-margin-narrow`: Grouping = `modal-dialog`; Noun = `margin`; State = `narrow`
28
28
29
-
See the variables available in `_config.scss`.
29
+
See the variables available in `_config.scss`, organized from global to component-specific.
30
30
31
31
### Functions
32
32
33
-
There are only a handful of functions. Each is written as `noun-value`. A function name always describes the thing it returns. E.g., `spacing-value` takes a size, such as `xs` or `lg`, and returns the value from the `$global-spacing-increments` map.
33
+
There are only a handful of functions. Each is written as `noun-value`. Each function name always describes the thing it returns. E.g., `spacing-value` takes a size, such as `xs` or `lg`, and returns the value from the `$global-spacing-increments` map.
34
34
35
35
See the functions available in `utilities/_functions.scss`.
36
36
@@ -45,11 +45,11 @@ See the mixins available in `utilities/_mixins.scss`.
45
45
Classes are a bit more unique compared to variables or other Sass utilities. Classes take one of two flavors, a **Root** or a **Modifier**. They are named using a pattern similar to that of Sass variables.
46
46
47
47
- Root classes use nouns.
48
-
- Modifier classes have the structure `verb-breakpoint-property-value-size`. A verb prefix is _always_ present. E.g., `is-*`, or `has-*`.
48
+
- Modifier classes have the structure `verb-breakpoint-noun-value-size`. A verb prefix is _always_ present. E.g., `is-*`, or `has-*`.
49
49
50
50
#### Roots
51
51
52
-
As explained, a Root class describes an object, so it's a noun.
52
+
As explained, a Root class describes an object, e.g. a noun.
53
53
54
54
Examples include `dropdown-menu`, `button`, or `grid`.
55
55
@@ -67,7 +67,7 @@ Here's a few examples:
67
67
68
68
## Style Scope
69
69
70
-
Undernet has a special feature that helps you control where its styles are applied. When enabled, a scope will enforce that a pre-defined class exists around any elements using framework styling.
70
+
Undernet has a special feature that helps you control where its styles are applied. When enabled, a scope will enforce that an element with a pre-defined class exists around any HTML in the document using framework styling.
0 commit comments