playbook_ui 13.23.0 → 13.24.0.pre.alpha.PBNTR261NewKitDropdown2681

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 452a03b346d2fe5cd79019537fb3bc6ac4bfbdaa621b3e552d898bdaaf1e7c00
-  data.tar.gz: fd5127e3deb4e55449b11d1d989335e3b48cfda1d0064b353d615749eef417c6
+  metadata.gz: e7befd6847de7d677af4be77be96824572a5fc0cb5a643ea35570064fe156ccb
+  data.tar.gz: 67dea2e25b7861d71730c3ad905df0316806517c70f663077e506bdee9be471f
 SHA512:
-  metadata.gz: 48edcdfd01a13c5082b670efa0a5d689cd3e3793ce9adacb1789f047bc1514f8f428194d2ea43e1e9bdef4b11d62a496a0b064d6009fed455287ca770ddb81fa
-  data.tar.gz: 37f2323fd3f2a3b4ea76822e139a9bc2c627f7c3bc6817f1f6092c7d9ea9159db7c9916bd0737baab951f7b4aeae28f17dfe5025282ad678898b5eb40bf05ffb
+  metadata.gz: 18d436e20297a673fbcaa699ce41a884d43859dd76482409ffb822b1dc803ceda9b78045642ccea169fd63645b73948e96d52343f76098ac8847415f57344e59
+  data.tar.gz: 16b5c21300347386fc574a61fa56a46c5b3e25c38bfb3f48f9b42ddc411b4f5a5d2c9121adbaa5e69384e189dcf24c896dcdf4892d41ff0078e3eea445f7edbb

data/app/pb_kits/playbook/_playbook.scss

@@ -1,5 +1,6 @@
 
 
+
 @import 'pb_advanced_table/advanced_table';
 @import 'pb_avatar/avatar';
 @import 'pb_avatar_action_button/avatar_action_button';
@@ -30,6 +31,7 @@
 @import 'pb_detail/detail';
 @import 'pb_dialog/dialog';
 @import 'pb_distribution_bar/distribution_bar';
+@import 'pb_dropdown/dropdown';
 @import 'pb_file_upload/file_upload';
 @import 'pb_filter/filter';
 @import 'pb_fixed_confirmation_toast/fixed_confirmation_toast';

data/app/pb_kits/playbook/index.js

@@ -35,6 +35,7 @@ export { default as DateYearStacked } from './pb_date_year_stacked/_date_year_st
 export { default as Detail} from './pb_detail/_detail'
 export { default as Dialog } from './pb_dialog/_dialog'
 export { default as DistributionBar } from './pb_distribution_bar/_distribution_bar'
+export { default as Dropdown} from './pb_dropdown/_dropdown'
 export { default as FileUpload } from './pb_file_upload/_file_upload'
 export { default as Filter } from './pb_filter/_filter'
 export { default as FixedConfirmationToast } from './pb_fixed_confirmation_toast/_fixed_confirmation_toast'

data/app/pb_kits/playbook/pb_avatar/avatar.html.erb

@@ -1,9 +1,4 @@
-<%= content_tag(:div,
-    id: object.id,
-    data: object.data.merge(initials: object.initials),
-    class: object.classname,
-    aria: object.aria,
-    **combined_html_options) do %>
+<%= object.pb_content_tag(:div, data: object.data.merge(initials: object.initials)) do %>
   <%= content_tag(:div, data: { initials: object.initials }, class: "avatar_wrapper") do %>
     <%= pb_rails("image", props: { alt: object.alt_text, url: object.image_url, on_error: object.handle_img_error }) if object.image_url.present? %>
   <% end %>

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

