playbook_ui 14.18.0.pre.rc.1 → 14.18.0.pre.rc.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8282ca482f5d5a4c19aa8a14d0589227d91b464faf6ee5f9e1034a5effd50e72
-  data.tar.gz: 0f5904c39418d95cc938d81f598dc36bed48063192050337cb708057cd4bfa7b
+  metadata.gz: 6365ffa349a3400e9838c6825d30fea0a806ea9e2cef468b45911071fe84fd2f
+  data.tar.gz: 2f491f5d69a296241312690575ccf94a08b985e67595ce116ec00e63081c78a6
 SHA512:
-  metadata.gz: de9dd899e7c2086885016d8f6ab780cf23ce1ad5429858d7379426bf31ee8aaec35123e3ea0aa29f599afbf3695590a746853b073691709929ac12412da3e986
-  data.tar.gz: c1e7da09113948ec469fd9fb76df9136c4867477d5eb80e126844bd57d26e0d12663079679e3ad3df66592d8a69ae8afbf6ef380f00aba77d2ad26025922d484
+  metadata.gz: 1dda3b47457cd1a0fa42f75c445b061f0a63a69a512811166ac3ff0458a31375a4bbe563259cddcb64f0082de48cc8f22eecaa49d8842b400caa101b92c3d0b0
+  data.tar.gz: 78c8e1619dba55b47099e415283da83f47bd4b8cbc6740f16c83e4a7a6df0070e806e8b98b5ade9c51f1fb839b46681bfe15fd7f148b623c6d88eec1190c05a6

data/app/pb_kits/playbook/pb_copy_button/_copy_button.tsx

@@ -1,5 +1,4 @@
-
-import React, { useState } from 'react'
+import React from 'react'
 import classnames from 'classnames'
 import { buildAriaProps, buildCss, buildDataProps } from '../utilities/props'
 import { globalProps } from '../utilities/globalProps'
@@ -7,16 +6,19 @@ import { globalProps } from '../utilities/globalProps'
 import Button from '../pb_button/_button'
 import Tooltip from '../pb_tooltip/_tooltip'
 
