Skip to content

Commit 450fce9

Browse files
committed
Vale fixes, heading fixes, adding word to accept.txt
1 parent 9f6b862 commit 450fce9

File tree

2 files changed

+28
-41
lines changed

2 files changed

+28
-41
lines changed

.github/styles/config/vocabularies/Mautic/accept.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ CloudAMQP
2525
Codeception
2626
Codecov
2727
Company(ies)
28+
Composability
2829
Composer
2930
Config
3031
config

docs/design/utilities.rst

Lines changed: 27 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
Utilities
2-
=========
2+
#########
33

44
Introduction
5-
------------
5+
************
66

77
Mautic offers a set of CSS utility classes designed to facilitate efficient implementation of flexible layouts using CSS flex-box. These utilities provide a systematic approach to constructing responsive and dynamic new areas for its User interface, enabling you to rapidly prototype and build complex layouts while minimizing custom CSS.
88

@@ -16,47 +16,35 @@ The utility classes seek to encompass a great spectrum of flex-box properties, i
1616
- Item ordering
1717

1818
Key aspects
19-
^^^^^^^^^^^^
19+
***********
2020

2121
1. **Abbreviated Nomenclature**: class names follow a logical, short and easy-to-remember convention.
2222
2. **Most Common Uses Coverage**: utilities address the full range of flex-box properties and behaviors.
2323
3. **Responsive Design**: includes variations for different view port sizes, enabling fine-grained control over layout across devices.
24-
.. vale off
25-
2624
4. **Composability**: you can combine classes to create sophisticated layout patterns.
27-
28-
.. vale on
29-
3025
5. **Consistent Spacing**: standardized options for managing padding, margin and gap properties.
3126

3227
This documentation clearly explains each utility class, its function, and its app. It includes practical examples and best practices for combining utilities to achieve complex layout requirements.
3328

3429
The following sections detail the individual utility classes, their usage, and advanced implementation strategies. This resource helps front-end developers efficiently leverage flex-box in their projects.
3530

36-
3731
Abbreviation keys
38-
----------------
39-
40-
.. vale off
41-
42-
- **d**: display
43-
- **fd**: flex-direction
44-
- **fw**: flex-wrap
45-
- **jc**: justify-content
46-
- **ai**: align-items
47-
- **ac**: align-content
48-
- **as**: align-self
49-
- **fg**: flex-grow
50-
- **fs**: flex-shrink
51-
- **fb**: flex-basis
52-
- **fo**: order
53-
54-
.. vale on
32+
=================
33+
34+
- **``d``**: display
35+
- **``fd``**: flex-direction
36+
- **``fw``**: flex-wrap
37+
- **``jc``**: justify-content
38+
- **``ai``**: align-items
39+
- **``ac``**: align-content
40+
- **``as``**: align-self
41+
- **``fg``**: flex-grow
42+
- **``fs``**: flex-shrink
43+
- **``fb``**: flex-basis
44+
- **``fo``**: order
5545

5646
Flex container properties
57-
-------------------------
58-
59-
.. vale off
47+
=========================
6048

6149
- ``.d-flex``: Sets an element to be a flex container by setting its display property to flex. It allows the direct children of the element to be laid out in a flex context.
6250
- ``.fd-row``: Sets the direction of the flex items in the container to a row. The items are laid out from left to right.
@@ -106,8 +94,6 @@ Flex container properties
10694
- ``.gap-1``: Sets the gap between flex items to 1px.
10795
- ``.gap-0``: Sets the gap between flex items to 0px.
10896

109-
.. vale on
110-
11197
Responsive variations
11298
---------------------
11399

@@ -128,8 +114,8 @@ For example:
128114
This approach allows for progressive enhancement of layouts as the view-port size increases, providing fine-grained control over the responsiveness of your design.
129115

130116

131-
Usage examples
132-
--------------
117+
Responsive examples
118+
===================
133119

134120
Here are some example scenarios that illustrate how to use these utilities in practice:
135121

@@ -154,7 +140,7 @@ This example creates a flex container with items spread across the container and
154140
This example creates a vertical stack of items that stretch to fill the container's width, with a 10px gap between them.
155141

156142
Combining utilities
157-
-------------------
143+
===================
158144

159145
Note that you can combine these utilities to create complex layouts. For example:
160146

@@ -172,12 +158,12 @@ This combination creates a flex container that:
172158
- Has a 15px gap between items
173159

174160
Padding and margin utilities
175-
============================
161+
****************************
176162

177163
The CSS utility classes for padding and margin provide a comprehensive set of options for controlling spacing within your layouts. These utilities follow a consistent naming convention and offer a range of predefined sizes, including pixel values and variable-based spacing.
178164

179165
Naming convention
180-
-----------------
166+
=================
181167

182168
The utility classes use the following prefixes:
183169

@@ -193,7 +179,7 @@ The utility classes use the following prefixes:
193179
- ``ml-``: margin left
194180

195181
Size options
196-
------------
182+
============
197183

198184
The utilities offer the following size options:
199185

@@ -205,8 +191,8 @@ The utilities offer the following size options:
205191

206192
.. vale on
207193
208-
Usage examples
209-
--------------
194+
Padding and margin examples
195+
===========================
210196

211197
.. code-block:: html
212198

@@ -217,13 +203,13 @@ Usage examples
217203
<div class="mt-32 mb-32">Margin 32px on top and bottom</div>
218204

219205
Variable-based sizes
220-
--------------------
206+
====================
221207

222208
Some utilities use CSS variables for spacing, allowing for easy theming and consistent spacing across your app:
223209

224210
- ``var(--spacing-03)`` to ``var(--spacing-13)``
225211

226-
These correspond to specific pixel values (for example, ``var(--spacing-03)`` is 8px, ``var(--spacing-13)`` is 160px).
212+
These correspond to specific pixel values - for example, ``var(--spacing-03)`` is 8px, ``var(--spacing-13)`` is 160px.
227213

228214
.. note::
229215
All padding and margin utilities use the ``!important`` declaration to ensure they take precedence over other styles. Use these utilities judiciously to maintain the integrity of your CSS architecture.

0 commit comments

Comments
 (0)