playbook_ui 14.14.0 → 14.15.0.pre.alpha.PBNTR617addgriddisplayglobalprop6700

data/app/pb_kits/playbook/pb_overlay/index.js

@@ -0,0 +1,61 @@
+import PbEnhancedElement from '../pb_enhanced_element'
+
+const OVERLAY_SELECTOR = '[data-pb-overlay]'
+const OVERLAY_SCROLL_ELEMENT = '[data-overlay-scroll-element]'
+const PREVIOUS_OVERLAY_CLASSNAME = '[data-previous-overlay-classname]'
+const SUBSEQUENT_OVERLAY_CLASSNAME = '[data-subsequent-overlay-classname]'
+
+export default class PbOverlay extends PbEnhancedElement {
+    static get selector() {
+        return OVERLAY_SELECTOR
+    }
+
+    get target() {
+        return this.element.querySelector(OVERLAY_SCROLL_ELEMENT).children[0]
+    }
+
+    connect() {
+        this.handleOverlayDynamic()
+    }
+
+    handleOverlayDynamic() {
+        const isOverlayDynamic = this.element.dataset?.overlayDynamic
+
+        if (isOverlayDynamic) {
+            const previousOverlayElement = this.element.querySelector(PREVIOUS_OVERLAY_CLASSNAME)
+            const previousOverlayClassname = previousOverlayElement?.dataset?.previousOverlayClassname
+            const subsequentOverlayElement = this.element.querySelector(SUBSEQUENT_OVERLAY_CLASSNAME)
+            const subsequentOverlayClassname = subsequentOverlayElement?.dataset?.subsequentOverlayClassname
+
+            const handleScrollChange = (target) => {
+                const { scrollLeft, scrollWidth, clientWidth } = target
+                const isScrollAtStart = scrollLeft === 0
+                const isScrollAtEnd = scrollLeft + clientWidth >= scrollWidth - 1
+        
+                if (isScrollAtStart) {
+                    previousOverlayElement.classList.remove(previousOverlayClassname)
+                } else {
+                    previousOverlayElement.classList.add(previousOverlayClassname)
+                }
+        
+                if (isScrollAtEnd) {
+                    subsequentOverlayElement.classList.remove(subsequentOverlayClassname)
+                } else {
+                    subsequentOverlayElement.classList.add(subsequentOverlayClassname)
+                }
+            }
+
+            this.target.addEventListener('scroll', (event) => {
+                handleScrollChange(event.target)
+            })
+
+            handleScrollChange(this.target)
+        }
+    }
+
+    disconnect() {
+        if (this.element.dataset?.overlayDynamic) {
+            this.target.removeEventListener('scroll')
+        }
+    }
+}

data/app/pb_kits/playbook/pb_overlay/overlay.html.erb

@@ -16,12 +16,14 @@ id: object.id,
         <% end %>
 
     <% else %>
-        <div class="<%= previous_overlay_class_name %>"></div>
+        <div class="<%= previous_overlay_class_name %>" data-previous-overlay-classname="<%= previous_overlay_class_name %>"></div>
 
-        <%= content.presence %>
+        <div data-overlay-scroll-element="true">
+            <%= content.presence %>
+        </div>
 
         <% if has_subsequent_overlay %>
-            <div class="<%= subsequent_overlay_class_name %>"></div>
+            <div class="<%= subsequent_overlay_class_name %>" data-subsequent-overlay-classname="<%= subsequent_overlay_class_name %>"></div>
         <% end %>
     <% end %>
 <% end %>

data/app/pb_kits/playbook/pb_overlay/overlay.rb

@@ -8,9 +8,13 @@ module Playbook
                    default: "card_light"
       prop :layout, type: Playbook::Props::HashProp,
                     default: { "bottom": "full" }
+      prop :dynamic, type: Playbook::Props::Boolean,
+                     default: false
+      prop :scroll_bar_none, type: Playbook::Props::Boolean,
+                             default: false
 
       def classname
-        generate_classname("pb_overlay")
+        generate_classname("pb_overlay", hide_scroll_bar_class)
       end
 
       def position
@@ -105,6 +109,17 @@ module Playbook
           "bg_dark": "#0a0527",
         }
       end
+
+      def data_attributes
+        data ||= {}
+        data.merge!("data-pb-overlay" => true)
+        data.merge!("data-overlay-dynamic" => true) if dynamic
+        data
+      end
+
+      def hide_scroll_bar_class
+        scroll_bar_none ? " overlay-hide-scrollbar" : ""
+      end
     end
   end
 end

