Skip to content

Commit 29b00e9

Browse files
committed
updated the H1 tags to H2
2 parents c5b3070 + 80482fd commit 29b00e9

5 files changed

Lines changed: 35 additions & 35 deletions

File tree

design/ux-patterns/branding.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Provide users with feedback as they interact with your plugin, this can be alert
1010
----------
1111
<br />
1212

13-
# Onboarding and branding
13+
## Onboarding and branding
1414

1515
When the user is interacting with the plugin for the first time for example in the onboarding or login screen, including the plugin logo will help the user identify the plugin in the future.
1616

@@ -20,7 +20,7 @@ When the user is interacting with the plugin for the first time for example in t
2020

2121
<br />
2222

23-
# Customized plugin UI
23+
## Customized plugin UI
2424

2525
Customizing the UI to include brand colors, will help users distinguish your plugin from native UI in XD.
2626

design/ux-patterns/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,17 +13,17 @@ UX Patterns will include UX requirements and/or UX best practices these will ens
1313

1414
<br />
1515

16-
# Documentation
16+
## Documentation
1717

18-
### Specs and UX Requirements
18+
#### Specs and UX Requirements
1919

20-
Requirements highlights key XD patterns all plugins need to follow to get approved by Adobe.
20+
Requirements highlight key XD patterns all plugins need to follow to get approved by Adobe.
2121

2222
![Example of specs and UX requirements](../ux-images/UX-Patterns-1-Specs.png)
2323

24-
### Best practices
24+
#### Best practices
2525

26-
Best practices provides recommendations on plugin usability and behavior, user feedback, privacy and interface guidelines.
26+
Best practices provide recommendations on plugin usability and behavior, user feedback, privacy, and interface guidelines.
2727

2828
![Example of a UX best practice](../ux-images/UX-Patterns-2-Best-Practices.png)
2929

design/ux-patterns/messaging.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Provide users with feedback as they interact with your plugin, this can be alert
1717
----------
1818
<br />
1919

20-
# Examples
20+
## Examples
2121

2222
![Operation failed to complete](../ux-images/Error-alert-example.png)
2323

@@ -41,14 +41,14 @@ Information dialog - if the plugin is unable to connect to the internet to compl
4141

4242
<br />
4343

44-
# Alerts
44+
## Alerts
4545

4646
**Use case**
4747
Use alert messaging whenever the plugin cannot perform the intended task, dialogs are persistent until dismissed
4848

4949
![Aler dialog requirements](../ux-images/Alert-Requirements.png)
5050

51-
### UX Requirements
51+
#### UX Requirements
5252

5353
**Header**
5454
Have a clear header that describes the error
@@ -61,13 +61,13 @@ Include at least one modal dismissal button to allow the user to dismiss/close t
6161

6262
![Alert Dialog Best Practices](../ux-images/Alert-Recommendations.png)
6363

64-
### Best practices
64+
#### Best practices
6565

6666
**Warning icon**
6767
To help communicate critical information for an error you can include a warning icon next to the header
6868

6969
**Help**
70-
If a plugin has a help page, consider adding it on the error modal dialog.
70+
If a plugin has a help page, consider adding it to the error modal dialog.
7171

7272
**Visual/tutorials**
7373
Provide image/GIF example as part of the dialog, to help users understand the actionable solution
@@ -77,14 +77,14 @@ In the alert messages use language that is easy to understand for the user.
7777

7878
<br />
7979

80-
# Success
80+
## Success
8181

8282
**Use case**
8383
Use success messaging whenever the plugin successfully completes a task and has no visual output on the canvas.
8484

8585
![Alert Success Dialog example](../ux-images/Alert-Requirements.png)
8686

87-
### UX Requirements
87+
#### UX Requirements
8888

8989
**Header**
9090
Have a clear header for the dialog.
@@ -97,14 +97,14 @@ Include at least one modal dismissal button to allow the user to dismiss/close t
9797

9898
<br />
9999

100-
# Output
100+
## Output
101101

102102
**Use case**
103103
If a plugin generates output that the user needs to complete a workflow, then the plugin needs to provide that information to the user.
104104

105105
![Plugin output example](../ux-images/Plugin-output.png)
106106

107-
### UX Requirements
107+
#### UX Requirements
108108

109109
**Plugin output**
110110
In use cases like these, the plugin output can be shown in the UI, copied onto the clipboard, populated on the document or generate a file.
@@ -117,14 +117,14 @@ Require users to go into the developer console to complete an action.
117117

118118
<br />
119119

120-
# Permission dialogs
120+
## Permission dialogs
121121

122122
**Use case**
123123
Use permission dialogs when being destructive or making modifications.
124124

125125
![Permission dialog example](../ux-images/Permission-dialog-example.png)
126126

127-
### UX Requirements
127+
#### UX Requirements
128128

