nfg_ui 0.9.8.17 → 0.9.8.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b85f443237f204368e6f3dd6fd5b749cc7f6a5ab17d10a7c508c6b4a81a12d6
-  data.tar.gz: d2cd103b34f4980a6cb1af31689e84a05d5ee9c1b10495c4549f2c786f17c4a3
+  metadata.gz: 0f540ed4257fe4de0037fc5de979e560d0b5625687de36ed13a43bf9ae2bfe01
+  data.tar.gz: e718cb003e1ffcdd1db29dcfa93515dc07099843b369c60c6ef89f5c366c30dd
 SHA512:
-  metadata.gz: 306eac19ce4097d139be9d8312425a9f6226b456e893ae746837472f3abb8ec002f0f00a571df3df779250097c2766f7b41c36bbf9618fa0f15d699b6cf10b17
-  data.tar.gz: 7b696ef0b1ff08185adf93a21c1cdaa8ea0ff51c9211dfe5419f7cc3597fd1252a6817ec3cd4874c88f9df383d0a1075a063a7c712f3e6fadd76fb2bad8b7cbe
+  metadata.gz: 2131c8f600c03eac815811d706e4be84be703f331ebab52d1727c8e7af55e969b0ba88c324ad3cdfa272f9c43b4e9f5c80b376537c211797ea94a32c79394063
+  data.tar.gz: 0a04d17b0116d9ab759ef03ff0452221e5171d5d291500b2adce2e64b37c9d5424ef9c39c86fdb9e8199986e48288570f1e7f098c48f2f5ad3e46f121a9ac9ed

data/app/assets/stylesheets/nfg_ui/network_for_good/admin/nfg_theme/custom/_slat.scss

@@ -24,14 +24,13 @@
       flex-grow: 2;
 
       // Sizing options
-      &.slat-item-sm { flex-grow: 0; }
+      &.slat-item-sm { flex-grow: 1; }
       &.slat-item-lg { flex-grow: 6; }
     }
   }
 }
 
 
-
 // Action Column
 .slat-actions {
   padding-left: ($grid-gutter-width * .5);

data/app/assets/stylesheets/nfg_ui/network_for_good/public/legacy_browser_support/nfg_theme/custom/_slat.scss

@@ -21,7 +21,7 @@
       -ms-flex-positive: 2;
 
       // Sizing options
-      &.slat-item-sm { -ms-flex-positive: 0; }
+      &.slat-item-sm { -ms-flex-positive: 1; }
       &.slat-item-lg { -ms-flex-positive: 6; }
     }
   }

data/app/assets/stylesheets/nfg_ui/network_for_good/public/nfg_theme/custom/_slat.scss

@@ -24,7 +24,7 @@
       flex-grow: 2;
 
       // Sizing options
-      &.slat-item-sm { flex-grow: 0; }
+      &.slat-item-sm { flex-grow: 1; }
       &.slat-item-lg { flex-grow: 6; }
     }
   }

data/lib/nfg_ui/bootstrap/components/base.rb

@@ -54,7 +54,7 @@ module NfgUi
         end
 
         def html_options
