playbook_ui 13.18.0.pre.alpha.play1141iconkitusinglibrary2210 → 13.18.0.pre.alpha.thor93bargraphoptions2211

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 678dcc3bb0c0838d369b7a2ff9415d8446cc40e2d1fa15c9ba95c85f266317c0
-  data.tar.gz: ca825e466b46de23eb9eef86ad9b43f50c7243654e7bcc696fd1a4941916d405
+  metadata.gz: ceb325111d4662aa6a0491153e357222b4f304d21c247fcc44a3db3aafda347a
+  data.tar.gz: 693e1c50633b9b8f309cd2c21ffaa457adbf54ed8a3bd3dfa965b9852c3f6ca6
 SHA512:
-  metadata.gz: 426ae3a6e11f5bb0cf0f8fa80cbddd703cc3e707ff22d2665644ee4d4e164e728da2ee3616425ea5e2672d73f9d8d5cfdc0c339fa207e71f9dc88ac957ae11af
-  data.tar.gz: a4d764a8f2f14a37eca3baf54c35f4bce8bc3f65baa340e0d57263c308f6452c7144d8279e53fe7a7edf8618af3d267a2a1022fbcc6cdacf45fc58a6224a0a17
+  metadata.gz: 64ae9216199a92f0559d7b524f6165f93698366b2d01e05669293b5a0fb974294148caf6415e97bcff6f8a09b1d2931cdc17cd28f2fc3b421be1532962061b97
+  data.tar.gz: 8134787717615c18836ec47718dae3518c79500d1786b9076618a71d8f0e5605706bc355aa9398c8dea710c3604828d93aeb680f0c7a17f4a19aab9510dc00c8

data/app/pb_kits/playbook/pb_bar_graph/_bar_graph.tsx

