RubyGems - playbook_ui - Versions diffs - 14.20.0.pre.rc.2 → 14.20.0 - Mend

playbook_ui 14.20.0.pre.rc.2 → 14.20.0

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 (62) hide show

data/app/pb_kits/playbook/pb_dropdown/subcomponents/DropdownTrigger.tsx CHANGED Viewed

@@ -10,6 +10,7 @@ import { globalProps } from "../../utilities/globalProps";
 import { useHandleOnKeyDown } from "../hooks/useHandleOnKeydown";
 import DropdownContext from "../context";
+import MultiSelectTriggerDisplay from "./MultiSelectTriggerDisplay";
 import Body from "../../pb_body/_body";
 import Icon from "../../pb_icon/_icon";
@@ -44,12 +45,14 @@ const DropdownTrigger = (props: DropdownTriggerProps) => {
   const {
     autocomplete,
     filterItem,
+    handleBackspace,
     handleChange,
     handleWrapperClick,
     inputRef,
     inputWrapperRef,
     isDropDownClosed,
     isInputFocused,
+    multiSelect,
     selected,
     setIsInputFocused,
     toggleDropdown,
@@ -69,9 +72,19 @@ const DropdownTrigger = (props: DropdownTriggerProps) => {
   const triggerWrapperClasses = buildCss(
     "dropdown_trigger_wrapper",
     isInputFocused && "focus",
-    !autocomplete && "select_only"
+    !autocomplete && !multiSelect && "select_only"
   );
+  const selectedArray = Array.isArray(selected)
+    ? selected
+    : selected && Object.keys(selected).length
+    ? [selected]
+    : [];
+  const joinedLabels = multiSelect
+    ? ""
+    : selectedArray.map((option) => option.label).join(", ");
   const customDisplayPlaceholder = selected?.label ? (
     ""
   ) : autocomplete ? (
@@ -82,8 +95,8 @@ const DropdownTrigger = (props: DropdownTriggerProps) => {
     "Select..."
   );
-  const defaultDisplayPlaceholder = selected?.label
-    ? selected.label
+  const defaultDisplayPlaceholder = joinedLabels
+    ? joinedLabels
     : autocomplete
     ? ""
     : placeholder
@@ -125,23 +138,60 @@ const DropdownTrigger = (props: DropdownTriggerProps) => {
                   paddingX="sm"
                   paddingY="xs"
               >
-                <FlexItem>
-                  <Flex align="center">
+                <FlexItem fixedSize={multiSelect ? "85%" : ""}>
+                  <Flex align="center"
+                      wrap
+                  >
                     {customDisplay ? (
                       <Flex align="center">
                         {customDisplay}
                         <Body dark={dark}
-                            paddingLeft={`${selected.label ? "xs" : "none"}`}
+                            paddingLeft={`${joinedLabels ? "xs" : "none"}`}
                         >
                           {customDisplayPlaceholder}
                         </Body>
                       </Flex>
                     ) : (
-                      <Body dark={dark}
-                          text={defaultDisplayPlaceholder}
-                      />
+                      multiSelect ? (
+                        <>
+                        <MultiSelectTriggerDisplay
+                            autocomplete={autocomplete}
+                            dark={dark}
+                            placeholder={placeholder}
+                            selected={selectedArray}
+                        />
+                        {autocomplete && (
+                          <input
+                              className="dropdown_input"
+                              onChange={handleChange}
+                              onClick={(e) => {
+                                e.stopPropagation();// keep the wrapper’s handler from firing
+                                toggleDropdown();
+                              }}
+                              onFocus={() => setIsInputFocused(true)}
+                              onKeyDown={(e) => {
+                                 handleKeyDown(e);
+                                 e.stopPropagation(); //Fixes issue with keyboard accessibility
+                               }}
+                              placeholder={
+                                joinedLabels
+                                  ? ""
+                                  : placeholder
+                                  ? placeholder
+                                  : "Select..."
+                              }
+                              ref={inputRef}
+                              value={filterItem}
+                          />
+                        )}
+                        </>
+                      ) : (
+                        <Body dark={dark}
+                            text={defaultDisplayPlaceholder}
+                        />
+                      )
                     )}
-                    {autocomplete && (
+                    {autocomplete && !multiSelect && (
                       <input
                           className="dropdown_input"
                           onChange={handleChange}
@@ -152,7 +202,7 @@ const DropdownTrigger = (props: DropdownTriggerProps) => {
                           onFocus={() => setIsInputFocused(true)}
                           onKeyDown={handleKeyDown}
                           placeholder={
-                            selected.label
+                            joinedLabels
                               ? ""
                               : placeholder
                               ? placeholder
@@ -164,14 +214,29 @@ const DropdownTrigger = (props: DropdownTriggerProps) => {
                     )}
                   </Flex>
                 </FlexItem>
+                <FlexItem>
                   <Body
+                      alignItems="center"
                       dark={dark}
                       display="flex"
                       htmlOptions={{
                         onClick: (e: Event) => {e.stopPropagation();handleWrapperClick()}
                       }}
                       key={`${isDropDownClosed ? "chevron-down" : "chevron-up"}`}
-                  >
+                  >
+                  {
+                    selectedArray.length > 0 && (
+                      <div onClick={(e)=>{e.stopPropagation();handleBackspace()}}>
+                        <Icon
+                            cursor="pointer"
+                            dark={dark}
+                            icon="times"
+                            paddingRight="xs"
+                            size="sm"
+                        />
+                      </div>
+                    )
+                  }
                     <Icon
                         cursor="pointer"
                         dark={dark}
@@ -179,6 +244,7 @@ const DropdownTrigger = (props: DropdownTriggerProps) => {
                         size="sm"
                     />
                   </Body>
+                </FlexItem>
               </Flex>
             </>
           )

data/app/pb_kits/playbook/pb_dropdown/subcomponents/MultiSelectTriggerDisplay.tsx ADDED Viewed

@@ -0,0 +1,58 @@
+import React, { useContext } from "react";
+import FormPill from "../../pb_form_pill/_form_pill";
+import Flex from "../../pb_flex/_flex";
+import Body from "../../pb_body/_body";
+import { GenericObject } from "../../types";
+import DropdownContext
+ from "../context";
+type MultiSelectTriggerDisplayProps = {
+  autocomplete?: boolean;
+  selected: GenericObject[];
+  placeholder?: string;
+  dark?: boolean;
+};
+const MultiSelectTriggerDisplay = ({
+  autocomplete,
+  selected,
+  placeholder,
+  dark = false,
+}: MultiSelectTriggerDisplayProps) => {
+  const { setSelected, onSelect, formPillProps } = useContext(DropdownContext);
+  if (selected.length === 0) {
+    if (autocomplete) return null;
+    return (
+    <Body dark={dark}
+        text={placeholder ? placeholder : "Select..."}
+    />
+    )
+  }
+ const handleRemoveIconClick = (option: GenericObject) => {
+  setSelected((prev: GenericObject[]) => {
+      const next = prev.filter((item) => item.label !== option.label);
+      onSelect && onSelect(next);
+      return next;
+    });
+ }
+  return (
+    <Flex wrap>
+      {selected.map((option, i) => (
+          <FormPill
+              dark={dark}
+              key={i}
+              marginRight="xs"
+              onClick={(e)=>{e.stopPropagation();handleRemoveIconClick(option)}}
+              tabIndex={0}
+              text={option.label}
+              {...formPillProps}
+          />
+      ))}
+    </Flex>
+  );
+};
+export default MultiSelectTriggerDisplay;

data/app/pb_kits/playbook/pb_form/docs/_form_form_with.html.erb CHANGED Viewed

@@ -99,6 +99,7 @@
   <%= form.url_field :example_url_field, props: { label: true } %>
   <%= form.text_area :example_text_area, props: { label: true } %>
   <%= form.dropdown_field :example_dropdown, props: { label: true, options: example_dropdown_options } %>
+  <%= form.dropdown_field :example_dropdown_multi, props: { label: true, options: example_dropdown_options, multi_select: true } %>
   <%= form.select :example_select, [ ["Yes", 1], ["No", 2] ], props: { label: true } %>
   <%= form.collection_select :example_collection_select, example_collection, :value, :name, props: { label: true } %>
   <%= form.check_box :example_checkbox,

data/app/pb_kits/playbook/pb_form/docs/_form_form_with_validate.html.erb CHANGED Viewed

@@ -98,6 +98,7 @@
   <%= form.url_field :example_url_field_validation, props: { label: true, required: true } %>
   <%= form.text_area :example_text_area_validation, props: { label: true, required: true } %>
   <%= form.dropdown_field :example_dropdown_validation, props: { label: true, options: example_dropdown_options, required: true } %>
+  <%= form.dropdown_field :example_dropdown_validation_multi, props: { label: true, options: example_dropdown_options, multi_select: true, required: true } %>
   <%= form.select :example_select_validation, [ ["Yes", 1], ["No", 2] ], props: { label: true, blank_selection: "Select One...", required: true, validation_message: "Please, select an option." } %>
   <%= form.collection_select :example_collection_select_validation, example_collection, :value, :name, props: { label: true, blank_selection: "Select One...", required: true } %>
   <%= form.check_box :example_checkbox, props: { text: "Example Checkbox", label: true, required: true } %>

data/app/pb_kits/playbook/pb_typeahead/_typeahead.tsx CHANGED Viewed

@@ -29,6 +29,7 @@ import { GenericObject, Noop } from '../types'
  * @prop {boolean} async - whether Typeahead should fetch data from
  * a remote location to populate the options
  * @prop {string} label - the text for the optional typeahead input label
+ * @prop {boolean} preserveSearchInput - whether to preserve the input value when the field loses focus
  */
 type TypeaheadProps = {
@@ -54,6 +55,7 @@ type TypeaheadProps = {
   optionsByContext?: Record<string, Array<{ label: string; value?: string }>>
   searchContextSelector?: string,
   clearOnContextChange?: boolean,
+  preserveSearchInput?: boolean,
 } & GlobalProps
 export type SelectValueType = {
@@ -93,8 +95,44 @@ const Typeahead = forwardRef<HTMLInputElement, TypeaheadProps>(({
   optionsByContext = {},
   searchContextSelector,
   clearOnContextChange = false,
+  preserveSearchInput = false, // Default to false to maintain backward compatibility
   ...props
 }: TypeaheadProps) => {
+  // State to manage the input value when preserveSearchInput is true
+  const [inputValue, setInputValue] = useState("")
+  // If preserveSearchInput is true, we need to control the input value
+  const handleInputChange = preserveSearchInput
+    ? (newValue: string, actionMeta: {action: string}) => {
+        // Only update the input value for certain actions
+        if (actionMeta.action === 'input-change') {
+          setInputValue(newValue)
+        } else if (actionMeta.action === 'menu-close' && !props.value) {
+          // Don't clear the input when the menu closes without a selection
+          // unless the component is controlled and has a value
+        } else if (actionMeta.action === 'set-value') {
+          // When an option is selected, clear the input
+          setInputValue('')
+        }
+        // If the original onInputChange was provided, call it too
+        if (props.onInputChange) {
+          return props.onInputChange(newValue, actionMeta)
+        }
+        return newValue
+      }
+    : props.onInputChange
+  // Handle blur events if we're preserving input
+  const handleBlur = preserveSearchInput
+    ? (event: React.FocusEvent<HTMLInputElement>) => {
+        // Do not clear input on blur - the value is preserved in our state
+        if (props.onBlur) {
+          props.onBlur(event)
+        }
+      }
+    : props.onBlur
   const selectProps = {
     cacheOptions: true,
     components: {
@@ -124,11 +162,29 @@ const Typeahead = forwardRef<HTMLInputElement, TypeaheadProps>(({
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     onMultiValueClick: (_option: SelectValueType): any => undefined,
     pillColor: pillColor,
+    ...(preserveSearchInput ? { inputValue } : {}),
+    onInputChange: handleInputChange,
+    onBlur: handleBlur,
     ...props,
   }
   const [contextValue, setContextValue] = useState("")
+  // Add listener for clearing
+  useEffect(() => {
+    const handleClear = () => {
+      if (preserveSearchInput) {
+        setInputValue('')
+      }
+    }
+    document.addEventListener(`pb-typeahead-kit-${selectProps.id}:clear`, handleClear)
+    return () => {
+      document.removeEventListener(`pb-typeahead-kit-${selectProps.id}:clear`, handleClear)
+    }
+  }, [selectProps.id, preserveSearchInput])
   useEffect(() => {
     if (searchContextSelector) {
       const searchContextElement = document.getElementById(searchContextSelector)
@@ -137,7 +193,12 @@ const Typeahead = forwardRef<HTMLInputElement, TypeaheadProps>(({
       const handleContextChange = (e: Event) => {
         const target = e.target as HTMLInputElement;
         setContextValue(target.value);
-        if (clearOnContextChange) document.dispatchEvent(new CustomEvent(`pb-typeahead-kit-${selectProps.id}:clear`))
+        if (clearOnContextChange) {
+          document.dispatchEvent(new CustomEvent(`pb-typeahead-kit-${selectProps.id}:clear`))
+          if (preserveSearchInput) {
+            setInputValue('')
+          }
+        }
       }
       if (searchContextElement) searchContextElement.addEventListener('change', handleContextChange)
@@ -146,7 +207,7 @@ const Typeahead = forwardRef<HTMLInputElement, TypeaheadProps>(({
         if (searchContextElement) searchContextElement.removeEventListener('change', handleContextChange)
       }
     }
-  }, [searchContextSelector])
+  }, [searchContextSelector, clearOnContextChange, selectProps.id, preserveSearchInput])
   const contextArray = optionsByContext[contextValue]
   if (Array.isArray(contextArray) && contextArray.length > 0) {
@@ -168,7 +229,12 @@ const Typeahead = forwardRef<HTMLInputElement, TypeaheadProps>(({
         onChange(_data)
       }
     }
+    // If a value is selected and we're preserving input on blur, clear the input
+    if (action === 'select-option' && preserveSearchInput) {
+      setInputValue('')
+    }
     if (action === 'select-option') {
       if (selectProps.onMultiValueClick) selectProps.onMultiValueClick(option)
       const multiValueClearEvent = new CustomEvent(`pb-typeahead-kit-${selectProps.id}-result-option-select`, { detail: option ? option : _data })
@@ -181,6 +247,10 @@ const Typeahead = forwardRef<HTMLInputElement, TypeaheadProps>(({
     if (action === 'clear') {
       const multiValueClearEvent = new CustomEvent(`pb-typeahead-kit-${selectProps.id}-result-clear`)
       document.dispatchEvent(multiValueClearEvent)
+      // If preserving input on blur, also clear input on explicit clear
+      if (preserveSearchInput) {
+        setInputValue('')
+      }
     }
   }

data/app/pb_kits/playbook/pb_typeahead/docs/_typeahead_preserve_input.jsx ADDED Viewed

@@ -0,0 +1,23 @@
+import React from 'react'
+import Typeahead from '../_typeahead'
+const options = [
+  { label: 'Orange', value: '#FFA500' },
+  { label: 'Red', value: '#FF0000' },
+  { label: 'Green', value: '#00FF00' },
+  { label: 'Blue', value: '#0000FF' },
+]
+const TypeaheadPreserveInput = (props) => {
+  return (
+    <Typeahead
+        label="Colors"
+        options={options}
+        preserveSearchInput
+        {...props}
+    />
+  )
+}
+export default TypeaheadPreserveInput

data/app/pb_kits/playbook/pb_typeahead/docs/_typeahead_preserve_input.md ADDED Viewed

	@@ -0,0 +1 @@
1	+ By default, text is not preserved in the typeahead kit when you click off of the input field. You can utilize the `preserveSearchInput` prop in order to prevent text from being cleared when the field loses focus

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

@@ -34,3 +34,4 @@ examples:
     - typeahead_with_pills_color: With Pills (Custom Color)
     - typeahead_truncated_text: Truncated Text
     - typeahead_disabled: Disabled
+    - typeahead_preserve_input: Preserve Search Input

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

@@ -15,3 +15,4 @@ export { default as TypeaheadWithPillsColor } from './_typeahead_with_pills_colo
 export { default as TypeaheadTruncatedText } from './_typeahead_truncated_text.jsx'
 export { default as TypeaheadReactHook } from './_typeahead_react_hook.jsx'
 export { default as TypeaheadDisabled } from './_typeahead_disabled.jsx'
+export { default as TypeaheadPreserveInput } from './_typeahead_preserve_input.jsx'