bulma_form_rails 0.9.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.idea/.gitignore +8 -0
- data/.idea/bulma_form_rails.iml +82 -0
- data/.idea/inspectionProfiles/Project_Default.xml +6 -0
- data/.idea/misc.xml +7 -0
- data/.idea/modules.xml +8 -0
- data/.idea/vcs.xml +6 -0
- data/.rbenv-gemsets +3 -0
- data/.ruby-version +1 -0
- data/Gemfile +14 -0
- data/Gemfile.lock +203 -0
- data/LICENSE +29 -0
- data/README.md +163 -0
- data/Rakefile +11 -0
- data/doc/BulmaFormRails/Helpers.html +698 -0
- data/doc/BulmaFormRails.html +93 -0
- data/doc/created.rid +2 -0
- data/doc/css/fonts.css +167 -0
- data/doc/css/rdoc.css +639 -0
- data/doc/fonts/Lato-Light.ttf +0 -0
- data/doc/fonts/Lato-LightItalic.ttf +0 -0
- data/doc/fonts/Lato-Regular.ttf +0 -0
- data/doc/fonts/Lato-RegularItalic.ttf +0 -0
- data/doc/fonts/SourceCodePro-Bold.ttf +0 -0
- data/doc/fonts/SourceCodePro-Regular.ttf +0 -0
- data/doc/images/add.png +0 -0
- data/doc/images/arrow_up.png +0 -0
- data/doc/images/brick.png +0 -0
- data/doc/images/brick_link.png +0 -0
- data/doc/images/bug.png +0 -0
- data/doc/images/bullet_black.png +0 -0
- data/doc/images/bullet_toggle_minus.png +0 -0
- data/doc/images/bullet_toggle_plus.png +0 -0
- data/doc/images/date.png +0 -0
- data/doc/images/delete.png +0 -0
- data/doc/images/find.png +0 -0
- data/doc/images/loadingAnimation.gif +0 -0
- data/doc/images/macFFBgHack.png +0 -0
- data/doc/images/moderngeosystems_logo.png +0 -0
- data/doc/images/package.png +0 -0
- data/doc/images/page_green.png +0 -0
- data/doc/images/page_white_text.png +0 -0
- data/doc/images/page_white_width.png +0 -0
- data/doc/images/plugin.png +0 -0
- data/doc/images/ruby.png +0 -0
- data/doc/images/tag_blue.png +0 -0
- data/doc/images/tag_green.png +0 -0
- data/doc/images/transparent.png +0 -0
- data/doc/images/wrench.png +0 -0
- data/doc/images/wrench_orange.png +0 -0
- data/doc/images/zoom.png +0 -0
- data/doc/index.html +82 -0
- data/doc/js/darkfish.js +84 -0
- data/doc/js/navigation.js +105 -0
- data/doc/js/navigation.js.gz +0 -0
- data/doc/js/search.js +110 -0
- data/doc/js/search_index.js +1 -0
- data/doc/js/search_index.js.gz +0 -0
- data/doc/js/searcher.js +229 -0
- data/doc/js/searcher.js.gz +0 -0
- data/doc/table_of_contents.html +125 -0
- data/lib/bulma_form_rails/field_helpers.rb +239 -0
- data/lib/bulma_form_rails/form_page_helpers.rb +36 -0
- data/lib/bulma_form_rails/header_and_footer_helpers.rb +36 -0
- data/lib/bulma_form_rails/javascript/controllers/child_objects_controller.js +66 -0
- data/lib/bulma_form_rails/message_box_helpers.rb +25 -0
- data/lib/bulma_form_rails/railtie.rb +62 -0
- data/lib/bulma_form_rails/subform_helpers.rb +33 -0
- data/lib/bulma_form_rails/version.rb +3 -0
- data/lib/bulma_form_rails.rb +3 -0
- data/lib/generators/bulma_form_rails/pagy_config_generator.rb +15 -0
- data/lib/generators/bulma_form_rails/views_generator.rb +19 -0
- data/lib/install/bulma_form_rails.rb +13 -0
- data/lib/tasks/bulma_form_rails_tasks.rake +30 -0
- data/lib/templates/app/views/_form.html.erb +0 -0
- data/lib/templates/app/views/bulma_form_rails/_child.html.erb +61 -0
- data/lib/templates/app/views/bulma_form_rails/_children.html.erb +61 -0
- data/lib/templates/app/views/bulma_form_rails/_datetime_select.html.erb +10 -0
- data/lib/templates/app/views/bulma_form_rails/_edit_form_page.html.erb +15 -0
- data/lib/templates/app/views/bulma_form_rails/_field.html.erb +10 -0
- data/lib/templates/app/views/bulma_form_rails/_form_footer.html.erb +17 -0
- data/lib/templates/app/views/bulma_form_rails/_index_header.html.erb +16 -0
- data/lib/templates/app/views/bulma_form_rails/_message_box.html.erb +35 -0
- data/lib/templates/app/views/bulma_form_rails/_new_form_page.html.erb +15 -0
- data/lib/templates/app/views/bulma_form_rails/_radio_group.html.erb +6 -0
- data/lib/templates/app/views/bulma_form_rails/_select.html.erb +7 -0
- data/lib/templates/app/views/bulma_form_rails/_time_select.html.erb +10 -0
- data/lib/templates/app/views/bulma_form_rails/_validation_box.html.erb +15 -0
- data/lib/templates/app/views/bulma_form_rails/_value.html.erb +6 -0
- data/lib/templates/config/initializers/pagy.rb +211 -0
- data/package.json +45 -0
- data/sig/bulma_form_helper.rbs +68 -0
- data/yarn.lock +53 -0
- metadata +291 -0
@@ -0,0 +1,698 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
|
3
|
+
<html>
|
4
|
+
<head>
|
5
|
+
<meta charset="UTF-8">
|
6
|
+
|
7
|
+
<title>module BulmaFormRails::Helpers - RDoc Documentation</title>
|
8
|
+
|
9
|
+
<script type="text/javascript">
|
10
|
+
var rdoc_rel_prefix = "../";
|
11
|
+
var index_rel_prefix = "../";
|
12
|
+
</script>
|
13
|
+
|
14
|
+
<script src="../js/navigation.js" defer></script>
|
15
|
+
<script src="../js/search.js" defer></script>
|
16
|
+
<script src="../js/search_index.js" defer></script>
|
17
|
+
<script src="../js/searcher.js" defer></script>
|
18
|
+
<script src="../js/darkfish.js" defer></script>
|
19
|
+
|
20
|
+
<link href="../css/fonts.css" rel="stylesheet">
|
21
|
+
<link href="../css/rdoc.css" rel="stylesheet">
|
22
|
+
|
23
|
+
|
24
|
+
<body id="top" role="document" class="module">
|
25
|
+
<nav role="navigation">
|
26
|
+
<div id="project-navigation">
|
27
|
+
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
|
28
|
+
<h2>
|
29
|
+
<a href="../index.html" rel="home">Home</a>
|
30
|
+
</h2>
|
31
|
+
|
32
|
+
<div id="table-of-contents-navigation">
|
33
|
+
<a href="../table_of_contents.html#pages">Pages</a>
|
34
|
+
<a href="../table_of_contents.html#classes">Classes</a>
|
35
|
+
<a href="../table_of_contents.html#methods">Methods</a>
|
36
|
+
</div>
|
37
|
+
</div>
|
38
|
+
|
39
|
+
<div id="search-section" role="search" class="project-section initially-hidden">
|
40
|
+
<form action="#" method="get" accept-charset="utf-8">
|
41
|
+
<div id="search-field-wrapper">
|
42
|
+
<input id="search-field" role="combobox" aria-label="Search"
|
43
|
+
aria-autocomplete="list" aria-controls="search-results"
|
44
|
+
type="text" name="search" placeholder="Search" spellcheck="false"
|
45
|
+
title="Type to search, Up and Down to navigate, Enter to load">
|
46
|
+
</div>
|
47
|
+
|
48
|
+
<ul id="search-results" aria-label="Search Results"
|
49
|
+
aria-busy="false" aria-expanded="false"
|
50
|
+
aria-atomic="false" class="initially-hidden"></ul>
|
51
|
+
</form>
|
52
|
+
</div>
|
53
|
+
|
54
|
+
</div>
|
55
|
+
|
56
|
+
|
57
|
+
|
58
|
+
<div id="class-metadata">
|
59
|
+
|
60
|
+
|
61
|
+
|
62
|
+
|
63
|
+
|
64
|
+
<!-- Method Quickref -->
|
65
|
+
<div id="method-list-section" class="nav-section">
|
66
|
+
<h3>Methods</h3>
|
67
|
+
|
68
|
+
<ul class="link-list" role="directory">
|
69
|
+
<li ><a href="#method-i-bulma_check_box">#bulma_check_box</a>
|
70
|
+
<li ><a href="#method-i-bulma_child_objects">#bulma_child_objects</a>
|
71
|
+
<li ><a href="#method-i-bulma_custom_field">#bulma_custom_field</a>
|
72
|
+
<li ><a href="#method-i-bulma_datetime_select">#bulma_datetime_select</a>
|
73
|
+
<li ><a href="#method-i-bulma_edit_form_page">#bulma_edit_form_page</a>
|
74
|
+
<li ><a href="#method-i-bulma_form_footer">#bulma_form_footer</a>
|
75
|
+
<li ><a href="#method-i-bulma_index_header">#bulma_index_header</a>
|
76
|
+
<li ><a href="#method-i-bulma_input">#bulma_input</a>
|
77
|
+
<li ><a href="#method-i-bulma_message_box">#bulma_message_box</a>
|
78
|
+
<li ><a href="#method-i-bulma_new_form_page">#bulma_new_form_page</a>
|
79
|
+
<li ><a href="#method-i-bulma_radio_group">#bulma_radio_group</a>
|
80
|
+
<li ><a href="#method-i-bulma_select">#bulma_select</a>
|
81
|
+
<li ><a href="#method-i-bulma_text_area">#bulma_text_area</a>
|
82
|
+
<li ><a href="#method-i-bulma_time_select">#bulma_time_select</a>
|
83
|
+
<li ><a href="#method-i-bulma_validation_box">#bulma_validation_box</a>
|
84
|
+
</ul>
|
85
|
+
</div>
|
86
|
+
|
87
|
+
</div>
|
88
|
+
</nav>
|
89
|
+
|
90
|
+
<main role="main" aria-labelledby="module-BulmaFormRails::Helpers">
|
91
|
+
<h1 id="module-BulmaFormRails::Helpers" class="module">
|
92
|
+
module BulmaFormRails::Helpers
|
93
|
+
</h1>
|
94
|
+
|
95
|
+
<section class="description">
|
96
|
+
|
97
|
+
<p><img src="../images/moderngeosystems_logo.png"></p>
|
98
|
+
|
99
|
+
<p>This Ruby on Rails Helper module allows easy and efficient web form construction with labeled fields of different types. It also supports tabular editable multi-object subforms.</p>
|
100
|
+
|
101
|
+
</section>
|
102
|
+
|
103
|
+
<section id="5Buntitled-5D" class="documentation-section">
|
104
|
+
|
105
|
+
|
106
|
+
<section class="constants-list">
|
107
|
+
<header>
|
108
|
+
<h3>Constants</h3>
|
109
|
+
</header>
|
110
|
+
<dl>
|
111
|
+
<dt id="VALID_INPUT_TYPES">VALID_INPUT_TYPES
|
112
|
+
<dd>
|
113
|
+
</dl>
|
114
|
+
</section>
|
115
|
+
|
116
|
+
|
117
|
+
|
118
|
+
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
119
|
+
<header>
|
120
|
+
<h3>Public Instance Methods</h3>
|
121
|
+
</header>
|
122
|
+
|
123
|
+
<div id="method-i-bulma_check_box" class="method-detail ">
|
124
|
+
<div class="method-heading">
|
125
|
+
<span class="method-name">bulma_check_box</span><span
|
126
|
+
class="method-args">(form_or_object, field_name, options = {})</span>
|
127
|
+
<span class="method-click-advice">click to toggle source</span>
|
128
|
+
</div>
|
129
|
+
|
130
|
+
<div class="method-description">
|
131
|
+
<p>Render a labeled checkbox field.</p>
|
132
|
+
<ul><li>
|
133
|
+
<p><code>form_or_object</code> - the form or object</p>
|
134
|
+
</li><li>
|
135
|
+
<p><code>field_name</code> - a symbol representing the name of the field</p>
|
136
|
+
</li><li>
|
137
|
+
<p><code>options</code> - a hash of additional options:</p>
|
138
|
+
<ul><li>
|
139
|
+
<p><code>class</code> - additional checkbox classes other than <code>checkbox</code></p>
|
140
|
+
</li><li>
|
141
|
+
<p><code>label</code> - custom field label text</p>
|
142
|
+
</li></ul>
|
143
|
+
</li></ul>
|
144
|
+
|
145
|
+
<div class="method-source-code" id="bulma_check_box-source">
|
146
|
+
<pre><span class="ruby-comment"># File lib/bulma_form_rails/helpers.rb, line 150</span>
|
147
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">bulma_check_box</span>(<span class="ruby-identifier">form_or_object</span>, <span class="ruby-identifier">field_name</span>, <span class="ruby-identifier">options</span> = {})
|
148
|
+
<span class="ruby-comment"># Prepare parameters.</span>
|
149
|
+
<span class="ruby-identifier">prepare_value_class!</span>(<span class="ruby-identifier">options</span>, <span class="ruby-value">base_class:</span> <span class="ruby-string">'checkbox'</span>)
|
150
|
+
<span class="ruby-identifier">render_parameters</span> = <span class="ruby-identifier">prepare_common_parameters</span>(<span class="ruby-identifier">field_name</span>, <span class="ruby-identifier">form_or_object</span>, <span class="ruby-identifier">options</span>)
|
151
|
+
|
152
|
+
<span class="ruby-comment"># Render the labeled field.</span>
|
153
|
+
<span class="ruby-identifier">render</span> <span class="ruby-value">layout:</span> <span class="ruby-string">'bulma_form_rails/field'</span>, <span class="ruby-value">locals:</span> <span class="ruby-identifier">render_parameters</span> <span class="ruby-keyword">do</span>
|
154
|
+
<span class="ruby-identifier">render</span> <span class="ruby-value">partial:</span> <span class="ruby-string">'bulma_form_rails/value'</span>, <span class="ruby-value">locals:</span> <span class="ruby-identifier">render_parameters</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-value">method:</span> <span class="ruby-value">:check_box</span>, <span class="ruby-value">additional_field_classes:</span> <span class="ruby-string">'is-narrow'</span>)
|
155
|
+
<span class="ruby-keyword">end</span>
|
156
|
+
<span class="ruby-keyword">end</span></pre>
|
157
|
+
</div>
|
158
|
+
</div>
|
159
|
+
|
160
|
+
|
161
|
+
</div>
|
162
|
+
|
163
|
+
<div id="method-i-bulma_child_objects" class="method-detail ">
|
164
|
+
<div class="method-heading">
|
165
|
+
<span class="method-name">bulma_child_objects</span><span
|
166
|
+
class="method-args">(collection, name, attributes_key, add_child_path, options = {})</span>
|
167
|
+
<span class="method-click-advice">click to toggle source</span>
|
168
|
+
</div>
|
169
|
+
|
170
|
+
<div class="method-description">
|
171
|
+
<p>Renders a child objects collection management UI subform, including row addition and deletion buttons by default.</p>
|
172
|
+
<ul><li>
|
173
|
+
<p><code>collection</code> - an array of serializable objects</p>
|
174
|
+
</li><li>
|
175
|
+
<p><code>name</code> - the lower-case singular name of the object for display purposes</p>
|
176
|
+
</li><li>
|
177
|
+
<p><code>attributes_key</code> - a symbolic key into the attribute reference hash retrievable via the <code>lookup_attributes(key)</code> method defined on the controller as a <code>helper_method</code>, eg <code>:object</code> for:</p>
|
178
|
+
|
179
|
+
<pre class="ruby">{<span class="ruby-value">object:</span> [<span class="ruby-string">"attribute_1"</span>, <span class="ruby-string">"attribute_2"</span>]}
|
180
|
+
</pre>
|
181
|
+
</li><li>
|
182
|
+
<p><code>add_child_path</code> - the controller URL path for the action to add a child object to the collection</p>
|
183
|
+
</li><li>
|
184
|
+
<p><code>options</code> - a hash of additional options to pass to the partials</p>
|
185
|
+
<ul><li>
|
186
|
+
<p><code>system_controlled</code> - <code>true</code> if you want no row add or delete buttons, <code>false</code> or unspecified if you do want add and delete buttons</p>
|
187
|
+
</li><li>
|
188
|
+
<p><code>total_columns</code> - an array of integers representing column numbers requiring arithmetic totals at the bottom of the subform, eg:</p>
|
189
|
+
|
190
|
+
<pre class="ruby">[<span class="ruby-value">3</span>, <span class="ruby-value">4</span>]
|
191
|
+
</pre>
|
192
|
+
</li><li>
|
193
|
+
<p><code>container</code> - a string representing an array index expression for a row if not a single index, eg:</p>
|
194
|
+
|
195
|
+
<pre class="ruby"><span class="ruby-node">"[related_reservations][#{related_reservation_counter}]"</span>
|
196
|
+
</pre>
|
197
|
+
</li></ul>
|
198
|
+
</li></ul>
|
199
|
+
|
200
|
+
<p>To use this helper method, you will first need to do the following:</p>
|
201
|
+
<ol><li>
|
202
|
+
<p>Call <code>bulma_child_forms</code> from the specific controller (but outside any existing method definitions) for your view, passing in a hash of the object collections to be managed along with their attributes, for example, <code>{object1: %w[attr1 attr2], object2: %w[attr3 attr4]}</code>.</p>
|
203
|
+
</li><li>
|
204
|
+
<p>Add a route to the <code>add_child</code> action for the same controller, for example, <code>put 'users/add_child', to: 'users#add_child'</code>.</p>
|
205
|
+
</li></ol>
|
206
|
+
|
207
|
+
<div class="method-source-code" id="bulma_child_objects-source">
|
208
|
+
<pre><span class="ruby-comment"># File lib/bulma_form_rails/helpers.rb, line 27</span>
|
209
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">bulma_child_objects</span>(<span class="ruby-identifier">collection</span>, <span class="ruby-identifier">name</span>, <span class="ruby-identifier">attributes_key</span>, <span class="ruby-identifier">add_child_path</span>, <span class="ruby-identifier">options</span> = {})
|
210
|
+
<span class="ruby-identifier">render</span> <span class="ruby-value">partial:</span> <span class="ruby-string">'bulma_form_rails/children'</span>, <span class="ruby-value">object:</span> <span class="ruby-identifier">collection</span>, <span class="ruby-value">locals:</span> {<span class="ruby-value">url:</span> <span class="ruby-identifier">add_child_path</span>, <span class="ruby-value">name:</span> <span class="ruby-identifier">name</span>, <span class="ruby-value">attributes_key:</span> <span class="ruby-identifier">attributes_key</span>}.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">options</span>)
|
211
|
+
<span class="ruby-keyword">end</span></pre>
|
212
|
+
</div>
|
213
|
+
</div>
|
214
|
+
|
215
|
+
|
216
|
+
</div>
|
217
|
+
|
218
|
+
<div id="method-i-bulma_custom_field" class="method-detail ">
|
219
|
+
<div class="method-heading">
|
220
|
+
<span class="method-name">bulma_custom_field</span><span
|
221
|
+
class="method-args">(form_or_object, field_name, options = {}, &block)</span>
|
222
|
+
<span class="method-click-advice">click to toggle source</span>
|
223
|
+
</div>
|
224
|
+
|
225
|
+
<div class="method-description">
|
226
|
+
<p>Render a labeled field with custom content.</p>
|
227
|
+
<ul><li>
|
228
|
+
<p><code>form_or_object</code> - the form or object</p>
|
229
|
+
</li><li>
|
230
|
+
<p><code>field_name</code> - a symbol representing the name of the field as a whole, regardless of how many tags are in the specified ERb block</p>
|
231
|
+
</li><li>
|
232
|
+
<p><code>options</code> - a hash of additional options:</p>
|
233
|
+
<ul><li>
|
234
|
+
<p><code>label</code> - custom field label text</p>
|
235
|
+
</li></ul>
|
236
|
+
</li><li>
|
237
|
+
<p><code>block</code> - ERb to render the field value content</p>
|
238
|
+
</li></ul>
|
239
|
+
|
240
|
+
<div class="method-source-code" id="bulma_custom_field-source">
|
241
|
+
<pre><span class="ruby-comment"># File lib/bulma_form_rails/helpers.rb, line 87</span>
|
242
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">bulma_custom_field</span>(<span class="ruby-identifier">form_or_object</span>, <span class="ruby-identifier">field_name</span>, <span class="ruby-identifier">options</span> = {}, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
243
|
+
<span class="ruby-comment"># Prepare parameters.</span>
|
244
|
+
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'No block given for custom field'</span>) <span class="ruby-keyword">if</span> <span class="ruby-operator">!</span><span class="ruby-identifier">block_given?</span>
|
245
|
+
<span class="ruby-identifier">render_parameters</span> = <span class="ruby-identifier">prepare_common_parameters</span>(<span class="ruby-identifier">field_name</span>, <span class="ruby-identifier">form_or_object</span>, <span class="ruby-identifier">options</span>)
|
246
|
+
<span class="ruby-identifier">render_parameters</span>.<span class="ruby-identifier">merge!</span>(<span class="ruby-value">additional_field_label_classes:</span> <span class="ruby-string">'is-normal'</span>) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:contains_check_box_or_radio_group</span>]
|
247
|
+
|
248
|
+
<span class="ruby-comment"># Render the labeled field.</span>
|
249
|
+
<span class="ruby-identifier">render</span> <span class="ruby-value">layout:</span> <span class="ruby-string">'bulma_form_rails/field'</span>, <span class="ruby-value">locals:</span> <span class="ruby-identifier">render_parameters</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>
|
250
|
+
<span class="ruby-keyword">end</span></pre>
|
251
|
+
</div>
|
252
|
+
</div>
|
253
|
+
|
254
|
+
|
255
|
+
</div>
|
256
|
+
|
257
|
+
<div id="method-i-bulma_datetime_select" class="method-detail ">
|
258
|
+
<div class="method-heading">
|
259
|
+
<span class="method-name">bulma_datetime_select</span><span
|
260
|
+
class="method-args">(form_or_object, field_name, options = {}, html_options = {})</span>
|
261
|
+
<span class="method-click-advice">click to toggle source</span>
|
262
|
+
</div>
|
263
|
+
|
264
|
+
<div class="method-description">
|
265
|
+
<p>Render a labeled date+time selection field.</p>
|
266
|
+
<ul><li>
|
267
|
+
<p><code>form_or_object</code> - the form or object</p>
|
268
|
+
</li><li>
|
269
|
+
<p><code>field_name</code> - a symbol representing the name of the field</p>
|
270
|
+
</li><li>
|
271
|
+
<p><code>options</code> - a hash of additional options</p>
|
272
|
+
</li><li>
|
273
|
+
<p><code>html_options</code> - a hash of additional options:</p>
|
274
|
+
<ul><li>
|
275
|
+
<p><code>class</code> - additional select classes other than <code>select</code></p>
|
276
|
+
</li><li>
|
277
|
+
<p><code>label</code> - custom field label text</p>
|
278
|
+
</li></ul>
|
279
|
+
</li></ul>
|
280
|
+
|
281
|
+
<div class="method-source-code" id="bulma_datetime_select-source">
|
282
|
+
<pre><span class="ruby-comment"># File lib/bulma_form_rails/helpers.rb, line 205</span>
|
283
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">bulma_datetime_select</span>(<span class="ruby-identifier">form_or_object</span>, <span class="ruby-identifier">field_name</span>, <span class="ruby-identifier">options</span> = {}, <span class="ruby-identifier">html_options</span> = {})
|
284
|
+
<span class="ruby-comment"># Prepare parameters.</span>
|
285
|
+
<span class="ruby-identifier">prepare_value_class!</span>(<span class="ruby-identifier">options</span>, <span class="ruby-value">base_class:</span> <span class="ruby-string">'select is-fullwidth'</span>)
|
286
|
+
<span class="ruby-identifier">render_parameters</span> = <span class="ruby-identifier">prepare_common_parameters</span>(<span class="ruby-identifier">field_name</span>, <span class="ruby-identifier">form_or_object</span>, <span class="ruby-identifier">options</span>)
|
287
|
+
|
288
|
+
<span class="ruby-comment"># Render the labeled field.</span>
|
289
|
+
<span class="ruby-identifier">render</span> <span class="ruby-value">layout:</span> <span class="ruby-string">'bulma_form_rails/field'</span>, <span class="ruby-value">locals:</span> <span class="ruby-identifier">render_parameters</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-value">additional_field_label_classes:</span> <span class="ruby-string">'is-normal'</span>) <span class="ruby-keyword">do</span>
|
290
|
+
<span class="ruby-identifier">render</span> <span class="ruby-value">partial:</span> <span class="ruby-string">'bulma_form_rails/datetime_select'</span>, <span class="ruby-value">locals:</span> <span class="ruby-identifier">render_parameters</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-value">html_options:</span> <span class="ruby-identifier">html_options</span>)
|
291
|
+
<span class="ruby-keyword">end</span>
|
292
|
+
<span class="ruby-keyword">end</span></pre>
|
293
|
+
</div>
|
294
|
+
</div>
|
295
|
+
|
296
|
+
|
297
|
+
</div>
|
298
|
+
|
299
|
+
<div id="method-i-bulma_edit_form_page" class="method-detail ">
|
300
|
+
<div class="method-heading">
|
301
|
+
<span class="method-name">bulma_edit_form_page</span><span
|
302
|
+
class="method-args">(name, model, models_path, model_path)</span>
|
303
|
+
<span class="method-click-advice">click to toggle source</span>
|
304
|
+
</div>
|
305
|
+
|
306
|
+
<div class="method-description">
|
307
|
+
<p>Render a standard model edit form page.</p>
|
308
|
+
<ul><li>
|
309
|
+
<p><code>name</code> - a symbol representing the model name</p>
|
310
|
+
</li><li>
|
311
|
+
<p><code>model</code> - the model object</p>
|
312
|
+
</li><li>
|
313
|
+
<p><code>models_path</code> - the controller URL path for the action that renders the model collection</p>
|
314
|
+
</li><li>
|
315
|
+
<p><code>model_path</code> - the controller URL path for the action that renders this individual model</p>
|
316
|
+
</li></ul>
|
317
|
+
|
318
|
+
<div class="method-source-code" id="bulma_edit_form_page-source">
|
319
|
+
<pre><span class="ruby-comment"># File lib/bulma_form_rails/helpers.rb, line 51</span>
|
320
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">bulma_edit_form_page</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">model</span>, <span class="ruby-identifier">models_path</span>, <span class="ruby-identifier">model_path</span>)
|
321
|
+
<span class="ruby-identifier">render</span> <span class="ruby-value">partial:</span> <span class="ruby-string">'bulma_form_rails/edit_form_page'</span>, <span class="ruby-value">locals:</span> {<span class="ruby-value">name:</span> <span class="ruby-identifier">name</span>, <span class="ruby-value">model:</span> <span class="ruby-identifier">model</span>, <span class="ruby-value">models_path:</span> <span class="ruby-identifier">models_path</span>, <span class="ruby-value">model_path:</span> <span class="ruby-identifier">model_path</span>}
|
322
|
+
<span class="ruby-keyword">end</span></pre>
|
323
|
+
</div>
|
324
|
+
</div>
|
325
|
+
|
326
|
+
|
327
|
+
</div>
|
328
|
+
|
329
|
+
<div id="method-i-bulma_form_footer" class="method-detail ">
|
330
|
+
<div class="method-heading">
|
331
|
+
<span class="method-name">bulma_form_footer</span><span
|
332
|
+
class="method-args">(form, models_path, options = {}, &block)</span>
|
333
|
+
<span class="method-click-advice">click to toggle source</span>
|
334
|
+
</div>
|
335
|
+
|
336
|
+
<div class="method-description">
|
337
|
+
<p>Render a standard model form page footer.</p>
|
338
|
+
<ul><li>
|
339
|
+
<p><code>form</code> - the form object</p>
|
340
|
+
</li><li>
|
341
|
+
<p><code>models_path</code> - the controller URL path for the action that renders the model collection</p>
|
342
|
+
</li><li>
|
343
|
+
<p><code>options</code> - a hash of additional options:</p>
|
344
|
+
<ul><li>
|
345
|
+
<p><code>exclude_submit_button</code> - don’t include a submit button if true</p>
|
346
|
+
</li></ul>
|
347
|
+
</li><li>
|
348
|
+
<p><code>block</code> - optional ERb to render any additional content for the footer, such as additional buttons</p>
|
349
|
+
</li></ul>
|
350
|
+
|
351
|
+
<div class="method-source-code" id="bulma_form_footer-source">
|
352
|
+
<pre><span class="ruby-comment"># File lib/bulma_form_rails/helpers.rb, line 72</span>
|
353
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">bulma_form_footer</span>(<span class="ruby-identifier">form</span>, <span class="ruby-identifier">models_path</span>, <span class="ruby-identifier">options</span> = {}, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
354
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span>
|
355
|
+
<span class="ruby-identifier">render</span> <span class="ruby-value">layout:</span> <span class="ruby-string">'bulma_form_rails/form_footer'</span>, <span class="ruby-value">locals:</span> {<span class="ruby-value">form:</span> <span class="ruby-identifier">form</span>, <span class="ruby-value">url:</span> <span class="ruby-identifier">models_path</span>, <span class="ruby-value">options:</span> <span class="ruby-identifier">options</span>}, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>
|
356
|
+
<span class="ruby-keyword">else</span>
|
357
|
+
<span class="ruby-identifier">render</span> <span class="ruby-value">partial:</span> <span class="ruby-string">'bulma_form_rails/form_footer'</span>, <span class="ruby-value">locals:</span> {<span class="ruby-value">form:</span> <span class="ruby-identifier">form</span>, <span class="ruby-value">url:</span> <span class="ruby-identifier">models_path</span>, <span class="ruby-value">options:</span> <span class="ruby-identifier">options</span>}
|
358
|
+
<span class="ruby-keyword">end</span>
|
359
|
+
|
360
|
+
<span class="ruby-keyword">end</span></pre>
|
361
|
+
</div>
|
362
|
+
</div>
|
363
|
+
|
364
|
+
|
365
|
+
</div>
|
366
|
+
|
367
|
+
<div id="method-i-bulma_index_header" class="method-detail ">
|
368
|
+
<div class="method-heading">
|
369
|
+
<span class="method-name">bulma_index_header</span><span
|
370
|
+
class="method-args">(name, models_path)</span>
|
371
|
+
<span class="method-click-advice">click to toggle source</span>
|
372
|
+
</div>
|
373
|
+
|
374
|
+
<div class="method-description">
|
375
|
+
<p>Render the header for a standard index page. Automatically calls <code>bulma_message_box</code>.</p>
|
376
|
+
<ul><li>
|
377
|
+
<p><code>name</code> - a symbol representing the model name</p>
|
378
|
+
</li><li>
|
379
|
+
<p><code>models_path</code> - the controller URL path for the action that renders the model collection</p>
|
380
|
+
</li></ul>
|
381
|
+
|
382
|
+
<div class="method-source-code" id="bulma_index_header-source">
|
383
|
+
<pre><span class="ruby-comment"># File lib/bulma_form_rails/helpers.rb, line 34</span>
|
384
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">bulma_index_header</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">models_path</span>)
|
385
|
+
<span class="ruby-identifier">render</span> <span class="ruby-value">partial:</span> <span class="ruby-string">'bulma_form_rails/index_header'</span>, <span class="ruby-value">locals:</span> {<span class="ruby-value">name:</span> <span class="ruby-identifier">name</span>, <span class="ruby-value">models_path:</span> <span class="ruby-identifier">models_path</span>}
|
386
|
+
<span class="ruby-keyword">end</span></pre>
|
387
|
+
</div>
|
388
|
+
</div>
|
389
|
+
|
390
|
+
|
391
|
+
</div>
|
392
|
+
|
393
|
+
<div id="method-i-bulma_input" class="method-detail ">
|
394
|
+
<div class="method-heading">
|
395
|
+
<span class="method-name">bulma_input</span><span
|
396
|
+
class="method-args">(form_or_object, field_name, type = :text, options = {})</span>
|
397
|
+
<span class="method-click-advice">click to toggle source</span>
|
398
|
+
</div>
|
399
|
+
|
400
|
+
<div class="method-description">
|
401
|
+
<p>Render a labeled input field. Mandatory parameters:</p>
|
402
|
+
<ul><li>
|
403
|
+
<p><code>form_or_object</code> - the form or object</p>
|
404
|
+
</li><li>
|
405
|
+
<p><code>field_name</code> - a symbol representing the name of the field</p>
|
406
|
+
</li><li>
|
407
|
+
<p><code>type</code> - <code>:color</code>, <code>:date</code>, <code>:datetime_local</code>, <code>:email</code>, <code>:file</code>, <code>:hidden</code>, <code>:month</code>, <code>:number</code>, <code>:password</code>, <code>:phone</code>, <code>:telephone</code>, <code>:text</code>, <code>:time</code>, or <code>:url</code> with optional <code>_field</code> suffix</p>
|
408
|
+
</li><li>
|
409
|
+
<p><code>options</code> - a hash of additional options:</p>
|
410
|
+
<ul><li>
|
411
|
+
<p><code>class</code> - additional input classes other than <code>input</code></p>
|
412
|
+
</li><li>
|
413
|
+
<p><code>label</code> - custom field label text</p>
|
414
|
+
</li></ul>
|
415
|
+
</li></ul>
|
416
|
+
|
417
|
+
<div class="method-source-code" id="bulma_input-source">
|
418
|
+
<pre><span class="ruby-comment"># File lib/bulma_form_rails/helpers.rb, line 107</span>
|
419
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">bulma_input</span>(<span class="ruby-identifier">form_or_object</span>, <span class="ruby-identifier">field_name</span>, <span class="ruby-identifier">type</span> = <span class="ruby-value">:text</span>, <span class="ruby-identifier">options</span> = {})
|
420
|
+
<span class="ruby-comment"># Convert type to form method.</span>
|
421
|
+
<span class="ruby-identifier">type</span> = <span class="ruby-identifier">type</span>.<span class="ruby-identifier">to_s</span>
|
422
|
+
<span class="ruby-identifier">type</span>.<span class="ruby-identifier">delete!</span>(<span class="ruby-string">'_field'</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">type</span>.<span class="ruby-identifier">end_with?</span>(<span class="ruby-string">'_field'</span>)
|
423
|
+
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-node">"Invalid input type #{type.inspect}"</span>) <span class="ruby-keyword">unless</span> <span class="ruby-constant">VALID_INPUT_TYPES</span>.<span class="ruby-identifier">any?</span>(<span class="ruby-identifier">type</span>.<span class="ruby-identifier">intern</span>)
|
424
|
+
<span class="ruby-identifier">method</span> = <span class="ruby-node">"#{type}_field"</span>.<span class="ruby-identifier">intern</span>
|
425
|
+
|
426
|
+
<span class="ruby-comment"># Prepare parameters.</span>
|
427
|
+
<span class="ruby-identifier">prepare_value_class!</span>(<span class="ruby-identifier">options</span>, <span class="ruby-value">base_class:</span> <span class="ruby-string">'input'</span>)
|
428
|
+
<span class="ruby-identifier">render_parameters</span> = <span class="ruby-identifier">prepare_common_parameters</span>(<span class="ruby-identifier">field_name</span>, <span class="ruby-identifier">form_or_object</span>, <span class="ruby-identifier">options</span>)
|
429
|
+
<span class="ruby-identifier">additional_render_parameters</span> = <span class="ruby-node">%i[date_field datetime_local_field month_field time_field]</span>.<span class="ruby-identifier">any?</span>(<span class="ruby-identifier">method</span>) <span class="ruby-operator">?</span> {<span class="ruby-value">additional_field_classes:</span> <span class="ruby-string">'is-narrow'</span>} <span class="ruby-operator">:</span> {}
|
430
|
+
|
431
|
+
<span class="ruby-comment"># Render the labeled field.</span>
|
432
|
+
<span class="ruby-identifier">render</span> <span class="ruby-value">layout:</span> <span class="ruby-string">'bulma_form_rails/field'</span>, <span class="ruby-value">locals:</span> <span class="ruby-identifier">render_parameters</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-value">additional_field_label_classes:</span> <span class="ruby-string">'is-normal'</span>) <span class="ruby-keyword">do</span>
|
433
|
+
<span class="ruby-identifier">render</span> <span class="ruby-value">partial:</span> <span class="ruby-string">'bulma_form_rails/value'</span>, <span class="ruby-value">locals:</span> <span class="ruby-identifier">render_parameters</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-value">method:</span> <span class="ruby-identifier">method</span>).<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">additional_render_parameters</span>)
|
434
|
+
<span class="ruby-keyword">end</span>
|
435
|
+
<span class="ruby-keyword">end</span></pre>
|
436
|
+
</div>
|
437
|
+
</div>
|
438
|
+
|
439
|
+
|
440
|
+
</div>
|
441
|
+
|
442
|
+
<div id="method-i-bulma_message_box" class="method-detail ">
|
443
|
+
<div class="method-heading">
|
444
|
+
<span class="method-name">bulma_message_box</span><span
|
445
|
+
class="method-args">()</span>
|
446
|
+
<span class="method-click-advice">click to toggle source</span>
|
447
|
+
</div>
|
448
|
+
|
449
|
+
<div class="method-description">
|
450
|
+
<p>Render a standard flash messages box. Automatically included with <code>bulma_validation_box</code> and <code>bulma_index_header</code> output.</p>
|
451
|
+
|
452
|
+
<div class="method-source-code" id="bulma_message_box-source">
|
453
|
+
<pre><span class="ruby-comment"># File lib/bulma_form_rails/helpers.rb, line 56</span>
|
454
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">bulma_message_box</span>
|
455
|
+
<span class="ruby-identifier">render</span> <span class="ruby-value">partial:</span> <span class="ruby-string">'bulma_form_rails/message_box'</span>
|
456
|
+
<span class="ruby-keyword">end</span></pre>
|
457
|
+
</div>
|
458
|
+
</div>
|
459
|
+
|
460
|
+
|
461
|
+
</div>
|
462
|
+
|
463
|
+
<div id="method-i-bulma_new_form_page" class="method-detail ">
|
464
|
+
<div class="method-heading">
|
465
|
+
<span class="method-name">bulma_new_form_page</span><span
|
466
|
+
class="method-args">(name, model, models_path)</span>
|
467
|
+
<span class="method-click-advice">click to toggle source</span>
|
468
|
+
</div>
|
469
|
+
|
470
|
+
<div class="method-description">
|
471
|
+
<p>Render a standard model creation form page.</p>
|
472
|
+
<ul><li>
|
473
|
+
<p><code>name</code> - a symbol representing the model name</p>
|
474
|
+
</li><li>
|
475
|
+
<p><code>model</code> - the model object</p>
|
476
|
+
</li><li>
|
477
|
+
<p><code>models_path</code> - the controller URL path for the action that renders the model collection</p>
|
478
|
+
</li></ul>
|
479
|
+
|
480
|
+
<div class="method-source-code" id="bulma_new_form_page-source">
|
481
|
+
<pre><span class="ruby-comment"># File lib/bulma_form_rails/helpers.rb, line 42</span>
|
482
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">bulma_new_form_page</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">model</span>, <span class="ruby-identifier">models_path</span>)
|
483
|
+
<span class="ruby-identifier">render</span> <span class="ruby-value">partial:</span> <span class="ruby-string">'bulma_form_rails/new_form_page'</span>, <span class="ruby-value">locals:</span> {<span class="ruby-value">name:</span> <span class="ruby-identifier">name</span>, <span class="ruby-value">model:</span> <span class="ruby-identifier">model</span>, <span class="ruby-value">models_path:</span> <span class="ruby-identifier">models_path</span>}
|
484
|
+
<span class="ruby-keyword">end</span></pre>
|
485
|
+
</div>
|
486
|
+
</div>
|
487
|
+
|
488
|
+
|
489
|
+
</div>
|
490
|
+
|
491
|
+
<div id="method-i-bulma_radio_group" class="method-detail ">
|
492
|
+
<div class="method-heading">
|
493
|
+
<span class="method-name">bulma_radio_group</span><span
|
494
|
+
class="method-args">(form_or_object, field_name, choices, options = {})</span>
|
495
|
+
<span class="method-click-advice">click to toggle source</span>
|
496
|
+
</div>
|
497
|
+
|
498
|
+
<div class="method-description">
|
499
|
+
<p>Render a labeled radio group field.</p>
|
500
|
+
<ul><li>
|
501
|
+
<p><code>form_or_object</code> - the form or object</p>
|
502
|
+
</li><li>
|
503
|
+
<p><code>field_name</code> - a symbol representing the name of the field as a whole, regardless of how many radio buttons are generated by <code>choices</code></p>
|
504
|
+
</li><li>
|
505
|
+
<p><code>choices</code> - an array of radio button choice options</p>
|
506
|
+
</li><li>
|
507
|
+
<p><code>options</code> - an array of additional options</p>
|
508
|
+
<ul><li>
|
509
|
+
<p><code>class</code> - additional radio classes other than <code>radio</code></p>
|
510
|
+
</li><li>
|
511
|
+
<p><code>label</code> - custom field label text</p>
|
512
|
+
</li></ul>
|
513
|
+
</li></ul>
|
514
|
+
|
515
|
+
<div class="method-source-code" id="bulma_radio_group-source">
|
516
|
+
<pre><span class="ruby-comment"># File lib/bulma_form_rails/helpers.rb, line 168</span>
|
517
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">bulma_radio_group</span>(<span class="ruby-identifier">form_or_object</span>, <span class="ruby-identifier">field_name</span>, <span class="ruby-identifier">choices</span>, <span class="ruby-identifier">options</span> = {})
|
518
|
+
<span class="ruby-comment"># Prepare parameters.</span>
|
519
|
+
<span class="ruby-identifier">prepare_value_class!</span>(<span class="ruby-identifier">options</span>, <span class="ruby-value">base_class:</span> <span class="ruby-string">'radio'</span>)
|
520
|
+
<span class="ruby-identifier">render_parameters</span> = <span class="ruby-identifier">prepare_common_parameters</span>(<span class="ruby-identifier">field_name</span>, <span class="ruby-identifier">form_or_object</span>, <span class="ruby-identifier">options</span>)
|
521
|
+
|
522
|
+
<span class="ruby-comment"># Render the labeled field.</span>
|
523
|
+
<span class="ruby-identifier">render</span> <span class="ruby-value">layout:</span> <span class="ruby-string">'bulma_form_rails/field'</span>, <span class="ruby-value">locals:</span> <span class="ruby-identifier">render_parameters</span> <span class="ruby-keyword">do</span>
|
524
|
+
<span class="ruby-identifier">render</span> <span class="ruby-value">partial:</span> <span class="ruby-string">'bulma_form_rails/radio_group'</span>, <span class="ruby-value">locals:</span> <span class="ruby-identifier">render_parameters</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-value">choices:</span> <span class="ruby-identifier">choices</span>)
|
525
|
+
<span class="ruby-keyword">end</span>
|
526
|
+
<span class="ruby-keyword">end</span></pre>
|
527
|
+
</div>
|
528
|
+
</div>
|
529
|
+
|
530
|
+
|
531
|
+
</div>
|
532
|
+
|
533
|
+
<div id="method-i-bulma_select" class="method-detail ">
|
534
|
+
<div class="method-heading">
|
535
|
+
<span class="method-name">bulma_select</span><span
|
536
|
+
class="method-args">(form_or_object, field_name, choices, options = {}, html_options = {})</span>
|
537
|
+
<span class="method-click-advice">click to toggle source</span>
|
538
|
+
</div>
|
539
|
+
|
540
|
+
<div class="method-description">
|
541
|
+
<p>Render a labeled selection field.</p>
|
542
|
+
<ul><li>
|
543
|
+
<p><code>form_or_object</code> - the form or object</p>
|
544
|
+
</li><li>
|
545
|
+
<p><code>field_name</code> - a symbol representing the name of the field</p>
|
546
|
+
</li><li>
|
547
|
+
<p><code>choices</code> - an array of select choice options</p>
|
548
|
+
</li><li>
|
549
|
+
<p><code>options</code> - a hash of additional options</p>
|
550
|
+
<ul><li>
|
551
|
+
<p><code>class</code> - additional select classes other than <code>select</code></p>
|
552
|
+
</li><li>
|
553
|
+
<p><code>label</code> - custom field label text</p>
|
554
|
+
</li></ul>
|
555
|
+
</li><li>
|
556
|
+
<p><code>html_options</code> - a hash of additional options:</p>
|
557
|
+
</li></ul>
|
558
|
+
|
559
|
+
<div class="method-source-code" id="bulma_select-source">
|
560
|
+
<pre><span class="ruby-comment"># File lib/bulma_form_rails/helpers.rb, line 187</span>
|
561
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">bulma_select</span>(<span class="ruby-identifier">form_or_object</span>, <span class="ruby-identifier">field_name</span>, <span class="ruby-identifier">choices</span>, <span class="ruby-identifier">options</span> = {}, <span class="ruby-identifier">html_options</span> = {})
|
562
|
+
<span class="ruby-comment"># Prepare parameters.</span>
|
563
|
+
<span class="ruby-identifier">prepare_value_class!</span>(<span class="ruby-identifier">options</span>, <span class="ruby-value">base_class:</span> <span class="ruby-string">'select is-fullwidth'</span>)
|
564
|
+
<span class="ruby-identifier">render_parameters</span> = <span class="ruby-identifier">prepare_common_parameters</span>(<span class="ruby-identifier">field_name</span>, <span class="ruby-identifier">form_or_object</span>, <span class="ruby-identifier">options</span>)
|
565
|
+
|
566
|
+
<span class="ruby-comment"># Render the labeled field.</span>
|
567
|
+
<span class="ruby-identifier">render</span> <span class="ruby-value">layout:</span> <span class="ruby-string">'bulma_form_rails/field'</span>, <span class="ruby-value">locals:</span> <span class="ruby-identifier">render_parameters</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-value">additional_field_label_classes:</span> <span class="ruby-string">'is-normal'</span>) <span class="ruby-keyword">do</span>
|
568
|
+
<span class="ruby-identifier">render</span> <span class="ruby-value">partial:</span> <span class="ruby-string">'bulma_form_rails/select'</span>, <span class="ruby-value">locals:</span> <span class="ruby-identifier">render_parameters</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-value">choices:</span> <span class="ruby-identifier">choices</span>, <span class="ruby-value">html_options:</span> <span class="ruby-identifier">html_options</span>)
|
569
|
+
<span class="ruby-keyword">end</span>
|
570
|
+
<span class="ruby-keyword">end</span></pre>
|
571
|
+
</div>
|
572
|
+
</div>
|
573
|
+
|
574
|
+
|
575
|
+
</div>
|
576
|
+
|
577
|
+
<div id="method-i-bulma_text_area" class="method-detail ">
|
578
|
+
<div class="method-heading">
|
579
|
+
<span class="method-name">bulma_text_area</span><span
|
580
|
+
class="method-args">(form_or_object, field_name, options = {})</span>
|
581
|
+
<span class="method-click-advice">click to toggle source</span>
|
582
|
+
</div>
|
583
|
+
|
584
|
+
<div class="method-description">
|
585
|
+
<p>Render a labeled text area field.</p>
|
586
|
+
<ul><li>
|
587
|
+
<p><code>form_or_object</code> - the form or object</p>
|
588
|
+
</li><li>
|
589
|
+
<p><code>field_name</code> - a symbol representing the name of the field</p>
|
590
|
+
</li><li>
|
591
|
+
<p><code>options</code> - a hash of additional options:</p>
|
592
|
+
<ul><li>
|
593
|
+
<p><code>class</code> - additional textarea classes other than <code>textarea</code></p>
|
594
|
+
</li><li>
|
595
|
+
<p><code>label</code> - custom field label text</p>
|
596
|
+
</li><li>
|
597
|
+
<p><code>rows</code> - number of text rows to be visible</p>
|
598
|
+
</li><li>
|
599
|
+
<p><code>cols</code> - number of text columns to be visible</p>
|
600
|
+
</li></ul>
|
601
|
+
</li></ul>
|
602
|
+
|
603
|
+
<div class="method-source-code" id="bulma_text_area-source">
|
604
|
+
<pre><span class="ruby-comment"># File lib/bulma_form_rails/helpers.rb, line 133</span>
|
605
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">bulma_text_area</span>(<span class="ruby-identifier">form_or_object</span>, <span class="ruby-identifier">field_name</span>, <span class="ruby-identifier">options</span> = {})
|
606
|
+
<span class="ruby-comment"># Prepare parameters.</span>
|
607
|
+
<span class="ruby-identifier">prepare_value_class!</span>(<span class="ruby-identifier">options</span>, <span class="ruby-value">base_class:</span> <span class="ruby-string">'textarea'</span>)
|
608
|
+
<span class="ruby-identifier">render_parameters</span> = <span class="ruby-identifier">prepare_common_parameters</span>(<span class="ruby-identifier">field_name</span>, <span class="ruby-identifier">form_or_object</span>, <span class="ruby-identifier">options</span>)
|
609
|
+
|
610
|
+
<span class="ruby-comment"># Render the labeled field.</span>
|
611
|
+
<span class="ruby-identifier">render</span> <span class="ruby-value">layout:</span> <span class="ruby-string">'bulma_form_rails/field'</span>, <span class="ruby-value">locals:</span> <span class="ruby-identifier">render_parameters</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-value">additional_field_label_classes:</span> <span class="ruby-string">'is-normal'</span>) <span class="ruby-keyword">do</span>
|
612
|
+
<span class="ruby-identifier">render</span> <span class="ruby-value">partial:</span> <span class="ruby-string">'bulma_form_rails/value'</span>, <span class="ruby-value">locals:</span> <span class="ruby-identifier">render_parameters</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-value">method:</span> <span class="ruby-value">:text_area</span>)
|
613
|
+
<span class="ruby-keyword">end</span>
|
614
|
+
<span class="ruby-keyword">end</span></pre>
|
615
|
+
</div>
|
616
|
+
</div>
|
617
|
+
|
618
|
+
|
619
|
+
</div>
|
620
|
+
|
621
|
+
<div id="method-i-bulma_time_select" class="method-detail ">
|
622
|
+
<div class="method-heading">
|
623
|
+
<span class="method-name">bulma_time_select</span><span
|
624
|
+
class="method-args">(form_or_object, field_name, options = {}, html_options = {})</span>
|
625
|
+
<span class="method-click-advice">click to toggle source</span>
|
626
|
+
</div>
|
627
|
+
|
628
|
+
<div class="method-description">
|
629
|
+
<p>Render a labeled time selection field.</p>
|
630
|
+
<ul><li>
|
631
|
+
<p><code>form_or_object</code> - the form or object</p>
|
632
|
+
</li><li>
|
633
|
+
<p><code>field_name</code> - a symbol representing the name of the field</p>
|
634
|
+
</li><li>
|
635
|
+
<p><code>options</code> - a hash of additional options</p>
|
636
|
+
</li><li>
|
637
|
+
<p><code>html_options</code> - a hash of additional options:</p>
|
638
|
+
<ul><li>
|
639
|
+
<p><code>class</code> - additional select classes other than <code>select</code></p>
|
640
|
+
</li><li>
|
641
|
+
<p><code>label</code> - custom field label text</p>
|
642
|
+
</li></ul>
|
643
|
+
</li></ul>
|
644
|
+
|
645
|
+
<div class="method-source-code" id="bulma_time_select-source">
|
646
|
+
<pre><span class="ruby-comment"># File lib/bulma_form_rails/helpers.rb, line 223</span>
|
647
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">bulma_time_select</span>(<span class="ruby-identifier">form_or_object</span>, <span class="ruby-identifier">field_name</span>, <span class="ruby-identifier">options</span> = {}, <span class="ruby-identifier">html_options</span> = {})
|
648
|
+
<span class="ruby-comment"># Prepare parameters.</span>
|
649
|
+
<span class="ruby-identifier">prepare_value_class!</span>(<span class="ruby-identifier">options</span>, <span class="ruby-value">base_class:</span> <span class="ruby-string">'select is-fullwidth'</span>)
|
650
|
+
<span class="ruby-identifier">render_parameters</span> = <span class="ruby-identifier">prepare_common_parameters</span>(<span class="ruby-identifier">field_name</span>, <span class="ruby-identifier">form_or_object</span>, <span class="ruby-identifier">options</span>)
|
651
|
+
|
652
|
+
<span class="ruby-comment"># Render the labeled field.</span>
|
653
|
+
<span class="ruby-identifier">render</span> <span class="ruby-value">layout:</span> <span class="ruby-string">'bulma_form_rails/field'</span>, <span class="ruby-value">locals:</span> <span class="ruby-identifier">render_parameters</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-value">additional_field_label_classes:</span> <span class="ruby-string">'is-normal'</span>) <span class="ruby-keyword">do</span>
|
654
|
+
<span class="ruby-identifier">render</span> <span class="ruby-value">partial:</span> <span class="ruby-string">'bulma_form_rails/time_select'</span>, <span class="ruby-value">locals:</span> <span class="ruby-identifier">render_parameters</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-value">html_options:</span> <span class="ruby-identifier">html_options</span>)
|
655
|
+
<span class="ruby-keyword">end</span>
|
656
|
+
<span class="ruby-keyword">end</span></pre>
|
657
|
+
</div>
|
658
|
+
</div>
|
659
|
+
|
660
|
+
|
661
|
+
</div>
|
662
|
+
|
663
|
+
<div id="method-i-bulma_validation_box" class="method-detail ">
|
664
|
+
<div class="method-heading">
|
665
|
+
<span class="method-name">bulma_validation_box</span><span
|
666
|
+
class="method-args">(model)</span>
|
667
|
+
<span class="method-click-advice">click to toggle source</span>
|
668
|
+
</div>
|
669
|
+
|
670
|
+
<div class="method-description">
|
671
|
+
<p>Render a standard model validation messages box. Automatically calls <code>bulma_message_box</code>.</p>
|
672
|
+
<ul><li>
|
673
|
+
<p><code>model</code> - the model object</p>
|
674
|
+
</li></ul>
|
675
|
+
|
676
|
+
<div class="method-source-code" id="bulma_validation_box-source">
|
677
|
+
<pre><span class="ruby-comment"># File lib/bulma_form_rails/helpers.rb, line 62</span>
|
678
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">bulma_validation_box</span>(<span class="ruby-identifier">model</span>)
|
679
|
+
<span class="ruby-identifier">render</span> <span class="ruby-value">partial:</span> <span class="ruby-string">'bulma_form_rails/validation_box'</span>, <span class="ruby-value">locals:</span> {<span class="ruby-value">model:</span> <span class="ruby-identifier">model</span>}
|
680
|
+
<span class="ruby-keyword">end</span></pre>
|
681
|
+
</div>
|
682
|
+
</div>
|
683
|
+
|
684
|
+
|
685
|
+
</div>
|
686
|
+
|
687
|
+
</section>
|
688
|
+
|
689
|
+
</section>
|
690
|
+
</main>
|
691
|
+
|
692
|
+
|
693
|
+
<footer id="validator-badges" role="contentinfo">
|
694
|
+
<p><a href="https://validator.w3.org/check/referer">Validate</a>
|
695
|
+
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.4.0.
|
696
|
+
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
697
|
+
</footer>
|
698
|
+
|