+import usePBCopy from './usePBCopy'
+
 type CopyButtonProps = {
-  aria?: { [key: string]: string },
-  className?: string,
-  data?: { [key: string]: string },
-  id?: string,
-  from?: string,
-  text?: string,
-  tooltipPlacement?:  "top" | "right" | "bottom" | "left",
-  tooltipText?: string,
-  value?: string,
+  aria?: { [key: string]: string }
+  className?: string
+  data?: { [key: string]: string }
+  id?: string
+  from?: string
+  text?: string
+  tooltipPlacement?: 'top' | 'right' | 'bottom' | 'left'
+  tooltipText?: string
+  value?: string
+  timeout?: number
 }
 
 const CopyButton = (props: CopyButtonProps) => {
@@ -27,62 +29,34 @@ const CopyButton = (props: CopyButtonProps) => {
     from = '',
     id,
     text= 'Copy',
+    timeout = 1000,
     tooltipPlacement= 'bottom',
     tooltipText = 'Copied!',
     value = '',
   } = props
 
-  const [copied, setCopied] = useState(false)
+  const [copied, copy] = usePBCopy({ value, from, timeout })
 
   const ariaProps = buildAriaProps(aria)
   const dataProps = buildDataProps(data)
   const classes = classnames(buildCss('pb_copy_button_kit'), globalProps(props), className)
 
-  const copy = () => {
-    if (!from && !value) {
-      return
-    }
-
-    if (value) {
-      navigator.clipboard.writeText(value)
-    } else if (from) {
-      const copyElement = document.getElementById(from);
-      let copyText = copyElement?.innerText
-
-      if (copyElement instanceof HTMLTextAreaElement || copyElement instanceof HTMLInputElement) {
-        copyText = copyElement.value;
-      }
-
-      if (copyText) {
-        navigator.clipboard.writeText(copyText)
-      }
-    }
-
-    setCopied(true)
-
-    setTimeout(() => {
-      setCopied(false)
-    }, 1000);
-  }
-
   return (
-    <div
-        {...ariaProps}
+    <div {...ariaProps}
         {...dataProps}
         className={classes}
         id={id}
     >
-      <Tooltip 
+      <Tooltip
           forceOpenTooltip={copied}
           placement={tooltipPlacement}
           showTooltip={false}
           text={tooltipText}
       >
-        <Button
-            icon='copy'
+        <Button icon="copy"
             onClick={copy}
         >
-          { text }
+          {text}
         </Button>
       </Tooltip>
     </div>

data/app/pb_kits/playbook/pb_copy_button/docs/_copy_button_hook.jsx

@@ -0,0 +1,54 @@
+import React, { useEffect, useState } from 'react'
+import usePBCopy from '../../pb_copy_button/usePBCopy'
+import Body from '../../pb_body/_body'
+import Textarea from '../../pb_textarea/_textarea'
+import Tooltip from '../../pb_tooltip/_tooltip'
+
+const CopyButtonHook = ({...props}) => {
+  // This is how you can use the copy button hook to copy text to the clipboard
+  // eslint-disable-next-line no-unused-vars
+  const [copied, copyToClipboard] = usePBCopy({ from: 'hookbody' })
+  // I added a tooltip so it looks better in the ui
+  const [showTooltip, setShowTooltip] = useState(false)
+
+  const handleCopy = () => {
+    copyToClipboard()
+    setShowTooltip(true)
+    setTimeout(() => setShowTooltip(false), 1500)
+  }
+
+  useEffect(() => {
+    const el = document.getElementById('hookbody')
+    if (!el) return
+
+    el.addEventListener('click', handleCopy)
+    return () => {
+      el.removeEventListener('click', handleCopy)
+    }
+  }, [copyToClipboard])
+
+  return (
+    <div>
+      <Tooltip
+          delay={{ close: 1000 }}
+          forceOpenTooltip={showTooltip}
+          placement="top"
+          showTooltip={false}
+          text="Copied!"
+      >
+        <Body
+            cursor="pointer"
+            id="hookbody"
+            text="I'm a custom copy hook! Click this body to copy this text!"
+        />
+      </Tooltip>
+
+      <Textarea
+          {...props}
+          placeholder="Paste here"
+      />
+    </div>
+  )
+}
+
+export default CopyButtonHook

data/app/pb_kits/playbook/pb_copy_button/docs/_copy_button_hook.md

@@ -0,0 +1,3 @@
+We provide a `usePBCopy` hook that you can import to your project. This hook will return a function that you can call to copy the text to the clipboard.
+
+`usePBCopy({ from: 'your_id' })` will grab the `innerText` from `your_id` element, or `value` if it is an input element.

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

@@ -6,3 +6,4 @@ examples:
   react:
   - copy_button_default: Default
   - copy_button_from: Copy From
+  - copy_button_hook: Copy Hook

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

@@ -1,2 +1,3 @@
 export { default as CopyButtonDefault } from './_copy_button_default.jsx'
-export { default as CopyButtonFrom } from './_copy_button_from.jsx'
+export { default as CopyButtonFrom } from './_copy_button_from.jsx' 
+export { default as CopyButtonHook } from './_copy_button_hook.jsx'

data/app/pb_kits/playbook/pb_copy_button/usePBCopy.ts

@@ -0,0 +1,45 @@
+import { useState, useRef, useEffect } from 'react'
+
+type UsePBCopyProps = {
+  value?: string
+  from?: string
+  timeout?: number
+}
+
+export default function usePBCopy({
+  value = '',
+  from = '',
+  timeout = 0,
+}: UsePBCopyProps) {
+  const [copied, setCopied] = useState(false)
+  const timerRef = useRef<number>()
+
+  const copy = () => {
+    if (!value && !from) return
+
+    if (value) {
+      navigator.clipboard.writeText(value)
+    } else {
+      const el = document.getElementById(from)
+      let text = el?.innerText
+      if (el instanceof HTMLTextAreaElement || el instanceof HTMLInputElement) {
+        text = el.value
+      }
+      if (text) navigator.clipboard.writeText(text)
+    }
+
+    setCopied(true)
+    window.clearTimeout(timerRef.current)
+    timerRef.current = window.setTimeout(() => {
+      setCopied(false)
+    }, timeout)
+  }
+
+  useEffect(() => {
+    return () => {
+      window.clearTimeout(timerRef.current)
+    }
+  }, [])
+
+  return [copied, copy] as const
+}

data/app/pb_kits/playbook/pb_form_group/_form_group.scss

@@ -97,7 +97,7 @@
     }   
   }
 
