bootstrap5_helper 1.1.0 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ab8982347a3e4e8f5b3f295df1d32c1436c96f6a0e6ed7ebe49be9cb2030acf
-  data.tar.gz: 1f0e37c6a736272b748fab3c8c00107d58d232f177d4fcbb812d212085670d6c
+  metadata.gz: 50b1e83426c0845570591efbaaf2c7071a528039ec8c5a051304784ab13e7f91
+  data.tar.gz: 2a543eca14020820fa8fcbfdbe208a97b925a4ca5371483d98249914ee9a4c06
 SHA512:
-  metadata.gz: 81a56bd544a7aaa270adbde0e361e2c1bf206e9e39980eca8ad8af45295a430c2cb1b21d76af32eb320013715ca5545ba99c784f881786e1df967f9a6df1aad8
-  data.tar.gz: 5aedd70cae3d0fce44b2457a1be9918b4e8c5cf95440970f6eb1dee8c4abb3be40af7b345a6312b7504f42f958304cf1be833fdde375a1bd21f9888888b1351f
+  metadata.gz: fa6a248942c919c442e4602781401de5b383394733c4a89eeba5fc5cfe50f066a58711d7f70411a708f84570d0b3ef07cd1b6bfebaa2638d1cc48ee15d9483f4
+  data.tar.gz: e2b0deb1b20740897688cb60d9a31c9e17477d57d93dbd0ddf19a586eb8b1cd967268c7db15ba3f5cd88dd07506cab8c58bad35696a2bd9ad0740e74cd18e024

data/README.md

@@ -49,11 +49,10 @@ end
 # @option opts [Hash]    :data
 # @option opts [Boolean] :always_open
 # @option opts [Boolean] :flush
+# @yield  [Accordion]
 # @return [Accordion]
 #
-def accordion_helper(opts = {}, &block)
-  Accordion.new(self, opts, &block)
-end
+accordion_helper(opts = {}, &block)
 ```
 
 #### Example:
@@ -99,9 +98,7 @@ Alerts use the context helper, where you can pass the context of the object and
 #
 # @return [String]
 #
-def alert_helper(*args, &block)
-  Alert.new(self, *args, &block)
-end
+alert_helper(*args, &block)
 ```
 
 #### Example:
@@ -132,9 +129,7 @@ The badge helper will build badges realitively quickly. If you are just passing
 #
 # @return [String]
 #
-def badge_helper(*args, &block)
-  Badge.new(self, *args, &block)
-end
+badge_helper(*args, &block)
 ```
 
 #### Example
@@ -164,18 +159,15 @@ Cards support a few methods that make building them easier:
 - `text`
 - `title`
 
-For usage on various card sub components, @see https://getbootstrap.com/docs/4.0/components/card/
-
 ```ruby
 # @param  [Hash] opts
 # @option opts [String] :id
 # @option opts [String] :class
 # @option opts [Hash]   :data
-# @return [String]
+# @yield  [Card]
+# @return [Card]
 #
-def card_helper(opts = {}, &block)
-  Card.new(self, opts, &block)
-end
+card_helper(opts = {}, &block)
 ```
 
 #### Example
@@ -236,79 +228,70 @@ Dropdowns support the following methods:
   - `divider` - A dividing element
 
 ```ruby
-# @overload dropdown_helper(type, opts)
-#   @param [Symbol|String] type - :dropdown, :dropup, :dropstart, :dropend
-#   @param [Hash] opts
+# @overload dropdown_helper(tag, opts)
+#   @param [Symbol|String] tag - The HTML element to use to wrap the component.
+#   @param [Hash]          opts
 #   @option opts [String]  :id
 #   @option opts [String]  :class
 #   @option opts [Hash]    :data
-#   @option opts [Boolean] :split
+#   @option opts [Boolean] :centered
 #
-# @overload dropdown(opts)
-#   @param [Hash] opts
+# @overload dropdown_helper(opts)
+#   @param [Hash]          opts
 #   @option opts [String]  :id
 #   @option opts [String]  :class
 #   @option opts [Hash]    :data
-#   @option opts [Boolean] :split
+#   @option opts [Boolean] :centered
 #
-# @return [String]
+# @yield  [Dropdown]
+# @return [Dropdown]
 #
