RubyGems - playbook_ui - Versions diffs - 16.1.0 → 16.2.0.pre.rc.1 - Mend

playbook_ui 16.1.0 → 16.2.0.pre.rc.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (104) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44f1e7afbe7c0d127bc680167e9427432c46f735f9f51ba6174221c0e9602770
-  data.tar.gz: 3b85879d8c62e120fb3303b62bb5a55e6a56c7cf4faea1e913b5cacf671e1c51
+  metadata.gz: 4716e526924fd62bb0c877a51c1b135e4d881bb50c2995a67a51aa3c667bf320
+  data.tar.gz: d8e539ed648f227860fee870d7c8b80ea9a6ba2cf9e0420c59cd192bf58dae50
 SHA512:
-  metadata.gz: dfe9036365c160f05b85ce8f2d4ecc7b110c4dc41e7ba7b86020887bd0947687e7efd74dd44af38caf7e776809984e9bb58010fd321ac624c7da145511bc518f
-  data.tar.gz: 91543b8fde65bba1238d3ec6d8448ccc3a42d8a0d0313abe3a5f4c08b7959ab33830cebad946ac001a09b874d50a6fe05c3c2d195c7e81c9aeec5bace0e9881a
+  metadata.gz: 8d2b0e61996919c9d3234518bf9ce2708f3be86de41039abf8a820029d22063a2ebdceb41a183852f5ab88315a44c6bd20daeba2bb1a95ec3dcb2aa59cf74d1a
+  data.tar.gz: b5b94f8ead24d755a3d0c1a10fe6e2175c45eb874fe413705a99d5740b82a25be3b44abb98a1c22c41da6562f61cd1815eea65622ad97686e7a9f07069d573cc

data/app/pb_kits/playbook/pb_date_picker/_date_picker.tsx CHANGED Viewed