-  & > [class^=pb_phone_number_input]:not(:first-child) {
+  & > [class^=pb_phone_number_input]:not(:first-child), [class^=pb_passphrase]:not(:first-child) {
     .text_input_wrapper input, [class^=pb_text_input_kit] .text_input_wrapper .text_input {
       border-bottom-left-radius: 0;
       border-top-left-radius: 0;
@@ -243,4 +243,8 @@
       padding-left: calc(var(--iti-flag-width) + 1px);
     }
   }
+  
+  &:has(> [class^="pb_select"]):has(> .pb_passphrase) [class^="pb_select"] {
+      align-self: baseline;
+  }
 }

data/app/pb_kits/playbook/pb_form_group/docs/_form_group_select.jsx

@@ -1,12 +1,16 @@
-import React from 'react'
+import React, {useState} from 'react'
 
 import FormGroup from '../_form_group'
 import PhoneNumberInput from '../../pb_phone_number_input/_phone_number_input'
 import Select from '../../pb_select/_select'
 import TextInput from '../../pb_text_input/_text_input'
 import Flex from '../../pb_flex/_flex'
+import Passphrase from '../../pb_passphrase/_passphrase'
 
 const FormGroupSelect = (props) => {
+  const [input, setInput] = useState("");
+  const handleChange = (e) => setInput(e.target.value);
+
   const options = [
     { value: 'Country' },
     { value: 'Pop' },
@@ -63,6 +67,20 @@ const FormGroupSelect = (props) => {
           {...props}
       />
     </FormGroup>
+    <FormGroup>
+        <Select 
+            blankSelection="Phone" 
+            options={phoneOptions}
+            {...props}
+        />
+        <Passphrase
+            id="my-passphrase"
+            label=""
+            onChange={handleChange}
+            value={input}
+            {...props}
+        />
+      </FormGroup>
     </Flex>
   )
 }

data/app/pb_kits/playbook/pb_table/_table.tsx

@@ -84,8 +84,8 @@ const Table = (props: TableProps): React.ReactElement => {
             'single-line': singleLine,
             'no-hover': disableHover,
             'sticky-header': sticky,
-            'sticky-left-column': stickyLeftColumn,
-            'sticky-right-column': stickyRightColumn,
+            'sticky-left-column': stickyLeftColumn.length,
+            'sticky-right-column': stickyRightColumn.length,
             'striped': striped,
             'header-borderless': headerStyle === 'borderless',
             'header-floating': headerStyle === 'floating',

data/app/pb_kits/playbook/pb_table/docs/_table_with_collapsible_with_nested_rows.md

@@ -1,3 +1,5 @@
 The `collapsibleContent` can display any content, including nested Table Rows. 
 
-Additionally, the `collapsibleSideHighlight` can also be removed by setting it to false if needed. This prop is set to true by default. 
+Additionally, the `collapsibleSideHighlight` can also be removed by setting it to false if needed. This prop is set to true by default. 
+
+**NOTE**: We advise against using the `disableHover` Table prop when nesting Table Rows within a Table.

data/app/pb_kits/playbook/pb_table/docs/_table_with_collapsible_with_nested_rows_rails.md

@@ -1,3 +1,5 @@
 The `collapsible_content` can display any content, including nested Table Rows.
 
-Additionally, the `collapsible_side_highlight` can also be removed by setting it to false if needed. This prop is set to true by default.
+Additionally, the `collapsible_side_highlight` can also be removed by setting it to false if needed. This prop is set to true by default.
+
+**NOTE**: We advise against using the `disable_hover` Table prop when nesting Table Rows within a Table.

data/app/pb_kits/playbook/pb_table/docs/_table_with_collapsible_with_nested_table.md

@@ -1 +1,3 @@
-The `collapsibleContent` can also be used to display nested Tables within each Row. 
+The `collapsibleContent` can also be used to display nested Tables within each Row. 
+
+**NOTE**: We advise against using the `disableHover` Table prop when nesting Tables within a Table.

data/app/pb_kits/playbook/pb_table/docs/_table_with_collapsible_with_nested_table_rails.md

@@ -1 +1,3 @@
-The `collapsible_content` can also be used to display nested Tables within each Row.
+The `collapsible_content` can also be used to display nested Tables within each Row.
+
+**NOTE**: We advise against using the `disable_hover` Table prop when nesting Tables within a Table.

data/app/pb_kits/playbook/pb_table/styles/_collapsible.scss

@@ -48,4 +48,4 @@
   .border-active {
     border-bottom: 1px;
   }
-}
+}

