playbook_ui 16.1.0.pre.rc.2 → 16.1.0.pre.rc.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b33580083b52f611802569a00b2e0cb6d8ae6aaa31f5a91ffc329649a4857834
-  data.tar.gz: 26448175846617514793f365ac4518dd47836608e0dc05ae295461cfb1778517
+  metadata.gz: 23eaf43827afe3364cfd4d2e9ab5cbb7c1da29851e28c70e0efe069a291e68f6
+  data.tar.gz: '05591b93014ec55478edfa95fb2d7c48fa8a82c11969c6bd5847f79817a26f77'
 SHA512:
-  metadata.gz: '04091c2ae2661ba6f1361b3e611e85f86b607efdfec658cbc48c57a7128565803535ea9cff192d7d3c1ca670cc69ce207d636b49b30d531815b310852985328d'
-  data.tar.gz: 553b79a320a6e6f2de774bd7ac22de0285dd27be4686c442de0560b1f495ddd7c9a28d4211c8a765f4b9b6040ed70a3ac49069278da2a631870f632cefa3ad43
+  metadata.gz: 88d25759c335f9c4178ce237e328adbd87b7bf57e2c39882a4cb7af2783ee383a5f52cdc59011f165c199be881f159887e7a348fa1abd7f04ee0793a456585a9
+  data.tar.gz: 628e81663cc1b9bf316d5734530510cbc721fa0afafb83aa8c5ac81d8200833a7cca94b49c432dee979fda90631715274c14cd2ab49ca5eb05df745d8a0ab906

data/app/pb_kits/playbook/pb_background/docs/_background_responsive.jsx

@@ -0,0 +1,30 @@
+import React from 'react'
+import Background from '../../pb_background/_background'
+
+const BackgroundResponsive = (props) => (
+  <>
+    <Background
+        alt="colorful background"
+        backgroundColor={{ xs: "primary", sm: "warning", md: "success", lg: "error", xl: "category_1" }}
+        className="background lazyload"
+        padding="xl"
+        {...props}
+    />
+    <br/>
+    <Background
+        alt="colorful background"
+        className="background lazyload"
+        imageUrl={{
+          xs: "https://unsplash.it/500/400/?image=633",
+          sm: "https://images.unsplash.com/photo-1528459801416-a9e53bbf4e17?ixlib=rb-1.2.1&ixid=eyJhcHBfaWQiOjEyMDd9&auto=format&fit=crop&w=1000&q=80",
+          md: "https://unsplash.it/500/400/?image=633",
+          lg: "https://images.unsplash.com/photo-1528459801416-a9e53bbf4e17?ixlib=rb-1.2.1&ixid=eyJhcHBfaWQiOjEyMDd9&auto=format&fit=crop&w=1000&q=80",
+          xl: "https://unsplash.it/500/400/?image=633"
+        }}
+        padding="xl"
+        {...props}
+    />
+  </>
+)
+
+export default BackgroundResponsive

data/app/pb_kits/playbook/pb_background/docs/_background_responsive.md

@@ -0,0 +1 @@
+The `backgroundColor`, `backgroundSize`, `backgroundPosition`, `backgroundRepeat`, and `imageUrl` props support responsive sizes. To use them, pass an object to the prop containing your values relative to responsive break points. To test this here, resize your browser window to responsively change these Backgrounds' `backgroundColor` and `imageUrl`.

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

@@ -20,3 +20,4 @@ examples:
   - background_category: Category
   - background_size: Size
   - background_overlay: Overlay
+  - background_responsive: Responsive

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

@@ -7,3 +7,4 @@ export { default as BackgroundStatusSubtle } from './_background_status_subtle.j
 export { default as BackgroundCategory } from './_background_category.jsx'
 export { default as BackgroundSize } from './_background_size.jsx'
 export { default as BackgroundOverlay } from './_background_overlay.jsx'
+export { default as BackgroundResponsive } from './_background_responsive.jsx'

data/app/pb_kits/playbook/pb_form/docs/_form_with_required_indicator.html.erb

