Skip to content
This repository
Newer
Older
100644 222 lines (155 sloc) 7.46 kb
292b4000 »
2010-09-11 more formatting README
1 # Csster
f531da7b »
2010-09-10 update readme with the intent
2
bdbc77c0 »
2010-09-24 add demos to the web
3 Concisely generate CSS style rules within Javascript. Features:
4
27ae3c68 »
2010-09-24 add demos to the web
5 * standard "object literal"/JSON format with good editor support
bdbc77c0 »
2010-09-24 add demos to the web
6 * nesting to DRY up stylesheets
27ae3c68 »
2010-09-24 add demos to the web
7 * color functions like <code>darken</code> and <code>saturate</code>
8 * built-in macros for common CSS idioms like *clearfix*, *rounded corners*, *drop shadows*.
9 * and all the plain old Javascript behavior: functions, data structures, looping, Math operations, etc.
0bdd67f0 »
2010-09-24 add demos to the web
10
11
292b4000 »
2010-09-11 more formatting README
12 ## Usage
06de1e37 »
2010-09-11 rename README and try to format
13
de891fa7 »
2010-09-24 add demos to the web
14 All code is packaged into a single Javascript file download, [csster.js](http://ndpsoftware.com/csster/csster.js). There are no external dependencies. The project itself is hosted on [GitHub](http://github.com/ndp/csster).
bdbc77c0 »
2010-09-24 add demos to the web
15
e1387e28 »
2010-09-11 more formatting README
16 <pre>
17 require('csster.js'); // however you manage dependencies
18
67b54b4c »
2010-09-11 figure out how to insert styles into the document
19 Csster.style({
e1387e28 »
2010-09-11 more formatting README
20 h1: {
21 fontSize: 18,
22 color: 'red'
23 }
24 });
25
26 ...
27 </pre>
28
b6d72d81 »
2010-09-13 update readme
29 Result, inserted in DOM automatically at the bottom of the &lt;head&gt; element:
30 <pre>
31 ...
e4cf4758 »
2010-09-13 update readme
32 &lt;style type="text/stylesheet"&gt;
b6d72d81 »
2010-09-13 update readme
33 h1 {
34 font-size: 18px;
35 color: red;
36 }
e4cf4758 »
2010-09-13 update readme
37 &lt;/style&gt;
38 &lt;/head&gt;
b6d72d81 »
2010-09-13 update readme
39 ...
40 </pre>
41
292b4000 »
2010-09-11 more formatting README
42 ### Format of CSS Rules
5b6d1124 »
2010-09-11 more formatting README
43
67b54b4c »
2010-09-11 figure out how to insert styles into the document
44 The *style* method accepts CSS rules passed either as arrays or hashes, arrays just being
de5d8699 »
2010-09-11 add some example documentation
45 a way to order the hashes. For example:
46
47 <pre>
48 {
49 ul: {
cb8d55f2 »
2010-09-18 update readme
50 margin: 5,
51 padding: 0,
de5d8699 »
2010-09-11 add some example documentation
52 }
5b6d1124 »
2010-09-11 more formatting README
53 'ul li:first': {
cb8d55f2 »
2010-09-18 update readme
54 paddingLeft: 20px
de5d8699 »
2010-09-11 add some example documentation
55 }
56 }
94279b68 »
2010-09-11 add some example documentation
57 </pre>
de5d8699 »
2010-09-11 add some example documentation
58
59 Note that
588af516 »
2010-09-11 more formatting README
60
da7d664e »
2010-09-27 update docs, move samples up,
61 * property names are automatically converted to hyphenated format from camelcase, so in many cases you can omit the quotation marks. ('float' needs to quoted since it's a reserved word.)
f99a96e4 »
2010-09-24 work on readme
62 * all raw numbers are assumed to be "pixels" (or "px"), and rendered as such.
292b4000 »
2010-09-11 more formatting README
63 * any sort of selectors are allowed... they are just passed through to the stylesheet.
64
65 #### Nesting
7726ab58 »
2010-09-11 more formatting README
66 Csster supports nesting of rules to keep things more concise:
de5d8699 »
2010-09-11 add some example documentation
67 <pre>
68 {
69 ul: {
cb8d55f2 »
2010-09-18 update readme
70 margin: 5,
de5d8699 »
2010-09-11 add some example documentation
71 li: {
80353b1a »
2010-09-18 rename macro to has
72 paddingLeft: 20,
73 '&:hover': {
74 color: 'red'
75 }
de5d8699 »
2010-09-11 add some example documentation
76 }
77 }
78 }
94279b68 »
2010-09-11 add some example documentation
79 </pre>
de5d8699 »
2010-09-11 add some example documentation
80
81 The "li" property in this case might be a selector or might be a property name. A list of valid
82 property names is used to identify properties right now, and otherwise it's considered a sub-selector.
83
80353b1a »
2010-09-18 rename macro to has
84 Csster supports SASS's "&" operator, to indicate that the selector should be combined with the parent selector.
85 Instead of the default "any descendent" space character being inserted, no space is inserted.
86
da7d664e »
2010-09-27 update docs, move samples up,
87 Combined rules (with commas) are expanded as expected, so nested rules with commas have their parents expanded.
88
89 By default, rules with multiple '#'s are simplified. For example, '#a #b #c' becomes '#c'. Usually this is what you will want, but if you need the specificity you can turn this off with <code>Csster.shortCircuitIds = false</code>
90
91
92
1703d0ac »
2010-09-13 update readme
93 #### Functions
b50ec798 »
2010-09-19 improve docs on functions
94 Most manipulations will fall into Javascript's language support, as far as any math or looping. Use Javascript to write necessary functions.
80353b1a »
2010-09-18 rename macro to has
95
b50ec798 »
2010-09-19 improve docs on functions
96 function/color.js contains SASS-like color functions:
8f276b66 »
2010-09-18 update readme
97
b50ec798 »
2010-09-19 improve docs on functions
98 * <code>"#ab342c".darken(%)</code> -- make color darker by given percent
99 * <code>"#ab342c".lighten(%)</code> -- make color lighter by given percent
100 * <code>"#ab342c".saturate(%)</code> -- make color more saturated by given percent. To *desaturate*, use negative values for the percent. Note that <code>"#ab342c".saturate(-100)</code> renders in grayscale.
101
102 There are also color conversion routines if you want to build your own manipulation.
103
104 * <code>"#ab342c".toRGB()</code>
105 * <code>"#ab342c".toHSL()</code>
106 * <code>Csster.hslToHexColor(h,s,l)</code>
107
108 Opacity is currently not supported by the color model.
1703d0ac »
2010-09-13 update readme
109
80353b1a »
2010-09-18 rename macro to has
110 #### Macros using "has" key
de5d8699 »
2010-09-11 add some example documentation
111
717a1e37 »
2010-09-24 work on readme
112 There are a host of pre-made macros that may be useful:
113
114 * <code>roundedCorners(radius)</code> -- add rounded corners on all sides
115 * <code>roundedCorners(side, radius)</code> -- add rounded corners on specified side: <code>'top'</code>, <code>'left'</code>, <code>'bottom'</code> or <code>'right'</code>
116 * <code>roundedCorners(corner, radius)</code> -- add rounded corners to a specified corner: <code>'tl'</code>, <code>'tr'</code>, <code>'bl'</code> or <code>'br'</code>
117 * <code>phark(width, height, img, imgXPosition=0, imgYPosition=0)</code> -- standard phark image replacement with optional background image offset.
118 * <code>boxShadow([xoffset, yoffset], radius, color)</code>
119 * <code>verticalCentering(height)</code> and <code>horizontalCentering(width)</code> -- center using the top 50% / margin-top -width/2 technique. See http://stackoverflow.com/questions/148251/css-centering-tricks
f99a96e4 »
2010-09-24 work on readme
120 * <code>clearfix()</code> -- standard clearfix
de5d8699 »
2010-09-11 add some example documentation
121
80353b1a »
2010-09-18 rename macro to has
122 To "mix these in", use the "has" key:
de5d8699 »
2010-09-11 add some example documentation
123
124 <pre>
125 {
126 'div#featured_box': {
cb8d55f2 »
2010-09-18 update readme
127 backgroundColor: '#394c89',
128 has: roundedCorner(5)
de5d8699 »
2010-09-11 add some example documentation
129 }
130 }
5b6d1124 »
2010-09-11 more formatting README
131 </pre>
132
27ae3c68 »
2010-09-24 add demos to the web
133 Multiple macros can be included by making that a list, eg. <code>has: [roundedCorners(5), dropShadow()]</code>.
80353b1a »
2010-09-18 rename macro to has
134
717a1e37 »
2010-09-24 work on readme
135 It's all Javascript, so macros and more complex functions are easy to write. To mix in a set of values, create a function
136 that returns a hash of values, for example:
137
138 <pre>
139 function roundedCorners(radius) {
140 return {
141 '-webkit-border-radius': radius,
142 '-moz-border-radius': radius,
143 'border-radius': radius
144 }
145 }
146 </pre>
147
27ae3c68 »
2010-09-24 add demos to the web
148 A macro's properties will be overwritten by properties within including selector (or later included macros), similar to how the cascade takes the last defined value.
149
150
d8837737 »
2010-10-10 Add note about extending and contributing.
151
152 ## Extending Csster
153
154 Csster is built as an extensible system.
155
7bb35d1b »
2010-10-10 formatting
156 ### Adding Custom Property Names
157 <code>Csster.addPropertyNames</code>
effb732f »
2010-10-10 Document extensibility.
158 Any non-standard property names you'd like to be considered valid. The build-in tool rejects non-standard property names.
d8837737 »
2010-10-10 Add note about extending and contributing.
159
7bb35d1b »
2010-10-10 formatting
160 ### Pre-proces rules
161 <code>Csster.propertyPreprocessors</code>
effb732f »
2010-10-10 Document extensibility.
162 Functions called before properties are expanded. Callback is provided a hash of properties to values, which it modifies in any way it wants.
163
7bb35d1b »
2010-10-10 formatting
164 ### Post-processing
165 <code>Csster.rulesPostProcessors</code>
effb732f »
2010-10-10 Document extensibility.
166 Functions called after rules are processed, but before they are output. Called with an array of processed rules.
167
7bb35d1b »
2010-10-10 formatting
168 ### Inserting into the DOM
169 <code>Csster.insertStylesheet</code>
effb732f »
2010-10-10 Document extensibility.
170 Function that outputs a set of rules into the DOM.
d8837737 »
2010-10-10 Add note about extending and contributing.
171
172 ## Contributing
173
174 Fork and submit changed back on Github.
175
176
69363d2d »
2010-09-27 update links
177 ## Links
178
179 * [Demo of the color functions and macros](http://ndpsoftware.com/csster/demo.html)
180 * [Demo of using to build a chart](http://ndpsoftware.com/csster/demo_chart.html)
181 * [Blog post](http://ndpsoft.blogspot.com/2010/09/introducing-csster.html)
182
183
184
632baa2a »
2010-09-24 add demos to the web
185
b5f9f8bb »
2010-09-24 add demos to the web
186 ## TDD
632baa2a »
2010-09-24 add demos to the web
187
27ae3c68 »
2010-09-24 add demos to the web
188 The design was driven by [the specs](http://ndpsoftware.com/csster/spec_runner.html).
80353b1a »
2010-09-18 rename macro to has
189
de5d8699 »
2010-09-11 add some example documentation
190
292b4000 »
2010-09-11 more formatting README
191 ## Todo
de5d8699 »
2010-09-11 add some example documentation
192
c56959da »
2010-09-24 add centering and clearfix
193 * decompile existing stylesheets
194 * jQuery rules
ee77c602 »
2010-09-13 start to add color functions
195 * Fix license
5b6d1124 »
2010-09-11 more formatting README
196 * Better name
06de1e37 »
2010-09-11 rename README and try to format
197
198
ee77c602 »
2010-09-13 start to add color functions
199
292b4000 »
2010-09-11 more formatting README
200 ## Motivation
f531da7b »
2010-09-10 update readme with the intent
201
202 This project comes from my frustration of trying to build standalone Javascript widgets. Web
203 projects always involve the combination of HTML DOM, CSS and Javascript. It's often simpler to
204 generate the necessary DOM within your Javascript, removing any coupling (and a simpler calling
205 convention) to a specific web page. But most widgets have certain style rules. To avoid
206 any coupling with the CSS at all, styles can be included inline, but these gets bulky
207 and hard to read. The "rule" nature of CSS is nice. So widgets then have a Javascript
208 and CSS component. Wouldn't it be nice, though, to remove that CSS component.
209
210 With the advent of SASS, the coupling is even more complicated, as now there's some other
211 tool completely unrelated to your component, written in some other language. Wouldn't
212 a unified approach be nice?
213
214
292b4000 »
2010-09-11 more formatting README
215 ## Similar projects
de5d8699 »
2010-09-11 add some example documentation
216
06de1e37 »
2010-09-11 rename README and try to format
217 http://revnode.com/oss/css/
218
292b4000 »
2010-09-11 more formatting README
219 ## Legal
de5d8699 »
2010-09-11 add some example documentation
220
06de1e37 »
2010-09-11 rename README and try to format
221 Copyright (c) 2010 Andrew J. Peterson
222 All Rights Reserved.
Something went wrong with that request. Please try again.