plinth 0.0.1.beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (237) hide show
  1. data/.codoopts +10 -0
  2. data/.env +1 -0
  3. data/.gitignore +23 -0
  4. data/.ruby-version +1 -0
  5. data/CHANGELOG.md +1 -0
  6. data/Capfile +4 -0
  7. data/Gemfile +52 -0
  8. data/Gemfile.lock +243 -0
  9. data/Guardfile +9 -0
  10. data/LICENSE +22 -0
  11. data/Procfile +1 -0
  12. data/README.md +79 -0
  13. data/Rakefile +35 -0
  14. data/app/assets/images/layouts/basic-marketing-site.png +0 -0
  15. data/app/assets/images/layouts/jumbotron-site.png +0 -0
  16. data/app/assets/images/rails.png +0 -0
  17. data/app/assets/javascripts/application.js +17 -0
  18. data/app/assets/javascripts/base.js.coffee +3 -0
  19. data/app/assets/javascripts/grids.js.coffee +3 -0
  20. data/app/assets/javascripts/javascript.js.coffee +3 -0
  21. data/app/assets/javascripts/lib/modernizr.js +4 -0
  22. data/app/assets/javascripts/modules.js.coffee +3 -0
  23. data/app/assets/stylesheets/application-old-ie.css.scss +10 -0
  24. data/app/assets/stylesheets/application.css.scss +57 -0
  25. data/app/assets/stylesheets/base/_all.scss +6 -0
  26. data/app/assets/stylesheets/base/_reset.css.scss +16 -0
  27. data/app/assets/stylesheets/base/_type.scss +16 -0
  28. data/app/assets/stylesheets/modules/_coderay.css.scss +171 -0
  29. data/app/assets/stylesheets/modules/_layout_examples.css.scss +13 -0
  30. data/app/assets/stylesheets/modules/_webfont_table.css.scss +47 -0
  31. data/app/assets/stylesheets/vanilla-normal-old-ie.css.scss +11 -0
  32. data/app/assets/stylesheets/vanilla-normal.css.scss +33 -0
  33. data/app/controllers/application_controller.rb +5 -0
  34. data/app/controllers/base_controller.rb +52 -0
  35. data/app/controllers/grids_controller.rb +48 -0
  36. data/app/controllers/javascript_controller.rb +20 -0
  37. data/app/controllers/javascripts_controller.rb +4 -0
  38. data/app/controllers/modules_controller.rb +43 -0
  39. data/app/controllers/ui_controller.rb +2 -0
  40. data/app/helpers/plinth_helper.rb +33 -0
  41. data/app/views/base/_webfonts_social_standard.html +429 -0
  42. data/app/views/base/_webfonts_ss_standard.html +2413 -0
  43. data/app/views/base/buttons.html.haml +20 -0
  44. data/app/views/base/forms.html.haml +40 -0
  45. data/app/views/base/images.html.haml +20 -0
  46. data/app/views/base/index.html.haml +68 -0
  47. data/app/views/base/labels.html.haml +22 -0
  48. data/app/views/base/lists.html.haml +20 -0
  49. data/app/views/base/webfonts.html.haml +17 -0
  50. data/app/views/grids/index.html.haml +73 -0
  51. data/app/views/grids/layouts/basic-marketing-site.haml +69 -0
  52. data/app/views/grids/layouts/jumbotron-site.haml +92 -0
  53. data/app/views/grids/layouts.html.haml +9 -0
  54. data/app/views/layouts/_main_nav.html.haml +15 -0
  55. data/app/views/layouts/application.html.haml +15 -0
  56. data/app/views/modules/alerts.html.haml +12 -0
  57. data/app/views/modules/footer.html.haml +2 -0
  58. data/app/views/modules/index.html.haml +5 -0
  59. data/app/views/modules/nav.html.haml +12 -0
  60. data/app/views/modules/panels.html.haml +3 -0
  61. data/app/views/modules/tabs.html.haml +58 -0
  62. data/app/views/old_javascript/close.html.haml +2 -0
  63. data/app/views/old_javascript/forms.html.haml +2 -0
  64. data/app/views/old_javascript/ga_events.html.haml +2 -0
  65. data/app/views/old_javascript/index.html.haml +2 -0
  66. data/app/views/old_javascript/responsive_resize.html.haml +2 -0
  67. data/app/views/old_javascript/switch.html.haml +2 -0
  68. data/app/views/parts/base/_button.haml +3 -0
  69. data/app/views/parts/base/_button_colours.haml +4 -0
  70. data/app/views/parts/base/_button_group.haml +4 -0
  71. data/app/views/parts/base/_button_sizing.haml +3 -0
  72. data/app/views/parts/base/_button_states.haml +3 -0
  73. data/app/views/parts/base/_form_example.haml +26 -0
  74. data/app/views/parts/base/_form_example_horizontal.haml +26 -0
  75. data/app/views/parts/base/_form_group.haml +10 -0
  76. data/app/views/parts/base/_form_location.haml +3 -0
  77. data/app/views/parts/base/_labels.haml +5 -0
  78. data/app/views/parts/base/_labels_sizing.haml +3 -0
  79. data/app/views/parts/base/_list.haml +10 -0
  80. data/app/views/parts/base/_list_action.haml +5 -0
  81. data/app/views/parts/base/_list_nav.haml +12 -0
  82. data/app/views/parts/base/_list_unset.haml +10 -0
  83. data/app/views/parts/base/_type_body.haml +2 -0
  84. data/app/views/parts/base/_type_headings.haml +5 -0
  85. data/app/views/parts/base/_type_helpers.haml +3 -0
  86. data/app/views/parts/base/_type_links.haml +9 -0
  87. data/app/views/parts/base/_type_shouts.haml +4 -0
  88. data/app/views/parts/grids/_example_layout_1.haml +10 -0
  89. data/app/views/parts/grids/_live_grid.haml +29 -0
  90. data/app/views/parts/modules/_alerts.haml +11 -0
  91. data/app/views/parts/modules/_nav_footer.haml +34 -0
  92. data/app/views/parts/modules/_nav_header.haml +18 -0
  93. data/app/views/parts/modules/_panels.haml +9 -0
  94. data/app/views/parts/modules/_tabs_minimal.haml +11 -0
  95. data/app/views/parts/modules/_tabs_simple_group.haml +11 -0
  96. data/app/views/parts/modules/_tabs_simple_group_toggle.haml +11 -0
  97. data/app/views/parts/modules/_tabs_toggle.haml +5 -0
  98. data/app/views/parts/modules/_tabs_traditional.haml +11 -0
  99. data/app/views/shared/_placeholder_text.html.haml +1 -0
  100. data/app/views/shared/_title.html.haml +8 -0
  101. data/app/views/shared/_ui_nav.html.haml +5 -0
  102. data/app/views/ui/alert.html.haml +35 -0
  103. data/app/views/ui/buttons.html.haml +116 -0
  104. data/app/views/ui/footer.html.haml +69 -0
  105. data/app/views/ui/forms/_vertical_form.haml +7 -0
  106. data/app/views/ui/forms.html.haml +59 -0
  107. data/app/views/ui/grids.html.haml +18 -0
  108. data/app/views/ui/index.html.haml +5 -0
  109. data/app/views/ui/labels.html.haml +15 -0
  110. data/app/views/ui/modules/panel.html.haml +3 -0
  111. data/app/views/ui/nav.html.haml +48 -0
  112. data/app/views/ui/tabs.html.haml +171 -0
  113. data/app/views/ui/typography.html.haml +118 -0
  114. data/db/development.sqlite3 +0 -0
  115. data/db/seeds.rb +7 -0
  116. data/doc/README_FOR_APP +2 -0
  117. data/lib/assets/.gitkeep +0 -0
  118. data/lib/plinth/version.rb +3 -0
  119. data/lib/plinth.rb +11 -0
  120. data/lib/tasks/.gitkeep +0 -0
  121. data/lib/templates/haml/scaffold/_form.html.haml +8 -0
  122. data/log/.gitkeep +0 -0
  123. data/plinth.gemspec +33 -0
  124. data/public/404.html +26 -0
  125. data/public/422.html +26 -0
  126. data/public/500.html +25 -0
  127. data/public/favicon.ico +0 -0
  128. data/public/javascripts/LICENSE.html +158 -0
  129. data/public/javascripts/README.md.html +163 -0
  130. data/public/javascripts/assets/codo.css +1 -0
  131. data/public/javascripts/assets/codo.js +21 -0
  132. data/public/javascripts/assets/search_data.js +1 -0
  133. data/public/javascripts/class_index.html +215 -0
  134. data/public/javascripts/class_list.html +58 -0
  135. data/public/javascripts/classes/Close.html +259 -0
  136. data/public/javascripts/classes/GAEvent.html +231 -0
  137. data/public/javascripts/classes/ResizeHandler.html +225 -0
  138. data/public/javascripts/classes/Switch.html +318 -0
  139. data/public/javascripts/classes/TBGForm.html +373 -0
  140. data/public/javascripts/extra_list.html +36 -0
  141. data/public/javascripts/file_list.html +74 -0
  142. data/public/javascripts/files/styleguide/plugins/tbg-close.js.coffee.html +160 -0
  143. data/public/javascripts/files/styleguide/plugins/tbg-forms.js.coffee.html +160 -0
  144. data/public/javascripts/files/styleguide/plugins/tbg-ga-events.js.coffee.html +160 -0
  145. data/public/javascripts/files/styleguide/plugins/tbg-respinsiveresize.js.coffee.html +160 -0
  146. data/public/javascripts/files/styleguide/plugins/tbg-switch.js.coffee.html +160 -0
  147. data/public/javascripts/index.html +14 -0
  148. data/public/javascripts/method_list.html +187 -0
  149. data/public/javascripts/mixin_list.html +28 -0
  150. data/public/robots.txt +5 -0
  151. data/script/rails +6 -0
  152. data/spec/javascripts/fixtures/plugins/tbg-close_fixture.html.haml +4 -0
  153. data/spec/javascripts/fixtures/plugins/tbg-forms_fixture.html.haml +12 -0
  154. data/spec/javascripts/fixtures/plugins/tbg-ga-events_fixture.html.haml +9 -0
  155. data/spec/javascripts/fixtures/plugins/tbg-switch_fixture.html.haml +11 -0
  156. data/spec/javascripts/plugins/tbg-close_spec.js.coffee +54 -0
  157. data/spec/javascripts/plugins/tbg-forms_spec.js.coffee +87 -0
  158. data/spec/javascripts/plugins/tbg-ga-events_spec.js.coffee +83 -0
  159. data/spec/javascripts/plugins/tbg-switch_spec.js.coffee +96 -0
  160. data/spec/javascripts/spec.js.coffee +2 -0
  161. data/vendor/assets/fonts/ss-social-circle.eot +0 -0
  162. data/vendor/assets/fonts/ss-social-circle.svg +139 -0
  163. data/vendor/assets/fonts/ss-social-circle.ttf +0 -0
  164. data/vendor/assets/fonts/ss-social-circle.woff +0 -0
  165. data/vendor/assets/fonts/ss-social-regular.eot +0 -0
  166. data/vendor/assets/fonts/ss-social-regular.svg +133 -0
  167. data/vendor/assets/fonts/ss-social-regular.ttf +0 -0
  168. data/vendor/assets/fonts/ss-social-regular.woff +0 -0
  169. data/vendor/assets/fonts/ss-social.js +75 -0
  170. data/vendor/assets/fonts/ss-standard.eot +0 -0
  171. data/vendor/assets/fonts/ss-standard.js +75 -0
  172. data/vendor/assets/fonts/ss-standard.svg +207 -0
  173. data/vendor/assets/fonts/ss-standard.ttf +0 -0
  174. data/vendor/assets/fonts/ss-standard.woff +0 -0
  175. data/vendor/assets/images/background.png +0 -0
  176. data/vendor/assets/images/logos/sb-logo-white.png +0 -0
  177. data/vendor/assets/images/logos/sb-logo-white.svg +5 -0
  178. data/vendor/assets/images/middleman.png +0 -0
  179. data/vendor/assets/index.html.haml +8 -0
  180. data/vendor/assets/javascripts/.gitkeep +0 -0
  181. data/vendor/assets/javascripts/plinth/lib/handlebars.js +3 -0
  182. data/vendor/assets/javascripts/plinth/lib/jquery.fitvids.js +81 -0
  183. data/vendor/assets/javascripts/plinth/lib/ss-social.js +75 -0
  184. data/vendor/assets/javascripts/plinth/lib/ss-standard.js +78 -0
  185. data/vendor/assets/javascripts/plinth/plugins/doc/assets/codo.css +1 -0
  186. data/vendor/assets/javascripts/plinth/plugins/doc/assets/codo.js +21 -0
  187. data/vendor/assets/javascripts/plinth/plugins/doc/assets/search_data.js +1 -0
  188. data/vendor/assets/javascripts/plinth/plugins/doc/class_index.html +194 -0
  189. data/vendor/assets/javascripts/plinth/plugins/doc/class_list.html +58 -0
  190. data/vendor/assets/javascripts/plinth/plugins/doc/classes/Close.html +215 -0
  191. data/vendor/assets/javascripts/plinth/plugins/doc/classes/GAEvent.html +235 -0
  192. data/vendor/assets/javascripts/plinth/plugins/doc/classes/ResizeHandler.html +192 -0
  193. data/vendor/assets/javascripts/plinth/plugins/doc/classes/Switch.html +233 -0
  194. data/vendor/assets/javascripts/plinth/plugins/doc/classes/TBGForm.html +318 -0
  195. data/vendor/assets/javascripts/plinth/plugins/doc/extra_list.html +30 -0
  196. data/vendor/assets/javascripts/plinth/plugins/doc/file_list.html +58 -0
  197. data/vendor/assets/javascripts/plinth/plugins/doc/files/tbg-close.js.coffee.html +154 -0
  198. data/vendor/assets/javascripts/plinth/plugins/doc/files/tbg-forms.js.coffee.html +154 -0
  199. data/vendor/assets/javascripts/plinth/plugins/doc/files/tbg-ga-events.js.coffee.html +154 -0
  200. data/vendor/assets/javascripts/plinth/plugins/doc/files/tbg-respinsiveresize.js.coffee.html +154 -0
  201. data/vendor/assets/javascripts/plinth/plugins/doc/files/tbg-switch.js.coffee.html +154 -0
  202. data/vendor/assets/javascripts/plinth/plugins/doc/index.html +14 -0
  203. data/vendor/assets/javascripts/plinth/plugins/doc/method_list.html +163 -0
  204. data/vendor/assets/javascripts/plinth/plugins/doc/mixin_list.html +28 -0
  205. data/vendor/assets/javascripts/plinth/plugins/tbg-close.js.coffee +97 -0
  206. data/vendor/assets/javascripts/plinth/plugins/tbg-forms.js.coffee +156 -0
  207. data/vendor/assets/javascripts/plinth/plugins/tbg-ga-events.js.coffee +107 -0
  208. data/vendor/assets/javascripts/plinth/plugins/tbg-respinsiveresize.js.coffee +73 -0
  209. data/vendor/assets/javascripts/plinth/plugins/tbg-switch.js.coffee +121 -0
  210. data/vendor/assets/stylesheets/.gitkeep +0 -0
  211. data/vendor/assets/stylesheets/_functions.scss +28 -0
  212. data/vendor/assets/stylesheets/_mixins.css.scss +273 -0
  213. data/vendor/assets/stylesheets/_settings.css.scss +120 -0
  214. data/vendor/assets/stylesheets/plinth/base/_all.css.scss +7 -0
  215. data/vendor/assets/stylesheets/plinth/base/_buttons.css.scss +166 -0
  216. data/vendor/assets/stylesheets/plinth/base/_form.css.scss +196 -0
  217. data/vendor/assets/stylesheets/plinth/base/_labels.css.scss +58 -0
  218. data/vendor/assets/stylesheets/plinth/base/_lists.css.scss +57 -0
  219. data/vendor/assets/stylesheets/plinth/base/_reset.css.scss +284 -0
  220. data/vendor/assets/stylesheets/plinth/base/_type.css.scss +328 -0
  221. data/vendor/assets/stylesheets/plinth/base/webfonts/_all.css.scss +2 -0
  222. data/vendor/assets/stylesheets/plinth/base/webfonts/ss-social.css.scss +57 -0
  223. data/vendor/assets/stylesheets/plinth/base/webfonts/ss-standard.css.scss +48 -0
  224. data/vendor/assets/stylesheets/plinth/grid/_grid.css.scss +127 -0
  225. data/vendor/assets/stylesheets/plinth/modules/_alert.css.scss +71 -0
  226. data/vendor/assets/stylesheets/plinth/modules/_all-grid.css.scss +1 -0
  227. data/vendor/assets/stylesheets/plinth/modules/_all-no-grid.css.scss +4 -0
  228. data/vendor/assets/stylesheets/plinth/modules/_footer.css.scss +93 -0
  229. data/vendor/assets/stylesheets/plinth/modules/_nav.css.scss +106 -0
  230. data/vendor/assets/stylesheets/plinth/modules/_panel.css.scss +28 -0
  231. data/vendor/assets/stylesheets/plinth/modules/_switch.css.scss +88 -0
  232. data/vendor/assets/stylesheets/plinth.css.scss +15 -0
  233. data/vendor/assets/views/buttons/_buttons.haml +9 -0
  234. data/vendor/assets/views/forms/_vertical_form.haml +7 -0
  235. data/vendor/assets/views/type/_headings.haml +6 -0
  236. data/vendor/assets/views/type/_paragraphs.haml +4 -0
  237. metadata +537 -0