129129
**Header**
130130
Have a clear header for the dialog.
@@ -140,17 +140,17 @@ Esc key or Enter key Dismisses the dialog when the “Cancel” button is in foc
140140

141141
<br />
142142

143-
# Loaders and Progress bars
143+
## Loaders and Progress bars
144144
Let the user know when something is happening in the background in the plugin UI.
145145

146-
### Determinate
146+
#### Determinate
147147
**Use case**
148148
Use case If the progress can be reflected on a loader.
149149

150150
![Determinate example](../ux-images/Determinate-loader-example.png)
151151

152152

153-
### Indeterminate
153+
#### Indeterminate
154154
**Use case**
155155
If the progress can’t be determined then provide a loader to let the user know something is loading.
156156

design/ux-patterns/modal-ux.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,13 @@ This section will have recommendations when using a Modal Dialog - Blocking UI.
1212

1313
<br />
1414

15-
# Specs and UX Requirements
15+
## Specs and UX Requirements
1616

17-
## MacOS example
17+
### MacOS example
1818

1919
![Modal Specs](../ux-images/Modal-UX-2-Specs.png)
2020

21-
## Specs
21+
### Specs
2222

2323
**Padding**
2424
The modal will have padding built-in (ex: MacOS modal will have a 40px padding). Additional padding shouldn’t be added.
@@ -27,7 +27,7 @@ The modal will have padding built-in (ex: MacOS modal will have a 40px padding).
2727
This is what the user can interact with before executing the plugin action.
2828

2929

30-
## UX Requirements
30+
### UX Requirements
3131

3232
**Header**
3333
Have a clear header for the dialog. e.g. “name of plugin”, “description of workflow”
@@ -37,32 +37,32 @@ Have a clear header for the dialog. e.g. “name of plugin”, “description of
3737
Include a modal dismissal button to allow the user to cancel/close the modal and a call to action button (blue) to highlight the primary action.
3838

3939

40-
## Best Practices
40+
### Best Practices
4141

4242
**Plugin Icon**.
4343
You can include a plugin icon to let the user know they are interacting with your plugin in the modal dialog
4444

4545
<br />
4646

47-
# Modal Dialog UI
47+
## Modal Dialog UI
4848

49-
## Modal dialog plugin UI
49+
### Modal dialog plugin UI
5050

5151
![Modal Dialog](../ux-images/Modal-UX-3-Modal-Dialog.png)
5252

53-
## Step process three buttons
53+
### Step process three buttons
5454

5555
![Step Process](../ux-images/Modal-UX-4-Step-Process.png)
5656

57-
## Step process loader
57+
### Step process loader
5858

5959
![Loader](../ux-images/Modal-UX-5-Loader.png)
6060

6161
<br />
6262

6363
# Dialog buttons and key commands
6464

65-
## Buttons
65+
### Buttons
6666

6767
![Buttons](../ux-images/Modal-UX-6-Buttons.png)
6868

@@ -79,7 +79,7 @@ The secondary button is for low emphasis. It is meant to be paired with other bu
7979
**Negative**
8080
The negative button is for high emphasis on negative or destructive actions. It should be used sparingly. It can be displayed either in standard style (visible stroke) or in quiet style.
8181

82-
## Best practice
82+
### Best practice
8383

8484
**Button Group Overflow**
8585
When horizontal space is limited, button groups stack vertically.
@@ -89,13 +89,13 @@ at the bottom.
8989
**Use 2 button styles maximum**
9090
The top-level action within a button group should be a call to action, primary, or negative button. The subsequent buttons should always be secondary buttons of the same style (standard or quiet). Don’t combine more than 2 button styles in a button group.
9191

92-
## Button labels
92+
### Button labels
9393

9494
Button labels should be clear about the intention of the action. Button text should be 1 to 2 words and consider the number of characters.
9595

9696
![Button labels](../ux-images/Modal-UX-7-Button-Labels.png)
9797

98-
## Key Commands
98+
### Key Commands
9999

100100
**Esc key**
101101
Dismisses the dialog. This is equivalent to choosing “Cancel”.

reference/uxp/class/WebSocket.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,5 +70,5 @@ Closes the websocket connection
7070
| Param | Type | Default | Description |
7171
| --- | --- | --- | --- |
7272
| [code] | `integer` | <code>1000</code> | A integer value as per https://developer.mozilla.org/en-US/docs/Web/API/WebSocket#close(). |
73-
| [reason] | `string` | <code>&quot;&quot;</code> | A human-readable string explaining why the connection is closing. Throws an exception of Error Object if invalid code or reason is passed Refer https://wiki.corp.adobe.com/pages/viewpage.action?pageId=1455687313#FileandNetworkI/OTestCases-CloseMethodbehaviorforWebSockets |
73+
| [reason] | `string` | <code>&quot;&quot;</code> | A human-readable string explaining why the connection is closing. Throws an exception of Error Object if invalid code or reason is passed |
7474

0 commit comments

Comments
 (0)