bootstrap5_helper 1.0.1 → 1.1.0

data/lib/bootstrap5_helper.rb

@@ -34,6 +34,7 @@ module Bootstrap5Helper
   # @option opts [Hash]    :data
   # @option opts [Boolean] :always_open
   # @option opts [Boolean] :flush
+  # @yield  [Accordion]
   # @return [Accordion]
   #
   def accordion_helper(opts = {}, &block)
@@ -62,7 +63,7 @@ module Bootstrap5Helper
   #   @option opts [String] :class
   #   @option opts [Boolean] :dismissible
   #
-  # @return [String]
+  # @return [Alert]
   #
   def alert_helper(*args, &block)
     Alert.new(self, *args, &block)
@@ -94,7 +95,7 @@ module Bootstrap5Helper
   #   @option opts [String] :class
   #   @option opts [Hash] : :data
   #
-  # @return [String]
+  # @return [Badge]
   #
   def badge_helper(*args, &block)
     Badge.new(self, *args, &block)
@@ -157,13 +158,34 @@ module Bootstrap5Helper
   # @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
 
-  # Generates a Dropdown component.  Default type `:dropdown`.
+  # @overload card_with_nav_tab_helper(type, opts)
+  #   @param [Symbol|String] type - :tabs, :pills
+  #   @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
+  #   @option opts [String]  :id
+  #   @option opts [String]  :class
+  #   @option opts [Hash]    :data
+  #
+  # @yield  [CardWithNavTab]
+  # @return [CardWithNavTab]
+  #
+  def card_with_nav_tab_helper(*args, &block)
+    CardWithNavTab.new(self, *args, &block)
+  end
+
+  # Generates a Dropdown component.
   #
   # @example Dropdown
   #   ```erb
@@ -177,19 +199,7 @@ module Bootstrap5Helper
   #    <% end %>
   #   ```
   #
-  # @example Dropup
-  #   ```erb
-  #    <%= dropdown_helper :dropup do |dropdown| %>
-  #      <%= dropdown.button(:primary) { "Action" } %>
-  #      <%= dropdown.menu do |menu| %>
-  #          <%= menu.link 'Edit', '#' %>
-  #          <%= menu.link 'Delete', '#' %>
-  #          <%= menu.text 'Static text' %>
-  #      <% end %>
-  #    <% end %>
-  #   ```
-  #
-  # @example Dropdown w/ menu
+  # @example Dropdown w/ Login Form
   #   ```erb
   #   <%= dropdown_helper do |dropdown| %>
   #     <%= dropdown.button :primary do %>
@@ -222,35 +232,100 @@ module Bootstrap5Helper
   #   <% end %>
   #   ```
   #
-  # @example Dropdown::Menu in a Nav menu
-  #   ```erb
-  #   <%= nav.dropdown 'More' do |dropdown| %>
-  #     <%= dropdown.item :item5 %>
-  #     <%= dropdown.item(:item6) { 'Item 6' } %>
-  #   <% end %>
-  #   ```
-  #
-  # @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
 
+  # Generates a Dropup component.
+  #
+  # @overload dropup_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] :centered
+  #
+  # @overload dropup_helper(opts)
+  #   @param [Hash]          opts
+  #   @option opts [String]  :id
+  #   @option opts [String]  :class
+  #   @option opts [Hash]    :data
+  #   @option opts [Boolean] :centered
+  #
+  # @yield  [Dropdup]
+  # @return [Dropup]
+  #
+  def dropup_helper(*args, &block)
+    Dropup.new(self, *args, &block)
+  end
+
+  # Generates a Dropstart component.
+  #
+  # @overload dropstart_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] :centered
+  #
+  # @overload dropstart_helper(opts)
+  #   @param [Hash]          opts
+  #   @option opts [String]  :id
+  #   @option opts [String]  :class
+  #   @option opts [Hash]    :data
+  #   @option opts [Boolean] :centered
+  #
+  # @yield  [Dropstart]
+  # @return [Dropstart]
+  #
+  def dropstart_helper(*args, &block)
+    Dropstart.new(self, *args, &block)
+  end
+
+  # Generates a Dropend component.
+  #
+  # @overload dropend_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] :centered
+  #
+  # @overload dropend_helper(opts)
+  #   @param [Hash]          opts
+  #   @option opts [String]  :id
+  #   @option opts [String]  :class
+  #   @option opts [Hash]    :data
+  #   @option opts [Boolean] :centered
+  #
+  # @yield  [Dropend]
+  # @return [Dropend]
+  #
+  def dropend_helper(*args, &block)
+    Dropend.new(self, *args, &block)
+  end
+
   # Generates Modal windows.
   #
   # @example
