bootstrap5_helper 1.0.0

data/lib/bootstrap5_helper/nav.rb

@@ -0,0 +1,145 @@
+module Bootstrap5Helper
+  # Builds a Nav Component that can be used in other components.
+  #
+  #
+  class Nav < Component
+    # Class constructor
+    #
+    # @param [ActionView]     template
+    # @param [Symbol|Hash]    tag_or_options
+    # @param [Hash]           opts
+    # @option opts [String]  :id
+    # @option opts [String]  :class
+    # @option opts [Hash]    :data
+    # @option opts [Hash]    :child
+    #
+    def initialize(template, tag_or_options = nil, opts = {}, &block)
+      super(template)
+
+      @tag, args = parse_tag_or_options(tag_or_options, opts)
+      @tag ||= config({ navs: :base }, :ul)
+
+      @id        = args.fetch(:id,    uuid)
+      @class     = args.fetch(:class, '')
+      @data      = args.fetch(:data,  {})
+      @child     = args.fetch(:child, {})
+      @content   = block || proc { '' }
+
+      @dropdown = Dropdown.new(@template)
+    end
+
+    # rubocop:disable Metrics/MethodLength
+
+    # Adds an nav-item to the nav component. this method gets used when the nav-item
+    # links to content in a tab or something.
+    #
+    # @param [Symbol|String] target
+    # @param [Hash] opts
+    # @option opts [String]  :id
+    # @option opts [String]  :class
+    # @option opts [Hash]    :data
+    # @option opts [Hash]    :aria
+    # @return [String]
+    #
+    def item(target, opts = {})
+      id    = opts.fetch(:id,    nil)
+      klass = opts.fetch(:class, '')
+      data  = opts.fetch(:data,  {})
+      aria  = opts.fetch(:aria,  {})
+
+      nav_item_wrapper id: id, data: data do
+        content_tag(
+          :a,
+          class:    "nav-link #{klass}",
+          href:     "##{target}",
+          tabindex: -1,
+          data:     @child[:data],
+          aria:     aria
+        ) do
+          block_given? ? yield : target.to_s.titleize
+        end
+      end
+    end
+    # rubocop:enable Metrics/MethodLength
+
+    # Use this when the nav item is nothing more than a hyperlink.
+    #
+    # @param [String|NilClass] name
+    # @param [Hash|NilClass]   options
+    # @param [Hash|NilClass]   html_options
+    # @return [String]
+    #
+    def link(name = nil, options = nil, html_options = nil, &block)
+      html_options ||= {}
+      html_options[:class] = (html_options[:class] || '') << ' nav-link'
+
+      nav_item_wrapper do
+        @template.link_to(name, options, html_options, &block)
+      end
+    end
+
+    # Creates a dropdown menu for the nav.
+    #
+    # @param [NilClass|Symbol|String] name
+    # @param [Hash] opts
+    # @option opts [String]  :id
+    # @option opts [String]  :class
+    # @option opts [Hash]    :data
+    # @option opts [Hash]    :aria
+    # @return [String]
+    #
+    def dropdown(name, opts = {}, &block)
+      id    = opts.fetch(:id,    nil)
+      klass = opts.fetch(:class, '')
+      data  = opts.fetch(:data,  {})
+      aria  = opts.fetch(:aria,  {}).merge(haspopup: true, expanded: false)
+
+      nav_item_wrapper id: id, class: 'dropdown', data: data do
+        content_tag(
+          :a,
+          name,
+          class: "nav-link dropdown-toggle #{klass}",
+          href:  '#',
+          data:  { 'bs-toggle' => 'dropdown' },
+          role:  'button',
+          aria:  aria
+        ) + @dropdown.menu(opts, &block).to_s.html_safe
+      end
+    end
+
+    # String representation of the object.
+    #
+    # @return [String]
+    #
+    def to_s
+      content_tag(@tag, id: @id, class: "nav #{@class}") do
+        @content.call(self)
+      end
+    end
+
+    private
+
+    # Decorator for elements require a wrapper component.
+    #
+    # @return [String]
+    #
+    def nav_item_wrapper(opts = {}, &block)
+      id    = opts.fetch(:id,    '')
+      klass = opts.fetch(:class, '')
+      data  = opts.fetch(:data,  {})
+
+      case @tag
+      when :nav
+        block.call
+      when :ul
+        content_tag(
+          :li,
+          id:    id,
+          class: "nav-item #{klass}",
+          data:  data,
+          &block
+        )
+      end
+    end
+  end
+end

