JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
stylus-helpers: fix space-evenly, add dimensions
[wfpl.git] / stylus-helpers.styl
1 // Copyright 2014 Jason Woofenden -- Public Domain (CC0)
2
3 // This file contains helpers for using stylus in your project.
4 //
5 // Put something like this in your styl.styl:
6 //     @require 'code/wfpl/stylus-helpers.styl'
7
8
9 // set units to px if it doesn't have a unit already
10 _px(i)
11         unit(i) == '' ? unit(i, px) : i
12
13 // transparently support vender-specific tags
14 border-radius()
15         -webkit-border-radius: arguments
16         border-radius: arguments
17 box-shadow()
18         -webkit-box-shadow: arguments
19         box-shadow: arguments
20 box-sizing()
21         -webkit-box-sizing: arguments
22         -moz-box-sizing: arguments
23         box-sizing: arguments
24 user-select()
25         -webkit-user-select: arguments
26         -moz-user-select: arguments
27         -ms-user-select: arguments
28         user-select: arguments
29
30 // map "whitespace:" to "white-space:"
31 whitespace()
32         white-space: arguments
33
34 // helper function
35 _pos(type, args)
36         position: unquote(type)
37         for i in (0...length(args))
38                 if not args[i] is a 'unit'
39                         {args[i]}: args[i + 1] is a 'unit' ? args[i + 1] : 0
40
41 // you can pass directions and units, or just directions. Examples:
42 //     absolute: top 20px left 0
43 //     fixed: top right
44 //     relative: top -4px
45 absolute()
46         _pos('absolute', arguments)
47 fixed()
48         _pos('fixed', arguments)
49 relative()
50         _pos('relative', arguments)
51
52 // Specify width and height on the same line
53 dimensions(w, h)
54         width: _px(w)
55         height: _px(h)
56
57 // Make children of this element inline-blocks that are spaced evenly accross.
58 //
59 // To create a minimum distance between: don't use word-spacing, it's broken in
60 // firefox. Instead, try padding on the children and negative margin on the
61 // parent.
62 space-evenly(line_height = 1.2em)
63         text-align justify
64         & > *
65                 display inline-block
66                 relative top line_height
67         &:before
68                 content ''
69                 display block
70                 width 100%
71                 margin-bottom -(line_height)
72         &:after
73                 content ''
74                 display inline-block
75                 width 100%
76
77 // image layout: left column has normal, right column hover versions
78 //
79 // arguments: width/height are pixel dimensions of a single sprite
80 //
81 // markup: put classes n1, n2, etc on the items.
82 //
83 // Example
84 //
85 //     html:
86 //         <nav>
87 //             <ul>
88 //                 <li class="n1">home</li>
89 //                 <li class="n2">contact</li>
90 //             </ul>
91 //         </nav>
92 //     styl:
93 //         nav li
94 //             sprite-rollover "images/nav.png" 150 35 2
95 sprite-rollover(image, width, height, count)
96         width = unit(width, px)
97         height = unit(height, px)
98         width width
99         height height
100         background: transparent url(image) top left no-repeat;
101         for n in (1..count)
102                 &.n{n}
103                         y = (height - n * height)
104                         background-position 0 y
105                         &:hover
106                                 background-position -(width) y
107
108 // Styling for a variable height element with an image background where the
109 // middle repeats vertically. You must split your image into three images, and
110 // name them with "-top", "-mid" and "-bot" suffixes (right before the file
111 // extension.) then pass a filepath as the first argument to this function
112 // which does not have a suffix.
113 //
114 // Example:
115 //
116 //     image files:
117 //         i/foo-top.png  (900x20)
118 //         i/foo-mid.png  (900xwhatever)
119 //         i/foo-bot.png  (900x30)
120 //
121 //     dom layout: <div id="expando"><div><div><div>...</div></div></div></div>
122 //
123 //     Stylus:
124 //
125 //         #expando
126 //            mangin: 10px auto;
127 //            width: 900px;
128 //            background-vertical-stretch("i/foo.png", 20, 30)
129 //
130 //     Notes:
131 //
132 //         You can (optionally) pass 1-4 additional arguments which
133 //         (effectively) add padding to the inner most div. The default is to
134 //         have the height and width of the inner div match exactly the outer
135 //         one. Parameters you specify are relative to that (not the section
136 //         filled with the "-mid" image).
137 background-vertical-stretch(image, top-height, bottom-height, top-pad = 0, right-pad = top-pad, bottom-pad = top-pad, left-pad = right-pad)
138         top-height = _px(top-height)
139         bottom-height = _px(bottom-height)
140         top-pad = _px(top-pad)
141         right-pad = _px(right-pad)
142         bottom-pad = _px(bottom-pad)
143         left-pad = _px(left-pad)
144         ext = extname(image)
145         path = pathjoin(dirname(image), basename(image, ext))
146
147         // bottom image (outermost block)
148         background transparent url(path + '-bot' + ext)
149         padding-bottom bottom-height + 1 // +1 to prevent margin collapsing
150         > *
151                 background transparent url(path + '-top' + ext) 0 0 no-repeat
152                 padding-top top-height + 1 // +1 to prevent margin collapsing
153         > * > *
154                 background transparent url(path + '-mid' + ext) 0 0 repeat-y;
155                 margin-top -1px; // correct for above +1 from top
156                 margin-bottom -1px; // correct for above +1 from bottom
157                 padding 1px; // to prevent margin collapsing
158         > * > * > *
159                 // all "2px" below are to correct for 1px above padding and below
160                 padding 1px;
161                 margin-top 2px - top-height + top-pad
162                 margin-left: left-pad - 2px
163                 margin-right: right-pad - 2px
164                 margin-bottom: 2px - bottom-height + bottom-pad
165                 background transparent;
166
167 li-reset()
168         margin 0
169         padding 0
170         list-style none