-def dropdown_helper(*args, &block)
-  Dropdown.new(self, *args, &block)
-end
+dropdown_helper(*args, &block)
 ```
 
 #### Example
 
 ```erb
-<%= dropdown_helper do |dropdown| %>
-    <%= dropdown.button(:primary) { "Action" } %>
-    <%= dropdown.menu do |menu| %>
-        <%= menu.link 'Edit', '#' %>
-        <%= menu.link 'Delete', '#' %>
-        <%= menu.text 'Static text' %>
-    <% end %>
+<%= dropdown_helper class: "btn-group" do |dropdown| %>
+  <button type="button" class="btn btn-primary">Dropdown</button>
+  <%= dropdown.caret :primary >
+  <%= dropdown.menu do |menu| %>
+    <%= menu.link 'Dropdown Link', '#' %>
+    <%= menu.link 'Dropdown Link', '#' %>
+  <% end %>
 <% end %>
 
-<%= dropdown_helper :group, class: 'dropright' do |dropdown| %>
-    <button type="button" class="btn btn-danger">Action 2</button>
-    <%= dropdown.button(:danger, split: true) %>
-    <%= dropdown.menu do |menu| %>
-        <%= menu.header "Crud operations" %>
-        <%= menu.divider %>
-        <%= menu.link 'Edit', 'SOME-URL' %>
-        <%= menu.link 'Delete', 'SOME-URL' %>
-    <% end %>
-<% end %>
+
+// Dropdown menu with a login form inside the menu
 
 <%= dropdown_helper do |dropdown| %>
-    <%= dropdown.button :primary do %>
-        <i class="fas fa-users"></i> User
-    <% end %>
-    <%= dropdown.menu do |menu| %>
-        <form class="px-4 py-3">
-            <div class="form-group">
-                <label for="exampleDropdownFormEmail1">Email address</label>
-                <input type="email" class="form-control" id="exampleDropdownFormEmail1" placeholder="email@example.com">
-            </div>
-            <div class="form-group">
-                <label for="exampleDropdownFormPassword1">Password</label>
-                <input type="password" class="form-control" id="exampleDropdownFormPassword1" placeholder="Password">
-            </div>
-            <div class="form-group">
-                <div class="form-check">
-                    <input type="checkbox" class="form-check-input" id="dropdownCheck">
-                    <label class="form-check-label" for="dropdownCheck">
-                        Remember me
-                    </label>
-                </div>
-            </div>
-            <button type="submit" class="btn btn-primary">Sign in</button>
-        </form>
-        <%= menu.divider %>
-        <%= menu.link "New around here? Sign up", "#" %>
-        <%= menu.link "Forgot password", "#" %>
-    <% end %>
+  <%= dropdown.button :primary do %>
+    Login
+  <% end %>
+  <%= dropdown.menu do |menu| %>
+    <form class="px-4 py-3">
+      <div class="form-group">
+        <label for="exampleDropdownFormEmail1">Email address</label>
+        <input type="email" class="form-control" id="exampleDropdownFormEmail1" placeholder="email@example.com">
+      </div>
+      <div class="form-group">
+        <label for="exampleDropdownFormPassword1">Password</label>
+        <input type="password" class="form-control" id="exampleDropdownFormPassword1" placeholder="Password">
+      </div>
+      <div class="form-group">
+        <div class="form-check">
+          <input type="checkbox" class="form-check-input" id="dropdownCheck">
+          <label class="form-check-label" for="dropdownCheck">
+            Remember me
+          </label>
+        </div>
+      </div>
+      <button type="submit" class="btn btn-primary">Sign in</button>
+    </form>
+    <%= menu.divider %>
+    <%= menu.link "New around here? Sign up", "#" %>
+    <%= menu.link "Forgot password", "#" %>
+  <% end %>
 <% end %>
 ```
 
@@ -324,11 +307,10 @@ end
 # @option opts [Boolean] :static
 # @option opts [Boolean|Symbol] :fullscreen - true, :sm, :lg, :xl etc
 # @option opts [Symbol]  :size - :sm, :md, :lg etc
-# @return [String]
+# @yield  [Modal]
+# @return [Modal]
 #
-def modal_helper(opts = {}, &block)
-  Modal.new(self, opts, &block)
-end
+modal_helper(opts = {}, &block)
 ```
 
 > Note: When the `close_button` is not passed a block, it will default to the X icon.
