bootstrap5_helper 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1dd8831d61ec067033a1681a8b91fb1b867fd55f06d36f71aa52488d1733bbf
-  data.tar.gz: b5ebdbdedc4454e8de46cf5f871159d671e66e631c660bc58f8046d82f6c5871
+  metadata.gz: 7ab8982347a3e4e8f5b3f295df1d32c1436c96f6a0e6ed7ebe49be9cb2030acf
+  data.tar.gz: 1f0e37c6a736272b748fab3c8c00107d58d232f177d4fcbb812d212085670d6c
 SHA512:
-  metadata.gz: 4b89389edc7232c9382e4889ddf8685b8ccf3b1057ae0e0a7a0281126c3046d51560b08f7da716a3c9d03b0eccb9b53ad531d57054e128ebce54bd16b4032a87
-  data.tar.gz: ce51660eca95ab8e0d1017eed62493cfdc4b048cd718f5728ea921e9dd9d91ef796a1550d0058c814d3759703cd33eb5f6e00b365b052cd901bd9f72fa910bc2
+  metadata.gz: 81a56bd544a7aaa270adbde0e361e2c1bf206e9e39980eca8ad8af45295a430c2cb1b21d76af32eb320013715ca5545ba99c784f881786e1df967f9a6df1aad8
+  data.tar.gz: 5aedd70cae3d0fce44b2457a1be9918b4e8c5cf95440970f6eb1dee8c4abb3be40af7b345a6312b7504f42f958304cf1be833fdde375a1bd21f9888888b1351f

data/lib/bootstrap5_helper/accordion/item.rb

@@ -11,29 +11,45 @@ module Bootstrap5Helper
       # @option opts [String]  :id
       # @option opts [String]  :class
       # @option opts [Hash]    :data
+      # @option opts [Hash]    :collapse
       #
       def initialize(template, parent_id = nil, opts = {}, &block)
         super(template)
 
-        @parent      = parent_id
-        @id          = opts.fetch(:id,       uuid)
-        @class       = opts.fetch(:class,    '')
-        @data        = opts.fetch(:data,     {})
-        @expanded    = opts.fetch(:expanded, false)
-        @header_id   = uuid
-        @collapse_id = uuid
-        @content     = block || proc { '' }
+        @parent         = parent_id
+        @id             = opts.fetch(:id,       uuid)
+        @class          = opts.fetch(:class,    '')
+        @data           = opts.fetch(:data,     {})
+        @expanded       = opts.fetch(:expanded, false)
+        @collapse       = opts.fetch(:collapse, {})
+        @collapse_id    = @collapse.fetch(:id,    uuid)
+        @collapse_klass = @collapse.fetch(:class, '')
+        @collapse_data  = @collapse.fetch(:data,  {})
+        @header_id      = uuid
+        @content        = block || proc { '' }
       end
 
       # rubocop:disable Metrics/MethodLength
 
       # Builds a header component for the accordion.
       #
-      # @param  [Hash] opts
+      # @overload header(tag, opts)
+      #   @param [Symbol|String] tag - The HTML element to use.
+      #   @param [Hash] options
+      #   @option opts [String] :id
+      #   @option opts [String] :class
+      #   @option opts [Hash] :data
+      #
+      # @overload header(opts)
+      #   @param [Hash] options
+      #   @option opts [String] :id
+      #   @option opts [String] :class
+      #   @option opts [Hash] :data
+      #
       # @return [String]
       #
-      def header(tag_or_options = nil, opts = {}, &block)
-        tag, args = parse_tag_or_options(tag_or_options, opts)
+      def header(*tag_or_options, &block)
+        tag, args = parse_tag_or_options(*tag_or_options, {})
 
         @header_id = args.fetch(:id,    @header_id)
         klass      = args.fetch(:class, '')
@@ -68,6 +84,9 @@ module Bootstrap5Helper
       # Builds the body component for the accordion.
       #
       # @param  [Hash] opts
+      # @option opts [String] :id
+      # @option opts [String] :class
+      # @option opts [Hash] :data
       # @return [String]
       #
       def body(opts = {}, &block)