data/lib/bootstrap5_helper/offcanvas/content.rb

@@ -0,0 +1,127 @@
+module Bootstrap5Helper
+  class Offcanvas
+    # Builds a Content component for use in offcanvas.
+    #
+    #
+    class Content < Component
+      # Constructor description...
+      #
+      #
+      # @param  [Hash] opts
+      # @return [ClassName]
+      #
+      def initialize(template, opts = {}, &block)
+        super(template)
+
+        @id         = opts.fetch(:id,         uuid)
+        @class      = opts.fetch(:class,      '')
+        @data       = opts.fetch(:data,       {})
+        @aria       = opts.fetch(:aria,       {})
+        @scrollable = opts.fetch(:scrollable, false)
+        @position   = opts.fetch(:position,   'start')
+        @content    = block || proc { '' }
+      end
+
+      # @todo
+      #
+      #
+      def header(opts = {}, &block)
+        id    = opts.fetch(:id,    nil)
+        klass = opts.fetch(:class, '')
+        data  = opts.fetch(:data,  {})
+
+        content_tag(
+          config({ offcanvas: :header }, :div),
+          id:    id,
+          class: "offcanvas-header #{klass}",
+          data:  data,
+          &block
+        )
+      end
+
+      # @todo
+      #
+      #
+      def title(text_or_options = nil, opts = {}, &block)
+        text, args = parse_text_or_options(text_or_options, opts)
+
+        id    = args.fetch(:id,    nil)
+        klass = args.fetch(:class, '')
+        data  = args.fetch(:data,  {})
+
+        content_tag(
+          config({ offcanvas: :title }, :h6),
+          text,
+          id:    id,
+          class: "offcanvas-title #{klass}",
+          data:  data,
+          &block
+        )
+      end
+
+      # @todo
+      #
+      #
+      def close_button(opts = {})
+        klass = opts.fetch(:class, '')
+
+        content_tag(
+          config({ offcanvas: :close }, :button),
+          class: block_given? ? klass : 'btn-close',
+          data:  { 'bs-dismiss': 'offcanvas' },
+          aria:  { label: 'Close' }
+        ) do
+          block_given? ? yield : xbutton
+        end
+      end
+
+      # @todo
+      #
+      #
+      def body(opts = {}, &block)
+        id    = opts.fetch(:id, nil)
+        klass = opts.fetch(:class, '')
+        data  = opts.fetch(:data, {})
+        aria  = opts.fetch(:aria, {})
+
+        content_tag(
+          :div,
+          id:    id,
+          class: "offcanvas-body #{klass}",
+          data:  data,
+          aria:  aria,
+          &block
+        )
+      end
+
+      # @todo
+      #
+      #
+      def to_s
+        @data.merge!('bs-scroll':   @scrollable)
+        @data.merge!('bs-backdrop': @backdrop)
+
+        content_tag(
+          :div,
+          id:       @id,
+          class:    "offcanvas offcanvas-#{@position} #{@class}",
+          tabindex: -1,
+          data:     @data,
+          aria:     { labelledby: 'offcanvasExampleLabel' }
+        ) do
+          @content.call(self)
+        end
+      end
+
+      private
+
+      # Builds the `x` button normally used in the header.
+      #
+      # @return [String]
+      #
+      def xbutton
+        content_tag :span, '&times;'.html_safe, class: 'visually-hidden', aria: { hidden: true }
+      end
+    end
+  end
+end

data/lib/bootstrap5_helper/offcanvas.rb

@@ -0,0 +1,169 @@
+module Bootstrap5Helper
+  # Builds a Offcanvas component.
+  #
+  #
+  class Offcanvas < Component
+    # Class constructor
+    #
+    # @param  [ActionView]
+    # @param  [NilClass|Symbol|Hash] position_or_options - :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
+    # @return [Offcanvas]
+    #
+    def initialize(template, position_or_options = nil, opts = {}, &block)
+      super(template)
+      @pos, args  = parse_position_or_options(position_or_options, opts)
+      @id         = args.fetch(:id,         uuid)
+      @class      = args.fetch(:class,      '')
+      @data       = args.fetch(:data,       {})
+      @aria       = args.fetch(:aria,       {})
+      @scrollable = args.fetch(:scrollable, false)
+      @backdrop   = args.fetch(:backdrop,   true)
+      @content    = block || proc { '' }
+    end
+    # rubocop:disable Metrics/MethodLength
+
+    # Creates a button element to act as the trigger for the offcanvas component.
+    #
+    # @param  [NilClass|String|Hash] text_or_options
+    # @param  [Hash] opts
+    # @option opts [String] :id
+    # @option opts [String] :class
+    # @option opts [Hash]   :data
+    # @option opts [Hash]   :aria
+    # @return [String]
+    #
+    def button(text_or_options = nil, opts = {}, &block)
+      text, args = parse_text_or_options(text_or_options, opts)
+
+      id    = args.fetch(:id,    nil)
+      klass = args.fetch(:class, '')
+
+      data = args.fetch(:data, {}).merge!(
+        'bs-toggle' => 'offcanvas',
+        'bs-target' => "##{@id}"
+      )
+
+      aria = args.fetch(:aria, {}).merge!(
+        'controls' => @id
+      )
+
+      content_tag(
+        :button,
+        text,
+        type:  :button,
+        id:    id,
+        class: klass,
+        data:  data,
+        aria:  aria,
+        &block
+      )
+    end
+    # rubocop:enable Metrics/MethodLength
+
+    # Creates a simple link to toggle the offcanvas content.
+    #
+    # @param  [String|Hash|NilClass] text_or_options
+    # @param  [Hash] opts
+    # @option opts [String] :id
+    # @option opts [String] :class
+    # @option opts [Hash]   :data
+    # @option opts [Hash]   :aria
+    # @return [String]
+    #
+    def link(text_or_options = nil, opts = {}, &block)
+      text, args  = parse_text_or_options(text_or_options, opts)
+      args[:data] = args.fetch(:data,  {}).merge!({ 'bs-toggle': 'offcanvas' })
+      args[:aria] = args.fetch(:aria,  {}).merge!({ 'controls': @id })
+
+      options = ["##{@id}", args]
+      options.prepend(text) if text.present?
+
+      @template.link_to(*options, &block)
+    end
+
+    # rubocop:disable Metrics/MethodLength
+
+    # Used to make a custom dom element for a trigger.  Use this when the
+    # trigger isnt a link or button.
+    #
+    # @param  [Symbol|Hash|NilClass] tag_or_options
+    # @param  [Hash] opts
+    # @option opts [String] :id
+    # @option opts [String] :class
+    # @option opts [Hash]   :data
+    # @option opts [Hash]   :aria
+    # @return [String]
+    #
+    def trigger(tag_or_options = nil, opts = {}, &block)
+      tag, args = parse_tag_or_options(tag_or_options, opts)
+
+      id    = args.fetch(:id,    nil)
+      klass = args.fetch(:class, '')
+      aria  = args.fetch(:aria,  {}).merge!({ 'controls': @id })
+      data  = args.fetch(:data,  {}).merge!(
+        'bs-toggle': 'offcanvas',
+        'bs-target': "##{@id}"
+      )
+
+      content_tag(
+        tag || config({ offcanvas: :trigger }, :div),
+        id:    id,
+        class: klass,
+        data:  data,
+        aria:  aria,
+        &block
+      )
+    end
+    # rubocop:enable Metrics/MethodLength
+
+    # Used to generate the main component.  This class serves as a wrapper, so
+    # that buttons and links have reference to the content component.
+    #
+    # @return [String]
+    #
+    def content(&block)
+      Content.new(
+        @template,
+        {
+          id:         @id,
+          class:      @class,
+          data:       @data,
+          aria:       @aria,
+          scrollable: @scrollable,
+          backdrop:   @backdrop,
+          position:   @pos
+        },
+        &block
+      )
+    end
+
+    # Renders the component as a String, but only to the output bugger.
+    #
+    # @return [NilClass]
+    #
+    def to_s
+      @content.call(self)
+
+      nil
+    end
+
+    private
+
+    # Because this options parser is only going to be used here, I figured
+    # we would just define it here.  That way other components don't have
+    # to inherit it.
+    #
+    # @return [Array]
+    #
+    def parse_position_or_options(*args)
+      parse_arguments(*args, 'start')
+    end
+  end
+end

