beathers 5.7.2 → 5.7.6

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/docs/colors.md CHANGED
@@ -1,250 +1,250 @@
1
- # Colors Documentation
2
-
3
- > Simple guide to using color utilities in Beathers CSS framework
4
-
5
- ## Table of Contents
6
-
7
- - [Text Colors](#text-colors)
8
- - [Background Colors](#background-colors)
9
- - [Border Colors](#border-colors)
10
- - [Color Opacity](#color-opacity)
11
- - [Special Utilities](#special-utilities)
12
-
13
- ---
14
-
15
- ## Text Colors
16
-
17
- ### Normal State
18
-
19
- ```html
20
- <p class="color-main">Main color text</p>
21
- <p class="color-primary">Primary color text</p>
22
- ```
23
-
24
- ### Pseudo State
25
-
26
- ```html
27
- <p class="color-main:hover">Hover text color</p>
28
- <p class="color-primary:focus">Focus text color</p>
29
-
30
- <input class="color-main:placeholder" placeholder="Placeholder color" />
31
- ```
32
-
33
- ### Current Color
34
-
35
- ```html
36
- <div class="color-primary">
37
- <span class="current-color">Inherits parent text color</span>
38
- </div>
39
- ```
40
-
41
- ### Dark/Light Mode
42
-
43
- ```html
44
- <!-- Context method -->
45
- <div class="light">
46
- <p class="color-main">Light theme text</p>
47
- </div>
48
-
49
- <!-- Direct method -->
50
- <p class="color-main light">Light text</p>
51
- <p class="color-main dark">Dark text</p>
52
-
53
- <!-- Utility-first -->
54
- <p class="light:color-main">Light only</p>
55
- <p class="dark:color-main">Dark only</p>
56
- ```
57
-
58
- ### CSS Integration
59
-
60
- ```css
61
- .custom-text {
62
- color: var(--color-main-light);
63
- }
64
- .dark .custom-text {
65
- color: var(--color-main-dark);
66
- }
67
- ```
68
-
69
- ### SCSS Integration
70
-
71
- ```scss
72
- @use 'beathers/scss/functions/colors' as colors;
73
-
74
- .custom-text {
75
- @include colors.useColor('main', color);
76
- }
77
- ```
78
-
79
- ---
80
-
81
- ## Background Colors
82
-
83
- ### Normal State
84
-
85
- ```html
86
- <div class="bg:color-main">Main background</div>
87
- <div class="bg:color-primary">Primary background</div>
88
- ```
89
-
90
- ### Pseudo State
91
-
92
- ```html
93
- <button class="bg:color-main:hover">Hover background</button>
94
- <input class="bg:color-primary:focus">Focus background</input>
95
- ```
96
-
97
- ### Current Color
98
-
99
- ```html
100
- <div class="color-primary">
101
- <span class="bg:current-color">Background matches text color</span>
102
- </div>
103
- ```
104
-
105
- ### Dark/Light Mode
106
-
107
- ```html
108
- <div class="bg:color-main light">Light background</div>
109
- <div class="bg:color-main dark">Dark background</div>
110
- <div class="light:bg:color-main">Light only background</div>
111
- ```
112
-
113
- ### CSS Integration
114
-
115
- ```css
116
- .custom-bg {
117
- background-color: var(--color-main-light);
118
- }
119
- .dark .custom-bg {
120
- background-color: var(--color-main-dark);
121
- }
122
- ```
123
-
124
- ### SCSS Integration
125
-
126
- ```scss
127
- @use 'beathers/scss/functions/colors' as colors;
128
-
129
- .custom-bg {
130
- @include colors.useColor('main', background-color);
131
- }
132
- ```
133
-
134
- ---
135
-
136
- ## Border Colors
137
-
138
- ### Normal State
139
-
140
- ```html
141
- <div class="border:color-main">Main border</div>
142
- <div class="border:color-primary">Primary border</div>
143
- ```
144
-
145
- ### Pseudo State
146
-
147
- ```html
148
- <input class="border:color-main:hover">Hover border</input>
149
- <input class="border:color-primary:focus">Focus border</input>
150
- ```
151
-
152
- ### Current Color
153
-
154
- ```html
155
- <div class="color-primary">
156
- <div class="border:current-color">Border matches text color</div>
157
- </div>
158
- ```
159
-
160
- ### Dark/Light Mode
161
-
162
- ```html
163
- <div class="border:color-main light">Light border</div>
164
- <div class="border:color-main dark">Dark border</div>
165
- <div class="light:border:color-main">Light only border</div>
166
- ```
167
-
168
- ### CSS Integration
169
-
170
- ```css
171
- .custom-border {
172
- border-color: var(--color-main-light);
173
- }
174
- .dark .custom-border {
175
- border-color: var(--color-main-dark);
176
- }
177
- ```
178
-
179
- ### SCSS Integration
180
-
181
- ```scss
182
- @use 'beathers/scss/functions/colors' as colors;
183
-
184
- .custom-border {
185
- @include colors.useColor('main', border-color);
186
- }
187
- ```
188
-
189
- ---
190
-
191
- ## Color Opacity
192
-
193
- ### Normal State
194
-
195
- ```html
196
- <p class="color-main:25">25% opacity text</p>
197
- <div class="bg:color-primary:50">50% opacity background</div>
198
- <div class="border:color-main:70">70% opacity border</div>
199
- ```
200
-
201
- ### Pseudo State
202
-
203
- ```html
204
- <p class="color-main:50:hover">Hover with opacity</p>
205
- <button class="bg:color-primary:25:focus">Focus with opacity</button>
206
- ```
207
-
208
- ### Dark/Light Mode
209
-
210
- ```html
211
- <p class="color-main:50 light">Light theme with opacity</p>
212
- <p class="dark:color-main:25">Dark theme with opacity</p>
213
- ```
214
-
215
- ### CSS Integration
216
-
217
- ```css
218
- .custom-opacity {
219
- color: rgba(var(--color-main-light-rgb), 0.5);
220
- }
221
- ```
222
-
223
- ### SCSS Integration
224
-
225
- ```scss
226
- @use 'beathers/scss/functions/colors' as colors;
227
-
228
- .custom-opacity {
229
- @include colors.useColor('main', color, 50);
230
- }
231
- ```
232
-
233
- ---
234
-
235
- ## Special Utilities
236
-
237
- ### Fill & Stroke (SVG)
238
-
239
- ```html
240
- <svg class="fill:color-main">SVG with main fill</svg>
241
- <svg class="stroke:color-primary">SVG with primary stroke</svg>
242
- <svg class="fill:color-main:hover">Hover fill color</svg>
243
- ```
244
-
245
- ### Text Stroke
246
-
247
- ```html
248
- <h1 class="text-stroke:color-main">Text with stroke</h1>
249
- <h2 class="text-stroke:color-primary:50">50% opacity stroke</h2>
250
- ```
1
+ # Colors Documentation
2
+
3
+ > Simple guide to using color utilities in Beathers CSS framework
4
+
5
+ ## Table of Contents
6
+
7
+ - [Text Colors](#text-colors)
8
+ - [Background Colors](#background-colors)
9
+ - [Border Colors](#border-colors)
10
+ - [Color Opacity](#color-opacity)
11
+ - [Special Utilities](#special-utilities)
12
+
13
+ ---
14
+
15
+ ## Text Colors
16
+
17
+ ### Normal State
18
+
19
+ ```html
20
+ <p class="color-main">Main color text</p>
21
+ <p class="color-primary">Primary color text</p>
22
+ ```
23
+
24
+ ### Pseudo State
25
+
26
+ ```html
27
+ <p class="color-main:hover">Hover text color</p>
28
+ <p class="color-primary:focus">Focus text color</p>
29
+
30
+ <input class="color-main:placeholder" placeholder="Placeholder color" />
31
+ ```
32
+
33
+ ### Current Color
34
+
35
+ ```html
36
+ <div class="color-primary">
37
+ <span class="current-color">Inherits parent text color</span>
38
+ </div>
39
+ ```
40
+
41
+ ### Dark/Light Mode
42
+
43
+ ```html
44
+ <!-- Context method -->
45
+ <div class="light">
46
+ <p class="color-main">Light theme text</p>
47
+ </div>
48
+
49
+ <!-- Direct method -->
50
+ <p class="color-main light">Light text</p>
51
+ <p class="color-main dark">Dark text</p>
52
+
53
+ <!-- Utility-first -->
54
+ <p class="light:color-main">Light only</p>
55
+ <p class="dark:color-main">Dark only</p>
56
+ ```
57
+
58
+ ### CSS Integration
59
+
60
+ ```css
61
+ .custom-text {
62
+ color: var(--color-main-light);
63
+ }
64
+ .dark .custom-text {
65
+ color: var(--color-main-dark);
66
+ }
67
+ ```
68
+
69
+ ### SCSS Integration
70
+
71
+ ```scss
72
+ @use 'beathers/scss/functions/colors' as colors;
73
+
74
+ .custom-text {
75
+ @include colors.useColor('main', color);
76
+ }
77
+ ```
78
+
79
+ ---
80
+
81
+ ## Background Colors
82
+
83
+ ### Normal State
84
+
85
+ ```html
86
+ <div class="bg:color-main">Main background</div>
87
+ <div class="bg:color-primary">Primary background</div>
88
+ ```
89
+
90
+ ### Pseudo State
91
+
92
+ ```html
93
+ <button class="bg:color-main:hover">Hover background</button>
94
+ <input class="bg:color-primary:focus">Focus background</input>
95
+ ```
96
+
97
+ ### Current Color
98
+
99
+ ```html
100
+ <div class="color-primary">
101
+ <span class="bg:current-color">Background matches text color</span>
102
+ </div>
103
+ ```
104
+
105
+ ### Dark/Light Mode
106
+
107
+ ```html
108
+ <div class="bg:color-main light">Light background</div>
109
+ <div class="bg:color-main dark">Dark background</div>
110
+ <div class="light:bg:color-main">Light only background</div>
111
+ ```
112
+
113
+ ### CSS Integration
114
+
115
+ ```css
116
+ .custom-bg {
117
+ background-color: var(--color-main-light);
118
+ }
119
+ .dark .custom-bg {
120
+ background-color: var(--color-main-dark);
121
+ }
122
+ ```
123
+
124
+ ### SCSS Integration
125
+
126
+ ```scss
127
+ @use 'beathers/scss/functions/colors' as colors;
128
+
129
+ .custom-bg {
130
+ @include colors.useColor('main', background-color);
131
+ }
132
+ ```
133
+
134
+ ---
135
+
136
+ ## Border Colors
137
+
138
+ ### Normal State
139
+
140
+ ```html
141
+ <div class="border:color-main">Main border</div>
142
+ <div class="border:color-primary">Primary border</div>
143
+ ```
144
+
145
+ ### Pseudo State
146
+
147
+ ```html
148
+ <input class="border:color-main:hover">Hover border</input>
149
+ <input class="border:color-primary:focus">Focus border</input>
150
+ ```
151
+
152
+ ### Current Color
153
+
154
+ ```html
155
+ <div class="color-primary">
156
+ <div class="border:current-color">Border matches text color</div>
157
+ </div>
158
+ ```
159
+
160
+ ### Dark/Light Mode
161
+
162
+ ```html
163
+ <div class="border:color-main light">Light border</div>
164
+ <div class="border:color-main dark">Dark border</div>
165
+ <div class="light:border:color-main">Light only border</div>
166
+ ```
167
+
168
+ ### CSS Integration
169
+
170
+ ```css
171
+ .custom-border {
172
+ border-color: var(--color-main-light);
173
+ }
174
+ .dark .custom-border {
175
+ border-color: var(--color-main-dark);
176
+ }
177
+ ```
178
+
179
+ ### SCSS Integration
180
+
181
+ ```scss
182
+ @use 'beathers/scss/functions/colors' as colors;
183
+
184
+ .custom-border {
185
+ @include colors.useColor('main', border-color);
186
+ }
187
+ ```
188
+
189
+ ---
190
+
191
+ ## Color Opacity
192
+
193
+ ### Normal State
194
+
195
+ ```html
196
+ <p class="color-main:25">25% opacity text</p>
197
+ <div class="bg:color-primary:50">50% opacity background</div>
198
+ <div class="border:color-main:70">70% opacity border</div>
199
+ ```
200
+
201
+ ### Pseudo State
202
+
203
+ ```html
204
+ <p class="color-main:50:hover">Hover with opacity</p>
205
+ <button class="bg:color-primary:25:focus">Focus with opacity</button>
206
+ ```
207
+
208
+ ### Dark/Light Mode
209
+
210
+ ```html
211
+ <p class="color-main:50 light">Light theme with opacity</p>
212
+ <p class="dark:color-main:25">Dark theme with opacity</p>
213
+ ```
214
+
215
+ ### CSS Integration
216
+
217
+ ```css
218
+ .custom-opacity {
219
+ color: rgba(var(--color-main-light-rgb), 0.5);
220
+ }
221
+ ```
222
+
223
+ ### SCSS Integration
224
+
225
+ ```scss
226
+ @use 'beathers/scss/functions/colors' as colors;
227
+
228
+ .custom-opacity {
229
+ @include colors.useColor('main', color, 50);
230
+ }
231
+ ```
232
+
233
+ ---
234
+
235
+ ## Special Utilities
236
+
237
+ ### Fill & Stroke (SVG)
238
+
239
+ ```html
240
+ <svg class="fill:color-main">SVG with main fill</svg>
241
+ <svg class="stroke:color-primary">SVG with primary stroke</svg>
242
+ <svg class="fill:color-main:hover">Hover fill color</svg>
243
+ ```
244
+
245
+ ### Text Stroke
246
+
247
+ ```html
248
+ <h1 class="text-stroke:color-main">Text with stroke</h1>
249
+ <h2 class="text-stroke:color-primary:50">50% opacity stroke</h2>
250
+ ```