rails_bootstrap_form 0.7.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f773eed0774b5b8895a39fb0e54dd557a4fbc044a4481d1cd9d969e58628ae6d
-  data.tar.gz: df7e9521626f1359d60c4d334cdb2e94520a18c5c4aad7ebf257874f6d3005b8
+  metadata.gz: 831ca7bb90715c33bd12b94176eecf4e229142b7b7c3b8a1d0366e5f287fb0fd
+  data.tar.gz: 6915c42e2221adce489e7a6564d6a88c31b52ce119dabb27a9e03ae51767d2d5
 SHA512:
-  metadata.gz: f436a23b69de6e53d63dd08726270f1e85df5d9f6d3b8ae2030a204edcae1454fb90f16b20fac087583dffebaf67f18053594771c20312fdf9460b8260013a37
-  data.tar.gz: 5c77b719bebdb2985c056ab03d7153d09e2de6e1ae15602db62395906f105b6b7d1f2271e6c83fbe371bdc27c59ea2220aae0b79cd06ddae7dc5bcca1c2958a5
+  metadata.gz: 31e6404b0c40f4ea07c148cee2b1b66edbe3a71a8290195705e8ab6507c754148b80ad601b84f4afa0908ed42ec3098d5f971d8c92eb33085b3fb100926aa015
+  data.tar.gz: 5bd3c08a5b50abef3af433b93b2ae518c9d7e5807a1c5aef9105dddaa5e52f17e5ec8e8f09ea7931298a24be195694b48eb8b6c98f26a34f5f8df7f0f04d0e32

data/CHANGELOG.md

@@ -4,6 +4,16 @@ You can find recent releases with docs in GitHub:
 
 https://github.com/shivam091/rails_bootstrap_form/releases
 
+## [0.8.0](https://github.com/shivam091/rails_bootstrap_form/compare/v0.7.2...v0.8.0) - 2023-05-26
+
+### What's new
+- Added support for `inline` layout for forms.
+
+## [0.7.2](https://github.com/shivam091/rails_bootstrap_form/compare/v0.7.1...v0.7.2) - 2023-05-25
+
+### What's new
+- Added wrapper method for `rich_text_area`.
+
 ## [0.7.1](https://github.com/shivam091/rails_bootstrap_form/compare/v0.7.0...v0.7.1) - 2023-05-24
 
 ### What's new

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rails_bootstrap_form (0.7.1)
+    rails_bootstrap_form (0.8.0)
       actionpack (~> 7.0)
       activemodel (~> 7.0)
 

data/README.md

