Commit 8c6d03bc authored by Mark Lapierre's avatar Mark Lapierre Committed by Rémy Coutable

Add types to style guide

`_placeholder` refers to a temporary element that appears while
content is loading. For example, the elements that are displayed
instead of discussions while the discussions are being fetched.

`_container` refers to an element that includes other elements, but
might not include any visible content itself. E.g., an element that
has a third-party editor inside it, but which isn't the editor itself
and so doesn't include the editor's content.

`_modal` refers to a popup modal dialog, e.g., a confirmation prompt.
parent ecb551e5
...@@ -54,18 +54,20 @@ We follow a simple formula roughly based on hungarian notation. ...@@ -54,18 +54,20 @@ We follow a simple formula roughly based on hungarian notation.
*Formula*: `element :<descriptor>_<type>` *Formula*: `element :<descriptor>_<type>`
- `descriptor`: The natural-language description of what the element is. On the login page, this could be `username`, or `password`. - `descriptor`: The natural-language description of what the element is. On the login page, this could be `username`, or `password`.
- `type`: A physical control on the page that can be seen by a user. - `type`: A generic control on the page that can be seen by a user.
- `_button` - `_button`
- `_link`
- `_tab`
- `_dropdown`
- `_field`
- `_checkbox` - `_checkbox`
- `_container`: an element that includes other elements, but doesn't present visible content itself. E.g., an element that has a third-party editor inside it, but which isn't the editor itself and so doesn't include the editor's content.
- `_content`: any element that contains text, images, or any other content displayed to the user.
- `_dropdown`
- `_field`: a text input element.
- `_link`
- `_modal`: a popup modal dialog, e.g., a confirmation prompt.
- `_placeholder`: a temporary element that appears while content is loading. For example, the elements that are displayed instead of discussions while the discussions are being fetched.
- `_radio` - `_radio`
- `_content` - `_tab`
*Note: This list is a work in progress. This list will eventually be the end-all enumeration of all available types. *Note: If none of the listed types are suitable, please open a merge request to add an appropriate type to the list.*
I.e., any element that does not end with something in this list is bad form.*
### Examples ### Examples
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment