card-mod-tabs 0.14.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fbab1a56eced219926dff1cb29690243bcb43e1443f313ad785e5e31c1233ed5
+  data.tar.gz: 91e2a11e56d5152a639a688005ce7db83448e4f1fb7cf4dc0621f98db21949f0
+SHA512:
+  metadata.gz: c18bf3d6456a8ef0395878881105b6c0a7c6e31fde66219712bdfbc006b59c32522c5425736339eaa2268a4cfca61d5e2f42f53407bcd65157dc18ba8d1f88be
+  data.tar.gz: 1aa5fe4827f8f8ef78060de52c42f498b5265fab04f74e2e15979aaffe495ccbae4098d254c5b1cb8b0716f12089cfdefdea89d267fe86ab9d090c8335c7e7cb

data/lib/card/lazy_tab.rb

@@ -0,0 +1,38 @@
+class Card
+  # lazy-loading tabs. Tab panel content doesn't load until tab is visited.
+  class LazyTab < Tab
+    def url
+      @url ||= (config_hash? && @config[:path]) || format.path(view: view)
+    end
+
+    def view
+      @view ||= (config_hash? && @config[:view]) || @config
+    end
+
+    def tab_button
+      if url
+        super
+      else
+        wrap_with(:li, label, role: "presentation")
+      end
+    end
+
+    def button_attrib
+      @button_attrib ||= super.merge("data-url" => url.html_safe)
+    end
+
+    def tab_button_link
+      add_class button_attrib, "load" unless active?
+      super
+    end
+
+    def content
+      @content ||= ""
+    end
+
+    def tab_pane args=nil, &block
+      @content = yield if active? && block_given?
+      super
+    end
+  end
+end

data/lib/card/tab.rb

@@ -0,0 +1,84 @@
+class Card
+  # tab object, handles tab configuration for view :tabs
+  class Tab
+    attr_reader :format, :name
+
+    class << self
+      def tab_objects format, tab_hash, active_name, klass=nil
+        klass ||= Card::Tab
+        active_name = active active_name, tab_hash.keys
+        tab_hash.map do |name, config|
+          klass.new format, name, active_name, config
+        end
+      end
+
+      private
+
+      def active requested, keys
+        r = requested.to_name
+        r && keys.find { |k| k.to_name == r } || keys.first
+      end
+    end
+
+    delegate :add_class, :wrap_with, :unique_id, :link_to, to: :format
+
+    def initialize format, name, active_name, config
+      @format = format
+      @name = name
+      @active_name = active_name
+      @config = config
+    end
+
+    def tab_button
+      add_class button_attrib, "active" if active?
+      wrap_with :li, tab_button_link,
+                role: :presentation,
+                class: "nav-item tab-li-#{name}"
+    end
+
+    def tab_pane args=nil
+      pane_attr = { role: :tabpanel, id: tab_id }
+      pane_attr.merge! args if args.present?
+      add_class pane_attr, "tab-pane tab-pane-#{name}"
+      add_class pane_attr, "active" if active?
+      wrap_with :div, content, pane_attr
+    end
+
+    def button_attrib
+      @button_attrib ||= (config_hash? && @config[:button_attr]) || {}
+    end
+
+    def content
+      @content ||= config_hash? ? @config[:content] : @config
+    end
+
+    def label
+      @label ||= (config_hash? && @config[:title]) || name
+    end
+
+    private
+
+    def config_hash?
+      @config.is_a? Hash
+    end
+
+    def tab_button_link
+      add_class button_attrib, "nav-link"
+
+      link_to label, button_attrib.merge(
+        path: "##{tab_id}",
+        role: "tab",
+        "data-toggle" => "tab",
+        "data-tab-name" => name
+      )
+    end
+
+    def tab_id
+      @tab_id ||= "#{unique_id}-#{name.to_name.safe_key}"
+    end
+
+    def active?
+      name == @active_name
+    end
+  end
+end

data/set/abstract/tabs.rb