@@ -283,7 +358,8 @@ module Bootstrap5Helper
   # @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)
@@ -324,7 +400,8 @@ module Bootstrap5Helper
   #   @option opts [Hash]    :data
   #   @option opts [Hash]    :child - data attributes for child, NOT wrapper
   #
-  # @return [String]
+  # @yield  [Nav]
+  # @return [Nav]
   #
   def nav_helper(*args, &block)
     Nav.new(self, *args, &block)
@@ -388,7 +465,8 @@ module Bootstrap5Helper
   #   @option opts [Boolean] :scrollable
   #   @option opts [Boolean|String] :backdrop - true, false, 'static'
   #
-  # @return [String]
+  # @yield  [Offcanvas]
+  # @return [Offcanvas]
   #
   def offcanvas_helper(*args, &block)
     Offcanvas.new(self, *args, &block)
@@ -416,7 +494,7 @@ module Bootstrap5Helper
   #   @option opts [String]  :class
   #   @option opts [Hash]    :data
   #
-  # @return [String]
+  # @return [PageHeader]
   #
   def page_header_helper(*args, &block)
     PageHeader.new(self, *args, &block)
@@ -455,7 +533,7 @@ module Bootstrap5Helper
   #   @option opts [String] :class
   #   @option opts [Hash]   :data
   #
-  # @return [String]
+  # @return [InputGroup]
   #
   def input_group_helper(*args, &block)
     InputGroup.new(self, *args, &block)
@@ -520,7 +598,8 @@ module Bootstrap5Helper
   #   @option opts [String]  :class
   #   @option opts [Hash]    :data
   #
-  # @return [String]
+  # @yield  [Tab]
+  # @return [Tab]
   #
   def tab_helper(*args, &block)
     Tab.new(self, *args, &block)
@@ -539,7 +618,7 @@ module Bootstrap5Helper
   # @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)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bootstrap5_helper
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Robert David
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-13 00:00:00.000000000 Z
+date: 2023-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bootstrap
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.1.3
+        version: 5.2.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.1.3
+        version: 5.2.2
 - !ruby/object:Gem::Dependency
   name: jquery-rails
   requirement: !ruby/object:Gem::Requirement
@@ -103,17 +103,22 @@ files:
 - lib/bootstrap5_helper/badge.rb
 - lib/bootstrap5_helper/callout.rb
 - lib/bootstrap5_helper/card.rb
+- lib/bootstrap5_helper/card_with_nav_tab.rb
 - lib/bootstrap5_helper/component.rb
 - lib/bootstrap5_helper/configuration.rb
 - lib/bootstrap5_helper/constants.rb
 - lib/bootstrap5_helper/dropdown.rb
-- lib/bootstrap5_helper/dropdown/menu.rb
+- lib/bootstrap5_helper/dropend.rb
+- lib/bootstrap5_helper/dropstart.rb
+- lib/bootstrap5_helper/dropup.rb
 - lib/bootstrap5_helper/initialize.rb
 - lib/bootstrap5_helper/input_group.rb
 - lib/bootstrap5_helper/modal.rb
 - lib/bootstrap5_helper/nav.rb
 - lib/bootstrap5_helper/offcanvas.rb
 - lib/bootstrap5_helper/offcanvas/content.rb
+- lib/bootstrap5_helper/overlay.rb
+- lib/bootstrap5_helper/overlay/menu.rb
 - lib/bootstrap5_helper/page_header.rb
 - lib/bootstrap5_helper/railtie.rb
 - lib/bootstrap5_helper/spinner.rb