@@ -22,7 +22,7 @@ And follow the remaining instructions in the [official bootstrap installation gu
 Add the `rails_bootstrap_form` gem to your `Gemfile`:
 
 ```ruby
-gem "rails_bootstrap_form", "~> 0.6.1"
+gem "rails_bootstrap_form", "~> 0.7.2"
 ```
 
 Then:
@@ -66,3 +66,275 @@ The current configuration options are:
 | Option | Default value | Description |
 |---------------------------|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | `default_form_attributes` | | Set this option to `{role: "form"}` to make forms non-compliant with W3C, but generate the `role="form"` attribute. |
+
+## Usage
+
+### bootstrap_form_for
+
+To get started, use the `bootstrap_form_for` helper in place of the Rails `form_for` helper. Here's an example:
+
+![bootstrap_form_for](https://github.com/shivam091/rails_bootstrap_form/assets/7858927/dfc5f03b-049a-4c12-b575-8298cf5551d7)
+
+```erb
+<%= bootstrap_form_for(@user) do |f| %>
+  <%= f.email_field :email %>
+  <%= f.password_field :password %>
+  <%= f.check_box :remember_me %>
+  <%= f.primary "Log In" %>
+<% end %>
+```
+
+This generates the following HTML:
+
+
+```html
+<form role="form" novalidate="novalidate" class="new_user" id="new_user" action="/users" accept-charset="UTF-8" method="post">
+  <div class="mb-3">
+    <label class="form-label required" for="user_email">Email address</label>
+    <input class="form-control" aria-required="true" required="required" type="email" name="user[email]" id="user_email">
+  </div>
+  <div class="mb-3">
+    <label class="form-label required" for="user_password">Password</label>
+    <input class="form-control" aria-required="true" required="required" type="password" name="user[password]" id="user_password">
+  </div>
+  <div class="form-check mb-3">
+    <input name="user[remember_me]" type="hidden" value="0" autocomplete="off">
+    <input class="form-check-input" type="checkbox" value="1" name="user[remember_me]" id="user_remember_me">
+    <label class="form-check-label" for="user_remember_me">Remember me</label>
+  </div>
+  <input type="submit" name="commit" value="Log In" class="btn btn-primary" data-disable-with="Log In">
+</form>
+```
+
+### bootstrap_form_with
+
+To get started, use the `bootstrap_form_with` helper in place of the Rails `form_with` helper. Here's an example:
+
+![bootstrap_form_with](https://github.com/shivam091/rails_bootstrap_form/assets/7858927/06c605b9-29e2-4670-9495-0e913508d73f)
+
+```erb
+<%= bootstrap_form_with(model: @user) do |f| %>
+  <%= f.email_field :email %>
+  <%= f.password_field :password %>
+  <%= f.check_box :remember_me %>
+  <%= f.primary "Log In" %>
+<% end %>
+```
+
+This generates the following HTML:
+
+
+```html
+<form role="form" novalidate="novalidate" class="new_user" id="new_user" action="/users" accept-charset="UTF-8" method="post">
+  <div class="mb-3">
+    <label class="form-label required" for="user_email">Email address</label>
+    <input class="form-control" aria-required="true" required="required" type="email" name="user[email]" id="user_email">
+  </div>
+  <div class="mb-3">
+    <label class="form-label required" for="user_password">Password</label>
+    <input class="form-control" aria-required="true" required="required" type="password" name="user[password]" id="user_password">
+  </div>
+  <div class="form-check mb-3">
+    <input name="user[remember_me]" type="hidden" value="0" autocomplete="off">
+    <input class="form-check-input" type="checkbox" value="1" name="user[remember_me]" id="user_remember_me">
+    <label class="form-check-label" for="user_remember_me">Remember me</label>
+  </div>
+  <input type="submit" name="commit" value="Log In" class="btn btn-primary" data-disable-with="Log In">
+</form>
+```
+
+## Bootstrap configuration options
+
+Here's a list of all possible options you can pass via `bootstrap_form` option that can be attached to the `bootstrap_form_for` or `bootstrap_form_with` or any field helpers inside of it:
+
+| Option | Description | Default value |
+| ------ | ------------- | ----------- |
+| `layout` | Controls layout of form and field helpers. It can be `vertical` `horizontal`, or `inline`. | `vertical` |
+| `field_class` | A CSS class that will be applied to all form fields. | `form-control` |
+| `additional_field_class` | An additional CSS class that will be added along with the existing css classes of field helpers. | `nil` |
+| `help_text` | Describes help text for the HTML field. Help text is automatically read from translation file. If you want to customize it, you can pass a string. You can also set it `false` if you do not want help text displayed. | `nil` |
+| `label_text` | An option to customize automatically generated label text. | `nil` |
+| `skip_label` | An option to control whether the label is to be displayed or not. | `false` |
+| `hide_label` | An option to control whether the label is only accessible to a screen readers. | `false` |
+| `hide_class` | A CSS class that will be used when the label is only accessible to a screen readers. | `visually-hidden` |
+| `label_class` | A CSS class that will be applied to all labels when layout is `vertical`. | `form-label` |
+| `additional_label_class` | An additional CSS class that will be added along with the existing label css classes. | `nil` |
+| `prepend` | Raw or HTML content to be prepended to the field. | `nil` |
+| `append` | Raw or HTML content to be appended to the field. | `nil` |
+| `additional_input_group_class` | An additional CSS class that will be added to existing input group wrapper css classes. | `nil` |
+| `floating` | An option to control whether the field should have a floating label. | `false` |
+| `static_field_class` | A CSS class that will be applied to all static fields. | `form-control-plaintext` |
+| `switch` | An option to control whether the check box should look like Bootstrap switches. | `false` |
+| `wrapper_options` | An option to control the HTML attributes and options that will be added to a field wrapper. | `{}` |
+| `size` | An option to control the size of input groups, buttons, labels, and fields. It can be `sm` or `lg`. | `nil` |
+| `inline` | An option to group checkboxes and radio buttons on the same horizontal row. | `false` |
+| `label_col_class` | A CSS class that will be applied to all labels when layout is `horizontal`. | `col-form-label` |
+| `label_col_wrapper_class` | A CSS class for label column when layout is `horizontal`. | `col-sm-2` |
+| `field_col_wrapper_class` | A CSS class for field column when layout is `horizontal`. | `col-sm-10` |
+| `render_as_button` | An option to render submit button using `<button type="submit">` instead of `<input type="submit">`. | `false` |
+
+Options applied on the form level will apply to all field helpers. Options applied on field helpers will override form-level options.
+Here's an example of a form where one field uses different layout:
+
+![bootstrap_option_override](https://github.com/shivam091/rails_bootstrap_form/assets/7858927/9d312870-033f-4bc4-922b-1b65df202352)
+
+```erb
+<%= bootstrap_form_for @user do |form| %>
+  <%= form.text_field :name %>
+  <%= form.email_field :email %>
+  <%= form.password_field :password, bootstrap_form: {layout: :horizontal} %>
+  <%= form.check_box :terms, required: true %>
+  <%= form.primary "Register" %>
+<% end %>
+```
+
+This generates the following HTML:
+
+```html
+<form role="form" novalidate="novalidate" class="new_user" id="new_user" action="/users" accept-charset="UTF-8" method="post">
+  <div class="mb-3">
+    <label class="form-label required" for="user_name">Name</label>
+    <input class="form-control" aria-required="true" required="required" type="text" name="user[name]" id="user_name">
+  </div>
+  <div class="mb-3">
+    <label class="form-label required" for="user_email">Email address</label>
+    <input class="form-control" aria-required="true" required="required" type="email" name="user[email]" id="user_email">
+  </div>
+  <div class="row mb-3">
+    <label class="col-form-label col-sm-2 required" for="user_password">Password</label>
+    <div class="col-sm-10">
+      <input class="form-control" aria-required="true" required="required" type="password" name="user[password]" id="user_password">
+    </div>
+  </div>
+  <div class="form-check mb-3">
+    <input name="user[terms]" type="hidden" value="0" autocomplete="off">
+    <input required="required" class="form-check-input" type="checkbox" value="1" name="user[terms]" id="user_terms">
+    <label class="form-check-label required" for="user_terms">I accept terms and conditions</label>
+    <div class="form-text text-muted">You must first accept terms and conditions in order to continue</div>
+  </div>
+  <input type="submit" name="commit" value="Register" class="btn btn-primary" data-disable-with="Register">
+</form>
+```
+
+## Supported form helpers
+
+This gem wraps most of the form field helpers. Here's the current list:
+
+```
+check_box                    collection_check_boxes       collection_radio_buttons
+collection_select            color_field                  date_field
+date_select                  datetime_field               datetime_local_field
+datetime_select              email_field                  file_field
+grouped_collection_select    hidden_field                 month_field
+number_field                 password_field               phone_field
+radio_button                 range_field                  rich_text_area
+search_field                 select                       static_field                 
+telephone_field              text_area                    text_field                   
+time_field                   time_select                  time_zone_select             
+url_field                    week_field                   weekday_select
+```
+
+## Supported form layouts
+
+### Vertical layout
+
+This layout is default layout for the form in which labels are above the fields and labels and fields take 100% of the width.
+
+Here's an example of how it looks like:
+
+![vertical_layout](https://github.com/shivam091/rails_bootstrap_form/assets/7858927/0795cad6-f2f9-4cc6-bb39-aace67156781)
+
+```erb
+<%= bootstrap_form_for @user do |form| %>
+  <%= form.email_field :email %>
+  <%= form.password_field :password %>
+  <%= form.primary "Sign in" %>
+<% end %>
+```
+
+This generates the following HTML:
+
+```html
+<form role="form" novalidate="novalidate" class="new_user" id="new_user" action="/users" accept-charset="UTF-8" method="post">
+  <div class="mb-3">
+    <label class="form-label required" for="user_email">Email address</label>
+    <input class="form-control" aria-required="true" required="required" type="email" name="user[email]" id="user_email">
+  </div>
+  <div class="mb-3">
+    <label class="form-label required" for="user_password">Password</label>
+    <input class="form-control" aria-required="true" required="required" type="password" name="user[password]" id="user_password">
+  </div>
+  <input type="submit" name="commit" value="Sign in" class="btn btn-primary" data-disable-with="Sign in">
+</form>
+```
+
+### Horizontal layout
+
+If you want to align label and field side by side, you can use horizontal layout for the form.
+You can optionally override `label_col_wrapper_class` and `field_col_wrapper_class` at either form level or field helpers if want to customize
+space between label and field.
+
+Here's an example of how it looks like by default:
+
+![horizontal_layout](https://github.com/shivam091/rails_bootstrap_form/assets/7858927/71493945-31d5-4917-83c2-8cb7b0825371)
+
+```erb
+<%= bootstrap_form_for @user, bootstrap_form: {layout: :horizontal} do |form| %>
+  <%= form.email_field :email %>
+  <%= form.password_field :password %>
+  <%= form.primary "Sign in" %>
+<% end %>
+```
+This generates the following HTML:
+
+```html
+<form role="form" novalidate="novalidate" class="new_user" id="new_user" action="/users" accept-charset="UTF-8" method="post">
+  <div class="row mb-3">
+    <label class="col-form-label col-sm-2 required" for="user_email">Email address</label>
+    <div class="col-sm-10">
+      <input class="form-control" aria-required="true" required="required" type="email" name="user[email]" id="user_email">
+    </div>
+  </div>
+  <div class="row mb-3">
+    <label class="col-form-label col-sm-2 required" for="user_password">Password</label>
+    <div class="col-sm-10">
+      <input class="form-control" aria-required="true" required="required" type="password" name="user[password]" id="user_password">
+    </div>
+  </div>
+  <input type="submit" name="commit" value="Sign in" class="btn btn-primary" data-disable-with="Sign in">
+</form>
+```
+
+### Inline layout
+
+You may choose to render form elements in one line. Please note that this layout won't render all form elements perfectly. Things like errors messages and help text won't show up right.
+
+Here's an example of how it looks like:
+
+![inline_layout](https://github.com/shivam091/rails_bootstrap_form/assets/7858927/644a08ec-b249-4e1c-8d61-5350e6649f11)
+
+```erb
+<%= bootstrap_form_for @user, bootstrap_form: {layout: :inline} do |form| %>
+  <%= form.email_field :email %>
+  <%= form.password_field :password %>
+  <%= form.primary "Sign in" %>
+<% end %>
+```
+
+This generates the following HTML:
+
+```html
+<form role="form" novalidate="novalidate" class="new_user row row-cols-lg-auto g-3 align-items-center" id="new_user" action="/users" accept-charset="UTF-8" method="post">
+  <div class="col-12">
+    <label class="form-label visually-hidden required" for="user_email">Email address</label>
+    <input class="form-control" aria-required="true" required="required" placeholder="Email address" type="email" name="user[email]" id="user_email">
+  </div>
+  <div class="col-12">
+    <label class="form-label visually-hidden required" for="user_password">Password</label>
+    <input class="form-control" aria-required="true" required="required" placeholder="Password" type="password" name="user[password]" id="user_password">
+  </div>
+  <div class="col-12">
+    <input type="submit" name="commit" value="Sign in" class="btn btn-primary" data-disable-with="Sign in">
+  </div>
+</form>
+```

data/demo/app/models/user.rb

@@ -3,6 +3,9 @@
 # -*- warn_indent: true -*-
 
 class User < ApplicationRecord
+
+  attr_accessor :username, :remember_me
+
   validates :name, presence: true, length: {in: 2..50}
   validates :terms, acceptance: true
   validates :email,

data/demo/app/views/users/_form.html.erb

@@ -2,6 +2,14 @@
   <%= render partial: "users/form_without_bootstrap_helpers" %>
 <% end %>
 
-<%= render partial: "users/vertical_form" %>
+<% if true %>
+  <%= render partial: "users/inline_form" %>
+<% end %>
+
+<% if true %>
+  <%= render partial: "users/vertical_form" %>
+<% end %>
 
-<%= render partial: "users/horizontal_form" %>
+<% if true %>
+  <%= render partial: "users/horizontal_form" %>
+<% end %>

data/demo/app/views/users/_horizontal_form.html.erb

@@ -1,10 +1,11 @@
 <div class="card card-primary my-3">
   <div class="card-header fw-bold">
-    Profile Form (Horizontal layout)
+    Horizontal layout
   </div>
   <div class="card-body">
     <%= bootstrap_form_for @user, bootstrap_form: {layout: :horizontal} do |form| %>
       <%= form.text_field :name, autocomplete: "new-name" %>
+      <%= form.text_field :username, autocomplete: "new-username" %>
       <%= form.email_field :email, autocomplete: "new-email" %>
       <%= form.password_field :password, autocomplete: "new-password" %>
       <%= form.phone_field :mobile_number %>
@@ -23,10 +24,8 @@
             {include_blank: "Select Country"} %>
       <% end %>
       <%= form.check_box :terms, required: true %>
-      <div class="mt-3">
-        <%= form.primary "Register" %>
-        <%= link_to "Cancel", users_path, class: "btn btn-secondary" %>
-      </div>
+      <%= form.primary "Register" %>
+      <%= link_to "Cancel", users_path, class: "btn btn-secondary" %>
     <% end %>
   </div>
 </div>

data/demo/app/views/users/_inline_form.html.erb

@@ -0,0 +1,13 @@
+<div class="card card-primary my-3">
+  <div class="card-header fw-bold">
+    Inline layout
+  </div>
+  <div class="card-body">
+    <%= bootstrap_form_for @user, bootstrap_form: {layout: :inline} do |form| %>
+      <%= form.text_field :username, autocomplete: "new-username" %>
+      <%= form.password_field :password, autocomplete: "new-password" %>
+      <%= form.check_box :remember_me %>
+      <%= form.primary "Login" %>
+    <% end %>
+  </div>
+</div>

data/demo/app/views/users/_vertical_form.html.erb

@@ -1,10 +1,11 @@
 <div class="card card-primary my-3">
   <div class="card-header fw-bold">
-    Profile Form (Vertical layout)
+    Vertical layout
   </div>
   <div class="card-body">
     <%= bootstrap_form_for @user do |form| %>
       <%= form.text_field :name, autocomplete: "new-name" %>
+      <%= form.text_field :username, autocomplete: "new-username" %>
       <%= form.email_field :email, autocomplete: "new-email" %>
       <%= form.password_field :password, autocomplete: "new-password" %>
       <%= form.phone_field :mobile_number %>
@@ -23,10 +24,8 @@
             {include_blank: "Select Country"} %>
       <% end %>
       <%= form.check_box :terms, required: true %>
-      <div class="mt-3">
-        <%= form.primary "Register" %>
-        <%= link_to "Cancel", users_path, class: "btn btn-secondary" %>
-      </div>
+      <%= form.primary "Register" %>
+      <%= link_to "Cancel", users_path, class: "btn btn-secondary" %>
     <% end %>
   </div>
 </div>

data/demo/config/locales/en.rb

@@ -27,6 +27,8 @@
           terms: "I accept terms and conditions",
           excellence: "Excellence",
           skill_ids: "Skills",
+          username: "Username",
+          remember_me: "Keep me signed in",
         },
         user_skill: {
           user_id: "User",
@@ -45,7 +47,7 @@
           email: "Please use official email address",
           terms: "You must first accept terms and conditions in order to continue",
           skill_ids: "Select your strong skills",
-          fruit_id: "Select your favorite fruit"
+          fruit_id: "Select your favorite fruit",
         }
       },
     }

data/lib/rails_bootstrap_form/bootstrap_form_builder.rb

@@ -17,6 +17,7 @@ module RailsBootstrapForm
     def initialize(object_name, object, template, options)
       @bootstrap_form_options = RailsBootstrapForm::BootstrapFormOptions.new(options[:bootstrap_form])
       apply_default_form_options(options)
+      apply_default_form_classes(options)
       super(object_name, object, template, options)
     end
 
@@ -31,12 +32,20 @@ module RailsBootstrapForm
       options[:html].reverse_merge!(RailsBootstrapForm.config.default_form_attributes)
     end
 
+    def apply_default_form_classes(options)
+      return unless @bootstrap_form_options.layout_inline?
+
+      options[:html][:class] =
+        ([*options[:html][:class]&.split(/\s+/)] + %w[row row-cols-lg-auto g-3 align-items-center])
+        .compact.uniq.join(" ")
+    end
+
     def fields_for_options(record_object, fields_options)
       field_options = record_object if record_object.is_a?(Hash) && record_object.extractable_options?
       field_options = {bootstrap_form: options[:bootstrap_form]}.deep_merge!(field_options)
       field_options
     end
 
-    private :apply_default_form_options, :fields_for_options
+    private :apply_default_form_options, :fields_for_options, :apply_default_form_classes
   end
 end

data/lib/rails_bootstrap_form/bootstrap_form_options.rb

@@ -16,47 +16,47 @@ module RailsBootstrapForm
   #
   class BootstrapFormOptions
 
-    # Controls form and field layout. It can be "vertical, "horizontal", or "inline".
-    # It can also be "floating" if field should have floating labels.
+    # Controls layout of form and field helpers. It can be "vertical,
+    # "horizontal", or "inline". The default value is `vertical`.
     attr_accessor :layout
 
-    # A CSS class that will be applied to all form fields and it can be overridden
-    # by the `BootstrapFormOptions` object. Default is `form-control`.
+    # A CSS class that will be applied to all form fields.
+    # The default value is `form-control`.
     attr_accessor :field_class
 
     # An additional CSS class that will be added along with the existing
-    # `field_class` of the field. Default is nil.
+    # css classes of field helpers. The default value is nil.
     attr_accessor :additional_field_class
 
     # Describes help text for the HTML field. Help text is automatically read
     # from translation file. If you want to customize it, you can pass string.
     # You can also set it false if you do not want help text displayed.
-    # Default is nil.
+    # The default value is nil.
     attr_accessor :help_text
 
-    # An option to override automatically generated label text.
-    # Default is `nil`.
+    # An option to customize automatically generated label text.
+    # The default value is `nil`.
     attr_accessor :label_text
 
-    # An option to custmize whether the label is to be displayed or not.
-    # Default is `false`.
+    # An option to control whether the label is to be displayed or not.
+    # The default value is `false`.
     attr_accessor :skip_label
 
-    # An option to customize whether the label is only visible to screen readers.
-    # Default is `false`.
+    # An option to control whether the label is only visible to a screen readers.
+    # The default value is `false`.
     attr_accessor :hide_label
 
-    # The CSS class that will be used when the label is only accessible by screen
-    # readers. Default is `visually-hidden`
+    # The CSS class that will be used when the label is only accessible to a
+    # screen readers. The default value is `visually-hidden`.
     attr_accessor :hide_class
 
-    # Default CSS class that will be applied to all label tags when layout is
+    # A CSS class that will be applied to all label tags when layout is
     # vertical.
     # The default value is `form-label`.
     attr_accessor :label_class
 
-    # An additional CSS class that will be added along with the existing
-    # `label_class` of the label. Default is `nil`.
+    # An additional CSS class that will be added along with the existing label
+    # css classes. The default value is `nil`.
     attr_accessor :additional_label_class
 
     # Input group specific options. Input groups allow prepending and appending
@@ -68,58 +68,57 @@ module RailsBootstrapForm
     #   form.text_field :search, bootstrap_form: {input_group: {append: button_tag("Go", type: :submit, class: "btn btn-secondary")}}
     #
     # Raw or HTML content to be prepended to the field.
-    # Default is `nil`.
+    # The default value is `nil`.
     attr_accessor :prepend
 
     # Raw or HTML content to be appended to the field.
-    # Default is `nil`.
+    # The default value is `nil`.
     attr_accessor :append
 
-    # Append additional CSS class added to the input group wrapper.
-    # Default is `nil`.
+    # An additional CSS class that will be added to existing input group wrapper
+    # css classes. The default value is `nil`.
     attr_accessor :additional_input_group_class
 
-    # Option to control whether the field should have a floating label.
-    # Default is false.
+    # An option to control whether the field should have a floating label.
+    # The default value is false.
     attr_accessor :floating
 
-    # Default CSS class that will be applied to all static fields.
-    # Default is `form-control-plaintext`.
+    # A CSS class that will be applied to all static fields.
+    # The default value is `form-control-plaintext`.
     attr_accessor :static_field_class
 
-    # Option to control whether the check box should look like bootstrap switches.
-    # Default is `false`.
+    # An option to control whether the check box should look like Bootstrap switches.
+    # The default value is `false`.
     attr_accessor :switch
 
-    # Controls the HTML attributes and options that will be added to the field wrapper.
-    # Default is `{}`.
+    # An option to control the HTML attributes and options that will be added to
+    # the field wrapper. The default value is `{}`.
     attr_accessor :wrapper_options
 
-    # Option to specify the size of input groups and fields.
+    # An option to control the size of input groups, buttons, labels, and fields.
     # The valid values are `sm` and `lg`. The default value is `nil`.
     attr_accessor :size
 
-    # Option to render checkboxes and radio buttons inline.
-    # The default value if `false`.
+    # An option to group checkboxes and radio buttons on the same horizontal row.
+    # The default value is `false`.
     #
     # Example:
     #   form.collection_radio_buttons :choices, ["yes", "no"], :to_s, :to_s, bootstrap_form: {inline: true}
     attr_accessor :inline
 
-    # Default CSS class that will be applied to all label tags when layout is
-    # horizontal.
+    # A CSS class that will be applied to all labels when layout is horizontal.
     # The default value is `col-form-label`.
     attr_accessor :label_col_class
 
-    # Default CSS class for label column when using horizontal form.
+    # A CSS class for label column when layout is horizontal.
     # The default value is `col-sm-2`.
     attr_accessor :label_col_wrapper_class
 
-    # Default CSS class for control column when using horizontal form.
+    # A CSS class for field column when layout is horizontal.
     # The default value is `col-sm-10`.
     attr_accessor :field_col_wrapper_class
 
-    # Option to render submit button using `<button type="submit">` instead of
+    # An option to render submit button using `<button type="submit">` instead of
     # `<input type="submit">`.
     # The default value is `false`.
     attr_accessor :render_as_button
@@ -181,6 +180,10 @@ module RailsBootstrapForm
       @label_class = "form-label"
       @additional_label_class = nil
 
+      @prepend = nil
+      @append = nil
+      @additional_input_group_class = nil
+
       @floating = false
 
       @static_field_class = "form-control-plaintext"

data/lib/rails_bootstrap_form/field_wrapper_builder.rb

@@ -58,12 +58,12 @@ module RailsBootstrapForm
     def field_wrapper_classes(bootstrap_options)
       classes = []
       classes << "row" if bootstrap_options.layout_horizontal?
-      classes << form_wrapper_default_class
+      classes << form_wrapper_default_class(bootstrap_options)
       classes.flatten.compact
     end
 
-    def form_wrapper_default_class
-      "mb-3"
+    def form_wrapper_default_class(bootstrap_options)
+      bootstrap_options.layout_inline? ? "col-12" : "mb-3"
     end
 
     def field_css_options(attribute, bootstrap_options, options, html_options)
@@ -82,7 +82,7 @@ module RailsBootstrapForm
       css_options[:class] = field_classes.flatten.compact
       css_options.merge!(required_field_options(attribute, options))
 
-      if (bootstrap_options.floating? && !bootstrap_options.layout_horizontal?)
+      if placeholder_required?(bootstrap_options)
         css_options[:placeholder] ||= label_text(attribute, bootstrap_options)
       end
 
@@ -97,6 +97,10 @@ module RailsBootstrapForm
       classes
     end
 
+    def placeholder_required?(bootstrap_options)
+      (bootstrap_options.floating? && !bootstrap_options.layout_horizontal?) || bootstrap_options.layout_inline?
+    end
+
     private :field_wrapper, :field_wrapper_classes, :form_wrapper_default_class,
             :field_css_options, :floating_label_classes
   end

data/lib/rails_bootstrap_form/helpers/buttons.rb

@@ -12,11 +12,17 @@ module RailsBootstrapForm
           value, options = nil, value if value.is_a?(Hash)
           bootstrap_options = bootstrap_form_options.scoped(options.delete(:bootstrap_form))
 
-          if (bootstrap_options.render_as_button? || block)
+          button_html = if (bootstrap_options.render_as_button? || block)
             button(value, options, &block)
           else
             submit(value, options)
           end
+
+          if bootstrap_options.layout_inline?
+            tag.div(class: "col-12") { button_html }
+          else
+            button_html
+          end
         end
 
         def secondary(value = nil, options = {}, &block)

data/lib/rails_bootstrap_form/helpers/check_box.rb

@@ -62,7 +62,9 @@ module RailsBootstrapForm
           classes = Array("form-check")
           classes << "form-switch" if bootstrap_options.switch?
           classes << "form-check-inline" if bootstrap_options.inline?
-          classes << "mb-3" unless (bootstrap_options.layout_horizontal? || bootstrap_options.inline?)
+          if (bootstrap_options.layout_vertical? && !bootstrap_options.inline?)
+            classes << "mb-3"
+          end
           classes.flatten.compact
         end
 

data/lib/rails_bootstrap_form/helpers/labels.rb

@@ -22,23 +22,32 @@ module RailsBootstrapForm
 
         def label_classes(attribute, bootstrap_options)
           classes = []
-          classes << if bootstrap_options.layout_horizontal?
-            [bootstrap_options.label_col_class, bootstrap_options.label_col_wrapper_class]
-          else
-            bootstrap_options.label_class
-          end
+          classes << label_layout_classes(bootstrap_options)
           classes << bootstrap_options.additional_label_class
-          classes << bootstrap_options.hide_class if bootstrap_options.hide_label?
+          classes << bootstrap_options.hide_class if hide_class_required?(bootstrap_options)
           classes << "required" if is_attribute_required?(attribute)
           classes << "is-invalid" if is_invalid?(attribute)
           classes.flatten.compact
         end
 
+        def label_layout_classes(bootstrap_options)
+          if bootstrap_options.layout_horizontal?
+            [bootstrap_options.label_col_class, bootstrap_options.label_col_wrapper_class]
+          else
+            bootstrap_options.label_class
+          end
+        end
+
         def label_text(attribute, bootstrap_options)
           bootstrap_options.label_text || object&.class.try(:human_attribute_name, attribute)
         end
 
-        private :draw_label, :label_classes, :label_text
+        def hide_class_required?(bootstrap_options)
+          bootstrap_options.hide_label? || (bootstrap_options.layout_inline? && !bootstrap_options.floating?)
+        end
+
+        private :draw_label, :label_classes, :label_text, :label_layout_classes,
+                :hide_class_required?
       end
     end
   end

data/lib/rails_bootstrap_form/helpers/radio_button.rb

@@ -58,7 +58,9 @@ module RailsBootstrapForm
         def radio_button_wrapper_class(bootstrap_options)
           classes = Array("form-check")
           classes << "form-check-inline" if bootstrap_options.inline?
-          classes << "mb-3" unless (bootstrap_options.layout_horizontal? || bootstrap_options.inline?)
+          if (bootstrap_options.layout_vertical? && !bootstrap_options.inline?)
+            classes << "mb-3"
+          end
           classes.flatten.compact
         end
 

data/lib/rails_bootstrap_form/inputs/check_box.rb

@@ -34,6 +34,8 @@ module RailsBootstrapForm
                   check_box_html
                 end
               end
+            elsif bootstrap_options.layout_inline?
+              tag.div(class: "col-12") { check_box_html }
             else
               check_box_html
             end

data/lib/rails_bootstrap_form/inputs/radio_button.rb

@@ -34,6 +34,8 @@ module RailsBootstrapForm
                   radio_button_html
                 end
               end
+            elsif bootstrap_options.layout_inline?
+              tag.div(class: "col-12") { radio_button_html }
             else
               radio_button_html
             end

data/lib/rails_bootstrap_form/inputs/rich_text_area.rb

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+# -*- warn_indent: true -*-
+
+module RailsBootstrapForm
+  module Inputs
+    module RichTextArea
+      extend ActiveSupport::Concern
+
+      included do
+        def rich_text_area(attribute, options = {})
+          options[:class] = ["trix-content", options[:class]].compact.join(" ")
+
+          field_wrapper_builder(attribute, options) do
+            super(attribute, options)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rails_bootstrap_form/inputs.rb

@@ -27,6 +27,7 @@ module RailsBootstrapForm
     autoload :PhoneField
     autoload :RadioButton
     autoload :RangeField
+    autoload :RichTextArea
     autoload :SearchField
     autoload :Select
     autoload :StaticField
@@ -61,6 +62,7 @@ module RailsBootstrapForm
     include PhoneField
     include RadioButton
     include RangeField
+    include RichTextArea
     include SearchField
     include Select
     include StaticField

data/lib/rails_bootstrap_form/version.rb

@@ -3,6 +3,6 @@
 # -*- warn_indent: true -*-
 
 module RailsBootstrapForm
-  VERSION = "0.7.1".freeze
+  VERSION = "0.8.0".freeze
   REQUIRED_RAILS_VERSION = "~> 7.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_bootstrap_form
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.0
 platform: ruby
 authors:
 - Harshal LADHE (shivam091)
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-05-24 00:00:00.000000000 Z
+date: 2023-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: generator_spec
@@ -94,6 +94,7 @@ files:
 - demo/app/views/users/_form.html.erb
 - demo/app/views/users/_form_without_bootstrap_helpers.html.erb
 - demo/app/views/users/_horizontal_form.html.erb
+- demo/app/views/users/_inline_form.html.erb
 - demo/app/views/users/_vertical_form.html.erb
 - demo/app/views/users/edit.html.erb
 - demo/app/views/users/index.html.erb
@@ -173,6 +174,7 @@ files:
 - lib/rails_bootstrap_form/inputs/phone_field.rb
 - lib/rails_bootstrap_form/inputs/radio_button.rb
 - lib/rails_bootstrap_form/inputs/range_field.rb
+- lib/rails_bootstrap_form/inputs/rich_text_area.rb
 - lib/rails_bootstrap_form/inputs/search_field.rb
 - lib/rails_bootstrap_form/inputs/select.rb
 - lib/rails_bootstrap_form/inputs/static_field.rb