@@ -1,6 +1,8 @@
 <%= pb_form_with(scope: :example, url: "", method: :get, validate: true) do |form| %>
   <%= form.text_field :example_text_field, props: { label: true, required: true, required_indicator: true } %>
   <%= form.text_field :example_text_field_2, props: { label: "Text Field Custom Label", required: true, required_indicator: true } %>
+  <%= form.text_area :example_text_area, props: { label: true, required: true, required_indicator: true } %>
+  <%= form.text_area :example_text_area_2, props: { label: "Textarea Custom Label", required: true, required_indicator: true } %>
   <%= form.email_field :example_email_field, props: { label: true, required: true, required_indicator: true } %>
   <%= form.number_field :example_number_field, props: { label: true, required: true, required_indicator: true } %>
   <%= form.search_field :example_search_field, props: { label: true, required: true, required_indicator: true } %>
@@ -11,4 +13,4 @@
     <%= action.submit %>
     <%= action.button props: { type: "reset", text: "Cancel", variant: "secondary" } %>
   <% end %>
-<% end %>
+<% end %>

data/app/pb_kits/playbook/pb_multi_level_select/docs/_multi_level_select_input_display.html.erb

@@ -0,0 +1,74 @@
+<% treeData = [{
+    label: "Power Home Remodeling",
+    value: "powerHomeRemodeling",
+    id: "100",
+    expanded: true,
+    children: [
+      {
+        label: "People",
+        value: "people",
+        id: "101",
+        expanded: true,
+        children: [
+          {
+            label: "Talent Acquisition",
+            value: "talentAcquisition",
+            id: "102",
+          },
+          {
+            label: "Business Affairs",
+            value: "businessAffairs",
+            id: "103",
+            children: [
+              {
+                label: "Initiatives",
+                value: "initiatives",
+                id: "104",
+              },
+              {
+                label: "Learning & Development",
+                value: "learningAndDevelopment",
+                id: "105",
+              },
+            ],
+          },
+          {
+            label: "People Experience",
+            value: "peopleExperience",
+            id: "106",
+          },
+        ],
+      },
+      {
+        label: "Contact Center",
+        value: "contactCenter",
+        id: "107",
+        children: [
+          {
+            label: "Appointment Management",
+            value: "appointmentManagement",
+            id: "108",
+          },
+          {
+            label: "Customer Service",
+            value: "customerService",
+            id: "109",
+          },
+          {
+            label: "Energy",
+            value: "energy",
+            id: "110",
+          },
+        ],
+      },
+    ],
+}] %>
+
+<%= pb_rails("multi_level_select", props: {
+    id: "multi-level-select-input-display-none",
+    name: :foo,
+    tree_data: treeData,
+    input_display: "none",
+    return_all_selected: true,
+    })
+%>

data/app/pb_kits/playbook/pb_multi_level_select/docs/_multi_level_select_input_display.jsx

@@ -0,0 +1,87 @@
+import React from "react";
+import MultiLevelSelect from "../_multi_level_select";
+
+const treeData = [
+  {
+    label: "Power Home Remodeling",
+    value: "powerHomeRemodeling",
+    id: "powerhome1",
+    expanded: true,
+    children: [
+      {
+        label: "People",
+        value: "people",
+        id: "people1",
+        expanded: true,
+        children: [
+          {
+            label: "Talent Acquisition",
+            value: "talentAcquisition",
+            id: "talent1",
+          },
+          {
+            label: "Business Affairs",
+            value: "businessAffairs",
+            id: "business1",
+            children: [
+              {
+                label: "Initiatives",
+                value: "initiatives",
+                id: "initiative1",
+              },
+              {
+                label: "Learning & Development",
+                value: "learningAndDevelopment",
+                id: "development1",
+              },
+            ],
+          },
+          {
+            label: "People Experience",
+            value: "peopleExperience",
+            id: "experience1",
+          },
+        ],
+      },
+      {
+        label: "Contact Center",
+        value: "contactCenter",
+        id: "contact1",
+        children: [
+          {
+            label: "Appointment Management",
+            value: "appointmentManagement",
+            id: "appointment1",
+          },
+          {
+            label: "Customer Service",
+            value: "customerService",
+            id: "customer1",
+          },
+          {
+            label: "Energy",
+            value: "energy",
+            id: "energy1",
+          },
+        ],
+      },
+    ],
+  },
+];
+
+const MultiLevelSelectInputDisplay = (props) => {
+  return (
+    <MultiLevelSelect
+        id="multi-level-select-input-display-none"
+        inputDisplay="none"
+        onSelect={(selectedNodes) =>
+          console.log("Selected Items", selectedNodes)
+        }
+        returnAllSelected
+        treeData={treeData}
+        {...props}
+    />
+  );
+};
+
+export default MultiLevelSelectInputDisplay;