@@ -381,9 +363,7 @@ The Nav component has the following methods:
 #
 # @return [String]
 #
-def nav_helper(*args, &block)
-  Nav.new(self, *args, &block)
-end
+nav_helper(*args, &block)
 ```
 
 #### Example
@@ -405,10 +385,60 @@ end
 <% end %>
 ```
 
+### Offcanvas
+
+```ruby
+# @overload offcanvas_helper(position, options)
+#   @param  [Symbol] position - :start, :end, :top, :bottom
+#   @param  [Hash] opts
+#   @option opts [String]  :id
+#   @option opts [String]  :class
+#   @option opts [Hash]    :data
+#   @option opts [Hash]    :aria
+#   @option opts [Boolean] :scrollable
+#   @option opts [Boolean|String] :backdrop - true, false, 'static'
+#
+# @overload offcanvas_helper(options)
+#   @param  [Hash] opts
+#   @option opts [String]  :id
+#   @option opts [String]  :class
+#   @option opts [Hash]    :data
+#   @option opts [Hash]    :aria
+#   @option opts [Boolean] :scrollable
+#   @option opts [Boolean|String] :backdrop - true, false, 'static'
+#
+# @yield  [Offcanvas]
+# @return [Offcanvas]
+#
+def offcanvas_helper(*args, &block)
+```
+
+#### Example
+
+```erb
+<%= offcanvas_helper scrollable: true do |off| %>
+  <%= off.link class: 'btn btn-danger' do %>
+      <strong>*</strong> Open sidebar
+  <% end %>
+
+  <%= off.content do |c| %>
+      <%= c.header do %>
+          <%= c.title { 'Sidebar content' } %>
+          <%= c.close_button class: 'btn btn-info' do %>
+              Close
+          <% end %>
+      <% end %>
+      <%= c.body do %>
+          <p>Some content in the sidebar!</p>
+      <% end %>
+  <% end %>
+<% end %>
+```
+
 ### Tabs
 
 ```ruby
- # @overload tab_helper(type, opts)
+# @overload tab_helper(type, opts)
 #   @param [Symbol|String] type - :tabs, :pills
 #   @param  [Hash] opts
 #   @option opts [String]  :id
@@ -421,11 +451,10 @@ end
 #   @option opts [String]  :class
 #   @option opts [Hash]    :data
 #
-# @return [String]
+# @yield  [Tab]
+# @return [Tab]
 #
 def tab_helper(*args, &block)
-  Tab.new(self, *args, &block)
-end
 ```
 
 #### Example
@@ -478,14 +507,13 @@ end
 ```ruby
 # @param  [Hash] args
 # @option opts [Symbol]  :type - :border, :grow
+# @option opts [Symbol]  :size - :sm
 # @option opts [String]  :id
 # @option opts [String]  :class
 # @option opts [Hash]    :data
-# @return [String]
+# @return [Spinner]
 #
-def spinner_helper(opts = {}, &block)
-  Spinner.new(self, opts, &block)
-end
+spinner_helper(opts = {}, &block)
 ```
 
 #### Example

data/lib/bootstrap5_helper/card_with_nav_tab.rb

@@ -2,12 +2,20 @@ module Bootstrap5Helper
   class CardWithNavTab < Component # :nodoc:
     # Class constructor
     #
-    # @param [ActionView] template
-    # @param [Symbol|String|Hash] type_or_options
-    # @param [Hash] opts
-    # @option opts [String]  :id
-    # @option opts [String]  :class
-    # @option opts [Hash]    :data
+    # @overload initialize(template, context, opts)
+    #   @param [ActionView]    template
+    #   @param [Symbol|String] context
+    #   @param [Hash] opts
+    #   @option opts [String]  :id
+    #   @option opts [String]  :class
+    #   @option opts [Hash]    :data
+    #
+    # @overload initialize(template, opts)
+    #   @param [ActionView]    template
+    #   @param [Hash] opts
+    #   @option opts [String]  :id
+    #   @option opts [String]  :class
+    #   @option opts [Hash]    :data
     #
     def initialize(template, *context_or_options, &block)
       super(template)