@@ -13,12 +13,12 @@ import classnames from "classnames";
 
 type BarGraphProps = {
   align?: "left" | "right" | "center";
-  axisTitle: string;
+  axisTitle: { name: string; }[] | string;
   dark?: boolean;
   xAxisCategories: [];
   yAxisMin: number;
   yAxisMax: number;
-  chartData: { name: string; data: number[] }[];
+  chartData: { name: string; data: number[], yAxis: number }[];
   className?: string;
   customOptions?: Partial<Highcharts.Options>;
   id: string;
@@ -37,6 +37,8 @@ type BarGraphProps = {
   y?: number;
   aria?: { [key: string]: string };
   data?: { [key: string]: string };
+  stacking?: "normal" | "percent" 
+  axisFormat?: { format: string; }[] | string;
 };
 
 
@@ -51,8 +53,10 @@ const BarGraph = ({
   colors,
   htmlOptions = {},
   customOptions = {},
+  axisFormat,
   id,
   pointStart,
+  stacking,
   subTitle,
   type = "column",
   title = "Title",
@@ -67,7 +71,7 @@ const BarGraph = ({
   x = 0,
   y = 0,
   ...props
-}: BarGraphProps): React.ReactElement => {
+}: BarGraphProps): React.ReactElement => { 
   const ariaProps = buildAriaProps(aria);
   const dataProps = buildDataProps(data)
   const htmlProps = buildHtmlProps(htmlOptions);
@@ -89,13 +93,23 @@ const BarGraph = ({
     subtitle: {
       text: subTitle,
     },
-    yAxis: {
+    yAxis: [{
+      labels: {
+        format: typeof axisFormat === 'string' ? axisFormat : (axisFormat && axisFormat[0] ? axisFormat[0].format : "")
+
+      },
       min: yAxisMin,
       max: yAxisMax,
+      opposite: false,
       title: {
-        text: axisTitle,
+        text: typeof axisTitle === 'string' ? axisTitle : axisTitle[0].name,
       },
-    },
+      plotLines: typeof yAxisMin !== 'undefined' && yAxisMin !== null ? [] : [{
+        value: 0,
+        zIndex: 10,
+        color: "#E4E8F0"
+    }],
+    }],
     xAxis: {
       categories: xAxisCategories,
     },
@@ -113,7 +127,9 @@ const BarGraph = ({
         : highchartsTheme.colors,
     plotOptions: {
       series: {
+        stacking: stacking,
         pointStart: pointStart,
+        borderWidth: stacking ? 0 : "",
         events: {},
         dataLabels: {
           enabled: false,
@@ -124,6 +140,25 @@ const BarGraph = ({
     credits: false,
   };
 
+if (Array.isArray(axisTitle) && axisTitle.length > 1 && axisTitle[1].name) {
+  staticOptions.yAxis.push({
+    labels: {
+      format: typeof axisFormat === 'string' ? axisFormat : axisFormat[1].format,
+    },
+    min: yAxisMin,
+    max: yAxisMax,
+    opposite: true,
+    title: {
+      text: axisTitle[1].name,
+    }, 
+    plotLines: typeof yAxisMin !== 'undefined' && yAxisMin !== null ? [] : [{
+      value: 0,
+      zIndex: 10,
+      color: "#E4E8F0"
+  }],
+  });
+}
+
   if (!toggleLegendClick) {
     staticOptions.plotOptions.series.events = { legendItemClick: () => false };
   }

data/app/pb_kits/playbook/pb_bar_graph/bar_graph.rb

@@ -7,6 +7,7 @@ module Playbook
                    values: %w[left right center],
                    default: "center"
       prop :axis_title
+      prop :axis_format
       prop :chart_data, type: Playbook::Props::Array,
                         default: []
       prop :custom_options, default: {}
@@ -14,6 +15,7 @@ module Playbook
                          values: %w[vertical horizontal],
                          default: "vertical"
       prop :point_start, type: Playbook::Props::Numeric
+      prop :stacking
       prop :subtitle
       prop :title
       prop :x_axis_categories, type: Playbook::Props::Array,
@@ -49,8 +51,10 @@ module Playbook
           dark: dark ? "dark" : "",
           type: chart_type,
           title: title,
+          stacking: stacking,
           subTitle: subtitle,
           axisTitle: axis_title,
+          axisFormat: axis_format,
           pointStart: point_start,
           xAxisCategories: x_axis_categories,
           yAxisMin: y_axis_min,

data/app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_negative_numbers.html.erb

@@ -0,0 +1,23 @@
+<% data = [{
+    name: 'Installation',
+    data: [-475, 400, -1000, 354, -856],
+    threshold: 0
+  }, {
+    name: 'Manufacturing',
+    data: [1475, 200, 1000, 654, -656],
+    threshold: 0
+  }, 
+  {
+    name: 'Sales & Distribution',
+    data: [1270, 100, -1200, 554, 756],
+    threshold: 0
+  }] %>
+
+<%= pb_rails("bar_graph", props: {
+    axis_title: 'Number of Employees',
+    chart_data: data,
+    id: "bar-default",
+    x_axis_categories:['Jan','Feb','Mar','Apr','May','Jun','Jul','Aug','Sep','Oct','Nov','Dec'],
+    title: 'Bar Graph with Negative Numbers',
+    legend: true,
+}) %>

data/app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_negative_numbers.jsx

@@ -0,0 +1,35 @@
+import React from 'react'
+
+import BarGraph from '../_bar_graph'
+
+const chartData = [{
+  name: 'Installation',
+  data: [-475, 400, -1000, 354, -856],
+  threshold: 0
+}, {
+  name: 'Manufacturing',
+  data: [1475, 200, 1000, 654, -656],
+  threshold: 0
+}, 
+{
+  name: 'Sales & Distribution',
+  data: [1270, 100, -1200, 554, 756],
+  threshold: 0
+}]
+
+
+const BarGraphStacked = (props) => (
+  <div>
+    <BarGraph
+        axisTitle="Number of Employees"
+        chartData={chartData}
+        id="bar-default"
+        legend
+        title="Bar Graph with Negative Numbers"
+        xAxisCategories={['Jan', 'Feb', 'Mar', 'Apr', 'May']}
+        {...props}
+    />
+  </div>
+)
+
+export default BarGraphStacked

data/app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_secondary_y_axis.html.erb

@@ -0,0 +1,26 @@
+<% data = [{
+    name: 'Number of Installations',
+    data: [1475,200,3000,654,656]
+}, {
+    type: 'spline',
+    name: 'Percentage',
+    data: [48, 70, 25, 55, 72],
+    color: '#F9BB00',
+    yAxis: 1
+}] %>
+
+<% axis_titles = [{name: "Number of Installations"}, {name: "Percentage"}] %>
+
+<% axis_formats = [{format: ""}, {format: "{value}%"}] %>
+
+<%= pb_rails("bar_graph", props: {
+    axis_format: axis_formats,
+    axis_title: axis_titles,
+    chart_data: data,
+    id: "bar-spline",
+    y_axis_min: 0,
+    x_axis_categories:['Jan','Feb','Mar','Apr','May','Jun','Jul','Aug','Sep','Oct','Nov','Dec'],
+    subtitle: 'Source: thesolarfoundation.com',
+    title: 'Bar Graph with Secondary Y-axis',
+    legend: true,
+}) %>

data/app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_secondary_y_axis.jsx

@@ -0,0 +1,36 @@
+import React from 'react'
+
+import BarGraph from '../_bar_graph'
+
+const chartData = [{
+  name: 'Number of Installations',
+  data: [1475, 200, 3000, 654, 656],
+}, {
+  type: 'spline',
+  name: 'Percentage',
+  data: [48, 70, 25, 55, 72],
+  color: '#F9BB00',
+  yAxis: 1
+}]
+
+const axisTitles = [ {name: "Number of Installations"}, {name: "Percentage"}]
+
+const axisFormats = [{format: ""}, {format: "{value}%"}]
+
+const BarGraphSecondaryYAxis= (props) => (
+  <div>
+    <BarGraph
+        axisFormat={axisFormats}
+        axisTitle={axisTitles}
+        chartData={chartData}
+        id="bar-spline"
+        legend
+        title="Bar Graph with Secondary Y-axis"
+        xAxisCategories={['Jan', 'Feb', 'Mar', 'Apr', 'May']}
+        yAxisMin={0}
+        {...props}
+    />
+  </div>
+)
+
+export default BarGraphSecondaryYAxis

data/app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_secondary_y_axis.md

@@ -0,0 +1,3 @@
+Optionally add a second yAxis to support secondary datasets (e.x., a spline) by passing` yAxis: 1` to the second node of your `chartData` array. 
+
+To customize the format and/or title of your secondary yAxis, pass your desired values as arrays through the `axisFormat` and `axisTitle` props, respectively.

data/app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_stacked.html.erb

@@ -0,0 +1,22 @@
+<% data = [{
+    name: 'Installation',
+    data: [1475, 200, 3000, 654, 656],
+  }, 
+  {
+    name: 'Manufacturing',
+    data: [1270, 800, 200, 454, 956],
+  }, {
+    name: 'Sales & Distribution',
+    data: [975, 1600, 1500, 924, 500],
+  }] %>
+
+<%= pb_rails("bar_graph", props: {
+    axis_title: 'Number of Employees',
+    chart_data: data,
+    id: "bar-default",
+    y_axis_min: 0,
+    x_axis_categories:['Jan','Feb','Mar','Apr','May','Jun','Jul','Aug','Sep','Oct','Nov','Dec'],
+    stacking: "normal",
+    title: 'Bar Graph with Stacked Columns',
+    legend: true,
+}) %>

data/app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_stacked.jsx

@@ -0,0 +1,34 @@
+import React from 'react'
+
+import BarGraph from '../_bar_graph'
+
+const chartData = [{
+  name: 'Installation',
+  data: [1475, 200, 3000, 654, 656],
+}, 
+{
+  name: 'Manufacturing',
+  data: [1270, 800, 200, 454, 956],
+}, {
+  name: 'Sales & Distribution',
+  data: [975, 1600, 1500, 924, 500],
+}]
+
+
+const BarGraphStacked = (props) => (
+  <div>
+    <BarGraph
+        axisTitle="Number Of Employees"
+        chartData={chartData}
+        id="bar-default"
+        legend
+        stacking="normal"
+        title="Bar Graph with Stacked Columns"
+        xAxisCategories={['Jan', 'Feb', 'Mar', 'Apr', 'May']}
+        yAxisMin={0}
+        {...props}
+    />
+  </div>
+)
+
+export default BarGraphStacked

data/app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_stacked.md

@@ -0,0 +1 @@
+The `stacking` prop can be used for a stacked bar graph. The prop allows for `normal` or `percent` as options. 

data/app/pb_kits/playbook/pb_bar_graph/docs/example.yml

@@ -9,6 +9,9 @@ examples:
   - bar_graph_spline: Spline
   - bar_graph_colors: Color Overrides
   - bar_graph_custom: Custom Overrides
+  - bar_graph_stacked: Stacked
+  - bar_graph_negative_numbers: Negative Numbers
+  - bar_graph_secondary_y_axis: Secondary Y-Axis
 
 
   react:
@@ -20,3 +23,6 @@ examples:
   - bar_graph_spline: Spline
   - bar_graph_colors: Color Overrides
   - bar_graph_custom: Custom Overrides
+  - bar_graph_stacked: Stacked
+  - bar_graph_negative_numbers: Negative Numbers
+  - bar_graph_secondary_y_axis: Secondary Y-Axis

data/app/pb_kits/playbook/pb_bar_graph/docs/index.js

@@ -6,3 +6,6 @@ export { default as BarGraphHeight } from './_bar_graph_height.jsx'
 export { default as BarGraphSpline } from './_bar_graph_spline.jsx'
 export { default as BarGraphColors } from './_bar_graph_colors.jsx'
 export { default as BarGraphCustom } from './_bar_graph_custom.jsx'
+export { default as BarGraphStacked } from './_bar_graph_stacked.jsx'
+export { default as BarGraphNegativeNumbers } from './_bar_graph_negative_numbers.jsx'
+export { default as BarGraphSecondaryYAxis } from './_bar_graph_secondary_y_axis.jsx'

data/app/pb_kits/playbook/pb_body/_body.scss

@@ -19,7 +19,7 @@
     }
   }
   b, strong {
-    @include pb_title_4
+    font-weight: $bold;
   }
 
   a {
@@ -29,8 +29,8 @@
     }
   }
 
-  em {
-    font-weight: $bold;
+  em, i {
+    font-style: italic;
   }
 
   small {

data/app/pb_kits/playbook/pb_dropdown/_dropdown.scss

@@ -0,0 +1,92 @@
+@import "../tokens/colors";
+@import "../tokens/spacing";
+@import "../tokens/typography";
+@import "../tokens/border_radius";
+@import "../tokens/shadows";
+@import "../tokens/positioning";
+@import "../pb_body/body_mixins";
+
+.pb_dropdown {
+  .dropdown_wrapper {
+    position: relative;
+    .dropdown_trigger_wrapper {
+      @include pb_body;
+      border: 1px solid $border_light;
+      background-color: $white;
+      &:hover {
+        background-color: rgba($focus_input_light, $opacity_5);
+        input {
+          background-color: rgba($focus_input_light, $opacity_5);
+        }
+      }
+
+      .dropdown_input {
+        @include pb_body;
+        border: unset;
+        border-radius: $border_rad_heavier;
+        padding: 0;
+
+        &:focus-visible {
+          outline: none;
+        }
+      }
+      &:focus {
+        box-shadow: 0px 0px 0 1px $primary;
+        outline: unset;
+        transition: box-shadow .15s ease-in-out;
+      }
+    }
+
+    .dropdown_trigger_wrapper_focus {
+      box-shadow: 0px 0px 0 1px $primary;
+      transition: box-shadow .10s ease-in-out;
+    }
+
+    .pb_dropdown_container {
+      background-color: $white;
+      overflow:hidden;
+      box-shadow: $shadow_deep;
+      border-radius: $border_rad_heavier;
+      border: 1px solid $border_light;
+      margin-top: $space_xs;
+      position: absolute;
+      z-index: $z_1;
+      width: 100%;
+      transition: opacity .25s ease-in-out;
+
+      .pb_dropdown_option {
+        :hover {
+          background-color: $border_light;
+        }
+      }
+
+      .dropdown_option_focused {
+        background-color: $border_light;
+      }
+
+      .dropdown_option {
+        width: 100%;
+      }
+
+      .dropdown_option_list {
+        border-bottom: 1px solid $border_light;
+      }
+      .dropdown_option_selected {
+        background-color: $primary;
+        [class^="pb_body"], [class^="pb_title_kit"] {
+          color: $white !important;
+        }
+        :hover {
+          background-color: unset;
+        }
+      }
+    }
+    .close {
+      display: none;
+    }
+
+    .open {
+      display: block;
+    }
+  }
+}

data/app/pb_kits/playbook/pb_dropdown/_dropdown.tsx

@@ -0,0 +1,152 @@
+import React, {useState, useRef, useEffect} from 'react'
+import classnames from 'classnames'
+import { buildAriaProps, buildCss, buildDataProps } from '../utilities/props'
+import { globalProps } from '../utilities/globalProps'
+
+import Body from '../pb_body/_body'
+
+import DropdownContainer from './subcomponents/DropdownContainer'
+import DropdownOption from './subcomponents/DropdownOption'
+import DropdownTrigger from './subcomponents/DropdownTrigger'
+import DropdownContext from './context'
+import useDropdown from './hooks/useDropdown'
+import { GenericObject } from '../types'
+
+type DropdownProps = {
+  aria?: { [key: string]: string },
+  className?: string,
+  data?: { [key: string]: string },
+  id?: string,
+  children?: React.ReactChild[] | React.ReactChild,
+  options?: GenericObject,
+  onSelect?: (arg:GenericObject) => null
+}
+
+const Dropdown = (props: DropdownProps) => {
+  const {
+    aria = {},
+    children,
+    className,
+    data = {},
+    id,
+    options,
+    onSelect
+  } = props
+
+  const ariaProps = buildAriaProps(aria)
+  const dataProps = buildDataProps(data)
+  const classes = classnames(buildCss('pb_dropdown'), globalProps(props), className)
+
+  const [ isDropDownClosed, setIsDropDownClosed, toggleDropdown ] = useDropdown()
+
+  const [filterItem, setFilterItem] = useState("");
+  const [selected, setSelected] = useState({});
+  const [isInputFocused, setIsInputFocused] = useState(false);
+  //state for keyboard events
+  const [focusedOptionIndex, setFocusedOptionIndex] = useState(-1);
+
+  const dropdownRef = useRef(null);
+  const inputRef = useRef(null);
+
+  // useEffect to handle clicks outside the dropdown
+  useEffect(() => {
+    const handleClickOutside = (event: any) => {
+      if (dropdownRef.current && !dropdownRef.current.contains(event.target)) {
+        setIsDropDownClosed(true);
+        setIsInputFocused(false)
+      }
+    };
+    window.addEventListener("click", handleClickOutside);
+    return () => {
+      window.removeEventListener("click", handleClickOutside);
+    };
+  }, []);
+
+
+  const handleChange = (e: any) => {
+    setFilterItem(e.target.value);
+    setIsDropDownClosed(false);
+  };
+
+  const handleOptionClick = (selectedItem: GenericObject) => {
+    setSelected(selectedItem);
+    setFilterItem("");
+    setIsDropDownClosed(true);
+    onSelect(selectedItem);
+  };
+
+
+  const handleWrapperClick = () => {
+    inputRef.current.focus();
+    toggleDropdown();
+  };
+
+  const handleBackspace = () => {
+    setSelected({})
+    onSelect(null)
+    setFocusedOptionIndex(-1)
+  }
+
+  const filteredOptions = options?.filter((option: GenericObject) =>
+  option.label.toLowerCase().includes(filterItem.toLowerCase())
+);
+
+  return (
+    <div
+        {...ariaProps}
+        {...dataProps}
+        className={classes}
+        id={id}
+    >
+      <DropdownContext.Provider
+          value={{
+            filteredOptions,
+            filterItem,
+            focusedOptionIndex,
+            handleBackspace,
+            handleChange,
+            handleOptionClick,
+            handleWrapperClick,
+            inputRef,
+            isInputFocused,
+            options,
+            selected,
+            setFocusedOptionIndex,
+            setIsInputFocused,
+            setSelected,
+            isDropDownClosed,
+            setIsDropDownClosed,
+            toggleDropdown
+        
+          }}
+      >
+        <div className="dropdown_wrapper" 
+            ref={dropdownRef}
+        >
+          {children ? (
+            children
+          ) : (
+            <>
+              <DropdownTrigger />
+              <DropdownContainer>
+              {options && options?.map((option: GenericObject) => (
+                <Dropdown.Option key={option.id} 
+                    option={option}
+                >
+                    <Body text={option.label}/>
+                </Dropdown.Option>
+              ))}
+              </DropdownContainer>
+            </>
+          )}
+        </div>
+      </DropdownContext.Provider>
+    </div>
+  )
+}
+
+Dropdown.Option = DropdownOption;
+Dropdown.Trigger = DropdownTrigger;
+Dropdown.Container = DropdownContainer;
+
+export default Dropdown

data/app/pb_kits/playbook/pb_dropdown/context/index.tsx

@@ -0,0 +1,5 @@
+import { createContext } from "react";
+
+const DropdownContext = createContext<any>({});
+
+export default DropdownContext;