data/lib/bootstrap5_helper/page_header.rb

@@ -0,0 +1,42 @@
+module Bootstrap5Helper
+  # Builds a simple CSS spinner component.
+  #
+  #
+  class PageHeader < Component
+    # Class constructor
+    #
+    # @param [ActionView] template
+    # @param [Symbol|Hash]    tag_or_options
+    # @param [Hash] opts
+    # @option opts [String]  :id
+    # @option opts [String]  :class
+    # @option opts [Hash]    :data
+    #
+    def initialize(template, tag_or_options = nil, opts = {}, &block)
+      super(template)
+
+      @tag, args = parse_tag_or_options(tag_or_options, opts)
+      @tag ||= config(:page_header, :h1)
+
+      @id      = args.fetch(:id,    uuid)
+      @class   = args.fetch(:class, '')
+      @data    = args.fetch(:data,  {})
+      @content = block || proc { '' }
+    end
+
+    # String representation of the object.
+    #
+    # @return [String]
+    #
+    def to_s
+      content_tag(
+        @tag,
+        id:    @id,
+        class: "pb-2 mt-4 mb-2 border-bottom #{@class}",
+        data:  @data
+      ) do
+        @content.call(self)
+      end
+    end
+  end
+end

data/lib/bootstrap5_helper/railtie.rb

@@ -0,0 +1,12 @@
+module Bootstrap5Helper
+  # Simple Railtie to hook out module into ActionView.
+  #
+  #
+  class Railtie < ::Rails::Railtie
+    config.after_initialize do
+      ActiveSupport.on_load(:action_view) do
+        include Bootstrap5Helper if Bootstrap5Helper.config.autoload_in_views?
+      end
+    end
+  end
+end

data/lib/bootstrap5_helper/spinner.rb

@@ -0,0 +1,44 @@
+module Bootstrap5Helper
+  # Builds a simple CSS spinner component.
+  #
+  #
+  class Spinner < Component
+    # Class constructor
+    #
+    # @note The different support types are: `:border` and `:grow`
+    #
+    # @param [ActionView] template
+    # @param [Hash] opts
+    # @option opts [Symbol]  :type
+    # @option opts [String]  :id
+    # @option opts [String]  :class
+    # @option opts [Hash]    :data
+    #
+    def initialize(template, opts = {}, &block)
+      super(template)
+
+      @type    = opts.fetch(:type, :border)
+      @id      = opts.fetch(:id,    uuid)
+      @class   = opts.fetch(:class, '')
+      @data    = opts.fetch(:data,  {})
+      @content = block || proc { '' }
+    end
+
+    # String representation of the object.
+    #
+    # @return [String]
+    #
+    def to_s
+      content_tag(
+        :span,
+        id:    @id,
+        class: "spinner-#{@type} #{@class}",
+        role:  'status',
+        aria:  { hidden: true },
+        data:  @data
+      ) do
+        content_tag :span, 'Loading', class: 'visually-hidden'
+      end
+    end
+  end
+end