data/app/pb_kits/playbook/pb_multi_level_select/docs/_multi_level_select_input_display.md

@@ -0,0 +1,3 @@
+Use the `inputDisplay`/`input_display` prop to optionally display only the count in the display as opposed to multiple pills. This prop is set to 'pills' by default.
+
+**NOTE**: `inputDisplay`/`input_display` is particularly useful for larger trees that may return many pill selections, helping to keep the input field clean and compact. This prop should not be used with the Single Select variant.

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

@@ -1,37 +1,39 @@
 examples:
   rails:
-  - multi_level_select_default: Default
-  - multi_level_select_single: Single Select
-  - multi_level_select_single_children_only: Single Select w/ Hidden Radios
-  - multi_level_select_return_all_selected: Return All Selected
-  - multi_level_select_selected_ids: Selected Ids
-  - multi_level_select_with_form: With Form
-  - multi_level_select_color: With Pills (Custom Color)
-  - multi_level_select_reset: Reset Selection
-  - multi_level_select_label: With Label
-  - multi_level_select_error: Error
-  - multi_level_select_disabled: Disabled Input
-  - multi_level_select_disabled_options_default: Disabled Options (Default)
-  - multi_level_select_disabled_options: Disabled Options (Return All Selected)
-  - multi_level_select_disabled_options_parent_default: Disabled Parent Option (Default)
-  - multi_level_select_disabled_options_parent: Disabled Parent Option (Return All Selected)
-  - multi_level_select_single_disabled: Disabled Options (Single Select)
+    - multi_level_select_default: Default
+    - multi_level_select_single: Single Select
+    - multi_level_select_single_children_only: Single Select w/ Hidden Radios
+    - multi_level_select_return_all_selected: Return All Selected
+    - multi_level_select_input_display: With Input Display None
+    - multi_level_select_selected_ids: Selected Ids
+    - multi_level_select_with_form: With Form
+    - multi_level_select_color: With Pills (Custom Color)
+    - multi_level_select_reset: Reset Selection
+    - multi_level_select_label: With Label
+    - multi_level_select_error: Error
+    - multi_level_select_disabled: Disabled Input
+    - multi_level_select_disabled_options_default: Disabled Options (Default)
+    - multi_level_select_disabled_options: Disabled Options (Return All Selected)
+    - multi_level_select_disabled_options_parent_default: Disabled Parent Option (Default)
+    - multi_level_select_disabled_options_parent: Disabled Parent Option (Return All Selected)
+    - multi_level_select_single_disabled: Disabled Options (Single Select)
 
   react:
-  - multi_level_select_default: Default
-  - multi_level_select_react_hook: React Hook
-  - multi_level_select_single: Single Select
-  - multi_level_select_single_children_only: Single Select w/ Hidden Radios
-  - multi_level_select_return_all_selected: Return All Selected
-  - multi_level_select_selected_ids_react: Selected Ids
-  - multi_level_select_color: With Pills (Custom Color)
-  - multi_level_select_with_children: Checkboxes With Children
-  - multi_level_select_with_children_with_radios: Single Select With Children
-  - multi_level_select_label: With Label
-  - multi_level_select_error: Error
-  - multi_level_select_disabled: Disabled Input
-  - multi_level_select_disabled_options_default: Disabled Options (Default)
-  - multi_level_select_disabled_options: Disabled Options (Return All Selected)
-  - multi_level_select_disabled_options_parent_default: Disabled Parent Option (Default)
-  - multi_level_select_disabled_options_parent: Disabled Parent Option (Return All Selected)
-  - multi_level_select_single_disabled: Disabled Options (Single Select)
+    - multi_level_select_default: Default
+    - multi_level_select_react_hook: React Hook
+    - multi_level_select_single: Single Select
+    - multi_level_select_single_children_only: Single Select w/ Hidden Radios
+    - multi_level_select_return_all_selected: Return All Selected
+    - multi_level_select_input_display: With Input Display None
+    - multi_level_select_selected_ids_react: Selected Ids
+    - multi_level_select_color: With Pills (Custom Color)
+    - multi_level_select_with_children: Checkboxes With Children
+    - multi_level_select_with_children_with_radios: Single Select With Children
+    - multi_level_select_label: With Label
+    - multi_level_select_error: Error
+    - multi_level_select_disabled: Disabled Input
+    - multi_level_select_disabled_options_default: Disabled Options (Default)
+    - multi_level_select_disabled_options: Disabled Options (Return All Selected)
+    - multi_level_select_disabled_options_parent_default: Disabled Parent Option (Default)
+    - multi_level_select_disabled_options_parent: Disabled Parent Option (Return All Selected)
+    - multi_level_select_single_disabled: Disabled Options (Single Select)

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

@@ -4,6 +4,7 @@ export { default as MultiLevelSelectSingleChildrenOnly } from './_multi_level_se
 export { default as MultiLevelSelectReturnAllSelected } from './_multi_level_select_return_all_selected.jsx'
 export { default as MultiLevelSelectSelectedIdsReact } from "./_multi_level_select_selected_ids_react.jsx"
 export { default as MultiLevelSelectColor } from './_multi_level_select_color.jsx'
+export { default as MultiLevelSelectInputDisplay } from './_multi_level_select_input_display.jsx'
 export { default as MultiLevelSelectWithChildren } from './_multi_level_select_with_children.jsx'
 export { default as MultiLevelSelectWithChildrenWithRadios } from './_multi_level_select_with_children_with_radios.jsx'
 export { default as MultiLevelSelectDisabled } from './_multi_level_select_disabled.jsx'

data/app/pb_kits/playbook/pb_rich_text_editor/_rich_text_editor.tsx

@@ -4,6 +4,8 @@ import { TrixEditor } from 'react-trix'
 
 import inlineFocus from './inlineFocus'
 import useFocus from './useFocus'
+import Caption from '../pb_caption/_caption'
+import colors from '../tokens/exports/_colors.module.scss'
 import { globalProps, GlobalProps } from '../utilities/globalProps'
 import { buildAriaProps, buildDataProps, noop, buildHtmlProps } from '../utilities/props'
 
