summaryrefslogtreecommitdiff
path: root/doc/development/ux_guide
diff options
context:
space:
mode:
authorHazel <hazel@gitlab.com>2017-10-17 14:30:50 +0800
committerHazel <hazel@gitlab.com>2017-10-17 14:30:50 +0800
commit4a289e1168c239b03fd386b5c6ca1aa9963849ae (patch)
tree15e2822cdc1221ef71974db866406213cf088c10 /doc/development/ux_guide
parentaeeefe28fbc6f27b200c5c1b15c5f6b5d946f3e8 (diff)
downloadgitlab-ce-4a289e1168c239b03fd386b5c6ca1aa9963849ae.tar.gz
Updated the content and added the images
Diffstat (limited to 'doc/development/ux_guide')
-rw-r--r--doc/development/ux_guide/components.md23
-rw-r--r--doc/development/ux_guide/img/modals-general-confimation-dialog.pngbin0 -> 55006 bytes
-rw-r--r--doc/development/ux_guide/img/modals-layout-for-modals.pngbin0 -> 71731 bytes
-rw-r--r--doc/development/ux_guide/img/modals-special-confimation-dialog.pngbin0 -> 94366 bytes
-rw-r--r--doc/development/ux_guide/img/modals-three-buttons-special.pngbin0 -> 59942 bytes
-rw-r--r--doc/development/ux_guide/img/modals-three-buttons.pngbin0 -> 55863 bytes
6 files changed, 12 insertions, 11 deletions
diff --git a/doc/development/ux_guide/components.md b/doc/development/ux_guide/components.md
index 2bcee69201b..a31d8cfb443 100644
--- a/doc/development/ux_guide/components.md
+++ b/doc/development/ux_guide/components.md
@@ -10,6 +10,7 @@
* [Tables](#tables)
* [Blocks](#blocks)
* [Panels](#panels)
+* [Dialog modals](#dialog-modals)
* [Alerts](#alerts)
* [Forms](#forms)
* [Search box](#search-box)
@@ -255,31 +256,31 @@ Skeleton loading can replace any existing UI elements for the period in which th
---
## Dialog modals
-Dialog modals are only used for having a conversation and confirmation with the user. The user is not able to access the features on the main page until making an action. Using dialog modals sparingly as it is interruptive.
+Dialog modals are only used for having a conversation and confirmation with the user. The user is not able to access the features on the main page until closing the modal.
### Usage
-* When the action is irreversible, we should provide the details and confirm with the user before they take an advanced action.
-* When the action will affect privacy or authorization, we should provide the advanced information and confirm with the user.
+* When the action is irreversible, dialog modals provide the details and confirm with the user before they take an advanced action.
+* When the action will affect privacy or authorization, dialog modals provide the advanced information and confirm with the user.
### Style
-* Dialog modals contain the header title, content, and action bar.
-* Having an affirmative action, a dismissive action, and an extra action in action bar.
-* The order of actions in the action bar: (Right to left) Affirmative action → Extra action → Dismissive action
+
+* Dialog modals contain the header, body, and actions.
+ * **Actions:** Contains a affirmative action, a dismissive action, and an extra action. The order of actions from right to left: Affirmative action → Extra action → Dismissive action
+ * **Header:** The header title is a question instead of a descriptive phrase.
+ * **Body:** The content in body should never be ambiguous and unclear. It provides specific information.
* Confirmations regarding labels should keep labeling styling.
* References to commits, branches, and tags should be **monospaced**.
-### Writing
-* The header title is a question instead of a descriptive phrase.
-* The content should not be ambiguous and unclear. It should provide specific information as a reference for the user to take an advanced action.
+![layout-modal](img/modals-layout-for-modals.png)
### Placement
+
* Dialog modals should always be the center of the screen horizontally and have **72px** from the top of the screen.
| Dialog with 2 actions | Dialog with 3 actions | Special confirmation |
| --------------------- | --------------------- | -------------------- |
-| ![two-actions]() | ![three-actions]() | ![spcial-confirmation]() |
-
+| ![two-actions](img/modals-general-confimation-dialog.png) | ![three-actions](img/modals-three-buttons-special.png) | ![spcial-confirmation](img/modals-special-confimation-dialog.png) |
---
diff --git a/doc/development/ux_guide/img/modals-general-confimation-dialog.png b/doc/development/ux_guide/img/modals-general-confimation-dialog.png
new file mode 100644
index 00000000000..8e51cb70c48
--- /dev/null
+++ b/doc/development/ux_guide/img/modals-general-confimation-dialog.png
Binary files differ
diff --git a/doc/development/ux_guide/img/modals-layout-for-modals.png b/doc/development/ux_guide/img/modals-layout-for-modals.png
new file mode 100644
index 00000000000..71ea52be124
--- /dev/null
+++ b/doc/development/ux_guide/img/modals-layout-for-modals.png
Binary files differ
diff --git a/doc/development/ux_guide/img/modals-special-confimation-dialog.png b/doc/development/ux_guide/img/modals-special-confimation-dialog.png
new file mode 100644
index 00000000000..ebdcae25e76
--- /dev/null
+++ b/doc/development/ux_guide/img/modals-special-confimation-dialog.png
Binary files differ
diff --git a/doc/development/ux_guide/img/modals-three-buttons-special.png b/doc/development/ux_guide/img/modals-three-buttons-special.png
new file mode 100644
index 00000000000..d2d40167e4d
--- /dev/null
+++ b/doc/development/ux_guide/img/modals-three-buttons-special.png
Binary files differ
diff --git a/doc/development/ux_guide/img/modals-three-buttons.png b/doc/development/ux_guide/img/modals-three-buttons.png
new file mode 100644
index 00000000000..3947902c021
--- /dev/null
+++ b/doc/development/ux_guide/img/modals-three-buttons.png
Binary files differ