@@ -40,7 +40,7 @@ type DatePickerProps = {
   maxDate: string,
   minDate: string,
   name: string,
-  pickerId?: string,
+  pickerId: string,
   placeholder?: string,
   positionElement?: HTMLElement | null,
   scrollContainer?: string,
@@ -196,6 +196,8 @@ const DatePicker = (props: DatePickerProps): React.ReactElement => {
   const angleDown = getAllIcons()["angleDown"].icon as unknown as { [key: string]: SVGElement }
+  const errorId = error ? `${pickerId}-error` : undefined
   return (
     <div
         {...ariaProps}
@@ -211,14 +213,18 @@ const DatePicker = (props: DatePickerProps): React.ReactElement => {
       >
         {!hideLabel && (
-          <Caption
-              className="pb_date_picker_kit_label"
-              text={label}
-          />
+           <label htmlFor={pickerId}>
+            <Caption
+                className="pb_date_picker_kit_label"
+                text={label}
+            />
+          </label>
         )}
           <>
             <div className="date_picker_input_wrapper">
               <input
+                  aria-describedby={errorId}
+                  aria-invalid={!!error}
                   autoComplete="off"
                   className="date_picker_input"
                   disabled={disableInput}
@@ -232,6 +238,9 @@ const DatePicker = (props: DatePickerProps): React.ReactElement => {
               {error &&
                   <Body
+                      aria={{ atomic: "true", live: "polite" }}
+                      htmlOptions={{ role: "alert" }}
+                      id={errorId}
                       status="negative"
                       text={error}
                       variant={null}

data/app/pb_kits/playbook/pb_date_picker/docs/_date_picker_default.md ADDED Viewed

	@@ -0,0 +1 @@
1	+ `pickerId`/`picker_id` is a required prop to instantiate the Date Picker. The presence of `pickerId`/`picker_id` in your Date Picker also associates the label with the input, providing the ability to focus the Date Picker by clicking the label.

data/app/pb_kits/playbook/pb_dialog/_dialog.scss CHANGED Viewed

@@ -135,6 +135,8 @@
     position: sticky;
     top: 0;
     background-color: $white;
+    border-top-left-radius: $border_radius_md;
+    border-top-right-radius: $border_radius_md;
     z-index: $z_8;
   }
@@ -256,7 +258,7 @@
   }
   &.full_height_left {
     justify-content: flex-start;
     .pb_dialog {
       border-radius: 0;
       height: 100%;
@@ -302,7 +304,7 @@
   &.full_height_center {
     justify-content: center;
     .pb_dialog {
       border-radius: 0;
       height: 100%;
@@ -346,7 +348,7 @@
   &.full_height_right {
     justify-content: flex-end;
     .pb_dialog {
       border-radius: 0;
       height: 100%;
@@ -417,7 +419,7 @@
       margin: unset !important;
       margin-right: auto !important;
     }
     .pb_dialog {
       border-radius: 0;
       height: 100% !important;
@@ -463,7 +465,7 @@
   &.full_height_center {
     justify-content: center;
     .pb_dialog {
       border-radius: 0;
       height: 100% !important;
@@ -510,7 +512,7 @@
       margin: unset !important;
       margin-left: auto !important;
     }
     .pb_dialog {
       border-radius: 0;
       height: 100% !important;

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

@@ -76,6 +76,12 @@
       z-index: $z_1;
       width: 100%;
+      &.constrain_height {
+        overflow-y: auto;
+        overflow-x: hidden;
+        max-height: 18em;
+      }
       .pb_dropdown_option,
       .pb_dropdown_option_list,
       .pb_dropdown_option_selected,

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

@@ -36,6 +36,8 @@ type DropdownProps = {
     blankSelection?: string;
     children?: React.ReactChild[] | React.ReactChild | React.ReactElement[];
     className?: string;
+    clearable?: boolean;
+    constrainHeight?: boolean;
     customQuickPickDates?: CustomQuickPickDates;
     formPillProps?: GenericObject;
     dark?: boolean;
@@ -49,6 +51,7 @@ type DropdownProps = {
     multiSelect?: boolean;
     onSelect?: (arg: GenericObject) => null;
     options?: GenericObject;
+    placeholder?: string;
     separators?: boolean;
     variant?: "default" | "subtle" | "quickpick";
     rangeEndsToday?: boolean;
@@ -74,6 +77,8 @@ let Dropdown = (props: DropdownProps, ref: any): React.ReactElement | null => {
         blankSelection = '',
         children,
         className,
+        clearable = true,
+        constrainHeight = false,
         customQuickPickDates,
         dark = false,
         data = {},
@@ -87,6 +92,7 @@ let Dropdown = (props: DropdownProps, ref: any): React.ReactElement | null => {
         formPillProps,
         onSelect,
         options,
+        placeholder,
         rangeEndsToday = false,
         controlsStartId,
         controlsEndId,
@@ -211,6 +217,34 @@ let Dropdown = (props: DropdownProps, ref: any): React.ReactElement | null => {
         }
     }, [isDropDownClosed]);
+    // Auto-position dropdown above/below based on available space
+    useEffect(() => {
+        if (!isDropDownClosed && dropdownContainerRef.current) {
+            const container = dropdownContainerRef.current;
+            const wrapper = container.closest('.dropdown_wrapper') as HTMLElement;
+            if (!wrapper) return;
+            const wrapperRect = wrapper.getBoundingClientRect();
+            const h = container.getBoundingClientRect().height || container.scrollHeight;
+            const spaceBelow = window.innerHeight - wrapperRect.bottom;
+            const spaceAbove = wrapperRect.top;
+            // If not enough space below but enough space above, position above
+            if (spaceBelow < h + 10 && spaceAbove >= h + 10) {
+                container.style.top = "auto";
+                container.style.bottom = "calc(100% + 5px)";
+                container.style.marginTop = "0";
+                container.style.marginBottom = "0";
+            } else {
+                // Default: position below
+                container.style.top = "";
+                container.style.bottom = "";
+                container.style.marginTop = "";
+                container.style.marginBottom = "";
+            }
+        }
+    }, [isDropDownClosed, dropdownContainerRef]);
     const handleChange = (e: React.ChangeEvent<HTMLInputElement>) => {
         setFilterItem(e.target.value);
@@ -375,6 +409,7 @@ let Dropdown = (props: DropdownProps, ref: any): React.ReactElement | null => {
                 value={{
                     activeStyle,
                     autocomplete,
+                    clearable,
                     dropdownContainerRef,
                     filteredOptions,
                     filterItem,
@@ -426,8 +461,8 @@ let Dropdown = (props: DropdownProps, ref: any): React.ReactElement | null => {
                         </>
                     ) : (
                         <>
-                            <DropdownTrigger />
-                            <DropdownContainer>
+                            <DropdownTrigger placeholder={placeholder} />
+                            <DropdownContainer constrainHeight={constrainHeight}>
                                 {optionsWithBlankSelection &&
                                     optionsWithBlankSelection?.map((option: GenericObject) => (
                                         <DropdownOption key={option.id}

data/app/pb_kits/playbook/pb_dropdown/docs/_dropdown_blank_selection_rails.md ADDED Viewed

@@ -0,0 +1,3 @@
+The `blank_selection` prop adds a blank option at the top of the dropdown options list. This allows users to explicitly clear their selection by choosing the blank option.
+The blank selection option appears as the first item in the dropdown and has an empty value (`id: ""`, `value: ""`). When selected, it effectively clears the dropdown selection.

data/app/pb_kits/playbook/pb_dropdown/docs/_dropdown_blank_selection_react.md ADDED Viewed

@@ -0,0 +1,3 @@
+The `blankSelection` prop adds a blank option at the top of the dropdown options list. This allows users to explicitly clear their selection by choosing the blank option.
+The blank selection option appears as the first item in the dropdown and has an empty value (`id: ""`, `value: ""`). When selected, it effectively clears the dropdown selection.

data/app/pb_kits/playbook/pb_dropdown/docs/_dropdown_with_clearable.html.erb ADDED Viewed

@@ -0,0 +1,52 @@
+<%
+  options = [
+    { label: 'United States', value: 'unitedStates', id: 'us' },
+    { label: 'Canada', value: 'canada', id: 'ca' },
+    { label: 'Pakistan', value: 'pakistan', id: 'pk' },
+  ]
+%>
+<%= pb_rails("dropdown", props: {
+  id: "date-range-quickpick-reset-closeable",
+  label: "Quick Pick",
+  variant: "quickpick",
+  clearable: false
+}) %>
+<%= pb_rails("button", props: {
+  margin_y: "md",
+  text: "Reset",
+  html_options: {
+    onclick: "handleReset()"
+  }
+}) %>
+<%= pb_rails("dropdown", props: {
+  id: "closeable-default",
+  options: options,
+  clearable: false,
+  default_value: options.last,
+  margin_bottom: "md",
+  label: "Default"
+}) %>
+<%= pb_rails("dropdown", props: {
+  id: "closeable-subtle",
+  options: options,
+  clearable: false,
+  default_value: options.second,
+  variant: "subtle",
+  separators: false,
+  label: "Subtle"
+}) %>
+<script>
+  function handleReset() {
+    const dropdown = document.querySelector("#date-range-quickpick-reset-closeable[data-pb-dropdown]");
+    const instance = dropdown?._pbDropdownInstance;
+    if (instance) {
+      instance.clearSelection();
+    }
+  }
+</script>

data/app/pb_kits/playbook/pb_dropdown/docs/_dropdown_with_clearable.jsx ADDED Viewed

@@ -0,0 +1,72 @@
+import React, { useRef } from 'react'
+import Button from '../../pb_button/_button'
+import Dropdown from '../../pb_dropdown/_dropdown'
+const DropdownWithClearable = (props) => {
+    const dropdownRef = useRef(null)
+    const options = [
+        {
+            label: "United States",
+            value: "unitedStates",
+            id: "us"
+        },
+        {
+            label: "Canada",
+            value: "canada",
+            id: "ca"
+        },
+        {
+            label: "Pakistan",
+            value: "pakistan",
+            id: "pk"
+        }
+    ]
+    const handleReset = () => {
+        if (dropdownRef.current) {
+            dropdownRef.current.clearSelected()
+        }
+    }
+    return (
+        <>
+            <Dropdown
+                clearable={false}
+                label="Quick Pick"
+                onSelect={() => {}}
+                ref={dropdownRef}
+                variant="quickpick"
+                {...props}
+            />
+            <Button
+                marginY="md"
+                onClick={handleReset}
+                text="Reset"
+            />
+            <Dropdown
+                clearable={false}
+                defaultValue={options[options.length - 1]}
+                label="Default"
+                marginBottom="md"
+                options={options}
+                variant="default"
+                {...props}
+            />
+            <Dropdown
+                clearable={false}
+                defaultValue={options[1]}
+                label="Subtle"
+                options={options}
+                separators={false}
+                variant="subtle"
+                {...props}
+            />
+        </>
+    )
+}
+export default DropdownWithClearable

data/app/pb_kits/playbook/pb_dropdown/docs/_dropdown_with_clearable.md ADDED Viewed

@@ -0,0 +1,5 @@
+The `clearable` prop controls whether the clear (X) button appears in the dropdown. When set to `false`, the clear button is hidden.
+This is useful in two scenarios:
+1. When you have a separate "Reset" or "Defaults" button that handles clearing the selection (as shown in the Quick Pick example)
+2. When you don't want to provide any way to clear the selection (as shown in the Default and Subtle examples)

data/app/pb_kits/playbook/pb_dropdown/docs/_dropdown_with_constrain_height.jsx ADDED Viewed

@@ -0,0 +1,33 @@
+import React from 'react'
+import Dropdown from '../../pb_dropdown/_dropdown'
+const DropdownWithConstrainHeight = (props) => {
+  // Create a long list of options to demonstrate height constraint
+  const options = Array.from({ length: 30 }, (_, i) => ({
+    label: `Option ${i + 1}`,
+    value: `option_${i + 1}`,
+    id: `opt_${i + 1}`
+  }))
+  return (
+    <>
+      <Dropdown
+          data={{ testid: "dropdown-no-constrain" }}
+          label="Without Constrain Height (Default)"
+          marginBottom="md"
+          options={options}
+          {...props}
+      />
+      <Dropdown
+          constrainHeight
+          data={{ testid: "dropdown-constrain" }}
+          label="With Constrain Height"
+          options={options}
+          {...props}
+      />
+    </>
+  )
+}
+export default DropdownWithConstrainHeight

data/app/pb_kits/playbook/pb_dropdown/docs/_dropdown_with_constrain_height_rails.html.erb ADDED Viewed

@@ -0,0 +1,20 @@
+<%
+  # Create a long list of options to demonstrate height constraint
+  options = (1..30).map do |i|
+    { label: "Option #{i}", value: "option_#{i}", id: "opt_#{i}" }
+  end
+%>
+<%= pb_rails("dropdown", props: {
+  id: "dropdown-no-constrain",
+  options: options,
+  label: "Without Constrain Height (Default)",
+  margin_bottom: "md"
+}) %>
+<%= pb_rails("dropdown", props: {
+  id: "dropdown-constrain",
+  options: options,
+  constrain_height: true,
+  label: "With Constrain Height"
+}) %>

data/app/pb_kits/playbook/pb_dropdown/docs/_dropdown_with_constrain_height_rails.md ADDED Viewed

@@ -0,0 +1,8 @@
+The `constrain_height` prop limits the dropdown container height to 18em and enables vertical scrolling when the content exceeds this height. This prevents long dropdown lists from rendering off-screen.
+When `constrain_height` is `true`, the dropdown will:
+- Have a maximum height of 18em
+- Show a scrollbar when content exceeds the max height
+- Prevent the dropdown from extending beyond the viewport
+This is particularly useful for dropdowns with many options, such as long lists or quickpick variants with many date range options.

data/app/pb_kits/playbook/pb_dropdown/docs/_dropdown_with_constrain_height_react.md ADDED Viewed

@@ -0,0 +1,8 @@
+The `constrainHeight` prop limits the dropdown container height to 18em and enables vertical scrolling when the content exceeds this height. This prevents long dropdown lists from rendering off-screen.
+When `constrainHeight` is `true`, the dropdown will:
+- Have a maximum height of 18em
+- Show a scrollbar when content exceeds the max height
+- Prevent the dropdown from extending beyond the viewport
+This is particularly useful for dropdowns with many options, such as long lists or quickpick variants with many date range options.

data/app/pb_kits/playbook/pb_dropdown/docs/_dropdown_with_placeholder.html.erb ADDED Viewed

@@ -0,0 +1,9 @@
+<%
+  options = [
+    { label: 'United States', value: 'unitedStates', id: 'us' },
+    { label: 'Canada', value: 'canada', id: 'ca' },
+    { label: 'Pakistan', value: 'pakistan', id: 'pk' },
+  ]
+%>
+<%= pb_rails("dropdown", props: { options: options, placeholder: "Choose a country" }) %>

data/app/pb_kits/playbook/pb_dropdown/docs/_dropdown_with_placeholder.jsx ADDED Viewed

@@ -0,0 +1,33 @@
+import React from 'react'
+import Dropdown from '../../pb_dropdown/_dropdown'
+const DropdownWithPlaceholder = (props) => {
+  const options = [
+    {
+      label: "United States",
+      value: "unitedStates",
+      id: "us"
+    },
+    {
+      label: "Canada",
+      value: "canada",
+      id: "ca"
+    },
+    {
+      label: "Pakistan",
+      value: "pakistan",
+      id: "pk"
+    }
+  ];
+  return (
+    <Dropdown
+        options={options}
+        placeholder="Choose a country"
+        {...props}
+    />
+  )
+}
+export default DropdownWithPlaceholder

data/app/pb_kits/playbook/pb_dropdown/docs/_dropdown_with_placeholder.md ADDED Viewed

@@ -0,0 +1,3 @@
+The `placeholder` prop allows you to customize the placeholder text that appears when no option is selected in the dropdown.
+The placeholder prop works with all dropdown variants (`default`, `subtle`, and `quickpick`). When no option is selected, the placeholder text is displayed. When an option is selected, the placeholder is replaced by the selected option's label. The default placeholder text is "Select..." if no placeholder is provided.

data/app/pb_kits/playbook/pb_dropdown/docs/example.yml CHANGED Viewed

@@ -21,7 +21,10 @@ examples:
   - dropdown_default_value: Default Value
   - dropdown_multi_select_with_default: Multi Select Default Value
   - dropdown_blank_selection: Blank Selection
+  - dropdown_with_placeholder: Placeholder
   - dropdown_separators_hidden: Separators Hidden
+  - dropdown_with_clearable: Clearable
+  - dropdown_with_constrain_height_rails: Constrain Height
   - dropdown_quickpick_rails: Quick Pick Variant
   - dropdown_quickpick_range_end_rails: Quick Pick Variant (Range Ends Today)
   - dropdown_quickpick_default_dates: Quick Pick Variant (Default Dates)
@@ -52,7 +55,10 @@ examples:
   - dropdown_default_value: Default Value
   - dropdown_multi_select_with_default: Multi Select Default Value
   - dropdown_blank_selection: Blank Selection
+  - dropdown_with_placeholder: Placeholder
   - dropdown_clear_selection: Clear Selection
+  - dropdown_with_clearable: Clearable
+  - dropdown_with_constrain_height: Constrain Height
   - dropdown_separators_hidden: Separators Hidden
   - dropdown_with_external_control: useDropdown Hook
   - dropdown_quickpick: Quick Pick Variant

data/app/pb_kits/playbook/pb_dropdown/docs/index.js CHANGED Viewed

@@ -11,6 +11,7 @@ export { default as DropdownSubcomponentStructure } from './_dropdown_subcompone
 export { default as DropdownError } from './_dropdown_error.jsx'
 export { default as DropdownDefaultValue } from './_dropdown_default_value.jsx'
 export { default as DropdownBlankSelection } from './_dropdown_blank_selection.jsx'
+export { default as DropdownWithPlaceholder } from './_dropdown_with_placeholder.jsx'
 export { default as DropdownClearSelection } from './_dropdown_clear_selection.jsx'
 export { default as DropdownSubtleVariant } from './_dropdown_subtle_variant.jsx'
 export { default as DropdownSeparatorsHidden } from './_dropdown_separators_hidden.jsx'
@@ -27,4 +28,6 @@ export { default as DropdownQuickpick } from './_dropdown_quickpick.jsx'
 export { default as DropdownQuickpickRangeEnd } from './_dropdown_quickpick_range_end.jsx'
 export { default as DropdownQuickpickDefaultDates } from './_dropdown_quickpick_default_dates.jsx'
 export { default as DropdownQuickpickWithDatePickers } from './_dropdown_quickpick_with_date_pickers.jsx'
-export { default as DropdownQuickpickCustom } from './_dropdown_quickpick_custom.jsx'
+export { default as DropdownQuickpickCustom } from './_dropdown_quickpick_custom.jsx'
+export { default as DropdownWithClearable } from './_dropdown_with_clearable.jsx'
+export { default as DropdownWithConstrainHeight } from './_dropdown_with_constrain_height.jsx'

data/app/pb_kits/playbook/pb_dropdown/dropdown.html.erb CHANGED Viewed

@@ -18,8 +18,8 @@
             <%= content.presence %>
             <%= pb_rails("body", props: { status: "negative", text: object.error }) %>
         <% else %>
-            <%= pb_rails("dropdown/dropdown_trigger", props:{ autocomplete: object.autocomplete, multi_select:object.multi_select }) %>
-            <%= pb_rails("dropdown/dropdown_container", props: { searchbar: object.searchbar }) do %>
+            <%= pb_rails("dropdown/dropdown_trigger", props:{ autocomplete: object.autocomplete, multi_select:object.multi_select, placeholder: object.placeholder }) %>
+            <%= pb_rails("dropdown/dropdown_container", props: { searchbar: object.searchbar, constrain_height: object.constrain_height }) do %>
                 <% if options_with_blank.present? %>
                     <% options_with_blank.each do |option| %>
                         <%= pb_rails("dropdown/dropdown_option", props: {option: option}) %>

data/app/pb_kits/playbook/pb_dropdown/dropdown.rb CHANGED Viewed

@@ -36,6 +36,8 @@ module Playbook
                              default: ""
       prop :controls_start_id, type: Playbook::Props::String,
                                default: ""
+      prop :clearable, type: Playbook::Props::Boolean,
+                       default: true
       prop :start_date_id, type: Playbook::Props::String,
                            default: "start_date_id"
       prop :start_date_name, type: Playbook::Props::String,
@@ -44,12 +46,16 @@ module Playbook
                          default: "end_date_id"
       prop :end_date_name, type: Playbook::Props::String,
                            default: "end_date_name"
+      prop :placeholder, type: Playbook::Props::String
+      prop :constrain_height, type: Playbook::Props::Boolean,
+                              default: false
       def data
         Hash(prop(:data)).merge(
           pb_dropdown: true,
           pb_dropdown_multi_select: multi_select,
           pb_dropdown_variant: variant,
+          pb_dropdown_clearable: clearable,
           form_pill_props: form_pill_props.to_json,
           start_date_id: variant == "quickpick" ? start_date_id : nil,
           end_date_id: variant == "quickpick" ? end_date_id : nil,