data/app/pb_kits/playbook/pb_text_input/_text_input.tsx

@@ -25,7 +25,7 @@ type TextInputProps = {
   name: string,
   label: string,
   mask?: 'currency' | 'zipCode' | 'postalCode' | 'ssn',
-  onChange: (e: React.FormEvent<HTMLInputElement>) => void,
+  onChange: (e: React.FormEvent<HTMLInputElement>, sanitizedValue?: string) => void,
   placeholder: string,
   required?: boolean,
   type: string,
@@ -102,10 +102,16 @@ const TextInput = (props: TextInputProps, ref: React.LegacyRef<HTMLInputElement>
 
       let cursorPosition = e.target.selectionStart;
       const isAtEnd = cursorPosition === inputValue.length;
-      
+
       const formattedValue = INPUTMASKS[mask].format(inputValue)
+
+      let sanitizedValue = formattedValue;
+      if (INPUTMASKS[mask].sanitize) {
+        sanitizedValue = INPUTMASKS[mask].sanitize(formattedValue)
+      }
+
       e.target.value = formattedValue
-      
+
       // Keep cursor position
       if (!isAtEnd) {
         // Account for extra characters (e.g., commas added/removed in currency)
@@ -116,9 +122,11 @@ const TextInput = (props: TextInputProps, ref: React.LegacyRef<HTMLInputElement>
         }
         e.target.selectionStart = e.target.selectionEnd = cursorPosition
       }
+
+      onChange(e, sanitizedValue);
+    } else {
+      onChange(e)
     }
-    
-    onChange(e)
   }
 
   const childInput = children ? children.type === "input" : undefined

data/app/pb_kits/playbook/pb_text_input/docs/_text_input_sanitize.jsx

@@ -0,0 +1,94 @@
+import React, { useState } from 'react'
+
+import TextInput from '../../pb_text_input/_text_input'
+
+const TextInputSanitize = (props) => {
+  const ref = React.createRef()
+
+  const [currency, setCurrency] = useState('')
+  const [sanitizedCurrency, setSanitizedCurrency] = useState('')
+  const handleOnChangeSanitizeCurrency = ({ target }, sanitizedValue) => {
+    setCurrency(target.value)
+    setSanitizedCurrency(sanitizedValue);
+  }
+
+  const [creditCard, setCreditCard] = useState('')
+  const [sanitizedCreditCard, setSanitizedCreditCard] = useState('')
+  const handleOnChangeSanitizeCC = ({ target }, sanitizedValue) => {
+    setCreditCard(target.value)
+    setSanitizedCreditCard(sanitizedValue);
+  }
+
+  const [ssn, setSSN] = useState('')
+  const [sanitizedSSN, setSanitizedSSN] = useState('')
+  const handleOnChangeSanitizeSSN = ({ target }, sanitizedValue) => {
+    setSSN(target.value)
+    setSanitizedSSN(sanitizedValue);
+  }
+
+  return (
+    <div>
+      <TextInput
+          label="Currency"
+          mask="currency"
+          onChange={handleOnChangeSanitizeCurrency}
+          placeholder="Enter Amount"
+          ref={ref}
+          value={currency}
+          {...props}
+      />
+
+      {currency !== "" && (
+        <React.Fragment>{`The masked value is: ${currency}`}</React.Fragment>
+      )}
+      <br />
+      {sanitizedCurrency !== "" && (
+        <React.Fragment>{`The sanitized value is: ${sanitizedCurrency}`}</React.Fragment>
+      )}
+
+      <br />
+      <br />
+
+      <TextInput
+          label="Credit Card"
+          mask="creditCard"
+          onChange={handleOnChangeSanitizeCC}
+          placeholder="Enter Card"
+          ref={ref}
+          value={creditCard}
+          {...props}
+      />
+
+      {creditCard !== "" && (
+        <React.Fragment>{`The masked value is: ${creditCard}`}</React.Fragment>
+      )}
+      <br />
+      {sanitizedCreditCard !== "" && (
+        <React.Fragment>{`The sanitized value is: ${sanitizedCreditCard}`}</React.Fragment>
+      )}
+
+      <br />
+      <br />
+
+      <TextInput
+          label="SSN"
+          mask="ssn"
+          onChange={handleOnChangeSanitizeSSN}
+          placeholder="Enter Amount"
+          ref={ref}
+          value={ssn}
+          {...props}
+      />
+
+      {ssn !== "" && (
+        <React.Fragment>{`The masked value is: ${ssn}`}</React.Fragment>
+      )}
+      <br />
+      {sanitizedSSN !== "" && (
+        <React.Fragment>{`The sanitized value is: ${sanitizedSSN}`}</React.Fragment>
+      )}
+    </div>
+  )
+}
+
+export default TextInputSanitize