@@ -0,0 +1,123 @@
+include_set Abstract::BsBadge
+
+format :html do
+  view :tabs, cache: :never do
+    tabs tab_map, default_tab, load: :lazy do
+      _render! "#{default_tab}_tab"
+    end
+  end
+
+  def tab_map
+    @tab_map ||= generate_tab_map
+  end
+
+  def generate_tab_map
+    options = tab_options
+    tab_list.each_with_object({}) do |codename, hash|
+      hash[codename] = {
+        view: "#{codename}_tab",
+        title: tab_title(codename, options[codename])
+      }
+    end
+  end
+
+  def tab_list
+    []
+  end
+
+  def tab_options
+    {}
+  end
+
+  def one_line_tab?
+    false
+  end
+
+  def default_tab
+    tab_from_params || tab_map.keys.first
+  end
+
+  def tab_from_params
+    return unless Env.params[:tab]
+    Env.params[:tab].to_sym
+  end
+
+  def tab_wrap
+    bs_layout do
+      row 12 do
+        col output(yield), class: "padding-top-10"
+      end
+    end
+  end
+
+  def tab_url tab
+    path tab: tab
+  end
+
+  def tab_title fieldcode, opts={}
+    opts ||= {}
+    parts = tab_title_parts fieldcode, opts
+    info = tab_title_info parts[:icon], parts[:count]
+    wrapped_tab_title parts[:label], info
+  end
+
+  def tab_title_info icon, count
+    if count
+      tab_count_badge count, icon
+    else
+      icon || tab_space
+    end
+  end
+
+  def tab_space
+    one_line_tab? ? :nil : " "
+  end
+
+  def tab_count_badge count, icon_tag
+    klass = nil
+    if count.is_a? Card
+      klass = css_classes count.safe_set_keys
+      count = count.try(:cached_count) || count.count
+    end
+    tab_badge count, icon_tag, klass: klass
+  end
+
+  def tab_title_parts fieldcode, opts
+    %i[count icon label].each_with_object({}) do |part, hash|
+      hash[part] = opts.key?(part) ? opts[part] : send("tab_title_#{part}", fieldcode)
+    end
+  end
+
+  def tab_title_count fieldcode
+    field_card = card.fetch fieldcode, new: {}
+    field_card if field_card.respond_to? :count
+  end
+
+  def tab_title_icon fieldcode
+    tab_icon_tag fieldcode
+  end
+
+  def tab_title_label fieldcode
+    fieldcode.cardname.vary :plural
+  end
+
+  def wrapped_tab_title label, info=nil
+    wrap_with :div, class: "tab-title text-center #{'one-line-tab' if one_line_tab?}" do
+      [wrapped_tab_title_info(info),
+       wrap_with(:span, label, class: "count-label")].compact
+    end
+  end
+
+  def wrapped_tab_title_info info
+    info ||= tab_space
+    return unless info
+
+    klass = css_classes "count-number", "clearfix"
+    wrap_with :span, info, class: klass
+  end
+
+  # TODO: handle mapped icon tagging in decko
+  def tab_icon_tag key
+    try :mapped_icon_tag, key
+  end
+end

data/set/all/tabs/tab_panel.haml

@@ -0,0 +1,7 @@
+.tabbable.tab-panel{ panel_attr.merge(role: "tabpanel") }
+  %ul{ class: "nav nav-#{tab_type}", role: "tablist" }
+    - tab_objects.each do |tab|
+      = tab.tab_button
+  .tab-content
+    - tab_objects.each do |tab|
+      = tab.send :tab_pane, pane_attr, &block

data/set/all/tabs.rb

@@ -0,0 +1,40 @@
+format :html do
+  # @param tab_hash [Hash] keys are the tab names
+  #   Each value can be either a String or a Hash.
+  #   If a Hash can contain the following keys:
+  #     :title - the label to appear in the clickable tab nav.
+  #        if title is not specified, the key is used
+  #     :content - body of tab pane
+  #     :button_attr - attributes for button link in tab nav.
+  #
+  #   If using lazy loading (see :load below), the following options also apply
+  #     :path - explicit path to use for tab pane
+  #     :view - card view from which to auto-construct path (if missing, uses key)
+  #
+  #   If the value is a String, it is treated as the tab content for static tabs and
+  #     the view for lazy tabs
+  #
+  # @param active_name [String] label of the tab that should be active at the
+  #
+  # @param [Hash] args options
+  # @option args [String] :tab_type ('tabs') use pills or tabs
+  # @option args [Hash] :panel_attr html args used for the panel div
+  # @option args [Hash] :pane_attr html args used for the pane div
+  # @option args [Hash] :load. `:lazy` for lazy-loading tabs
+  #
+  # @param [Block] block content of the active tab (for lazy-loading)
+  # beginning (default is the first)
+  #
+  # @return [HTML] bootstrap tabs element with all content preloaded
+  def tabs tab_hash, active_name=nil, args={}, &block
+    klass = args[:load] == :lazy ? Card::LazyTab : Card::Tab
+    args.reverse_merge!(
+      panel_attr: {},
+      pane_attr: {},
+      tab_type: "tabs",
+      block: block,
+      tab_objects: Card::Tab.tab_objects(self, tab_hash, active_name, klass)
+    )
+    haml :tab_panel, args
+  end
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: card-mod-tabs
+version: !ruby/object:Gem::Version
+  version: 0.14.0
+platform: ruby
+authors:
+- Ethan McCutchen
+- Philipp Kühl
+- Gerry Gleason
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-12-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: card
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.104.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.104.0
+- !ruby/object:Gem::Dependency
+  name: card-mod-bootstrap
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+description: ''
+email:
+- info@decko.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/card/lazy_tab.rb
+- lib/card/tab.rb
+- set/abstract/tabs.rb
+- set/all/tabs.rb
+- set/all/tabs/tab_panel.haml
+homepage: https://decko.org
+licenses:
+- GPL-3.0
+metadata:
+  source_code_uri: https://github.com/decko-commons/decko
+  homepage_uri: https://decko.org
+  bug_tracker_uri: https://github.com/decko-commons/decko/issues
+  wiki_uri: https://decko.org
+  documentation_url: http://docs.decko.org/
+  card-mod: tabs
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: tabs
+test_files: []