Skip to content

Commit 92dd6e2

Browse files
author
Bogdan Plieshka
committed
MAGETWO-37920: Add documentation for Styles Library components
- CR changes
1 parent a181e4d commit 92dd6e2

File tree

4 files changed

+170
-22
lines changed

4 files changed

+170
-22
lines changed

lib/web/css/docs/components.html

Lines changed: 153 additions & 0 deletions
Large diffs are not rendered by default.

lib/web/css/docs/source/components.less

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,8 @@
44
// */
55

66
// # Components
7-
// It's ready made parts that can be reused in Storefront or Admin area.
8-
// Instead of lib mixins, they are generates CSS code and not included in code by default.
9-
// To use them, just include it as simply imports.
7+
// Components are complete ready-for-use parts both for Storefront or Admin area.
8+
// They are not mixins, but classes. To use them, include this file with @import.
109
//
1110
// ``` less
1211
// @import 'components/_component.less';
@@ -16,11 +15,11 @@
1615

1716
// ## Modals
1817
//
19-
// This component contains two kinds of modals, popups and slide panels.
20-
// ### Modal popups
21-
// Calling with class <code>.modal-popup</code>
22-
//<textarea class="preview-code" spellcheck="false">
23-
//<div class="modals-wrapper">
18+
// This component contains two kinds of modals: popups and slide panels.
19+
// ### Modal popups
20+
// To have a modal popup use <code>.modal-popup</code> class.
21+
// <textarea class="preview-code" spellcheck="false">
22+
// <div class="modals-wrapper">
2423
// <aside
2524
// class="modal-popup _show"
2625
// data-role="modal"
@@ -44,13 +43,13 @@
4443
// </div>
4544
// </aside>
4645
// <div class="modals-overlay"></div>
47-
//</div>
48-
//</textarea>
46+
// </div>
47+
// </textarea>
4948
//
50-
// ### Modal slide panels
51-
// Calling with class <code>.modal-slide</code>
52-
//<textarea class="preview-code" spellcheck="false">
53-
//<div class="modals-wrapper">
49+
// ### Modal slide panels
50+
// To have a modal slide panel use <code>.modal-slide</code> class.
51+
// <textarea class="preview-code" spellcheck="false">
52+
// <div class="modals-wrapper">
5453
// <aside
5554
// class="modal-slide _show"
5655
// data-role="modal"
@@ -74,8 +73,8 @@
7473
// </div>
7574
// </aside>
7675
// <div class="modals-overlay"></div>
77-
//</div>
78-
//</textarea>
76+
// </div>
77+
// </textarea>
7978

8079
// ### Variables
8180
// <pre>

lib/web/css/docs/source/variables.less

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -827,6 +827,7 @@
827827
// </pre>
828828
//
829829
// ## Structure
830+
// #### Predefined variables for handle global Z-axis positioning
830831
// <pre>
831832
// <table>
832833
// <tr>
@@ -835,9 +836,6 @@
835836
// <th class="vars_head">Allowed values</th></th>
836837
// </tr>
837838
// <tr>
838-
// <th colspan="3" class="vars_section">Predefined variables for handle global Z-axis positioning</th>
839-
// </tr>
840-
// <tr>
841839
// <th>@z-index-1</th>
842840
// <td class="vars_value">100</td>
843841
// <td class="vars_value">constant</td>

lib/web/css/docs/variables.html

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -830,16 +830,14 @@ <h4 id="the-codetypographyallcode-mixin-variables">The <code>.typography-all()</
830830
</pre>
831831

832832
<h2 id="structure">Structure</h2>
833+
<h4 id="predefined-variables-for-handle-global-zaxis-positioning">Predefined variables for handle global Z-axis positioning</h4>
833834
<pre>
834835
<table>
835836
<tr>
836837
<th class="vars_head">Variable</th>
837838
<th class="vars_head">Default value</th>
838839
<th class="vars_head">Allowed values</th></th>
839840
</tr>
840-
<tr>
841-
<th colspan="3" class="vars_section">Predefined variables for handle global Z-axis positioning</th>
842-
</tr>
843841
<tr>
844842
<th>@z-index-1</th>
845843
<td class="vars_value">100</td>

0 commit comments

Comments
 (0)