data/public/javascripts/classes/Switch.html ADDED
@@ -0,0 +1,318 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset='UTF-8'>
5
+ <title>Codo Documentation</title>
6
+ <link rel='stylesheet' href='../assets/codo.css' type='text/css'>
7
+ <script src='../assets/codo.js'></script>
8
+ <script src='../assets/search_data.js'></script>
9
+ </head>
10
+ <body>
11
+ <div id='base' data-path='../'></div>
12
+ <div id='header'>
13
+ <div id='menu'>
14
+ <a href='../README.md.html' title='Codo'>Codo</a>
15
+ &raquo;
16
+ <a href='../class_index.html' title='Index'>Index</a>
17
+ &raquo;
18
+ <span class='title'>Switch</span>
19
+ <nav>
20
+ <ul>
21
+ <li class='noframes'>
22
+ (<a class='noframes' href='#'>no frames</a>)
23
+ </li>
24
+ </ul>
25
+ </nav>
26
+ <div id='search'>
27
+ <a id='class_list_link' href='../class_list.html'>Classes</a>
28
+ <a id='file_list_link' href='../file_list.html'>Files</a>
29
+ <a id='method_list_link' href='../method_list.html'>Methods</a>
30
+ <a id='extra_list_link' href='../extra_list.html'>Extras</a>
31
+ </div>
32
+ </div>
33
+ <iframe id='search_frame'></iframe>
34
+ <div id='fuzzySearch'>
35
+ <input type='text'>
36
+ <ol></ol>
37
+ </div>
38
+ <div id='help'>
39
+ <p>
40
+ Quickly fuzzy find classes, mixins, methods, file:
41
+ </p>
42
+ <ul>
43
+ <li>
44
+ <span>Ctrl-T</span>
45
+ Open fuzzy finder dialog
46
+ </li>
47
+ </ul>
48
+ <p>
49
+ In frame mode you can toggle the list naviation frame on the left side:
50
+ </p>
51
+ <ul>
52
+ <li>
53
+ <span>Ctrl-L</span>
54
+ Toggle list view
55
+ </li>
56
+ </ul>
57
+ <p>
58
+ You can focus a list in frame mode or toggle a tab in frameless mode:
59
+ </p>
60
+ <ul>
61
+ <li>
62
+ <span>Ctrl-C</span>
63
+ Class list
64
+ </li>
65
+ <li>
66
+ <span>Ctrl-I</span>
67
+ Mixin list
68
+ </li>
69
+ <li>
70
+ <span>Ctrl-F</span>
71
+ File list
72
+ </li>
73
+ <li>
74
+ <span>Ctrl-M</span>
75
+ Method list
76
+ </li>
77
+ <li>
78
+ <span>Ctrl-E</span>
79
+ Extras list
80
+ </li>
81
+ </ul>
82
+ <p>
83
+ You can focus and blur the search input:
84
+ </p>
85
+ <ul>
86
+ <li>
87
+ <span>Ctrl-S</span>
88
+ Focus search input
89
+ </li>
90
+ <li>
91
+ <span>Esc</span>
92
+ Blur search input
93
+ </li>
94
+ </ul>
95
+ <p>
96
+ In frameless mode you can close the list tab:
97
+ </p>
98
+ <ul>
99
+ <li>
100
+ <span>Esc</span>
101
+ Close list tab
102
+ </li>
103
+ </ul>
104
+ </div>
105
+ </div>
106
+ <div id='content'>
107
+ <h1>
108
+ Class:
109
+ Switch
110
+ </h1>
111
+ <table class='box'>
112
+ <tr>
113
+ <td>Defined in:</td>
114
+ <td>vendor&#47;assets&#47;javascripts&#47;plinth&#47;plugins&#47;tbg-switch.js.coffee</td>
115
+ </tr>
116
+ </table>
117
+ <h2>Overview</h2>
118
+ <div class='docstring'>
119
+ <p>SWITCH CLASS DEFINITION</p>
120
+ <div class='examples'>
121
+ <h3>Examples:</h3>
122
+ <h4>
123
+ How to ensure plugin self initialises on element
124
+ </h4>
125
+ <pre><code class='coffee'>&lt;div data-switch=&quot;true&quot;&gt; ... &lt;&#47;div&gt;</code></pre>
126
+ <h4>
127
+ How to group switches and allow them to change state of other switches in that group
128
+ </h4>
129
+ <pre><code class='coffee'>&lt;div data-switch-group=&quot;[group name]&quot;&gt; ... &lt;&#47;div&gt;</code></pre>
130
+ <h4>
131
+ How to toggle switch state
132
+ </h4>
133
+ <pre><code class='coffee'>&lt;div data-switch-toggle=&quot;true&quot;&gt; ... &lt;&#47;div&gt;</code></pre>
134
+ </div>
135
+ </div>
136
+ <div class='tags'>
137
+ </div>
138
+ <h2>Instance Method Summary</h2>
139
+ <ul class='summary'>
140
+ <li>
141
+ <span class='signature'>
142
+ <a href='#constructor-instance'>
143
+ - (void) <strong>constructor</strong>(el)
144
+ </a>
145
+ </span>
146
+ <span class='constructor note title'>Constructor</span>
147
+ <span class='desc'>
148
+ Construct a new Switch instance Set this.parent, this.target, this.group and this.container elements for this.el; set this.toggle if attribute present
149
+ </span>
150
+ </li>
151
+ <li>
152
+ <span class='signature'>
153
+ <a href='#click-instance'>
154
+ - (void) <strong>click</strong>()
155
+ </a>
156
+ </span>
157
+ <span class='desc'>
158
+ Click handler - If this.parent isn&#39;t active, close group if this.group defined and change state to true; if this.parent is active and this.toggle set then change state to false otherwise return undefined
159
+ </span>
160
+ </li>
161
+ <li>
162
+ <span class='signature'>
163
+ <a href='#changeStateTo-instance'>
164
+ - (void) <strong>changeStateTo</strong>(action, elements)
165
+ </a>
166
+ </span>
167
+ <span class='desc'>
168
+ Change active state of target content - add or remove activeClass from content and parent elements
169
+ </span>
170
+ </li>
171
+ <li>
172
+ <span class='signature'>
173
+ <a href='#_closeGroup-instance'>
174
+ - (void) <strong>_closeGroup</strong>()
175
+ </a>
176
+ </span>
177
+ <span class='note private title'>Private</span>
178
+ <span class='desc'>
179
+ Close group - if any content is active, get the target for that element&#39;s descendant link element and pass false and elements array [activeContent, activeEl] to switch group
180
+ </span>
181
+ </li>
182
+ <li>
183
+ <span class='signature'>
184
+ <a href='#_getContent-instance'>
185
+ - (Object) <strong>_getContent</strong>(el)
186
+ </a>
187
+ </span>
188
+ <span class='note private title'>Private</span>
189
+ <span class='desc'>
190
+ Get target element to do switch on
191
+ </span>
192
+ </li>
193
+ </ul>
194
+ <h2>Constructor Details</h2>
195
+ <div class='methods'>
196
+ <div class='method_details'>
197
+ <p class='signature' id='constructor-instance'>
198
+ - (void) <strong>constructor</strong>(el)
199
+ </p>
200
+ <div class='docstring'>
201
+ <p>Construct a new Switch instance</p><p>Set this.parent, this.target, this.group and this.container elements for this.el; set this.toggle if attribute present</p>
202
+ </div>
203
+ <div class='tags'>
204
+ <h3>Parameters:</h3>
205
+ <ul class='param'>
206
+ <li>
207
+ <span class='name'>el</span>
208
+ <span class='type'>
209
+ (<tt>Object</tt>)
210
+ </span>
211
+ &mdash;
212
+ <span class='desc'>HTMLElement, this.el, that acts as the switch</span>
213
+ </li>
214
+ </ul>
215
+ </div>
216
+ </div>
217
+ </div>
218
+ <h2>Instance Method Details</h2>
219
+ <div class='methods'>
220
+ <div class='method_details'>
221
+ <p class='signature' id='click-instance'>
222
+ - (void) <strong>click</strong>()
223
+ </p>
224
+ <div class='docstring'>
225
+ <p>Click handler - If this.parent isn&#39;t active, close group if this.group defined and change state to true; if this.parent is active and this.toggle set then change state to false otherwise return undefined</p>
226
+ </div>
227
+ <div class='tags'>
228
+ </div>
229
+ </div>
230
+ <div class='method_details'>
231
+ <p class='signature' id='changeStateTo-instance'>
232
+ - (void) <strong>changeStateTo</strong>(action, elements)
233
+ </p>
234
+ <div class='docstring'>
235
+ <p>Change active state of target content - add or remove activeClass from content and parent elements</p>
236
+ </div>
237
+ <div class='tags'>
238
+ <h3>Parameters:</h3>
239
+ <ul class='param'>
240
+ <li>
241
+ <span class='name'>action</span>
242
+ <span class='type'>
243
+ (<tt>Boolean</tt>)
244
+ </span>
245
+ &mdash;
246
+ <span class='desc'>true to addClass to elements, false to removeClass from elements</span>
247
+ </li>
248
+ <li>
249
+ <span class='name'>elements</span>
250
+ <span class='type'>
251
+ (<tt>Array</tt>)
252
+ </span>
253
+ &mdash;
254
+ <span class='desc'>array of jQuery wrapped HTMLElements - target content element and parent element</span>
255
+ </li>
256
+ </ul>
257
+ </div>
258
+ </div>
259
+ <div class='method_details'>
260
+ <p class='signature' id='_closeGroup-instance'>
261
+ - (void) <strong>_closeGroup</strong>()
262
+ (private)
263
+ </p>
264
+ <div class='docstring'>
265
+ <p>Close group - if any content is active, get the target for that element&#39;s descendant link element and pass false and elements array [activeContent, activeEl] to switch group</p>
266
+ </div>
267
+ <div class='tags'>
268
+ </div>
269
+ </div>
270
+ <div class='method_details'>
271
+ <p class='signature' id='_getContent-instance'>
272
+ - (Object) <strong>_getContent</strong>(el)
273
+ (private)
274
+ </p>
275
+ <div class='docstring'>
276
+ <p>Get target element to do switch on</p>
277
+ </div>
278
+ <div class='tags'>
279
+ <h3>Parameters:</h3>
280
+ <ul class='param'>
281
+ <li>
282
+ <span class='name'>el</span>
283
+ <span class='type'>
284
+ (<tt>Object</tt>)
285
+ </span>
286
+ &mdash;
287
+ <span class='desc'>jQuery wrapped HTMLElement to get target element from</span>
288
+ </li>
289
+ </ul>
290
+ <h3>Returns:</h3>
291
+ <ul class='return'>
292
+ <li>
293
+ <span class='type'></span>
294
+ (<tt>Object</tt>)
295
+ &mdash;
296
+ <span class='desc'>jQuery wrapped HTMLElement for el&#39;s target element</span>
297
+ </li>
298
+ </ul>
299
+ </div>
300
+ </div>
301
+ </div>
302
+ </div>
303
+ <div id='footer'>
304
+ Generated on
305
+ Thu Mar 14 2013 13:49:05 GMT+0000 (GMT)
306
+ by
307
+ <a href='https://github.com/netzpirat/codo' title='CoffeeScript API documentation generator'>Codo</a>
308
+ v1.5.6
309
+ (Node.js v0.8.8).
310
+ &#10034;
311
+ Press Ctrl-h to see the keyboard shortcuts
312
+ &#10034;
313
+ <a href='http://twitter.com/#!/netzpirat'>@netzpirat</a>
314
+ &#10034;
315
+ <a href='https://mksoft.ch'>mksoft.ch</a>
316
+ </div>
317
+ </body>
318
+ </html>
data/public/javascripts/classes/TBGForm.html ADDED
@@ -0,0 +1,373 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset='UTF-8'>
5
+ <title>Codo Documentation</title>
6
+ <link rel='stylesheet' href='../assets/codo.css' type='text/css'>
7
+ <script src='../assets/codo.js'></script>
8
+ <script src='../assets/search_data.js'></script>
9
+ </head>
10
+ <body>
11
+ <div id='base' data-path='../'></div>
12
+ <div id='header'>
13
+ <div id='menu'>
14
+ <a href='../README.md.html' title='Codo'>Codo</a>
15
+ &raquo;
16
+ <a href='../class_index.html' title='Index'>Index</a>
17
+ &raquo;
18
+ <span class='title'>TBGForm</span>
19
+ <nav>
20
+ <ul>
21
+ <li class='noframes'>
22
+ (<a class='noframes' href='#'>no frames</a>)
23
+ </li>
24
+ </ul>
25
+ </nav>
26
+ <div id='search'>
27
+ <a id='class_list_link' href='../class_list.html'>Classes</a>
28
+ <a id='file_list_link' href='../file_list.html'>Files</a>
29
+ <a id='method_list_link' href='../method_list.html'>Methods</a>
30
+ <a id='extra_list_link' href='../extra_list.html'>Extras</a>
31
+ </div>
32
+ </div>
33
+ <iframe id='search_frame'></iframe>
34
+ <div id='fuzzySearch'>
35
+ <input type='text'>
36
+ <ol></ol>
37
+ </div>
38
+ <div id='help'>
39
+ <p>
40
+ Quickly fuzzy find classes, mixins, methods, file:
41
+ </p>
42
+ <ul>
43
+ <li>
44
+ <span>Ctrl-T</span>
45
+ Open fuzzy finder dialog
46
+ </li>
47
+ </ul>
48
+ <p>
49
+ In frame mode you can toggle the list naviation frame on the left side:
50
+ </p>
51
+ <ul>
52
+ <li>
53
+ <span>Ctrl-L</span>
54
+ Toggle list view
55
+ </li>
56
+ </ul>
57
+ <p>
58
+ You can focus a list in frame mode or toggle a tab in frameless mode:
59
+ </p>
60
+ <ul>
61
+ <li>
62
+ <span>Ctrl-C</span>
63
+ Class list
64
+ </li>
65
+ <li>
66
+ <span>Ctrl-I</span>
67
+ Mixin list
68
+ </li>
69
+ <li>
70
+ <span>Ctrl-F</span>
71
+ File list
72
+ </li>
73
+ <li>
74
+ <span>Ctrl-M</span>
75
+ Method list
76
+ </li>
77
+ <li>
78
+ <span>Ctrl-E</span>
79
+ Extras list
80
+ </li>
81
+ </ul>
82
+ <p>
83
+ You can focus and blur the search input:
84
+ </p>
85
+ <ul>
86
+ <li>
87
+ <span>Ctrl-S</span>
88
+ Focus search input
89
+ </li>
90
+ <li>
91
+ <span>Esc</span>
92
+ Blur search input
93
+ </li>
94
+ </ul>
95
+ <p>
96
+ In frameless mode you can close the list tab:
97
+ </p>
98
+ <ul>
99
+ <li>
100
+ <span>Esc</span>
101
+ Close list tab
102
+ </li>
103
+ </ul>
104
+ </div>
105
+ </div>
106
+ <div id='content'>
107
+ <h1>
108
+ Class:
109
+ TBGForm
110
+ </h1>
111
+ <table class='box'>
112
+ <tr>
113
+ <td>Defined in:</td>
114
+ <td>vendor&#47;assets&#47;javascripts&#47;plinth&#47;plugins&#47;tbg-forms.js.coffee</td>
115
+ </tr>
116
+ </table>
117
+ <h2>Overview</h2>
118
+ <div class='docstring'>
119
+ <p>FORM CLASS DEFINITION</p>
120
+ <div class='examples'>
121
+ <h3>Examples:</h3>
122
+ <h4>
123
+ How to use the class
124
+ </h4>
125
+ <pre><code class='coffee'>formInstance = new TBGForm $(&#39;.my-element&#39;)
126
+ # Send form
127
+ formInstance.send()</code></pre>
128
+ <h4>
129
+ How to use the class with jQuery
130
+ </h4>
131
+ <pre><code class='coffee'>$(&#39;.my-element&#39;).send()</code></pre>
132
+ <h4>
133
+ How to ensure plugin self initialises on element
134
+ </h4>
135
+ <pre><code class='coffee'>&lt;form data-forms=&quot;&#47;endpoint&quot;&gt; ... &lt;&#47;form&gt;</code></pre>
136
+ </div>
137
+ </div>
138
+ <div class='tags'>
139
+ </div>
140
+ <h2>Instance Method Summary</h2>
141
+ <ul class='summary'>
142
+ <li>
143
+ <span class='signature'>
144
+ <a href='#constructor-instance'>
145
+ - (void) <strong>constructor</strong>(element)
146
+ </a>
147
+ </span>
148
+ <span class='constructor note title'>Constructor</span>
149
+ <span class='desc'>
150
+ Construct a new TBGForm instance
151
+ </span>
152
+ </li>
153
+ <li>
154
+ <span class='signature'>
155
+ <a href='#send-instance'>
156
+ - (void) <strong>send</strong>()
157
+ </a>
158
+ </span>
159
+ <span class='desc'>
160
+ Send the form, calls sendRequest passing form data and url to post to
161
+ </span>
162
+ </li>
163
+ <li>
164
+ <span class='signature'>
165
+ <a href='#sendRequest-instance'>
166
+ - (void) <strong>sendRequest</strong>(data, url)
167
+ </a>
168
+ </span>
169
+ <span class='desc'>
170
+ Execute ajax post
171
+ </span>
172
+ </li>
173
+ <li>
174
+ <span class='signature'>
175
+ <a href='#showErrors-instance'>
176
+ - (void) <strong>showErrors</strong>(errors)
177
+ </a>
178
+ </span>
179
+ <span class='desc'>
180
+ Handle form post errors - called from sendRequest error callback.
181
+ </span>
182
+ </li>
183
+ <li>
184
+ <span class='signature'>
185
+ <a href='#showSuccess-instance'>
186
+ - (void) <strong>showSuccess</strong>(data)
187
+ </a>
188
+ </span>
189
+ <span class='desc'>
190
+ Handle form post success - called from sendRequest success callback.
191
+ </span>
192
+ </li>
193
+ <li>
194
+ <span class='signature'>
195
+ <a href='#_showSuccessTemplated-instance'>
196
+ - (void) <strong>_showSuccessTemplated</strong>(data)
197
+ </a>
198
+ </span>
199
+ <span class='note private title'>Private</span>
200
+ <span class='desc'>
201
+ Display compiled success template Compile template from data-formsSuccessContent; display with data object
202
+ </span>
203
+ </li>
204
+ <li>
205
+ <span class='signature'>
206
+ <a href='#_showSuccessPlain-instance'>
207
+ - (void) <strong>_showSuccessPlain</strong>()
208
+ </a>
209
+ </span>
210
+ <span class='note private title'>Private</span>
211
+ <span class='desc'>
212
+ Display success with replaced content Display data-formsSuccessContent HTML
213
+ </span>
214
+ </li>
215
+ </ul>
216
+ <h2>Constructor Details</h2>
217
+ <div class='methods'>
218
+ <div class='method_details'>
219
+ <p class='signature' id='constructor-instance'>
220
+ - (void) <strong>constructor</strong>(element)
221
+ </p>
222
+ <div class='docstring'>
223
+ <p>Construct a new TBGForm instance</p>
224
+ </div>
225
+ <div class='tags'>
226
+ <h3>Parameters:</h3>
227
+ <ul class='param'>
228
+ <li>
229
+ <span class='name'>element</span>
230
+ <span class='type'>
231
+ (<tt>Object</tt>)
232
+ </span>
233
+ &mdash;
234
+ <span class='desc'>form we will attach the TBGForm to</span>
235
+ </li>
236
+ </ul>
237
+ </div>
238
+ </div>
239
+ </div>
240
+ <h2>Instance Method Details</h2>
241
+ <div class='methods'>
242
+ <div class='method_details'>
243
+ <p class='signature' id='send-instance'>
244
+ - (void) <strong>send</strong>()
245
+ </p>
246
+ <div class='docstring'>
247
+ <p>Send the form, calls sendRequest passing form data and url to post to</p>
248
+ </div>
249
+ <div class='tags'>
250
+ </div>
251
+ </div>
252
+ <div class='method_details'>
253
+ <p class='signature' id='sendRequest-instance'>
254
+ - (void) <strong>sendRequest</strong>(data, url)
255
+ </p>
256
+ <div class='docstring'>
257
+ <p>Execute ajax post</p>
258
+ </div>
259
+ <div class='tags'>
260
+ <h3>Parameters:</h3>
261
+ <ul class='param'>
262
+ <li>
263
+ <span class='name'>data</span>
264
+ <span class='type'>
265
+ (<tt>String</tt>)
266
+ </span>
267
+ &mdash;
268
+ <span class='desc'>serialized form data</span>
269
+ </li>
270
+ <li>
271
+ <span class='name'>url</span>
272
+ <span class='type'>
273
+ (<tt>String</tt>)
274
+ </span>
275
+ &mdash;
276
+ <span class='desc'>URL to post form to</span>
277
+ </li>
278
+ </ul>
279
+ </div>
280
+ </div>
281
+ <div class='method_details'>
282
+ <p class='signature' id='showErrors-instance'>
283
+ - (void) <strong>showErrors</strong>(errors)
284
+ </p>
285
+ <div class='docstring'>
286
+ <p>Handle form post errors - called from sendRequest error callback.</p><p>Clear previous errors, add error classes to relevent fields and labels and add error message summary</p>
287
+ </div>
288
+ <div class='tags'>
289
+ <h3>Parameters:</h3>
290
+ <ul class='param'>
291
+ <li>
292
+ <span class='name'>errors</span>
293
+ <span class='type'>
294
+ (<tt>Object</tt>)
295
+ </span>
296
+ &mdash;
297
+ <span class='desc'>errors object</span>
298
+ </li>
299
+ </ul>
300
+ </div>
301
+ </div>
302
+ <div class='method_details'>
303
+ <p class='signature' id='showSuccess-instance'>
304
+ - (void) <strong>showSuccess</strong>(data)
305
+ </p>
306
+ <div class='docstring'>
307
+ <p>Handle form post success - called from sendRequest success callback.</p><p>Pass empty error object to showErrors; if Handlebars defined call _showSuccessTemplated with data object otherwise call _showSuccessPlain; trigger &#39;tbgform-success&#39; event with form data; fade form if necessary</p>
308
+ </div>
309
+ <div class='tags'>
310
+ <h3>Parameters:</h3>
311
+ <ul class='param'>
312
+ <li>
313
+ <span class='name'>data</span>
314
+ <span class='type'>
315
+ (<tt>Object</tt>)
316
+ </span>
317
+ &mdash;
318
+ <span class='desc'>response from ajax post</span>
319
+ </li>
320
+ </ul>
321
+ </div>
322
+ </div>
323
+ <div class='method_details'>
324
+ <p class='signature' id='_showSuccessTemplated-instance'>
325
+ - (void) <strong>_showSuccessTemplated</strong>(data)
326
+ (private)
327
+ </p>
328
+ <div class='docstring'>
329
+ <p>Display compiled success template</p><p>Compile template from data-formsSuccessContent; display with data object</p>
330
+ </div>
331
+ <div class='tags'>
332
+ <h3>Parameters:</h3>
333
+ <ul class='param'>
334
+ <li>
335
+ <span class='name'>data</span>
336
+ <span class='type'>
337
+ (<tt>Object</tt>)
338
+ </span>
339
+ &mdash;
340
+ <span class='desc'>data object from showSuccess</span>
341
+ </li>
342
+ </ul>
343
+ </div>
344
+ </div>
345
+ <div class='method_details'>
346
+ <p class='signature' id='_showSuccessPlain-instance'>
347
+ - (void) <strong>_showSuccessPlain</strong>()
348
+ (private)
349
+ </p>
350
+ <div class='docstring'>
351
+ <p>Display success with replaced content</p><p>Display data-formsSuccessContent HTML</p>
352
+ </div>
353
+ <div class='tags'>
354
+ </div>
355
+ </div>
356
+ </div>
357
+ </div>
358
+ <div id='footer'>
359
+ Generated on
360
+ Thu Mar 14 2013 13:49:05 GMT+0000 (GMT)
361
+ by
362
+ <a href='https://github.com/netzpirat/codo' title='CoffeeScript API documentation generator'>Codo</a>
363
+ v1.5.6
364
+ (Node.js v0.8.8).
365
+ &#10034;
366
+ Press Ctrl-h to see the keyboard shortcuts
367
+ &#10034;
368
+ <a href='http://twitter.com/#!/netzpirat'>@netzpirat</a>
369
+ &#10034;
370
+ <a href='https://mksoft.ch'>mksoft.ch</a>
371
+ </div>
372
+ </body>
373
+ </html>