@@ -40,12 +42,14 @@ type RichTextEditorProps = {
   inputOptions?: { [key: string]: string | number | boolean | (() => void) },
   id?: string,
   inline?: boolean,
+  label?: string,
   extensions?: { [key: string]: string }[],
   name?: string,
   onChange: (html: string, text: string) => void,
   placeholder?: string,
   inputHeight?: "sm" | "md" | "lg",
   inputMinHeight?: "sm" | "md" | "lg",
+  requiredIndicator?: boolean,
   simple?: boolean,
   sticky?: boolean,
   template: string,
@@ -64,6 +68,7 @@ const RichTextEditor = (props: RichTextEditorProps): React.ReactElement => {
     data = {},
     focus = false,
     htmlOptions = {},
+    id,
     inputOptions = {},
     inline = false,
     extensions,
@@ -76,7 +81,9 @@ const RichTextEditor = (props: RichTextEditorProps): React.ReactElement => {
     sticky = false,
     template = '',
     value = '',
-    maxWidth = "md"
+    maxWidth = "md",
+    requiredIndicator = false,
+    label,
   } = props
 
   const ariaProps = buildAriaProps(aria),
@@ -86,7 +93,7 @@ const RichTextEditor = (props: RichTextEditorProps): React.ReactElement => {
     containerRef = useRef<HTMLDivElement>(null)
 
   const htmlProps = buildHtmlProps(htmlOptions)
-  
+
   const handleOnEditorReady = (editorInstance: Editor) => {
     setEditor(editorInstance)
     setTimeout(() => {
@@ -94,7 +101,7 @@ const RichTextEditor = (props: RichTextEditorProps): React.ReactElement => {
       if (oldId) {
         const hiddenInput = document.getElementById(oldId)
         if (hiddenInput) {
-          const newId = (inputOptions.id as string) || oldId  
+          const newId = (inputOptions.id as string) || oldId
           hiddenInput.id = newId
           editorInstance.element.setAttribute('input', newId)
 
@@ -119,7 +126,7 @@ const RichTextEditor = (props: RichTextEditorProps): React.ReactElement => {
       // set button attributes
       inlineCodeButton.dataset.trixAttribute = 'inlineCode'
       blockCodeButton.insertAdjacentElement('afterend', inlineCodeButton)
-    } 
+    }
 
     if (toolbarBottom) editor.element.after(toolbarElement)
 
@@ -147,7 +154,7 @@ const RichTextEditor = (props: RichTextEditorProps): React.ReactElement => {
     if (!advancedEditor || !focus) return
 
     const handleFocus = () => setShowToolbarOnFocus(true)
-    
+
     const handleClickOutside = (event: Event) => {
       if (isClickInContainer(event) || isClickInPopover(event)) return
       setShowToolbarOnFocus(false)
@@ -215,9 +222,29 @@ const RichTextEditor = (props: RichTextEditorProps): React.ReactElement => {
         className={css}
         ref={focus ? containerRef : undefined}
     >
+    {label && (
+      <label  htmlFor={id}>
+        {
+          requiredIndicator ? (
+            <Caption className="pb_text_input_kit_label"
+                marginBottom="xs"
+            >
+              {label} <span style={{ color: `${colors.error}` }}>*</span>
+            </Caption>
+          ) : (
+            <Caption
+                className="pb_text_input_kit_label"
+                marginBottom="xs"
+                text={label}
+            />
+          )
+        }
+
+      </label>
+    )}
       {
         advancedEditor ? (
-          <div 
+          <div
               className={classnames(
                 "pb_rich_text_editor_advanced_container",
                 { [`input_height_${inputHeight}`]: !!inputHeight,[`input_min_height_${inputMinHeight}`]: !!inputMinHeight ,["toolbar-active"]: shouldShowToolbar }

data/app/pb_kits/playbook/pb_rich_text_editor/docs/_rich_text_editor_advanced_required_indicator.jsx

@@ -0,0 +1,35 @@
+import React from 'react'
+import RichTextEditor from '../../pb_rich_text_editor/_rich_text_editor'
+import { useEditor, EditorContent } from "@tiptap/react"
+import StarterKit from "@tiptap/starter-kit"
+import Link from '@tiptap/extension-link'
+
+
+const RichTextEditorAdvancedRequiredIndicator = (props) => {
+
+    const editor = useEditor({
+        extensions: [
+            StarterKit,
+            Link
+        ],
+        content:"Add your text here. You can format your text, add links, quotes, and bullets."
+    })
+      if (!editor) {
+        return null
+      }
+
+  return (
+    <div>
+      <RichTextEditor
+          advancedEditor={editor}
+          label="Label"
+          requiredIndicator
+          {...props}
+      >
+        <EditorContent editor={editor}/>
+      </RichTextEditor>
+    </div>
+  )
+}
+
+export default RichTextEditorAdvancedRequiredIndicator

data/app/pb_kits/playbook/pb_rich_text_editor/docs/_rich_text_editor_advanced_required_indicator.md

@@ -0,0 +1,3 @@
+The `requiredIndicator`/`required_indicator` prop displays a red asterisk (*) next to the label, visually indicating that the field is required. This is purely visual and does not enforce validation.
+
+You can use `requiredIndicator`/`required_indicator` with any validation approach: HTML5 validation via the `required` prop, client-side validation, or backend validation. For this reason, it works independently and doesn't need to be paired with the `required` prop.

data/app/pb_kits/playbook/pb_rich_text_editor/docs/_rich_text_editor_required_indicator.html.erb

@@ -0,0 +1,10 @@
+<%= pb_rails("rich_text_editor", props: {
+  id: "required-indicator",
+  input_options: {
+    id: 'hidden_input_id',
+    name: "hidden_input_name"
+  },
+  label: "Label",
+  required_indicator: true,
+  value: "Add your text here. You can format your text, add links, quotes, and bullets."
+}) %>

data/app/pb_kits/playbook/pb_rich_text_editor/docs/_rich_text_editor_required_indicator.jsx

@@ -0,0 +1,21 @@
+import React, { useState } from 'react'
+import RichTextEditor from '../../pb_rich_text_editor/_rich_text_editor'
+
+const RichTextEditorRequiredIndicator = (props) => {
+  const [value, setValue] = useState('Add your text here. You can format your text, add links, quotes, and bullets.'),
+  handleOnChange = (html) => setValue(html)
+
+  return (
+    <div>
+      <RichTextEditor
+          label="Label"
+          onChange={handleOnChange}
+          requiredIndicator
+          value={value}
+          {...props}
+      />
+    </div>
+  )
+}
+
+export default RichTextEditorRequiredIndicator

data/app/pb_kits/playbook/pb_rich_text_editor/docs/_rich_text_editor_required_indicator.md

@@ -0,0 +1,3 @@
+The `requiredIndicator`/`required_indicator` prop displays a red asterisk (*) next to the label, visually indicating that the field is required. This is purely visual and does not enforce validation.
+
+You can use `requiredIndicator`/`required_indicator` with any validation approach: HTML5 validation via the `required` prop, client-side validation, or backend validation. For this reason, it works independently and doesn't need to be paired with the `required` prop.

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

@@ -9,6 +9,7 @@ examples:
   - rich_text_editor_templates: Templates
   # - rich_text_editor_toolbar_bottom: Toolbar Bottom
   - rich_text_editor_inline: Inline
+  - rich_text_editor_required_indicator: Required Indicator
   - rich_text_editor_preview: Preview
 
   react:
@@ -31,5 +32,7 @@ examples:
   - rich_text_editor_advanced_inline: Advanced (Inline)
   - rich_text_editor_advanced_height: Advanced Height
   - rich_text_editor_advanced_min_height: Advanced Min Height
+  - rich_text_editor_required_indicator: Required Indicator
+  - rich_text_editor_advanced_required_indicator: Advanced Required Indicator
   - rich_text_editor_preview: Preview
   - rich_text_editor_advanced_preview: Advanced Preview

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

@@ -19,3 +19,5 @@ export { default as RichTextEditorAdvancedSticky } from './_rich_text_editor_adv
 export { default as RichTextEditorAdvancedInline } from './_rich_text_editor_advanced_inline.jsx'
 export { default as RichTextEditorAdvancedHeight } from './_rich_text_editor_advanced_height.jsx'
 export { default as RichTextEditorAdvancedMinHeight } from './_rich_text_editor_advanced_min_height.jsx'
+export { default as RichTextEditorRequiredIndicator } from './_rich_text_editor_required_indicator.jsx'
+export { default as RichTextEditorAdvancedRequiredIndicator } from './_rich_text_editor_advanced_required_indicator.jsx'

data/app/pb_kits/playbook/pb_rich_text_editor/rich_text_editor.rb

@@ -21,6 +21,9 @@ module Playbook
       prop :template
       prop :placeholder
       prop :input_options
+      prop :label
+      prop :required_indicator, type: Playbook::Props::Boolean,
+                                default: false
 
       def classname
         generate_classname("pb_rich_text_editor_kit", simple_class, focus_class, sticky_class, separator: " ")
@@ -51,6 +54,8 @@ module Playbook
           template: template,
           placeholder: placeholder,
           inputOptions: input_options,
+          label: label,
+          requiredIndicator: required_indicator,
         }
       end
     end