data/app/pb_kits/playbook/pb_text_input/docs/_text_input_sanitize.md

@@ -0,0 +1 @@
+When utilizing the Mask prop, you can retrieve the sanitized value of your input through an event handler that targets `sanitizedValue`.

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

@@ -18,6 +18,8 @@ examples:
   - text_input_inline: Inline
   - text_input_no_label: No Label
   - text_input_mask: Mask
+  - text_input_sanitize: Sanitized Masked Input
+
 
   swift:
     - text_input_default_swift: Default

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

@@ -6,3 +6,4 @@ export { default as TextInputAddOn } from './_text_input_add_on.jsx'
 export { default as TextInputInline } from './_text_input_inline.jsx'
 export { default as TextInputNoLabel } from './_text_input_no_label.jsx'
 export { default as TextInputMask } from './_text_input_mask.jsx'
+export { default as TextInputSanitize } from './_text_input_sanitize.jsx'

data/app/pb_kits/playbook/pb_text_input/inputMask.ts

@@ -3,6 +3,7 @@ type InputMask = {
     formatDefaultValue: (value: string) => string
     pattern: string
     placeholder: string
+    sanitize?: (value: string) => string;
 }
 
 type InputMaskDictionary = {
@@ -73,35 +74,41 @@ export const INPUTMASKS: InputMaskDictionary = {
         // eslint-disable-next-line no-useless-escape
         pattern: '^\\$\\d{1,3}(?:,\\d{3})*(?:\\.\\d{2})?$',
         placeholder: '$0.00',
+        sanitize: (value: string) => value.replace(/[$,]/g, ''),
     },
     zipCode: {
         format: formatBasicPostal,
         formatDefaultValue: formatBasicPostal,
         pattern: '\\d{5}',
         placeholder: '12345',
+        sanitize: (value: string) => value,
     },
     postalCode: {
         format: formatExtendedPostal,
         formatDefaultValue: formatExtendedPostal,
         pattern: '\\d{5}-\\d{4}',
         placeholder: '12345-6789',
+        sanitize: (value: string) => value.replace(/-/g, ''),
     },
     ssn: {
         format: formatSSN,
         formatDefaultValue: formatSSN,
         pattern: '\\d{3}-\\d{2}-\\d{4}',
         placeholder: '123-45-6789',
+        sanitize: (value: string) => value.replace(/-/g, ''),
     },
     creditCard: {
         format: formatCreditCard,
         formatDefaultValue: formatCreditCard,
         pattern: '\\d{4} \\d{4} \\d{4} \\d{4}',
         placeholder: '1234 5678 9012 3456',
+        sanitize: (value: string) => value.replace(/\s/g, ''),
     },
     cvv: {
         format: formatCVV,
         formatDefaultValue: formatCVV,
         pattern: '\\d{3,4}',
         placeholder: '123',
+        sanitize: (value: string) => value,
     },
-} 
+}