-          options.except(*non_html_attribute_options)
+          options.except(*non_html_attribute_options.uniq)
                  .merge!(id: id,
                          class: css_classes,
                          data: data,
@@ -122,7 +122,7 @@ module NfgUi
         # adding a new string of css classes to this method
         # ex: super.push('new-class')
         def css_classes
-          @css_classes ||= [component_css_class, options[:class]].join(' ').squish
+          @css_classes ||= [component_css_class, options[:class]].reject(&:nil?).uniq.join(' ').squish
         end
 
         def defaults

data/lib/nfg_ui/components/patterns/slat_actions.rb

@@ -5,63 +5,48 @@ module NfgUi
     module Patterns
       # Slat doc coming soon
       class SlatActions < NfgUi::Components::Base
-        include NfgUi::Components::Utilities::Iconable
-
-        include NfgUi::Components::Traits::Theme
+        # Includes a workaround suite of functionality
+        # to integrate a singular SlatAction automatically when
+        # The SlatActions component is rendered when the `:menu` option is set to false.
+        #
+        # When menu is set to false:
+        # You can then pass in SlatAction options in the parent SlatAction
+        #
+        # Example usage:
+        # ui.nfg(:slat_actions, menu: false, theme: :parent, body: 'My Custom Slat Action')
+        # require 'nfg_ui/components/utilities/patches/integrated_slat_action'
+        include NfgUi::Components::Utilities::Patches::IntegratedSlatAction
 
         def component_family
           :slats
         end
 
+        # Signals whether or not this SlatActions will house a menu
+        # This is a critical condition.
+        # When false, a SlatAction is automatically integrated on your behalf.
         def menu
           options.fetch(:menu, true)
         end
 
-        def confirm
-          options.fetch(:confirm, nil)
-        end
-
-        def method
-          return if delete_link?
-          options.fetch(:method, nil)
-        end
-
-        def delete_link?
-          @delete_link ||= options.fetch(:method, nil) == :delete
-        end
-
+        # Signal if this slat_action is being used
+        # In the slat_header area of the Slats
+        #
+        # If so, this then customizes the output of the
+        # SlatActions to ensure that the widths of the slat_header columns
+        # is accurate and matches the width of the slats below.
         def slat_header
           options.fetch(:slat_header, false)
         end
 
+        # Signals if this is a wide SlatActions.
+        # This is a stylistic update which is used in situations like shopping carts where
+        # you may only be providing a summary and have no actions or extra columns.
+        #
+        # Note: Further documentation is needed on this
         def wide
           options.fetch(:wide, true)
         end
 
-        def disable_with
-          options.fetch(:disable_with, nil)
-        end
-
-        def remote
-          options.fetch(:remote, nil)
-        end
-
-        def action_link_html_options
-          { href: href,
-            class: [
-                     (theme ? "text-#{theme}" : ''),
-                     'd-block'
-                   ].join(' ').squish,
-            method: send(:method),
-            remote: remote,
-            data: { disable_with: disable_with,
-                    confirm: confirm }.merge(delete_link? ? { method: :delete } : {}) }
-        end
-
-        def theme
-          options.fetch(:theme, nil)
-        end
-
         def render
           content_tag(:div, html_options) do
             if menu
@@ -70,7 +55,7 @@ module NfgUi
               else
                 NfgUi::Components::Patterns::Dropdown.new({ }, view_context).render do
                   capture do
-                    concat(NfgUi::Components::Elements::DropdownToggle.new({ traits: [:outlined, :secondary], body: ('Actions' if wide)}, view_context).render)
+                    concat(NfgUi::Components::Elements::DropdownToggle.new({ **default_dropdown_toggle_options, body: ('Actions' if wide)}, view_context).render)
                     concat(NfgUi::Components::Patterns::DropdownMenu.new({ traits: [:right] }, view_context).render {
                       (block_given? ? yield : body)
                     })
@@ -78,27 +63,19 @@ module NfgUi
                 end
               end
             else
-              if href.present?
-                content_tag(:a, href: href, **action_link_html_options) do
-                  if icon
-                    NfgUi::Components::Foundations::Icon.new({ traits: [icon], text: (block_given? ? yield : body), theme: theme }, view_context).render
-                  else
-                    (block_given? ? yield : body)
-                  end
-                end
-              else
-                if icon
-                  NfgUi::Components::Foundations::Icon.new({ traits: [icon], text: (block_given? ? yield : body), theme: theme }, view_context).render
-                else
-                  (block_given? ? yield : body)
-                end
-              end
+              # Render the integrated slat action and pass in all of the
+              # related slat action options that are present in this SlatActions `:options`
+              render_integrated_slat_action
             end
           end
         end
 
         private
 
+        def default_dropdown_toggle_options
+          { outlined: true, theme: :secondary }
+        end
+
         def css_classes
           [
             super,
@@ -107,7 +84,7 @@ module NfgUi
         end
 
         def non_html_attribute_options
-          super.push(:slat_header, :wide, :menu, :theme, :method, :remote, :confirm, :disable_with)
+          super.push(:slat_header, :wide, :menu)
         end
       end
     end

data/lib/nfg_ui/components/traits/theme.rb

@@ -5,17 +5,20 @@ module NfgUi
     module Traits
       # Access to pre-designed theme traits
       module Theme
-        # TODO: Figure out how to get NfgUi::BOOTSTRAP_THEMES to be recognized for TRAITS
-        TRAITS = %i[primary
-                    secondary
-                    success
-                    danger
-                    warning
-                    info
-                    light
-                    dark
-                    white
-                    outlined].freeze
+        COLOR_TRAITS = %i[primary
+                          secondary
+                          success
+                          danger
+                          warning
+                          info
+                          light
+                          dark
+                          white]
+
+        TRAITS = [*COLOR_TRAITS,
+                  :outlined].freeze
+
+
 
         def primary_trait
           options[:theme] = :primary

data/lib/nfg_ui/components/utilities/patches/integrated_slat_action.rb

@@ -0,0 +1,215 @@
+# frozen_string_literal: true
+
+# This module should be removed upon re-evaluation of Slat components.
+module NfgUi
+  module Components
+    module Utilities
+      module Patches
+        # Terminology:
+        # SlatAction  - is the equivalent of a dropdown menu item
+        # SlatActions - is the parent / wrapping component of the SlatAction(s)
+        #
+        # and... Integrated Slat Action essentially replaces a dropdown toggle & dropdown menu with either a text link or a button component.
+        #
+        # Usage: When you are creating a slat that does not need a menu but has a singular action link
+        # For example: when the only option you have on a slat is to delete that item.
+        #
+        # This module allows you to pass in options that will
+        # automatically generate a slat action for you
+        # ... without having to manually add a slat_action to your code.
+        #
+        # Example usage:
+        # = ui.nfg :slat_actions, menu: false, icon: 'trash', body: 'Delete', href: '#nogo'
+        #
+        # The above will automatically generate a slat action so you
+        # do not need to add a slat action in the slat_actions (note: plural slat_actions)
+        #
+        # This is a monkeypatch while we re-evaluate the Slat component suite
+        # so as not to break existing code implementation on our apps.
+        module IntegratedSlatAction
+          # Allows for icons to be passed into the integrated slat action component
+          include NfgUi::Components::Utilities::Iconable
+
+          # Allows for using theme traits on the slat action component
+          # that is then passed through to the integrated slat action.
+          include NfgUi::Components::Traits::Theme
+
+          # This sets whether or not the SlatAction is a button.
+          # If it's not a button, the integrated slat action
+          # is rendered via a content_tag as a normal link.
+          #
+          # If it is a button, the integrated slat action
+          # is rendered as a button component
+          # (NfgUi::Components::Elements::Button)
+          def button
+            options.fetch(:button, false)
+          end
+
+          # Passes in the rails confirm option to the slat action component.
+          # Rails example: link_to 'Delete', ..., confirm: 'Are you sure?'
+          def confirm
+            options.fetch(:confirm, nil)
+          end
+
+          # Passes the :disable_with option, when present, to the
+          # integrated slat action component -- this adds the rails disable_with
+          # Rails example: link_to 'Delete', ..., disable_with: 'Deleting...'
+          def disable_with
+            options.fetch(:disable_with, nil)
+          end
+
+          # Sets a fallback for href so that
+          # integrated action items are still
+          # correctly styled
+          def href
+            options[:href] || '#'
+          end
+
+          # Passes in the rails confirm option to the slat action component.
+          # Rails example: link_to 'Update', ..., method: :patch
+          def method
+            options.fetch(:method, nil)
+          end
+
+          # Allow for outline settings to be added
+          # Assumes true if `button: true` per design system
+          # style guide expectations.
+          def outlined
+            options[:outlined] || button
+          end
+
+          # Passes in the rails :remote option to the slat action component
+          # Rails example: link_to 'Get Started', remote: true
+          def remote
+            options.fetch(:remote, nil)
+          end
+
+          def render_integrated_slat_action
+            button ? render_button : render_link
+          end
+
+          # Passes the standard `:theme` option to the integrated Slat Action
+          #
+          # When the slat action component is a `button` (`button: true`):
+          # The integrated slat action will default to the `:secondary` theme
+          # per the design system style guide.
+          #
+          # The default `:secondary` theme can be manually overridden by passing in a
+          # `:theme` trait or `:theme` option to the parent SlatActions component.
+          def theme
+            # Note: this needs to be solved / addressed
+            # For whatever reason, the traits are not being picked up by the
+            # button version of the slat action.
+            # This ensures that any theme traits get applied here.
+            # calculated_theme = (traits & NfgUi::Components::Traits::Theme::COLOR_TRAITS)
+
+            # calculated_theme.any? ? calculated_theme.first : options[:theme]
+            # raise options.inspect
+            # options[:theme]
+            # options.fetch(:theme, super)
+            options.fetch(:theme, nil)
+          end
+
+          private
+
+          # Supplies the SlatActions with
+          # the appropriate css classes for the action link
+          # when the SlatActions is used to bypass writing a manual slat action component
+          # This is complicated, and thus...
+          # This is why we are creating a patching module -- so that we can later rip this stuff out.
+          def integrated_slat_action_link_css_classes
+            [
+              ("text-#{theme}" if theme),
+              'd-block'
+            ].join(' ').squish
+          end
+
+          # Determines if the slat action component is a delete link
+          # Evaluated by examining the :method option
+          #
+          # This is used to determine where to inject the `delete` HTML data attribute (data-method)
+          # and value ('delete') in the integrated slat action's HTML options
+          def delete_link?
+            @delete_link ||= options.fetch(:method, nil) == :delete
+          end
+
+          # When the slat action component is a button component,
+          # These are the compiled options that are passed
+          # through from the SlatActions options into the integrated button's options.
+          #
+          # This also acts as a filter against what is allowed to pass
+          # and what is not allowed to pass into the
+          # integrated component.
+          def integrated_slat_action_button_component_options
+            # Do not set theme to nil (so theme defaults will run)
+            # Instead, do not pass in a theme at all.
+            # theme_options_hash = theme ? { theme: theme } : {}
+
+            { theme: (theme || :secondary),
+              # **theme_options_hash,
+              traits: traits,
+              as: :a,
+              confirm: confirm,
+              disable_with: disable_with,
+              href: href,
+              method: send(:method),
+              remote: remote,
+              outlined: outlined,
+              icon: icon }
+          end
+
+          # Given the complexity of the data-attributes,
+          # this isolates them into their own method for ease
+          # of following what's going on.
+          #
+          # Essentially, since the :delete method is actually
+          # converted to a data-attribute in rails, we
+          # have to manually merge the `data-method='delete'` into the data attributes hash
+          #
+          # This brings the whole data-attributes suite together
+          # and optionally merges in the data-method='delete' if
+          # this is a delete button/link.
+          def integrated_slat_action_html_data_attributes
+            mergable_delete_link = delete_link? ? { method: :delete } : {}
+
+            { disable_with: disable_with,
+              confirm: confirm }.merge(mergable_delete_link)
+          end
+
+          # The HTML options that are passed into the manually created slat action component
+          # For instances where you are bypassing the manual slat action component by leveraging the
+          def integrated_slat_action_html_options
+          { href: href,
+            class: integrated_slat_action_link_css_classes,
+            method: send(:method),
+            remote: remote,
+            data: integrated_slat_action_html_data_attributes }
+          end
+
+          # These options are removed from attributes because
+          # they are picked up and placed on the *SlatActions*
+          # and not on the integrated *slat action component*
+          def non_html_attribute_options
+            super.push(:button, :confirm, :disable_with, :href, :method, :remote, :theme)
+          end
+
+          # When `:button` is `true`, this is what is rendered
+          def render_button
+            NfgUi::Components::Elements::Button.new({ **integrated_slat_action_button_component_options, body: (block_given? ? yield : body) }, view_context).render
+          end
+
+          # When `:button` is `false`, a link is rendered
+          def render_link
+            content_tag(:a, **integrated_slat_action_html_options) do
+              if icon
+                NfgUi::Components::Foundations::Icon.new({ traits: [icon], text: (block_given? ? yield : body), theme: theme }, view_context).render
+              else
+                (block_given? ? yield : body)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/nfg_ui/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module NfgUi
-  VERSION = '0.9.8.17'
+  VERSION = '0.9.8.18'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nfg_ui
 version: !ruby/object:Gem::Version
-  version: 0.9.8.17
+  version: 0.9.8.18
 platform: ruby
 authors:
 - Jonathan Roehm
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-28 00:00:00.000000000 Z
+date: 2019-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bootstrap
@@ -53,20 +53,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.7'
-- !ruby/object:Gem::Dependency
-  name: haml
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: inky-rb
   requirement: !ruby/object:Gem::Requirement
@@ -702,6 +688,7 @@ files:
 - lib/nfg_ui/components/utilities/iconable.rb
 - lib/nfg_ui/components/utilities/left_iconable.rb
 - lib/nfg_ui/components/utilities/methodable.rb
+- lib/nfg_ui/components/utilities/patches/integrated_slat_action.rb
 - lib/nfg_ui/components/utilities/renderable.rb
 - lib/nfg_ui/components/utilities/resource_themeable.rb
 - lib/nfg_ui/components/utilities/titleable.rb