diff options
author | Hazel <hazel@gitlab.com> | 2017-10-16 15:13:21 +0800 |
---|---|---|
committer | Hazel <hazel@gitlab.com> | 2017-10-16 15:13:21 +0800 |
commit | a632440fa91c750bb4a75ee430c3a34c6d98f51c (patch) | |
tree | 166f47668eab63251741e02dcc4e0a511d3863fb /doc | |
parent | 2087f121bfedd2f51eb943f23026e823d196466a (diff) | |
download | gitlab-ce-a632440fa91c750bb4a75ee430c3a34c6d98f51c.tar.gz |
Draft a guide of modals in UX guide
Diffstat (limited to 'doc')
-rw-r--r-- | doc/development/ux_guide/components.md | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/doc/development/ux_guide/components.md b/doc/development/ux_guide/components.md index fa31c496b30..20230a9bb2c 100644 --- a/doc/development/ux_guide/components.md +++ b/doc/development/ux_guide/components.md @@ -254,6 +254,35 @@ 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. + +### 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. + +### 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: Affirmative action → Extra action → Dismissive action (Right to left) +* 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. + +### 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]() | + + +--- + ## Panels > TODO: Catalog how we are currently using panels and rationalize how they relate to alerts |