richard
/
SemanSemantic-UItic-UI
mirror of https://github.com/Semantic-Org/Semantic-UI.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

Update README.md

pull/13/head
Jack Lukic 11 years ago
parent
a6691d2ca3
commit
d40ac7ec43
1 changed files with 53 additions and 52 deletions
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 105
      README.md

105
README.md
View File

@ -7,77 +7,92 @@ Semantic's goal is to define a vocabulary for interface elements based on consen
For developers, this means defining class names for UI elements, outlining states that an elements can exist, and describing common variations of that element. For developers, this means defining class names for UI elements, outlining states that an elements can exist, and describing common variations of that element.
## How
### Download
You can use our build tool to select only the components you want
http://semantic-ui.com/download
Or download the whole kit and kaboodle
http://semantic-ui.com/ui/semantic.min.css
http://semantic-ui.com/ui/semantic.min.js
## A More Semantic Web
### Based on class
Semantic is based on class names, instead of tags. This means, except for links, tables and forms, you can use semantic with tags like ``<div> <article> <nav>`` without any difference.
### Context sensitive ### Context sensitive
In Semantic, variations maintain context based on the element they modify, but keep the same vocabulary between element,
just like in natural language, the adjective 'big' may have very different implications for a big planet versus a big insect.
In Semantic, variations maintain context based on the element they modify, but keep the same vocabulary between elements. Just like how in English, the adjective 'big' may describe a different scale for a big planet versus a big insect.
For example, a UI Collection like a form you may have a size variation called "large". This may tell individual elements inside the form to change in size:
For example, a form you can have a variation called "inverted". This changes the appearance of form elements to work on dark backgrounds.
```html ```html
<div class="ui large form"></div>
<div class="ui inverted form"></div>
``` ```
However the same variation can exist on an individual element and carry its own contextual meaning
The same variation can also be useful in the context of a menu.
```html ```html
<div class="ui large button"></div>
<div class="ui inverted menu"></div>
``` ```
### Defining UI ### Defining UI
Here is part of Semantic's definition of a button Here is part of Semantic's definition of a button
**Standard**: A button is a shape that can be pressed in to complete an action
**Standard**: A button is a shape that can be pressed in to complete an action.
```html ```html
<div class="ui button"></div> <div class="ui button"></div>
``` ```
**State**: A button can sometimes be active, or selected by the user
**State**: A button can sometimes be active, designating it is selected by the user.
``` html
<div class="ui active button">
```html
<div class="ui active button">
``` ```
**Variations**: A button may sometimes look different than a simple button.
``` html
<div class="ui large blue icon button">
<i class="ui icon heart"></i>
</div>
**Variations**: A button may sometimes look different than its prototype.
```html
<div class="ui large blue icon button">
<i class="ui icon heart"></i>
</div>
``` ```
**Plurality**: A button can sometimes exist in a group of buttons **Plurality**: A button can sometimes exist in a group of buttons
``` html ``` html
<div class="ui large blue buttons">
<div class="ui button">
I am blue
</div>
<div class="ui button">
I am blue too
</div>
</div>
<div class="ui large blue buttons">
<div class="ui button">
I am blue
</div>
<div class="ui button">
I am blue too
</div>
</div>
``` ```
## Types of UI ## Types of UI
UI components are split into four categories: UI components are split into four categories:
* UI elements
* UI Elements
* UI Collections * UI Collections
* UI VIews * UI VIews
* UI Modules * UI Modules
All UI definitions are made of a neutral prototypical definition, a list of states it can occupy, and a set of common variations or "types" of that element.
All UI definitions are made of a neutral, ideal definition, a list of states it can occupy, and a set of common variations or "types" of that element.
### UI Elements ### UI Elements
UI Elements are basic design elements. Any part of the element cannot be thought of as something separate, although they may be made up of parts. In chemistry, you can think of this as an "element".
UI Elements are interface elements which do not contain other elements inside themselves. This can be thought of as similar in definition as an "element" in chemistry.
They may also may be useful sometimes to define in plural. Groups of UI elements are always homogenous.
UI elements can have plural definitions when they are known to exist together frequently.
For example in this case each button can be described as large because we understand it is a type of large button
In this case each button will be large because we understand it is a part of the large button group
``` html ``` html
<div class="large buttons">
<div class="ui button">Cancel</div>
<div class="ui positive button">Continue</div>
</div>
<div class="large buttons">
<div class="ui button">Cancel</div>
<div class="ui positive button">Continue</div>
</div>
``` ```
Examples of UI elements: Examples of UI elements:
@ -88,9 +103,9 @@ Examples of UI elements:
### UI Collections ### UI Collections
UI Collections are groups of heteregeneous UI elements which are usually found together. These can be thought of as molecules.
UI Collections are groups of heteregeneous UI elements which are usually found together. Carrying the chemistry metaphor, these can be thought of as molecules.
UI collections do not usually require all elements to be found, but they describe a list of the "usual suspects". Collections are not typically useful to define in plural.
UI collections have a definition of elements that exist, or could exist inside of them. They do not usually require all elements to be found, but they describe a list of the "usual suspects". Unlike elements, collections are not typically useful to define in plural.
Examples of UI collections: Examples of UI collections:
* Forms * Forms
@ -99,7 +114,7 @@ Examples of UI collections:
* Menus * Menus
## UI Views ## UI Views
UI Views are common ways that UI collections are grouped together. The focus is not on providing a specific interaction, but providing a view for a website's content. These might be difficult to define completely.
UI Views are common ways to display site content. Instead of providing a specific interaction, views structure content so that it can be understood more easily.
Examples of UI views: Examples of UI views:
** Comment Feed ** Comment Feed
@ -109,7 +124,7 @@ Examples of UI views:
## UI Modules ## UI Modules
UI modules are UI elements where it's behavior is a fundamental part of its existence.
UI modules are UI elements where it's behavior is a fundamental part of its definition. UI Modules are dependent on the javascript which carry their definition.
Examples of UI modules: Examples of UI modules:
* Popups * Popups
@ -123,19 +138,5 @@ Examples of UI modules:
#### I want to contribute to the spec #### I want to contribute to the spec
Semantic is very new. We're still working out the best way to join in the discussion.
We're currently working to figure ouin [coding guidelines](http://semantic-ui.com/guidelines).
###Library
You can use our build tool to select only the components you want
http://semantic-ui.com/download
Or download the whole kit and kaboodle
http://semantic-ui.com/ui/semantic.min.css
http://semantic-ui.com/ui/semantic.min.js
Semantic is very new standard, and we need a community to become truly useful. We're working currently to determine the best ways to engage the community for contribution. If you'd like to participate feel free to reach out by e-mail [semantic@quirky.com](mailto:semantic@quirky.com)
Write Preview
Loading…
Cancel
Save