@@ -42,12 +50,12 @@ module Bootstrap5Helper
       tag, args      = parse_tag_or_options(*tag_or_options, {})
       args[:class]   = (args[:class] || '') << 'nav-tabs card-header-tabs'
       args[:data]    = (args[:data]  || {}).merge('bs-toggle' => 'tab')
-      args[:child]   = {
+      args[:child]   = (args[:child] || {}).merge(
         data: {
           'bs-toggle'  => 'tab',
           'bs-display' => 'static'
         }
-      }
+      )
 
       content_tag :div, class: 'card-header' do
         Nav.new(@template, tag, args, &block).to_s

data/lib/bootstrap5_helper/offcanvas.rb

@@ -146,12 +146,15 @@ module Bootstrap5Helper
 
     # Renders the component as a String, but only to the output bugger.
     #
-    # @return [NilClass]
+    # @note Was updated to return an empty string opposed to nil.
+    # @see changelog.md
+    #
+    # @return [String]
     #
     def to_s
       @content.call(self)
 
-      nil
+      ''
     end
 
     private

data/lib/bootstrap5_helper/spinner.rb

@@ -10,6 +10,7 @@ module Bootstrap5Helper
     # @param [ActionView] template
     # @param [Hash] opts
     # @option opts [Symbol]  :type
+    # @option opts [Symbol]  :size
     # @option opts [String]  :id
     # @option opts [String]  :class
     # @option opts [Hash]    :data
@@ -18,6 +19,7 @@ module Bootstrap5Helper
       super(template)
 
       @type    = opts.fetch(:type, :border)
+      @size    = opts.fetch(:size,  nil)
       @id      = opts.fetch(:id,    uuid)
       @class   = opts.fetch(:class, '')
       @data    = opts.fetch(:data,  {})
@@ -32,7 +34,7 @@ module Bootstrap5Helper
       content_tag(
         :span,
         id:    @id,
-        class: "spinner-#{@type} #{@class}",
+        class: component_classes,
         role:  'status',
         aria:  { hidden: true },
         data:  @data
@@ -40,5 +42,18 @@ module Bootstrap5Helper
         content_tag :span, 'Loading', class: 'visually-hidden'
       end
     end
+
+    private
+
+    # Cleaner way of getting the base component classes.
+    #
+    # @return [String]
+    #
+    def component_classes
+      string = "spinner-#{@type} #{@class}"
+      string << " spinner-#{@type}-#{@size}" if @size.present?
+
+      string
+    end
   end
 end

data/lib/bootstrap5_helper/tab.rb

@@ -68,13 +68,13 @@ module Bootstrap5Helper
     #   string or DOM element, we want to return nil, so that only the output buffer on the sub components are
     #   returned.
     #
-    #   If we return the return value of the block, we will get the last element added to the input
-    #   buffer as an unescaped string.
+    # @note Was updated to return an empty string opposed to nil.
+    # @see changelog.md
     #
     def to_s
       @content.call(self)
 
-      nil
+      ''
     end
 
     def type_or_options(*args)

data/lib/bootstrap5_helper/version.rb

@@ -1,3 +1,3 @@
 module Bootstrap5Helper
-  VERSION = '1.1.0'.freeze
+  VERSION = '1.1.2'.freeze
 end

data/lib/bootstrap5_helper.rb

@@ -165,15 +165,15 @@ module Bootstrap5Helper
     Card.new(self, opts, &block)
   end
 
-  # @overload card_with_nav_tab_helper(type, opts)
-  #   @param [Symbol|String] type - :tabs, :pills
-  #   @param  [Hash] opts
+  # @overload card_with_nav_tab_helper(context, opts)
+  #   @param [Symbol|String] context
+  #   @param [Hash] opts
   #   @option opts [String]  :id
   #   @option opts [String]  :class
   #   @option opts [Hash]    :data
   #
   # @overload card_with_nav_tab_helper(opts)
-  #   @param  [Hash] opts
+  #   @param [Hash] opts
   #   @option opts [String]  :id
   #   @option opts [String]  :class
   #   @option opts [Hash]    :data

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bootstrap5_helper
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.2
 platform: ruby
 authors:
 - Robert David
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-11 00:00:00.000000000 Z
+date: 2024-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bootstrap
@@ -150,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: Rails helpers for generating Bootstrap 5 components.