data/app/pb_kits/playbook/pb_overlay/overlay.test.jsx

@@ -64,3 +64,15 @@ test('should render children', () => {
     const kit = screen.getByTestId(testId)
     expect(kit).toHaveTextContent(props.children)
 })
+
+test('should add overlay-hide-scrollbar class when scrollBarNone is true', () => {
+    const props = {
+      children,
+      data: { testid: testId },
+      scrollBarNone: true
+    }
+  
+    render(<Overlay {...props} />)
+    const kit = screen.getByTestId(testId)
+    expect(kit).toHaveClass('overlay-hide-scrollbar')
+})

data/app/pb_kits/playbook/pb_phone_number_input/_phone_number_input.tsx

@@ -23,6 +23,7 @@ type PhoneNumberInputProps = {
   data?: { [key: string]: string },
   disabled?: boolean,
   error?: string,
+  hiddenInputs?: boolean,
   htmlOptions?: {[key: string]: string | number | boolean | (() => void)},
   id?: string,
   initialCountry?: string,
@@ -72,6 +73,7 @@ const PhoneNumberInput = (props: PhoneNumberInputProps, ref?: React.MutableRefOb
     dark = false,
     data = {},
     disabled = false,
+    hiddenInputs = false,
     htmlOptions = {},
     id = "",
     initialCountry = "",
@@ -243,6 +245,10 @@ const PhoneNumberInput = (props: PhoneNumberInputProps, ref?: React.MutableRefOb
       countrySearch: false,
       fixDropdownWidth: false,
       formatAsYouType: formatAsYouType,
+      hiddenInput: hiddenInputs ? () => ({
+        phone: `${name}_full`,
+        country: `${name}_country_code`,
+      }) : null,
     })
 
     itiRef.current = telInputInit;

data/app/pb_kits/playbook/pb_phone_number_input/docs/_phone_number_input_default.html.erb

@@ -1,3 +1,3 @@
 <%= pb_rails("phone_number_input", props: {
-    id: "hello"
+    id: "hello",
 }) %>

data/app/pb_kits/playbook/pb_phone_number_input/docs/_phone_number_input_hidden_inputs.html.erb

@@ -0,0 +1,5 @@
+<%= pb_rails("phone_number_input", props: {
+    hidden_inputs: true,
+    id: "hidden_inputs",
+    name: "hidden_inputs",
+}) %>

data/app/pb_kits/playbook/pb_phone_number_input/docs/_phone_number_input_hidden_inputs.md

@@ -0,0 +1 @@
+The `hidden_inputs` boolean prop generates two hidden input fields, {field_name}_full and {field_name}_country_code. The value passed when the form is submitted contains the full phone number including the country code. Because it requires the submission of a form to function, only use this prop on Rails phone number elements within html form tags `<form>/<form>` or [pb_forms](https://playbook.powerapp.cloud/kits/form). Read the [intl-tel-input](https://intl-tel-input.com/examples/hidden-input.html) docs for more information.

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

@@ -16,4 +16,6 @@ examples:
   - phone_number_input_initial_country: Initial Country
   - phone_number_input_only_countries: Limited Countries
   - phone_number_input_validation: Form Validation
-  - phone_number_input_format: Format as You Type
+  - phone_number_input_format: Format as You Type
+  - phone_number_input_hidden_inputs: Hidden Inputs
+  

data/app/pb_kits/playbook/pb_phone_number_input/phone_number_input.rb

@@ -23,6 +23,8 @@ module Playbook
                    default: ""
       prop :format_as_you_type, type: Playbook::Props::Boolean,
                                 default: false
+      prop :hidden_inputs, type: Playbook::Props::Boolean,
+                           default: false
 
       def classname
         generate_classname("pb_phone_number_input")
@@ -35,6 +37,7 @@ module Playbook
           disabled: disabled,
           error: error,
           formatAsYouType: format_as_you_type,
+          hiddenInputs: hidden_inputs,
           initialCountry: initial_country,
           label: label,
           name: name,

data/app/pb_kits/playbook/pb_popover/_popover.tsx

@@ -19,7 +19,7 @@ import {
 
 import classnames from "classnames";
 import { globalProps, GlobalProps } from "../utilities/globalProps";
-import { uniqueId } from 'lodash';
+import { uniqueId } from '../utilities/object';
 
 type ModifiedGlobalProps = Omit<GlobalProps, 'minWidth' | 'maxHeight' | 'minHeight'>
 
@@ -84,7 +84,7 @@ const Popover = (props: PbPopoverProps) => {
   } = props;
 
   const items = globalProps(props).split(' ')
-  const filteredItems = items.filter(item => !item.includes('min_width'))
+  const filteredItems = items.filter(item => !item.includes('min-width') && !item.includes('width'))
   const filteredGlobalProps = filteredItems.join(' ')
   const popoverSpacing =
     filteredGlobalProps.includes("dark") || !filteredGlobalProps

data/app/pb_kits/playbook/pb_popover/popover.test.js

@@ -181,7 +181,7 @@ const PopoverTestClicktoClose3 = () => {
     const btn = screen.getByText(/click me/i)
     fireEvent.click(btn);
     const kit = screen.getByText("Click Anywhere");
-    expect(kit).toHaveClass("pb_popover_body max_width_240px overflow_handling");
+    expect(kit).toHaveClass("pb_popover_body p_sm overflow_handling");
   });
 
   test("closes Popover on click anywhere", async () => {

data/app/pb_kits/playbook/pb_progress_step/progress_step_item.html.erb

@@ -1,6 +1,6 @@
 <%= pb_content_tag(:li) do %>
-  <div class="box" style="max-width: min-content;" id="<%= object.tooltip_trigger_class %>">
-    <div class="circle">
+  <div class="box" style="max-width: min-content;">
+    <div class="circle" id="<%= object.tooltip_trigger_class %>" >
       <%= pb_rails("icon", props: { icon: object.icon, size: "xs" }) if object.icon.present? %>
     </div>
     <% if object.tooltip.present? %>

data/app/pb_kits/playbook/pb_radio/_radio.tsx

@@ -1,6 +1,4 @@
-/*eslint-disable react/no-multi-comp */
-
-import React, { forwardRef, useRef } from 'react'
+import React, { useRef, forwardRef } from 'react'
 import Body from '../pb_body/_body'
 import Flex from '../pb_flex/_flex'
 import classnames from 'classnames'
@@ -10,7 +8,7 @@ import { globalProps, GlobalProps } from '../utilities/globalProps'
 type RadioProps = {
   aria?: { [key: string]: string },
   alignment?: string,
-  checked?: boolean,
+  checked?: boolean, // removed default assignment here
   children?: React.ReactChild[] | React.ReactChild,
   customChildren?: boolean,
   className?: string,
@@ -24,10 +22,10 @@ type RadioProps = {
   name?: string,
   value?: string,
   text?: string,
-  onChange: (event: React.FormEvent<HTMLInputElement> | null) => void,
+  onChange?: (event: React.FormEvent<HTMLInputElement> | null) => void,
 } & GlobalProps
 
-const Radio = ({
+const Radio = forwardRef<HTMLInputElement, RadioProps>(({
   aria = {},
   alignment,
   children,
@@ -43,110 +41,123 @@ const Radio = ({
   name = 'radio_name',
   text = 'Radio Text',
   value = 'radio_text',
+  checked,
   onChange = () => { void 0 },
   ...props
-}: RadioProps, ref: any) => {
-  const radioRef = useRef(null);
+}, ref) => {
+  const internalRef = useRef<HTMLInputElement>(null)
+  const setRefs = (el: HTMLInputElement) => {
+    internalRef.current = el
+    if (typeof ref === 'function') {
+      ref(el)
+    } else if (ref) {
+      (ref as React.MutableRefObject<HTMLInputElement | null>).current = el
+    }
+  }
+
+  const ariaProps = buildAriaProps(aria)
+  const dataProps = buildDataProps(data)
+  const htmlProps = buildHtmlProps(htmlOptions)
 
-  const ariaProps = buildAriaProps(aria);
-  const dataProps = buildDataProps(data);
-  const htmlProps = buildHtmlProps(htmlOptions);
   const classes = classnames(
     buildCss('pb_radio_kit', alignment),
     dark ? 'dark' : null,
     error ? 'error' : null,
     globalProps(props),
     className
-  );
+  )
 
   const classesCustom = classnames(
     dark ? 'dark' : null,
     error ? 'error' : null,
     globalProps(props),
     className
-  );
+  )
+
+  const checkedProps = checked !== undefined ? { checked } : {}
 
-  const displayRadio = (props: RadioProps & any) => {
-    if (children && customChildren == false)
-      return (children)
+  const displayRadio = (inputProps: any) => {
+    if (children && customChildren === false)
+      return children
     else
-    return (
-    <input
-        disabled={disabled}
-        id={id}
-        name={name}
-        onChange={onChange}
-        ref={ref}
-        text={text}
-        type="radio"
-        value={value}
-        {...props}
-    />
-  )}
+      return (
+        <input
+            {...checkedProps}
+            disabled={disabled}
+            id={id}
+            name={name}
+            onChange={onChange}
+            ref={setRefs}
+            type="radio"
+            value={value}
+            {...inputProps}
+        />
+      )
+  }
 
   const handleContainerClick = (event: React.MouseEvent<HTMLDivElement, MouseEvent> | undefined) => {
     if (event) {
-      const target = event.target as HTMLElement;
+      const target = event.target as HTMLElement
       if (
         target.id === 'pb-radio-children-wrapper' ||
         target.closest('#pb-radio-children-wrapper')
       ) {
-        radioRef.current?.click();
+        internalRef.current?.click()
       }
     }
-  };
+  }
 
-  return (
-    customChildren ? (
-      <Flex 
-          {...ariaProps}
-          {...dataProps}
-          {...htmlProps}
-          align='center'
-          className={classesCustom}
-          cursor='pointer'
-          htmlFor={id}
-          htmlOptions={{
-            onClick: ((event: React.MouseEvent<HTMLDivElement, MouseEvent>) => {
-              handleContainerClick(event);
-            }) as unknown as () => void
-          }}
-          id="radio-container"
-      >
-        <label className={buildCss('pb_radio_kit', alignment)}>
+  return customChildren ? (
+    <Flex
+        {...ariaProps}
+        {...dataProps}
+        {...htmlProps}
+        align="center"
+        className={classesCustom}
+        cursor="pointer"
+        htmlFor={id}
+        htmlOptions={{
+          onClick: ((event: React.MouseEvent<HTMLDivElement, MouseEvent>) => {
+            handleContainerClick(event)
+          }) as unknown as () => void
+        }}
+        id="radio-container"
+    >
+      <label className={buildCss('pb_radio_kit', alignment)}>
         <input
+            {...checkedProps}
             disabled={disabled}
             id={id}
             name={name}
             onChange={onChange}
-            ref={radioRef}
+            ref={setRefs}
             type="radio"
             value={value}
             {...props}
         />
-          <span className="pb_radio_button" />
-        </label>
-        <div id="pb-radio-children-wrapper"> {children} </div>
-      </Flex>
-    ) : (
-        <label
-            {...ariaProps}
-            {...dataProps}
-            {...htmlProps}
-            className={classes}
-            htmlFor={id}
-        >
-        <>{displayRadio(props)}</>
         <span className="pb_radio_button" />
-        <Body
-            dark={dark}
-            status={error ? 'negative' : null}
-            text={label}
-            variant={null}
-        />
       </label>
-    )
-  );
-};
+      <div id="pb-radio-children-wrapper"> {children} </div>
+    </Flex>
+  ) : (
+    <label
+        {...ariaProps}
+        {...dataProps}
+        {...htmlProps}
+        className={classes}
+        htmlFor={id}
+    >
+      {displayRadio(props)}
+      <span className="pb_radio_button" />
+      <Body
+          dark={dark}
+          status={error ? 'negative' : null}
+          text={label}
+          variant={null}
+      />
+    </label>
+  )
+})
 
-export default forwardRef(Radio);
+Radio.displayName = "Radio"
+export default Radio

data/app/pb_kits/playbook/pb_radio/docs/_radio_react_hook.jsx

@@ -0,0 +1,60 @@
+import React from "react"
+import { useForm } from "react-hook-form"
+import { Radio, Flex, Body } from "playbook-ui"
+
+const RadioReactHook = () => {
+  const { register, watch } = useForm({
+    defaultValues: {
+      size: "Small",
+    },
+  })
+
+  const selectedSize = watch("size", "Small")
+
+  return (
+    <Flex orientation="row">
+      <Flex
+          align="start"
+          orientation="column"
+          paddingRight="lg"
+        >
+        <Radio
+            alignment="left"
+            label="Small"
+            marginBottom='sm'
+            name="size"
+            value="Small"
+            {...register("size")}
+        />
+        <br />
+        <Radio
+            alignment="left"
+            label="Medium"
+            marginBottom='sm'
+            name="size"
+            value="Medium"
+            {...register("size")}
+        />
+        <br />
+        <Radio
+            alignment="left"
+            label="Large"
+            marginBottom='sm'
+            name="size"
+            value="Large"
+            {...register("size")}
+        />
+      </Flex>
+      <Flex
+          align="start"
+          orientation="column"
+      >
+        <Body
+            text={`Selected Size: ${selectedSize}`}
+        />
+      </Flex>
+    </Flex>
+  )
+}
+
+export default RadioReactHook

data/app/pb_kits/playbook/pb_radio/docs/_radio_react_hook.md

@@ -0,0 +1 @@
+You can pass react hook props to the radio kit.

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

@@ -16,6 +16,7 @@ examples:
   - radio_alignment: Alignment
   - radio_disabled: Disabled
   - radio_custom_children: Custom Children
+  - radio_react_hook: React Hook Form
 
   swift:
   - radio_default_swift: Default
@@ -26,4 +27,4 @@ examples:
   - radio_spacing_swift: Spacing
   - radio_padding_swift: Padding
   - radio_subtitle_swift: Subtitle
-  - radio_props_swift: ""
+  - radio_props_swift: ""

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

@@ -4,3 +4,4 @@ export { default as RadioError } from './_radio_error.jsx'
 export { default as RadioAlignment } from './_radio_alignment.jsx'
 export { default as RadioDisabled } from './_radio_disabled.jsx'
 export { default as RadioCustomChildren } from './_radio_custom_children.jsx'
+export { default as RadioReactHook } from './_radio_react_hook.jsx'

data/app/pb_kits/playbook/pb_radio/radio.test.js

@@ -86,3 +86,19 @@ test('has disabled attribute', () => {
   expect(input).toHaveAttribute('disabled')
 })
 
+
+test('has ref in the input element', () => {
+  const ref = React.createRef()
+    render(
+      <Radio
+          data={{ testid: testId }}
+          name="Radio-name"
+          ref={ref}
+          text="Radio"
+          value="radio value"
+      />
+  )
+
+  expect(ref.current).not.toBeNull()
+  expect(ref.current?.tagName).toBe('INPUT')
+})

data/app/pb_kits/playbook/pb_select/docs/_select_react_hook.jsx

@@ -0,0 +1,58 @@
+import React, { useState } from "react"
+import { useForm } from "react-hook-form"
+import { Button, Body, Select } from "playbook-ui"
+
+const SelectReactHook = (props) => {
+  const { register, handleSubmit, formState: { errors } } = useForm({
+    defaultValues: {
+      food: '',
+    },
+  })
+
+  const [submittedData, setSubmittedData] = useState({
+    food: '',
+  })
+
+  const onSubmit = (data) => {
+    setSubmittedData(data)
+  }
+
+  const options = [
+    {
+      value: 1,
+      text: 'Burgers',
+    },
+    {
+      value: 2,
+      text: 'Pizza',
+    },
+    {
+      value: 3,
+      text: 'Tacos',
+    },
+  ]
+
+  return (
+    <>
+      <form onSubmit={handleSubmit(onSubmit)}>
+        <Select
+            {...props}
+            {...register("food", { required: true })}
+            error={errors.food ? "Please select a food." : null}
+            label="Favorite Food"
+            options={options}
+        />
+        <br />
+        <Button htmlType="submit"
+            marginTop="sm"
+            text="Submit"
+          />
+      </form>
+      <Body padding="xs"
+          text={`Food: ${submittedData.food}`}
+      />
+    </>
+  )
+}
+
+export default SelectReactHook

data/app/pb_kits/playbook/pb_select/docs/_select_react_hook.md

@@ -0,0 +1 @@
+You can pass react-hook-form props to a select kit. You can use `register` which will make the value available for both the form validation and submission. 

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

@@ -30,6 +30,7 @@ examples:
   - select_inline_show_arrow: Select Inline (Always Show Arrow)
   - select_inline_compact: Select Inline Compact
   - select_multiple: Select Multiple
+  - select_react_hook: React Hook
 
   swift:
   - select_default_swift: Default

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

@@ -10,3 +10,4 @@ export { default as SelectInline } from './_select_inline.jsx'
 export { default as SelectInlineShowArrow } from './_select_inline_show_arrow.jsx'
 export { default as SelectInlineCompact } from './_select_inline_compact.jsx'
 export { default as SelectMultiple } from './_select_multiple.jsx'
+export { default as SelectReactHook } from './_select_react_hook.jsx'