data/lib/bootstrap5_helper/tab/content.rb

@@ -0,0 +1,58 @@
+module Bootstrap5Helper
+  class Tab
+    # Build a Content component to be used with Tabs
+    #
+    #
+    class Content < Component
+      # Class constructor
+      #
+      # @param [ActionView] template
+      # @param [Hash] opts
+      # @option opts [String]  :id
+      # @option opts [String]  :class
+      # @option opts [Hash]    :data
+      #
+      def initialize(template, opts = {}, &block)
+        super(template)
+
+        @id      = opts.fetch(:id,    uuid)
+        @class   = opts.fetch(:class, '')
+        @data    = opts.fetch(:data,  {})
+        @content = block || proc { '' }
+      end
+
+      # Builds the pane for the tab.
+      #
+      # @param [Symbol] source
+      # @param [Hash]   opts
+      # @option opts [String]  :class
+      # @option opts [Hash]    :data
+      # @return [String]
+      #
+      def pane(source, opts = {}, &block)
+        id    = opts.fetch(:id,    source)
+        klass = opts.fetch(:class, '')
+        data  = opts.fetch(:data,  {})
+
+        content_tag(
+          :div,
+          id:    id,
+          class: "tab-pane #{klass}",
+          role:  'tabpanel',
+          data:  data,
+          &block
+        )
+      end
+
+      # String representation of the object.
+      #
+      # @return [String]
+      #
+      def to_s
+        content_tag :div, id: @id, class: "tab-content #{@class}" do
+          @content.call(self)
+        end
+      end
+    end
+  end
+end

data/lib/bootstrap5_helper/tab.rb

@@ -0,0 +1,72 @@
+module Bootstrap5Helper
+  # Builds a Tab component.
+  #
+  #
+  class Tab < Component
+    # 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, type_or_options = nil, opts = {}, &block)
+      super(template)
+      @type, args = type_or_options(type_or_options, opts)
+
+      @id      = args.fetch(:id,    uuid)
+      @class   = args.fetch(:class, '')
+      @data    = args.fetch(:data,  {})
+      @content = block || proc { '' }
+    end
+
+    # Builds a custom Nav component for the tabs.
+    #
+    # @param  [Symbol|Hash] tag_or_options
+    # @param  [Hash] opts
+    # @option opts [String] :class
+    # @option opts [Hash]   :data
+    # @return [Nav]
+    #
+    def nav(tag_or_options = nil, opts = {}, &block)
+      tag, args = parse_tag_or_options(tag_or_options, opts)
+
+      args[:class] = (args[:class] || '') << " nav-#{@type}"
+      args[:data]  = (args[:data]  || {}).merge('bs-toggle' => 'tab')
+      args[:child] = { data: { 'bs-toggle' => 'tab' } }
+
+      Nav.new(@template, tag, args, &block)
+    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.new(@template, opts, &block)
+    end
+
+    # @note This has a weird interaction.  Because this object doesn't actually return any wrapping
+    #   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.
+    #
+    def to_s
+      @content.call(self)
+
+      nil
+    end
+
+    def type_or_options(*args)
+      parse_arguments(*args, :tabs)
+    end
+  end
+end

data/lib/bootstrap5_helper/toast.rb

@@ -0,0 +1,7 @@
+module Bootstrap5Helper
+  # Builds a Toast component.
+  #
+  #
+  class Toast < Component
+  end
+end

data/lib/bootstrap5_helper/version.rb

@@ -0,0 +1,3 @@
+module Bootstrap5Helper
+  VERSION = '1.0.0'.freeze
+end