Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

Commit 0001ade

Browse files
Merge pull request #5668 from magento/5248-ol-list-prefix-3
Fixed ordered list prefix (MD029) - Group 3
2 parents 4adccc5 + 52b7b76 commit 0001ade

File tree

14 files changed

+166
-165
lines changed

14 files changed

+166
-165
lines changed

guides/v2.2/pattern-library/containers/slideouts-modals-overlays/slideouts-modals-overalys.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,12 @@ _Example of panel animation_
3232

3333
The active panel should include the following elements:
3434

35-
* Content container (Panel)
36-
* A Page title
37-
* Close control "×" (ESC-key via keyboard)
38-
* Button bar for actions, including a "Cancel" (ESC-key is Cancel via keyboard)
39-
* Page content
40-
* "Shade" to disable lower level page
35+
* Content container (Panel)
36+
* A Page title
37+
* Close control "×" (ESC-key via keyboard)
38+
* Button bar for actions, including a "Cancel" (ESC-key is Cancel via keyboard)
39+
* Page content
40+
* "Shade" to disable lower level page
4141

4242
![Example of active panel positioned over "parent"](img/slideout-panel2.png)
4343

@@ -82,7 +82,7 @@ If the form in slide-in panel creates new entities, or changes existing ones (Cr
8282
Clicking that button will:
8383

8484
1. Validate the form in Slideout. If form has errors, it will show the error messages following the Error Messaging Pattern. If no errors found, it will:
85-
2. Close the Slideout and apply changes immediately (entity will be created in the database, for example).
85+
1. Close the Slideout and apply changes immediately (entity will be created in the database, for example).
8686

8787
### Extend Form
8888

@@ -91,7 +91,7 @@ Clicking that button will:
9191
If the Slideout panel is a part of the form, extending it (like Advanced Inventory, or Advanced Pricing), primary action should be labeled as "Done". Clicking it will:
9292

9393
1. Validate the form in Slideout. If form has errors, it will show the error messages following the Error Messaging Pattern. If no errors found, it will:
94-
2. Close the Slideout and save the contents of its form. User still has to click "Save" button on the main form to apply changes.
94+
1. Close the Slideout and save the contents of its form. User still has to click "Save" button on the main form to apply changes.
9595

9696
Clicking "Cancel" or clicking "×" or clicking outside of the panel (passive close) in both cases should reset contents of the current level Slideout form to default state.
9797
If user made changes to a form, he is presented with the modal window to confirm Cancellation:
@@ -133,12 +133,12 @@ _Example of a Confirmation Modal_
133133

134134
The active modal should include the following elements:
135135

136-
* Content container (Modal Window)
137-
* A Title
138-
* Close control "×" (ESC-key via keyboard)
139-
* Page content
140-
* Call to action(s), including "Cancel" (ESC-key is Cancel via keyboard)
141-
* "Shade" to disable lower level page
136+
* Content container (Modal Window)
137+
* A Title
138+
* Close control "×" (ESC-key via keyboard)
139+
* Page content
140+
* Call to action(s), including "Cancel" (ESC-key is Cancel via keyboard)
141+
* "Shade" to disable lower level page
142142

143143
### Cancel and Close controls
144144

@@ -168,10 +168,10 @@ _Sample of progress bar in modal_
168168

169169
Modal windows are implemented by the following Magento [jQuery](https://glossary.magento.com/jquery) widgets:
170170

171-
* [modal]({{ page.baseurl }}/javascript-dev-guide/widgets/widget_modal.html)
172-
* [alert]({{ page.baseurl }}/javascript-dev-guide/widgets/widget_alert.html) (extends modal)
173-
* [confirm]({{ page.baseurl }}/javascript-dev-guide/widgets/widget_confirm.html) (extends modal)
174-
* [prompt]({{ page.baseurl }}/javascript-dev-guide/widgets/widget_prompt.html) (extends modal)
171+
* [modal]({{ page.baseurl }}/javascript-dev-guide/widgets/widget_modal.html)
172+
* [alert]({{ page.baseurl }}/javascript-dev-guide/widgets/widget_alert.html) (extends modal)
173+
* [confirm]({{ page.baseurl }}/javascript-dev-guide/widgets/widget_confirm.html) (extends modal)
174+
* [prompt]({{ page.baseurl }}/javascript-dev-guide/widgets/widget_prompt.html) (extends modal)
175175

176176
## Overlays
177177

@@ -223,8 +223,8 @@ _Data-table with Confirmation Message_
223223

224224
## Assets
225225

226-
* [Download Slide-out Panels PSD source](src/Slide-out-Panels.psd)
227-
* [Download Modal PSD source](src/Modal.psd)
226+
* [Download Slide-out Panels PSD source](src/Slide-out-Panels.psd)
227+
* [Download Modal PSD source](src/Modal.psd)
228228

229229
## Technical Implementation
230230

guides/v2.2/pattern-library/controls/Expandable_Sections/expand-collapse.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -17,48 +17,48 @@ Required fields should not be located within a collapsed section, as this increa
1717

1818
### Position and dimensions
1919

20-
* Expandable sections can exist with or without a left sidebar.
21-
* A level 1 expandable section has 24px top padding and 30px bottom padding of the section title.
22-
* Level 2, 3, and 4 expandable sections have 18px top and bottom padding of the section title. Each expandable sub-section is indented by 40px.
20+
* Expandable sections can exist with or without a left sidebar.
21+
* A level 1 expandable section has 24px top padding and 30px bottom padding of the section title.
22+
* Level 2, 3, and 4 expandable sections have 18px top and bottom padding of the section title. Each expandable sub-section is indented by 40px.
2323

2424
![Specs](img/specs.png)
2525

26-
* If the expandable section belongs to a [layout](https://glossary.magento.com/layout) with a sidebar, and the content area contains forms, then the form field starts at the 7th column for level 2 and at 8th column for levels 3 and 4.
27-
* The content areas in the expandable section have 30px padding at the top and bottom. _The current design proposal accommodates 4 levels of nested expandable sections._
26+
* If the expandable section belongs to a [layout](https://glossary.magento.com/layout) with a sidebar, and the content area contains forms, then the form field starts at the 7th column for level 2 and at 8th column for levels 3 and 4.
27+
* The content areas in the expandable section have 30px padding at the top and bottom. _The current design proposal accommodates 4 levels of nested expandable sections._
2828

2929
### Visual appearance
3030

31-
* A simple expandable section is a container with a border, section header, and a toggle arrow (right aligned) to control the showing and hiding of content.
31+
* A simple expandable section is a container with a border, section header, and a toggle arrow (right aligned) to control the showing and hiding of content.
3232

3333
![Simple expandable section](img/simple.png)
3434

35-
* A nested expandable section is a sub-section within an expandable section. The nested expandable section has all the same features as the "simple" expandable section, however the expand and collapse control is located on the left. This is to help the User more easily identify the expandable sub-sections within an expanded section.
35+
* A nested expandable section is a sub-section within an expandable section. The nested expandable section has all the same features as the "simple" expandable section, however the expand and collapse control is located on the left. This is to help the User more easily identify the expandable sub-sections within an expanded section.
3636

3737
![Nested section](img/nested.png)
3838

39-
* When expanded, the control (chevron symbol) points upward, and it points downward when closed or collapsed. This indicates the direction the section will expand or collapse when clicked.
39+
* When expanded, the control (chevron symbol) points upward, and it points downward when closed or collapsed. This indicates the direction the section will expand or collapse when clicked.
4040

41-
* The section deader title font size is 17px semibold.
41+
* The section deader title font size is 17px semibold.
4242

4343
## Functional behavior
4444

45-
* Expandable sections should expand to become visible when the heading or toggle arrow is clicked.
46-
* Several expandable sections can be kept open at the same time.
47-
* When a page contains several expandable sections, all sections remain collapsed by default.
48-
* Once the user expands or collapses a few panels, the system remembers the panels states and on a return visit the same states are displayed.
49-
* For nested panels, if a section is collapsed, all "nested" expandable sections within that section should be collapsed as well.
45+
* Expandable sections should expand to become visible when the heading or toggle arrow is clicked.
46+
* Several expandable sections can be kept open at the same time.
47+
* When a page contains several expandable sections, all sections remain collapsed by default.
48+
* Once the user expands or collapses a few panels, the system remembers the panels states and on a return visit the same states are displayed.
49+
* For nested panels, if a section is collapsed, all "nested" expandable sections within that section should be collapsed as well.
5050

5151
## Variations
5252

5353
1. Simple – section that contains a single level of expansion in a section (no nested expandable sub-sections).
5454

5555
![Simple section](img/simple_exp.png)
5656

57-
2. Nested – section that contains one or more expandable sub-sections.
57+
1. Nested – section that contains one or more expandable sub-sections.
5858

5959
![Nested section](img/nested_exp.png)
6060

61-
3. Single expandable – section that contains only one expandable section; usually used to hide additional information.
61+
1. Single expandable – section that contains only one expandable section; usually used to hide additional information.
6262

6363
![Single expandable section](img/single_exp.png)
6464

guides/v2.2/pattern-library/controls/button-bar/button-bar.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -8,27 +8,27 @@ For solutions not described in this article, please refer to other related patte
88

99
## When to Use
1010

11-
* When page level actions are necessary.
11+
* When page level actions are necessary.
1212

1313
## When Not to Use
1414

15-
* When there is already a button bar.
16-
* When there is a wizard bar.
17-
* When buttons are needed but they are not page level buttons.
15+
* When there is already a button bar.
16+
* When there is a wizard bar.
17+
* When buttons are needed but they are not page level buttons.
1818

1919
## Rules
2020

2121
### General Rules
2222

23-
* Only one button bar is allowed per page.
24-
* Either use a button bar or a wizard bar. Both cannot be on the page.
25-
* The buttons within the button bar must be one of the page-level buttons from [buttons pattern](../buttons/buttons.html).
26-
* All the buttons in button bar should be visible at all time.
23+
* Only one button bar is allowed per page.
24+
* Either use a button bar or a wizard bar. Both cannot be on the page.
25+
* The buttons within the button bar must be one of the page-level buttons from [buttons pattern](../buttons/buttons.html).
26+
* All the buttons in button bar should be visible at all time.
2727

2828
### Location
2929

30-
* Button bar can be used in a page or a slide-in panel.
31-
* Its location in either scenario must be right below the page title or the slide-in panel title.
30+
* Button bar can be used in a page or a slide-in panel.
31+
* Its location in either scenario must be right below the page title or the slide-in panel title.
3232

3333
#### Button Bar Position in Page
3434

@@ -40,18 +40,18 @@ For solutions not described in this article, please refer to other related patte
4040

4141
### Page Level Button Order and Priority - General Rules
4242

43-
* There should never be more than one primary page level button on a single page.
44-
* Primary page level buttons should always be placed on the far right of the button order.
45-
* If a Back button is present, it should always fall on the far left of the button order.
46-
* Buttons should be ordered by group as specified below. In situations where button groups do not apply, they should be ordered by importance.
43+
* There should never be more than one primary page level button on a single page.
44+
* Primary page level buttons should always be placed on the far right of the button order.
45+
* If a Back button is present, it should always fall on the far left of the button order.
46+
* Buttons should be ordered by group as specified below. In situations where button groups do not apply, they should be ordered by importance.
4747

4848
### Ordering of Button Bar
4949

5050
Page level buttons can be logically grouped as follows:
5151

52-
* Regress
53-
* Remove
54-
* Progress
52+
* Regress
53+
* Remove
54+
* Progress
5555

5656
Groups can contain multiple CTAs but only one primary CTA. Groups should follow the below order:
5757

@@ -72,7 +72,7 @@ All buttons should be right aligned. The button bar is spread across 12 columns
7272
## Recommendation
7373

7474
1. It is recommended that all buttons in button bar should only be in one line. Because the button bar is in fluid grid, it is possible for the buttons to be wrap around to the next line.
75-
2. If you have multiple page-level buttons. We recommend using the split button rather having too many buttons that will clutter the page.
75+
1. If you have multiple page-level buttons. We recommend using the split button rather having too many buttons that will clutter the page.
7676

7777
![](img/button-bar-with-splitbutton.jpg)
7878

guides/v2.2/pattern-library/displaying-data/tree/tree.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -82,9 +82,9 @@ Icons should always be placed on the left of the icon label and Icons should NOT
8282

8383
Select All is the default state for tree with multi select functionality. When this functionality is triggered:
8484

85-
* All checkboxes are checked
86-
* Complete tree DOESN’T highlight
87-
* "Select All" link changes to "Clear All".
85+
* All checkboxes are checked
86+
* Complete tree DOESN’T highlight
87+
* "Select All" link changes to "Clear All".
8888

8989
When Clear All functionality is triggered – All the checkboxes are deselected. The "Clear All" link is only shown when everything is selected.
9090

@@ -96,25 +96,25 @@ _Note:_ The "Expand All/Collapse All" control can appear simultaneously with the
9696

9797
#### Select Indicators
9898

99-
* Partial Selection – this appears when a parent has items BOTH in checked and unchecked states. Partial selection only occurs at anchor level
100-
* Unchecked State – Item not selected and can be clicked for selection
101-
* Checked State – item selected and can be unchecked for de-selection
102-
* Unchecked and Inactive – this state appears when the item is unselected and not active
103-
* Checked and Inactive – this state appears when the item is selected and not active.
99+
* Partial Selection – this appears when a parent has items BOTH in checked and unchecked states. Partial selection only occurs at anchor level
100+
* Unchecked State – Item not selected and can be clicked for selection
101+
* Checked State – item selected and can be unchecked for de-selection
102+
* Unchecked and Inactive – this state appears when the item is unselected and not active
103+
* Checked and Inactive – this state appears when the item is selected and not active.
104104

105105
![](img/states.jpg)
106106

107107
*3. Checking a checkbox for a child item should automatically change its parent state to:*
108108

109-
* Partially selected – if parent also contains unchecked children
110-
* Checked – if all checkboxes for all children are in "checked" state
111-
* Unchecked – if all children are in "unchecked" state.
109+
* Partially selected – if parent also contains unchecked children
110+
* Checked – if all checkboxes for all children are in "checked" state
111+
* Unchecked – if all children are in "unchecked" state.
112112

113113
*4. Checking a checkbox for a Parent item should automatically change its child state to:*
114114

115-
* Checked – if the parent state is changed from "unchecked" to "checked" state
116-
* Unchecked – if the parent state is changed from "checked" to "unchecked" state
117-
* Partial Selection – if parent has a partial selection state, clicking on it will deselect all the child items.
115+
* Checked – if the parent state is changed from "unchecked" to "checked" state
116+
* Unchecked – if the parent state is changed from "checked" to "unchecked" state
117+
* Partial Selection – if parent has a partial selection state, clicking on it will deselect all the child items.
118118

119119
## Drag and Arrange
120120

@@ -172,7 +172,7 @@ The 'Add' triggers should be placed above the tree container area. (Note: the ou
172172
There are two types of items that can be added:
173173

174174
1. *A Group item* This is the parent item, which means there can be children. Example: a folder for the media [library](https://glossary.magento.com/library) or a new [category](https://glossary.magento.com/category). The group item can also be added to another parent group. This allows for n-level tree.
175-
2. *An item* This is the child. Example: a media item or a sub-category. The child item will be added to whichever parent is selected or to the same parent as sibling.
175+
1. *An item* This is the child. Example: a media item or a sub-category. The child item will be added to whichever parent is selected or to the same parent as sibling.
176176

177177
The "add child" button should always have more importance than the "add parent" button.
178178

guides/v2.2/pattern-library/feedbackToUser/progressIndicator/progressIndicator.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,18 @@ The use of progress indicator should follow this guideline.
88

99
## When to Use
1010

11-
* Use when needing to provide feedback to the user that a process is running, especially when user initiate the process.
12-
* When a percentage of completion can be shown and the process , use a progress bar.
13-
* When a percentage of completion cannot be shown or the process is relatively short, use a spinner.
11+
* Use when needing to provide feedback to the user that a process is running, especially when user initiate the process.
12+
* When a percentage of completion can be shown and the process , use a progress bar.
13+
* When a percentage of completion cannot be shown or the process is relatively short, use a spinner.
1414

1515
## When Not to Use
1616

17-
* When process' progress communicates well enough on its own.
18-
* When process completes so quickly that it is distracting to show progress. If the task takes less than 500ms.
19-
* When the process waits for the user to complete the task.
20-
* When the user doesn't need to know something is happening
21-
* When the process operates in the background and doesn't block user activity, progress indicator can be used but is not necessary.
22-
* When you can use content from the operation to visualize progress.
17+
* When process' progress communicates well enough on its own.
18+
* When process completes so quickly that it is distracting to show progress. If the task takes less than 500ms.
19+
* When the process waits for the user to complete the task.
20+
* When the user doesn't need to know something is happening
21+
* When the process operates in the background and doesn't block user activity, progress indicator can be used but is not necessary.
22+
* When you can use content from the operation to visualize progress.
2323

2424
## Behavior
2525

@@ -32,8 +32,8 @@ Spinner is a gif image.
3232
![](img/Spinner-lg.gif)
3333

3434
1. Process is triggered
35-
2. Show spinner - To avoid flickering, if a process generally takes 2 seconds to complete, but can be completed under 500ms. Delay 500ms before showing the spinner.
36-
3. Once process is completed, the spinner disappear along with other indicative elements depending on the context.
35+
1. Show spinner - To avoid flickering, if a process generally takes 2 seconds to complete, but can be completed under 500ms. Delay 500ms before showing the spinner.
36+
1. Once process is completed, the spinner disappear along with other indicative elements depending on the context.
3737

3838
### Progress Bar
3939

@@ -47,19 +47,19 @@ In general, it is not recommended to use the progress bar if the process can be
4747

4848
This process trigger is what the user tell system to start process. It can be anything depending on the context such as a button or a drop action.
4949

50-
2. **Starting State**
50+
1. **Starting State**
5151

5252
![](img/progressbar-starting-state.png)
5353

54-
3. **Progressing**
54+
1. **Progressing**
5555

5656
![](img/progressbar-progressing.png)
5757

58-
4. **Success**
58+
1. **Success**
5959

6060
Once success, the page should refresh to show success status. The success status and behavior will depend on context of the scenario. (ie. open new page, stay on the same page, success message, etc.)
6161

62-
5. **Failed**
62+
1. **Failed**
6363

6464
The progress bar will disappeared and is replaced with this error message.
6565

guides/v2.2/pattern-library/getting-user-input/image_uploader/image_uploader.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ This pattern should be used specifically to upload images, and not to upload doc
1515
## Variations
1616

1717
1. Upload Single Image
18-
2. Upload Multiple Images
19-
3. Upload Video Content
18+
1. Upload Multiple Images
19+
1. Upload Video Content
2020

2121
## Behavior
2222

0 commit comments

Comments
 (0)