@@ -19,6 +19,7 @@ type BarGraphProps = {
   yAxisMax: number;
   chartData: { name: string; data: number[] }[];
   className?: string;
+  customOptions?: Partial<Highcharts.Options>;
   id: string;
   pointStart: number;
   htmlOptions?: {[key: string]: string | number | boolean | (() => void)},
@@ -48,6 +49,7 @@ const BarGraph = ({
   className = "pb_bar_graph",
   colors,
   htmlOptions = {},
+  customOptions = {},
   id,
   pointStart,
   subTitle,
@@ -128,7 +130,7 @@ const BarGraph = ({
   const [options, setOptions] = useState({});
 
   useEffect(() => {
-    setOptions({ ...staticOptions });
+    setOptions({ ...staticOptions, ...customOptions });
   }, [chartData]);
 
   return (

data/app/pb_kits/playbook/pb_icon/_icon.tsx

@@ -1,4 +1,4 @@
-import React, { ReactSVGElement } from 'react'
+import React from 'react'
 import classnames from 'classnames'
 import { buildAriaProps, buildDataProps, buildHtmlProps } from '../utilities/props'
 import { GlobalProps, globalProps } from '../utilities/globalProps'
@@ -27,7 +27,7 @@ type IconProps = {
   data?: {[key: string]: string},
   fixedWidth?: boolean,
   flip?: "horizontal" | "vertical" | "both" | "none",
-  icon: string | ReactSVGElement,
+  icon: string,
   htmlOptions?: {[key: string]: string | number | boolean | (() => void)},
   id?: string,
   inverse?: boolean,
@@ -47,11 +47,6 @@ const flipMap = {
   none: ""
 }
 
-declare global {
-  // eslint-disable-next-line no-var
-  var PB_ICONS: {[key: string]: React.FunctionComponent<any>}
-}
-
 const Icon = (props: IconProps) => {
   const {
     aria = {},
@@ -62,7 +57,7 @@ const Icon = (props: IconProps) => {
     fixedWidth = true,
     flip = "none",
     htmlOptions = {},
-    icon = "",
+    icon,
     id,
     inverse = false,
     listItem = false,
@@ -74,8 +69,6 @@ const Icon = (props: IconProps) => {
     spin = false,
   } = props
 
-  let iconElement: ReactSVGElement | null = typeof(icon) === "object" ? icon : null
-
   const faClasses = {
     'fa-border': border,
     'fa-fw': fixedWidth,
@@ -86,23 +79,19 @@ const Icon = (props: IconProps) => {
     [`fa-${size}`]: size,
     [`fa-pull-${pull}`]: pull,
     [`fa-rotate-${rotation}`]: rotation,
-  }
-
-  if (!customIcon && !iconElement) {
-    const PowerIcon: React.FunctionComponent<any> | undefined =
-      window.PB_ICONS ? window.PB_ICONS[icon as string] : null
 
-    if (PowerIcon) {
-      iconElement = <PowerIcon /> as ReactSVGElement
-    } else {
-      faClasses[`fa-${icon}`] = icon as string
-    }
   }
 
+  // Lets check and see if the icon prop is referring to a custom Power icon...
+  // If so, then set fa-icon to "custom"
+  // this ensures the JS will not do any further operations
+  // faClasses[`fa-${icon}`] = customIcon ? 'custom' : icon
+  if (!customIcon) faClasses[`fa-${icon}`] = icon
+  
   const classes = classnames(
     flipMap[flip],
-    (!iconElement && !customIcon) ? 'pb_icon_kit' : '',
-    (iconElement || customIcon) ? 'pb_custom_icon' : fontStyle,
+    'pb_icon_kit',
+    customIcon ? '' : fontStyle,
     faClasses,
     globalProps(props),
     className
@@ -121,22 +110,20 @@ const Icon = (props: IconProps) => {
 
   // Add a conditional here to show only the SVG if custom
   const displaySVG = (customIcon: any) => {
-    if (iconElement || customIcon)
+    if (customIcon)
       return (
         <>
           {
-            React.cloneElement(iconElement || customIcon, {
+            React.cloneElement(customIcon, {
               ...dataProps,
               ...htmlProps,
               className: classes,
               id,
-              width: 'auto',
-              height: 'auto',
             })
           }
         </>
       )
-    else if (isValidEmoji(icon as string))
+    else if (isValidEmoji(icon))
       return (
         <>
           <span
@@ -149,6 +136,7 @@ const Icon = (props: IconProps) => {
           </span>
         </>
       )
+
     else
       return (
         <>
@@ -173,4 +161,4 @@ const Icon = (props: IconProps) => {
   )
 }
 
-export default Icon
+export default Icon

data/app/pb_kits/playbook/pb_icon/docs/_icon_custom.html.erb

@@ -2,9 +2,15 @@
 <div class="icon-wrapper">
 
   <% svg_url = "https://upload.wikimedia.org/wikipedia/commons/3/3b/Wrench_font_awesome.svg" %>
-  <p><%= pb_rails("icon", props: { icon: svg_url } ) %></p>
-  <p><%= pb_rails("icon", props: { rotation: 90, icon: svg_url, size: "2x" } ) %></p>
-  <p><%= pb_rails("icon", props: { spin: true, icon: svg_url, size: "3x" } ) %></p>
-  <p><%= pb_rails("icon", props: { size: "5x", icon: svg_url } ) %></p>
-  <p><%= pb_rails("icon", props: { flip: "horizontal", size: "5x", icon: svg_url } ) %></p>
+  <p><%= pb_rails("icon", props: { custom_icon: svg_url } ) %></p>
+  <p><%= pb_rails("icon", props: { rotation: 90, custom_icon: svg_url, size: "2x" } ) %></p>
+  <p><%= pb_rails("icon", props: { spin: true, custom_icon: svg_url, size: "3x" } ) %></p>
+  <p><%= pb_rails("icon", props: { size: "5x", custom_icon: svg_url } ) %></p>
+  <p><%= pb_rails("icon", props: { flip: "horizontal", size: "5x", custom_icon: svg_url } ) %></p>
+
+  <%= pb_rails("body", props: {
+    text: "Custom icons are compatible with other icon props (size, rotation,
+    spin, flip, etc). Their SVG fill colors will be inherited from
+    parent element's css color properties."
+  } ) %>
 </div>

data/app/pb_kits/playbook/pb_icon/docs/_icon_custom.jsx

@@ -1,59 +1,33 @@
 import React from 'react'
 import { Icon } from '../../'
 
+// import Icons as config from 'power-icons'
 const config = {
-  icon: (
-    <svg viewBox="0 -256 1792 1792"
+  moon: (
+    <svg
+        ariaHidden="true"
+        focusable="false"
+        role="img"
+        viewBox="0 0 512 512"
         xmlns="http://www.w3.org/2000/svg"
     >
-      <g transform="matrix(1,0,0,-1,53.152542,1217.0847)">
-          <path d="m 384,64 q 0,26 -19,45 -19,19 -45,19 -26,0 -45,-19 -19,-19 -19,-45 0,-26 19,-45 19,-19 45,-19 26,0 45,19 19,19 19,45 z m 644,420 -682,-682 q -37,-37 -90,-37 -52,0 -91,37 L 59,-90 Q 21,-54 21,0 21,53 59,91 L 740,772 Q 779,674 854.5,598.5 930,523 1028,484 z m 634,435 q 0,-39 -23,-106 Q 1592,679 1474.5,595.5 1357,512 1216,512 1031,512 899.5,643.5 768,775 768,960 q 0,185 131.5,316.5 131.5,131.5 316.5,131.5 58,0 121.5,-16.5 63.5,-16.5 107.5,-46.5 16,-11 16,-28 0,-17 -16,-28 L 1152,1120 V 896 l 193,-107 q 5,3 79,48.5 74,45.5 135.5,81 61.5,35.5 70.5,35.5 15,0 23.5,-10 8.5,-10 8.5,-25 z" />
-      </g>
+      <path
+          d="M448 0H64C28.7 0 0 28.7 0 64v288c0 35.3 28.7 64 64 64h96v84c0 7.1 5.8 12 12 12 2.4 0 4.9-.7 7.1-2.4L304 416h144c35.3 0 64-28.7 64-64V64c0-35.3-28.7-64-64-64zm16 352c0 8.8-7.2 16-16 16H288l-12.8 9.6L208 428v-60H64c-8.8 0-16-7.2-16-16V64c0-8.8 7.2-16 16-16h384c8.8 0 16 7.2 16 16v288zM336 184h-56v-56c0-8.8-7.2-16-16-16h-16c-8.8 0-16 7.2-16 16v56h-56c-8.8 0-16 7.2-16 16v16c0 8.8 7.2 16 16 16h56v56c0 8.8 7.2 16 16 16h16c8.8 0 16-7.2 16-16v-56h56c8.8 0 16-7.2 16-16v-16c0-8.8-7.2-16-16-16z"
+          fill="currentColor"
+      />
     </svg>
   ),
 }
 
 const IconCustom = (props) => {
   return (
-    <React.Fragment>
-      <p>
-        <Icon
-            icon={config.icon}
-            {...props}
-        />
-      </p>
-      <p>
-        <Icon
-            icon={config.icon}
-            rotation={90}
-            size="2x"
-            {...props}
-        />
-      </p>
-      <p>
-        <Icon
-            icon={config.icon}
-            size="3x"
-            spin
-            {...props}
-        />
-      </p>
-      <p>
-        <Icon
-            icon={config.icon}
-            size="5x"
-            {...props}
-        />
-      </p>
-      <p>
-        <Icon
-            flip="horizontal"
-            icon={config.icon}
-            size="5x"
-            {...props}
-        />
-      </p>
-    </React.Fragment>
+    <div>
+      <Icon
+          customIcon={config.moon}
+          size="7x"
+          {...props}
+      />
+    </div>
   )
 }
 

data/app/pb_kits/playbook/pb_icon/docs/_icon_custom.md

@@ -4,12 +4,16 @@ When using custom icons it is important to introduce a "clean" SVG. In order to
 
 Attributes must be React compatible e.g. <code>xmlns:xlink</code> should be <code>xmlnsXlink</code> and so on. <strong>There should be no hyphenated attributes and no semi-colons!.</strong>
 
-Fill colors with regards to <code>g</code> or <code>path</code> nodes, e.g. <code>fill="black"</code>, should be replaced with <code>currentColor</code> ala <code>fill="currentColor"</code>. Your mileage may vary depending on the complexity of your SVG.
+Fill colors with regards to <code>g</code> or <code>path</code> nodes, e.g. <code>fill="black"</code>, should be replaced with   <code>currentColor</code> ala <code>fill="currentColor"</code>. Your mileage may vary depending on the complexity of your SVG.
 
-Pay attention to your custom icon's dimensions and `viewBox` attribute. It is best to use a `viewBox="0 0 512 512"` starting point **when designing instead of trying to retrofit the viewbox afterwards**!
+Pay attention to your custom icon's dimensions and `viewBox` attribute. It is best to use a `viewBox="0 0 512 512"` starting point __when designing instead of trying to retrofit the viewbox afterwards__!
 
-You must source _your own SVG into component/view_ you are working on. This can easily be done in programmatic and maintainable ways.
+You must source *your own SVG into component/view* you are working on. This can easily be done in programmatic and maintainable ways.
+
+### React
+
+So long as you have a valid React `<SVG>` node, you can send it as the `customIcon` prop and the kit will take care of the rest.
 
 ### Rails
 
-Sending the absolute path to the `icon` prop results in an `<SVG>` tag within the working view.
+Some Rails applications use only webpack(er) which means using `image_url` will be successful over `image_path` in most cases especially development where Webpack Dev Server is serving assets over HTTP. Rails applications still using Asset Pipeline may use `image_path` or `image_url`. Of course, YMMV depending on any custom configurations in your Rails application.

data/app/pb_kits/playbook/pb_icon/icon.html.erb

@@ -1,9 +1,7 @@
-<% if object.is_svg? %>
-  <%= object.render_svg %>
-<% elsif object.valid_emoji? %>
-  <span class="pb_icon_kit_emoji">
-    <%= object.icon.html_safe %>
-  </span>
+<% if object.custom_icon %>
+  <%= object.render_svg(object.custom_icon) %>
+<% elsif object.valid_emoji(object.icon) %>
+  <span class="pb_icon_kit_emoji"><%= object.icon.html_safe %></span>
 <% else %>
   <%= content_tag(:i, nil,
       id: object.id,

data/app/pb_kits/playbook/pb_icon/icon.rb

@@ -38,7 +38,7 @@ module Playbook
       prop :spin, type: Playbook::Props::Boolean,
                   default: false
 
-      def valid_emoji?
+      def valid_emoji(icon)
         emoji_regex = /\p{Emoji}/
         emoji_regex.match?(icon)
       end
@@ -79,33 +79,19 @@ module Playbook
         )
       end
 
-      def asset_path
-        return unless Rails.application.config.respond_to?(:icon_path)
-        return unless Dir.entries(Rails.application.config.icon_path).include? "#{icon}.svg"
-
-        Rails.root.join(Rails.application.config.icon_path, "#{icon}.svg")
-      end
-
-      def render_svg
-        doc = Nokogiri::XML(URI.open(asset_path || icon || custom_icon)) # rubocop:disable Security/Open
-        svg = doc.at_css "svg"
-        svg["class"] = "pb_custom_icon " + object.custom_icon_classname
-        svg["height"] = "auto"
-        svg["width"] = "auto"
-        doc.at_css("path")["fill"] = "currentColor"
-        raw doc
-      end
-
-      def is_svg?
-        (icon || custom_icon.to_s).include?(".svg") || asset_path.present?
+      def render_svg(path)
+        if File.extname(path) == ".svg"
+          doc = Nokogiri::XML(URI.open(path)) # rubocop:disable Security/Open
+          svg = doc.at_css "svg"
+          svg["class"] = "pb_custom_icon " + object.custom_icon_classname
+          raw doc
+        else
+          raise("Custom icon must be an svg. Please check your path and file type.")
+        end
       end
 
     private
 
-      def svg_size
-        size.nil? ? "1x" : size
-      end
-
       def border_class
         border ? "fa-border" : nil
       end