forked from draganbabic/uni-form
-
Notifications
You must be signed in to change notification settings - Fork 0
/
readme
95 lines (64 loc) · 4.1 KB
/
readme
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
----------------------------------------------------------------------------------
Copyright (c) 2010, Dragan Babic
Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
----------------------------------------------------------------------------------
### What is Uni–Form
Uni-Form is a framework that standardizes form markup and styles it with CSS
giving you two most widely used layout options to choose from. Anyone can get nice
looking, well structured, highly customizable, accessible and usable forms. To put
it simply: it makes a developer's life a lot easier.
----------------------------------------------------------------------------------
### How to Use?
First thing you need to do is to link up the necessary files:
* Link up the main CSS file
<link href="path/to/file/uni-form.css" media="all" rel="stylesheet"/>
* Link up the Uni–Form style CSS file
<link href="path/to/file/default.uni-form.css" media="all" rel="stylesheet"/>
* Optionally you'll want to link up jQuery and Uni–Form jQuery files if you'd
like Uni–Form to highlight the form rows on focus (it's a usability aid):
<script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>
<script src="path/to/file/uni-form.jquery.js" type="text/javascript"></script>
Now that you're all set up, all you need to do is add form fields that are formatted
with Uni–Form markup so the CSS and JavaScript will get the “hooks” they need. These
chunks of code are called “units” and all available units can be found within the
file called fauxform.html that is included in this package.
Feel free to extend Uni–Form with units of your own and share.
----------------------------------------------------------------------------------
### Styles
As of v1.4 Uni–Form supports styles. These are separate CSS files that contain the
presentation aspect of your form (considering that uni-form.css) contains the
layout. Style CSS files should be used to control how your form looks, spacing…
Sharing styles is encouraged, and by default Uni–Form is shipped with three:
* Default
* Blue
* Dark
Consider these a starting point for making your own.
----------------------------------------------------------------------------------
### Options and Layout Control
Uni–Form by default has two form layouts: default and inline. This is controlled
by adding (or removing) a CSS class .inlineLabels to the fieldset element.
There is another option in regards to the layout and it concerns what is referred
to as “multifields”. These are fields that contain multiple inputs per unit and
are usually used for checkboxes and radio buttons. Each layout supports an
alternate multifield layout. This is achieved by adding (or removing) a CSS class
.alternate to the ul element.
----------------------------------------------------------------------------------
Give respect and get it back.
----------------------------------------------------------------------------------