@@ -78,9 +97,11 @@ module Bootstrap5Helper
         content_tag(
           :div,
           id:    @collapse_id,
-          class: "accordion-collapse collapse #{@expanded ? 'show' : ''}",
+          class: "accordion-collapse collapse #{@collapse_klass} #{@expanded ? 'show' : ''}",
           aria:  { labelledby: @header_id },
-          data:  { 'bs-parent' => @parent.present? ? "##{@parent}" : nil }
+          data:  {
+            'bs-parent' => @parent.present? ? "##{@parent}" : nil
+          }.merge(@collapse_data)
         ) do
           content_tag(
             :div,

data/lib/bootstrap5_helper/accordion.rb

@@ -24,8 +24,12 @@ module Bootstrap5Helper
       @content     = block || proc { '' }
     end
 
-    def item(*args, &block)
-      Accordion::Item.new(self, (@always_open ? nil : @id), *args, &block)
+    # Used to generate a <tt>Accordion::Item</tt> component.
+    #
+    # @return [Accodion::Item]
+    #
+    def item(opts = {}, &block)
+      Accordion::Item.new(self, (@always_open ? nil : @id), opts, &block)
     end
 
     # String representation of the object.

data/lib/bootstrap5_helper/badge.rb

@@ -28,7 +28,7 @@ module Bootstrap5Helper
     #
     def to_s
       content_tag(
-        config(:badges, :span),
+        config({ badges: :base }, :span),
         id:    @id,
         class: container_class,
         data:  @data
@@ -44,10 +44,17 @@ module Bootstrap5Helper
     # @return [String]
     #
     def container_class
-      string = 'badge '
-      string += @context == 'secondary' ? 'bg-secondary' : "bg-#{@context}"
-      string += " #{@class}"
-      string
+      "badge #{component_class} #{@class}"
+    end
+
+    def component_class
+      contrast = config({ badges: :contrast }, false)
+
+      if @context == 'secondary'
+        contrast ? 'text-bg-secondary' : 'bg-secondary'
+      else
+        contrast ? "text-bg-#{@context}" : "bg-#{@context}"
+      end
     end
   end
 end

data/lib/bootstrap5_helper/card.rb

@@ -23,15 +23,23 @@ module Bootstrap5Helper
 
     # Builds the Header component.
     #
-    # @param  [Symbol|Hash|NilClass] tag_or_options
-    # @param  [Hash] opts
-    # @option opts [String] :id
-    # @option opts [String] :class
-    # @option opts [Hash]   :data
+    # @overload header(tag, opts)
+    #   @param [Symbol|String] tag - The HTML element to use.
+    #   @param [Hash] options
+    #   @option opts [String] :id
+    #   @option opts [String] :class
+    #   @option opts [Hash] :data
+    #
+    # @overload header(opts)
+    #   @param [Hash] options
+    #   @option opts [String] :id
+    #   @option opts [String] :class
+    #   @option opts [Hash] :data
+    #
     # @return [String]
     #
-    def header(tag_or_options = nil, opts = {}, &block)
-      tag, args = parse_tag_or_options(tag_or_options, opts)
+    def header(*tag_or_options, &block)
+      tag, args = parse_tag_or_options(*tag_or_options, {})
       build_base_component(
         tag || config({ cards: :header }, :h5),
         :header,
@@ -42,15 +50,23 @@ module Bootstrap5Helper
 
     # Builds the Body component.
     #
-    # @param  [Symbol|Hash|NilClass] tag_or_options
-    # @param  [Hash] opts
-    # @option opts [String] :id
-    # @option opts [String] :class
-    # @option opts [Hash]   :data
+    # @overload body(tag, opts)
+    #   @param [Symbol|String] tag - The HTML element to use.
+    #   @param [Hash] options
+    #   @option opts [String] :id
+    #   @option opts [String] :class
+    #   @option opts [Hash] :data
+    #
+    # @overload body(opts)
+    #   @param [Hash] options
+    #   @option opts [String] :id
+    #   @option opts [String] :class
+    #   @option opts [Hash] :data
+    #
     # @return [String]
     #
-    def body(tag_or_options = nil, opts = {}, &block)
-      tag, args = parse_tag_or_options(tag_or_options, opts)
+    def body(*tag_or_options, &block)
+      tag, args = parse_tag_or_options(*tag_or_options, {})
       build_base_component(
         tag || config({ cards: :body }, :div),
         :body,
@@ -61,15 +77,24 @@ module Bootstrap5Helper
 
     # Builds the Footer component.
     #
-    # @param  [Symbol|Hash|NilClass] tag_or_options
-    # @param  [Hash] opts
-    # @option opts [String] :id
-    # @option opts [String] :class
-    # @option opts [Hash]   :data
+    #
+    # @overload footer(tag, opts)
+    #   @param [Symbol|String] tag - The HTML element to use.
+    #   @param [Hash] options
+    #   @option opts [String] :id
+    #   @option opts [String] :class
+    #   @option opts [Hash] :data
+    #
+    # @overload footer(opts)
+    #   @param [Hash] options
+    #   @option opts [String] :id
+    #   @option opts [String] :class
+    #   @option opts [Hash] :data
+    #
     # @return [String]
     #
-    def footer(tag_or_options = nil, opts = {}, &block)
-      tag, args = parse_tag_or_options(tag_or_options, opts)
+    def footer(*tag_or_options, &block)
+      tag, args = parse_tag_or_options(*tag_or_options, {})
       build_base_component(
         tag || config({ cards: :footer }, :div),
         :footer,
@@ -80,15 +105,23 @@ module Bootstrap5Helper
 
     # Builds a Title component.
     #
-    # @param  [Symbol|Hash|NilClass] tag_or_options
-    # @param  [Hash] opts
-    # @option opts [String] :id
-    # @option opts [String] :class
-    # @option opts [Hash]   :data
+    # @overload title(tag, opts)
+    #   @param [Symbol|String] tag - The HTML element to use.
+    #   @param [Hash] options
+    #   @option opts [String] :id
+    #   @option opts [String] :class
+    #   @option opts [Hash] :data
+    #
+    # @overload title(opts)
+    #   @param [Hash] options
+    #   @option opts [String] :id
+    #   @option opts [String] :class
+    #   @option opts [Hash] :data
+    #
     # @return [String]
     #
-    def title(tag_or_options = nil, opts = {}, &block)
-      tag, args = parse_tag_or_options(tag_or_options, opts)
+    def title(*tag_or_options, &block)
+      tag, args = parse_tag_or_options(*tag_or_options, {})
       build_sub_component(
         tag || config({ cards: :title }, :h5),
         :title,
@@ -97,17 +130,52 @@ module Bootstrap5Helper
       )
     end
 
+    # Builds a Title component.
+    #
+    # @overload subtitle(tag, opts)
+    #   @param [Symbol|String] tag - The HTML element to use.
+    #   @param [Hash] options
+    #   @option opts [String] :id
+    #   @option opts [String] :class
+    #   @option opts [Hash] :data
+    #
+    # @overload subtitle(opts)
+    #   @param [Hash] options
+    #   @option opts [String] :id
+    #   @option opts [String] :class
+    #   @option opts [Hash] :data
+    #
+    # @return [String]
+    #
+    def subtitle(*tag_or_options, &block)
+      tag, args = parse_tag_or_options(*tag_or_options, {})
+      build_sub_component(
+        tag || config({ cards: :subtitle }, :h6),
+        :subtitle,
+        args,
+        &block
+      )
+    end
+
     # Builds a Text component.
     #
-    # @param  [Symbol|Hash|NilClass] tag_or_options
-    # @param  [Hash] opts
-    # @option opts [String] :id
-    # @option opts [String] :class
-    # @option opts [Hash]   :data
+    # @overload header(tag, opts)
+    #   @param [Symbol|String] tag - The HTML element to use.
+    #   @param [Hash] options
+    #   @option opts [String] :id
+    #   @option opts [String] :class
+    #   @option opts [Hash] :data
+    #
+    # @overload header(opts)
+    #   @param [Hash] options
+    #   @option opts [String] :id
+    #   @option opts [String] :class
+    #   @option opts [Hash] :data
+    #
     # @return [String]
     #
-    def text(tag_or_options = nil, opts = {}, &block)
-      tag, args = parse_tag_or_options(tag_or_options, opts)
+    def text(*tag_or_options, &block)
+      tag, args = parse_tag_or_options(*tag_or_options, {})
       build_sub_component(
         tag || config(:card_text, :p),
         :text,

data/lib/bootstrap5_helper/card_with_nav_tab.rb

@@ -0,0 +1,80 @@
+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
+    #
+    def initialize(template, *context_or_options, &block)
+      super(template)
+      @context, args = parse_context_or_options(*context_or_options, {})
+      @id      = args.fetch(:id,    '')
+      @class   = args.fetch(:class, '')
+      @data    = args.fetch(:data,  nil)
+      @content = block || proc { '' }
+    end
+
+    # Builds a custom Nav component for the tabs.
+    #
+    # @overload nav(tag, opts)
+    #   @param [Symbol|String] tag - :nav, :ul
+    #   @param [Hash] opts
+    #   @option opts [String]  :id
+    #   @option opts [String]  :class
+    #   @option opts [Hash]    :data
+    #   @option opts [Hash]    :child - data attributes for child, NOT wrapper
+    #
+    # @overload nav(opts)
+    #   @param [Hash] opts
+    #   @option opts [String]  :id
+    #   @option opts [String]  :class
+    #   @option opts [Hash]    :data
+    #   @option opts [Hash]    :child - data attributes for child, NOT wrapper
+    #
+    # @yield  [Nav]
+    # @return [Nav]
+    #
+    def nav(*tag_or_options, &block)
+      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]   = {
+        data: {
+          'bs-toggle'  => 'tab',
+          'bs-display' => 'static'
+        }
+      }
+
+      content_tag :div, class: 'card-header' do
+        Nav.new(@template, tag, args, &block).to_s
+      end
+    end
+
+    # Builds the Content object for the Tab.
+    #
+    # @param  [Hash] opts
+    # @option opts [String]  :id
+    # @option opts [String]  :class
+    # @option opts [Hash]    :data
+    # @return [Tab::Content]
+    #
+    def content(opts = {}, &block)
+      content_tag :div, class: 'card-body' do
+        Tab::Content.new(@template, opts, &block).to_s
+      end
+    end
+
+    # @todo
+    #
+    #
+    def to_s
+      content_tag :div, class: "card with-nav-tabs-#{@context}" do
+        @content.call(self)
+      end
+    end
+  end
+end

data/lib/bootstrap5_helper/configuration.rb

@@ -10,19 +10,24 @@ module Bootstrap5Helper
         header: :h2,
         body:   :div
       },
-      badges:            :span,
+      badges:            {
+        contrast: false,
+        base:     :span
+      },
       callouts:          {
         header: :h4
       },
       cards:             {
-        header: :h5,
-        body:   :div,
-        footer: :div,
-        title:  :h5,
-        text:   :p
+        header:   :h5,
+        body:     :div,
+        footer:   :div,
+        title:    :h5,
+        subtitle: :h6,
+        text:     :p
       },
       dropdowns:         {},
-      dropdown_menus:    {
+      overlay_menus:     {
+        base:    :div,
         text:    :span,
         header:  :h6,
         divider: :div

data/lib/bootstrap5_helper/constants.rb

@@ -12,8 +12,12 @@ module Bootstrap5Helper
       card
       callout
       configuration
+      overlay
+      overlay/menu
       dropdown
-      dropdown/menu
+      dropup
+      dropstart
+      dropend
       input_group
       modal
       nav
@@ -23,6 +27,7 @@ module Bootstrap5Helper
       spinner
       tab
       tab/content
+      card_with_nav_tab
     ].freeze
   end
 end

data/lib/bootstrap5_helper/dropdown.rb

@@ -2,120 +2,33 @@ module Bootstrap5Helper
   # Builds a Dropdown component that can be used in other components.
   #
   #
-  class Dropdown < Component
+  class Dropdown < Overlay
     # Class constructor
     #
-    # @param [ActionView]    template
-    # @param [Symbol|String] type
-    # @param [Hash]          opts
-    # @option opts [String]  :id
-    # @option opts [String]  :class
-    # @option opts [Hash]    :data
-    # @option opts [Boolea]  :split
-    # @option opts [Boolean] :centered
-    #
-    def initialize(template, type = :dropdown, opts = {}, &block)
-      super(template)
-
-      @type     = type
-      @split    = opts.fetch(:split,    false)
-      @centered = opts.fetch(:centered, false)
-      @id       = opts.fetch(:id,       uuid)
-      @class    = opts.fetch(:class,    '')
-      @data     = opts.fetch(:data,     {})
-      @content  = block || proc { '' }
-    end
-
-    # Used to generate a button for the dropdown.  The buttons default as just
-    # a button that opens the coresponding dropdown menu.  The `split: true` option
-    # make the button just the arrow indicator that open the menu.
-    #
-    # @param  [Symbol] context
-    # @param  [Hash]   opts
-    # @option opts [String]  :id
-    # @option opts [String]  :class
-    # @option opts [Hash]    :data
-    # @option opts [Boolean] :split
-    # @return [String]
-    #
-    def button(context = :primary, opts = {})
-      id     = opts.fetch(:id,    nil)
-      klass  = opts.fetch(:class, '')
-      split  = opts.fetch(:split, false)
-      data   = opts.fetch(:data,  {}).merge('bs-toggle' => 'dropdown')
-      extra  = @split ? 'dropdown-toggle-split' : ''
-
-      content_tag(
-        :button,
-        id:    id,
-        type:  'button',
-        class: "dropdown-toggle btn btn-#{context} #{klass} #{extra}",
-        data:  data,
-        aria:  { haspopup: true, expanded: false }
-      ) do
-        split ? content_tag(:span, 'Toggle Dropdown', class: 'visually-hidden') : yield
-      end
-    end
-
-    # Used to create a new `Dropdown::Menu`
-    #
-    # @param  [Hash] opts
-    # @option opts [String] :id
-    # @option opts [String] :class
-    # @option opts [Hash]   :data
-    # @return [Dropdown::Menu]
-    #
-    def menu(opts = {}, &block)
-      Menu.new(@template, opts, &block)
-    end
-
-    # String reprentation of the object.
-    #
-    # @return [String]
-    #
-    def to_s
-      content_tag(
-        :div,
-        id:    @id,
-        class: "#{element_type_class} #{alignment_type_class} #{@class}",
-        data:  @data
-      ) do
-        @content.call(self)
-      end
-    end
-
-    private
-
-    # Returns the container class for the dropdown component.
-    #
-    # @return [String]
-    #
-    def element_type_class
-      case @type
-      when :dropdown
-        'dropdown'
-      when :dropup
-        'dropup'
-      when :dropstart
-        'dropstart'
-      when :dropend
-        'dropend'
-      else
-        ''
-      end
-    end
-
-    # Returns the alignment class for the dropdown component.
-    #
-    # @return [String]
-    #
-    def alignment_type_class
-      case @type
-      when :dropdown, :dropup
-        @centered ? "#{element_type_class}-center" : ''
-      else
-        ''
-      end
+    # @overload initialize(template, tag, opts)
+    #   @param [ActionView]    template
+    #   @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 [Boolea]  :split
+    #   @option opts [Boolean] :centered
+    #
+    # @overload initialize(template, opts)
+    #   @param [ActionView]    template
+    #   @param [Hash]          opts
+    #   @option opts [String]  :id
+    #   @option opts [String]  :class
+    #   @option opts [Hash]    :data
+    #   @option opts [Boolea]  :split
+    #   @option opts [Boolean] :centered
+    #
+    # @return [Dropdown]
+    #
+    def initialize(template, *tag_or_options, &block)
+      super(template, *tag_or_options, &block)
+      @type = :dropdown
     end
   end
 end

data/lib/bootstrap5_helper/dropend.rb

@@ -0,0 +1,34 @@
+module Bootstrap5Helper
+  # Builds a Dropdown component that can be used in other components.
+  #
+  #
+  class Dropend < Overlay
+    # Class constructor
+    #
+    # @overload initialize(template, tag, opts)
+    #   @param [ActionView]    template
+    #   @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 [Boolea]  :split
+    #   @option opts [Boolean] :centered
+    #
+    # @overload initialize(template, opts)
+    #   @param [ActionView]    template
+    #   @param [Hash]          opts
+    #   @option opts [String]  :id
+    #   @option opts [String]  :class
+    #   @option opts [Hash]    :data
+    #   @option opts [Boolea]  :split
+    #   @option opts [Boolean] :centered
+    #
+    # @return [Dropend]
+    #
+    def initialize(template, *tag_or_options, &block)
+      super(template, *tag_or_options, &block)
+      @type = :dropend
+    end
+  end
+end

data/lib/bootstrap5_helper/dropstart.rb

@@ -0,0 +1,34 @@
+module Bootstrap5Helper
+  # Builds a Dropdown component that can be used in other components.
+  #
+  #
+  class Dropstart < Overlay
+    # Class constructor
+    #
+    # @overload initialize(template, tag, opts)
+    #   @param [ActionView]    template
+    #   @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 [Boolea]  :split
+    #   @option opts [Boolean] :centered
+    #
+    # @overload initialize(template, opts)
+    #   @param [ActionView]    template
+    #   @param [Hash]          opts
+    #   @option opts [String]  :id
+    #   @option opts [String]  :class
+    #   @option opts [Hash]    :data
+    #   @option opts [Boolea]  :split
+    #   @option opts [Boolean] :centered
+    #
+    # @return [Dropstart]
+    #
+    def initialize(template, *tag_or_options, &block)
+      super(template, *tag_or_options, &block)
+      @type = :dropstart
+    end
+  end
+end