playbook_ui 14.18.0.pre.rc.3 → 14.18.0

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

@@ -1,6 +1,33 @@
 import PbEnhancedElement from "../pb_enhanced_element"
 
-export default class PbCopyButton extends PbEnhancedElement {
+function getTextFromElement(element) {
+  if (!element) return ''
+  return element.tagName.toLowerCase() === 'input'
+    ? element.value
+    : element.innerText
+}
+
+function copyTextToClipboard(text) {
+  if (!text) return
+  navigator.clipboard.writeText(text)
+    .catch(err => console.error('Failed to copy text:', err))
+}
+
+function handleExternalControlCopyClick(element) {
+  const value = element.getAttribute('data-external-copy-value')
+  const fromId = element.getAttribute('data-external-copy-from')
+
+  if (value) {
+    copyTextToClipboard(value)
+  } else if (fromId) {
+    const fromElement = document.querySelector(`#${fromId}`)
+    copyTextToClipboard(getTextFromElement(fromElement))
+  } else {
+    console.warn('Failed to copy:', element)
+  }
+}
+
+export class PbCopyButton extends PbEnhancedElement {
   static get selector() {
     return '.pb_copy_button_kit'
   }
@@ -20,28 +47,27 @@ export default class PbCopyButton extends PbEnhancedElement {
   }
 
   handleClick() {
+    const value = this.element.getAttribute('data-copy-value')
     const fromId = this.element.getAttribute('data-from')
-    if (fromId) {
-      const fromElement = document.querySelector(`#${fromId}`)
-      if (fromElement) {
-        let contentToCopy = ''
-        if (fromElement.tagName.toLowerCase() === 'input') {
-          contentToCopy = fromElement.value
-        } else {
-          contentToCopy = fromElement.innerText
-        }
-        navigator.clipboard.writeText(contentToCopy)
-          .catch(err => console.error('Failed to copy text', err))
-        return
-      }
-    }
 
-    const textToCopy = this.element.getAttribute('data-copy-value')
-    if (textToCopy) {
-      navigator.clipboard.writeText(textToCopy)
-        .catch(err => console.error('Failed to copy text', err))
+    if (value) {
+      copyTextToClipboard(value)
+    } else if (fromId) {
+      const fromElement = document.querySelector(`#${fromId}`)
+      copyTextToClipboard(getTextFromElement(fromElement))
     } else {
-      console.warn('No data-copy-value attribute found or data-from element')
+      console.warn('No data-copy-value or data-from attribute found')
     }
   }
 }
+
+export function addCopyEventListeners() {
+  const externalCopyElements = [
+    ...document.querySelectorAll('div[data-external-copy-value]'),
+    ...document.querySelectorAll('div[data-external-copy-from]')
+  ]
+
+  externalCopyElements.forEach(element => {
+    element.addEventListener('click', () => handleExternalControlCopyClick(element))
+  })
+}

data/app/pb_kits/playbook/pb_dialog/dialog.html.erb

@@ -1,7 +1,16 @@
 <div
     class="pb_dialog_wrapper_rails <%= object.full_height_style %>"
     data-pb-dialog-wrapper="true"
-    data-overlay-click= <%= object.overlay_close %>
+    data-overlay-click="<%= object.overlay_close %>"
+    <% if object.custom_event_type.present? %>
+        data-custom-event-type="<%= object.custom_event_type %>"
+    <% end %>
+    <% if object.confirm_button_id.present? %>
+        data-confirm-button-id="<%= object.confirm_button_id %>"
+    <% end %>
+    <% if object.cancel_button_id.present? %>
+        data-cancel-button-id="<%= object.cancel_button_id %>"
+    <% end %>
 >
     <%= pb_content_tag(:dialog) do %>
             <% if object.status === "" && object.title %>

data/app/pb_kits/playbook/pb_dialog/dialog.rb

@@ -21,6 +21,8 @@ module Playbook
       prop :status, type: Playbook::Props::Enum,
                     values: ["info", "caution", "delete", "error", "success", "default", ""],
                     default: ""
+      prop :custom_event_type, type: Playbook::Props::String,
+                               default: ""
 
       def classname
         generate_classname("pb_dialog pb_dialog_rails pb_dialog_#{size}_#{placement}")

data/app/pb_kits/playbook/pb_dialog/docs/_dialog_turbo_frames.html.erb

@@ -0,0 +1,117 @@
+<%= pb_rails("flex", props:{ gap: "xs", wrap:true}) do %>
+    <%= pb_rails("button", props: { id: "button-open-example-turbo-frames", margin_right: "md", text: "Open Dialog via Custom Event" }) %>
+    <%= pb_rails("button", props: { id: "open-dialog-button", data: { open_dialog: "dialog-confirm-turbo-frames" }, margin_right: "md", text: "Custom Event Linked to Confirm Button" }) %>
+    <%= pb_rails("button", props: { id: "button-open-multi-dialog", text: "Mutliple Events Example" }) %>
+<% end %>
+
+<!-- Example 1: Basic dialog with custom event opening -->
+<%= pb_rails("dialog", props: { 
+  id: "dialog-open-turbo-frames", 
+  title: "Click Event Simulation", 
+  text: "Demonstrating Opening the Dialog with a Custom Event.",
+  custom_event_type: "dialogOpen",
+  cancel_button: "Cancel Button",
+  confirm_button: "Okay", 
+  confirm_button_id: "confirm-button-turbo-frames"
+}) %>
+
+<script>
+    document.getElementById("button-open-example-turbo-frames").addEventListener("click", () => {
+        console.log("📣 Dispatching 'dialogOpen' custom event")
+
+        window.dispatchEvent(new CustomEvent("dialogOpen", { 
+            bubbles: true,
+            detail: { 
+                dialogId: "dialog-open-turbo-frames",
+                action: "open"
+            }
+        }))
+
+        console.log("✅ Custom event dispatched - dialog should open")
+    })
+</script>
+
+<!-- Example 2: Dialog with custom event linking confirm button to closing the dialog-->
+<%= pb_rails("dialog", props: { 
+  id: "dialog-confirm-turbo-frames", 
+  title: "Custom Event Button Action", 
+  text: "Clicking this dialog's confirm button triggers closing the dialog as well.",
+  custom_event_type: "turboResponse",
+  cancel_button: "Cancel",
+  cancel_button_id: "cancel-button-id-turbo-frames",
+  confirm_button: "Confirm Button", 
+  confirm_button_id: "confirm-button-id-turbo-frames"
+}) %>
+
+<script>
+  window.addEventListener("turboResponse", (event) => {
+    const { dialogId, action, cancelButtonId } = event.detail || {}
+    console.log("📦 turboResponse event triggered:", { dialogId, action, cancelButtonId })
+
+    if (action === "close" && cancelButtonId) {
+        const dialog = document.getElementById(dialogId)
+        if (dialog?.close) {
+          console.log("🚪 Closing dialog programmatically")
+          dialog.close()
+        }
+    }
+  })
+
+  document.getElementById("confirm-button-id-turbo-frames").addEventListener("click", function () {
+    console.log("✅ Confirm button clicked! Triggering cancel via turboResponse")
+
+    window.dispatchEvent(new CustomEvent("turboResponse", {
+      detail: {
+        dialogId: "dialog-confirm-turbo-frames",
+        action: "close", 
+        cancelButtonId: "cancel-button-id-turbo-frames"
+      }
+    }))
+  })
+</script>
+
+<!-- Example 3: Dialog with multiple custom event types -->
+<%= pb_rails("dialog", props: { 
+  id: "multi-event-dialog", 
+  title: "Multiple Event Types", 
+  text: "This dialog responds to multiple custom event types - see console logs.",
+  custom_event_type: "dialogOpenMutli,turboResponseMulti",
+  cancel_button: "Cancel",
+  cancel_button_id: "multi-event-cancel",
+  confirm_button: "Confirm", 
+  confirm_button_id: "multi-event-confirm"
+}) %>
+
+<script>
+  document.getElementById("button-open-multi-dialog").addEventListener("click", () => {
+    console.log("📣 Dispatching 'dialogOpenMutli' custom event")
+    window.dispatchEvent(new CustomEvent("dialogOpenMutli", { 
+      detail: { 
+        dialogId: "multi-event-dialog",
+        action: "open"
+      }
+    }))
+  })
+
+  document.getElementById("multi-event-confirm")?.addEventListener("click", function() {
+    console.log("✅ Confirm clicked — dispatching 'turboResponseMulti' to simulate dialog close")
+
+    window.dispatchEvent(new CustomEvent("turboResponseMulti", {
+      detail: {
+        dialogId: "multi-event-dialog",
+        action: "close",
+        cancelButtonId: "multi-event-cancel"
+      }
+    }))
+  })
+
+  window.addEventListener("turboResponseMulti", (event) => {
+    const { dialogId, action, cancelButtonId } = event.detail || {}
+  
+    if (action === "close" && dialogId) {
+      const dialog = document.getElementById(dialogId)
+      dialog.close?.()
+      console.log("🚪 Closing dialog programmatically")
+    }
+  })
+</script>

data/app/pb_kits/playbook/pb_dialog/docs/_dialog_turbo_frames_rails.md

@@ -0,0 +1,9 @@
+The `custom_event_type` prop allows you to specify custom events that will trigger the dialog's initialization or control its behavior. This is especially useful when working with Turbo Frame updates where standard DOM events might not suffice.
+
+The examples demonstrate two use cases:
+1) Opening a dialog via custom event dispatch: The first example shows how to configure a dialog to listen for a specific custom event (dialogOpen). When this event is dispatched, the dialog will automatically open, making it easy to trigger the dialog from JavaScript or after Turbo Frame operations.
+2) Controlling dialog button actions with custom events: The second example demonstrates how to set up a dialog that can have its confirm button triggered through external events (turboResponse). This pattern is useful when you need to programmatically confirm a dialog after some background operation completes.
+3) Multiple custom events: The third example combines the first two to show how `custom_event_type` prop can support multiple event types separated by a comma.
+
+For Turbo integration, you can use standard Turbo events like turbo:frame-load or turbo:submit-end as your `custom_event_type` to ensure the dialog responds properly after Turbo navigation or form submissions. The dialog component will listen for these events automatically.
+The implementation handles various actions including 'open', 'close', 'clickConfirm', and 'clickCancel', making it flexible for different interaction patterns in your Turbo-enhanced application.

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

@@ -11,6 +11,7 @@ examples:
   - dialog_full_height: Full Height
   - dialog_full_height_placement: Full Height Placement
   - dialog_loading: Loading
+  - dialog_turbo_frames: Within Turbo Frames
 
 
   react:

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

@@ -10,6 +10,81 @@ export default class PbDialog extends PbEnhancedElement {
   connect() {
     window.addEventListener("DOMContentLoaded", () => this.setupDialog())
     window.addEventListener("turbo:frame-load", () => this.setupDialog())
+
+    // Code for custom_event_type setup (can take multiple events in a string separated by commas)
+    const customEventTypeString = this.element.dataset.customEventType
+    if (customEventTypeString && !this.element.hasAttribute("data-custom-event-handled")) {
+      this.customEventTypes = customEventTypeString.split(",").map(e => e.trim()).filter(Boolean)
+      this.customEventTypes.forEach(eventType => {
+        window.addEventListener(eventType, this.handleCustomEvent)
+      })
+
+      this.element.setAttribute("data-custom-event-handled", "true")
+    }
+  }
+
+  disconnect() {
+    if (this.customEventTypes && Array.isArray(this.customEventTypes)) {
+      this.customEventTypes.forEach(eventType => {
+        window.removeEventListener(eventType, this.handleCustomEvent)
+      })
+    }
+  }
+
+  handleCustomEvent = (event) => {
+    const dialogId = event.detail?.dialogId || this.element.querySelector("dialog")?.id
+    const dialog = dialogId && document.getElementById(dialogId)
+  
+    if (!dialog) {
+      console.warn(`[PbDialog] Could not find dialog with ID '${dialogId}'`)
+      return
+    }
+  
+    this.setupDialog()
+  
+    const action = event.detail?.action || 'open'
+  
+    // Known Actions - four "standard" dialog actions that felt like things devs might want to do
+    const knownActions = ['open', 'close', 'clickConfirm', 'clickCancel'];
+  
+    if (knownActions.includes(action)) {
+      switch (action) {
+        case 'open':
+          if (!dialog.open) dialog.showModal()
+          break
+        case 'close':
+          if (dialog.open) dialog.close(event.detail?.returnValue)
+          break
+        case 'clickConfirm':
+          this.triggerButtonClick(dialog, event, 'confirm')
+          break
+        case 'clickCancel':
+          this.triggerButtonClick(dialog, event, 'cancel')
+          break
+      }
+    } 
+    // Custom Actions - flexible for Turbo or other integration
+    else if (typeof event.detail?.customAction === 'function') {
+      event.detail.customAction({ dialog, event })
+    } else if (window.pbDialogActions?.[action]) {
+      // Can register custom actions globally
+      window.pbDialogActions[action]({ dialog, event })
+    } else {
+      console.warn(`[PbDialog] Unknown action: ${action}`)
+    }
+  }
+
+  triggerButtonClick(dialog, event, type) {
+    const buttonId = event.detail?.[`${type}ButtonId`] || 
+                     dialog.closest('[data-pb-dialog-wrapper]')?.dataset[`${type}ButtonId`]
+    const button = buttonId ? document.getElementById(buttonId) : 
+                  dialog.querySelector(`[data-${type}-button]`)
+  
+    if (button) {
+      button.click()
+    } else {
+      console.warn(`[PbDialog] Could not find ${type} button for dialog`)
+    }
   }
 
   setupDialog() {
@@ -18,7 +93,7 @@ export default class PbDialog extends PbEnhancedElement {
     const dialogs = document.querySelectorAll(".pb_dialog_rails")
 
     const loadingButton = document.querySelector('[data-disable-with="Loading"]');
-    if (loadingButton) {
+    if (loadingButton && !loadingButton.dataset.listenerAttached) {
       loadingButton.addEventListener("click", function () {
         const okayLoadingButton = document.querySelector('[data-disable-with="Loading"]');
         const cancelButton = document.querySelector('[data-disable-cancel-with="Loading"]');
@@ -35,27 +110,42 @@ export default class PbDialog extends PbEnhancedElement {
         okayLoadingButton.className = newClass;
         if (cancelButton) cancelButton.className = newCancelClass;
       });
+    
+      // Prevent multiple registrations
+      loadingButton.dataset.listenerAttached = "true";
     }
-
+    
     openTrigger.forEach((open) => {
-      open.addEventListener("click", () => {
-        var openTriggerData = open.dataset.openDialog;
-        var targetDialog = document.getElementById(openTriggerData)
-        if (targetDialog.open) return;
-        targetDialog.showModal();
-      });
+      const originalClickHandler = open._openDialogClickHandler
+      if (originalClickHandler) open.removeEventListener("click", originalClickHandler)
+
+      open._openDialogClickHandler = () => {
+        const openTriggerData = open.dataset.openDialog;
+        const targetDialogOpen = document.getElementById(openTriggerData)
+        if (targetDialogOpen && !targetDialogOpen.open) targetDialogOpen.showModal()
+      };
+
+      open.addEventListener("click", open._openDialogClickHandler)
     });
 
     closeTrigger.forEach((close) => {
-      close.addEventListener("click", () => {
-        var closeTriggerData = close.dataset.closeDialog;
-        document.getElementById(closeTriggerData).close();
-      });
+      const originalClickHandler = close._closeDialogClickHandler
+      if (originalClickHandler) close.removeEventListener("click", originalClickHandler)
+
+      close._closeDialogClickHandler = () => {
+        const closeTriggerData = close.dataset.closeDialog;
+        const targetDialogClose = document.getElementById(closeTriggerData)
+        if (targetDialogClose) targetDialogClose.close();
+      };
+
+      close.addEventListener("click", close._closeDialogClickHandler)
     });
 
     // Close dialog box on outside click
     dialogs.forEach((dialogElement) => {
-      dialogElement.addEventListener("mousedown", (event) => {
+      const originalMousedownHandler = dialogElement._outsideClickHandler
+      if (originalMousedownHandler) dialogElement.removeEventListener("mousedown", originalMousedownHandler)
+      dialogElement._outsideClickHandler = (event) => {
         const dialogParentDataset = dialogElement.parentElement.dataset
         if (dialogParentDataset.overlayClick === "overlay_close") return
 
@@ -69,7 +159,9 @@ export default class PbDialog extends PbEnhancedElement {
           dialogElement.close()
           event.stopPropagation()
         }
-      })
+      }
+
+      dialogElement.addEventListener("mousedown", dialogElement._outsideClickHandler);
     })
   }
 }

data/app/pb_kits/playbook/pb_draggable/docs/_draggable_event_listeners.html.erb

@@ -0,0 +1,42 @@
+<% initial_items = [
+  {
+    id: "100",
+    url: "https://unsplash.it/500/400/?image=638",
+  },
+  {
+    id: "200",
+    url: "https://unsplash.it/500/400/?image=639",
+  },
+  {
+    id: "300",
+    url: "https://unsplash.it/500/400/?image=640",
+  },
+] %>
+
+<%= pb_rails("draggable", props: {initial_items: initial_items}) do %>
+  <%= pb_rails("draggable/draggable_container") do %>
+    <%= pb_rails("flex") do %>
+      <% initial_items.each do |item| %>
+        <%= pb_rails("draggable/draggable_item", props:{drag_id: item[:id]}) do %>
+          <%= pb_rails("image", props: { alt: item[:id], size: "md", url: item[:url], margin: "xs" }) %>
+        <% end %>
+      <% end %>
+    <% end %>
+  <% end %>
+<% end %>
+
+<script>
+  const itemIds = ["item_100", "item_200", "item_300"];
+
+  itemIds.forEach((id) => {
+    const element = document.getElementById(id);
+    if (element) {
+      element.addEventListener("dragstart", (event) => {
+        console.log(`${id} drag start!`);
+      });
+      element.addEventListener("dragend", (event) => {
+        console.log(`${id} drag end!`);
+      });
+    }
+  });
+</script>

data/app/pb_kits/playbook/pb_draggable/docs/_draggable_event_listeners.md

@@ -0,0 +1 @@
+You can add drag event listeners for `drag`, `dragend`, `dragenter`, `dragleave`, `dragover`, `dragstart`, and `drop`.

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

@@ -17,4 +17,5 @@ examples:
   - draggable_with_cards: Draggable with Cards
   - draggable_with_table: Draggable with Table
   - draggable_multiple_containers: Dragging Across Multiple Containers
+  - draggable_event_listeners: Draggable Event Listeners
 

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

@@ -35,7 +35,7 @@ type DropdownProps = {
     label?: string;
     onSelect?: (arg: GenericObject) => null;
     options: GenericObject;
-    separators: boolean;
+    separators?: boolean;
     triggerRef?: any;
     variant?: "default" | "subtle";
 };

data/app/pb_kits/playbook/pb_dropdown/subcomponents/DropdownOption.tsx

@@ -22,7 +22,7 @@ type DropdownOptionProps = {
   data?: { [key: string]: string };
   htmlOptions?: { [key: string]: string | number | boolean | (() => void) };
   id?: string;
-  key?: string;
+  key?: string | number;
   option?: GenericObject;
   padding?: string;
 }  & GlobalProps;

data/app/pb_kits/playbook/pb_gauge/docs/_gauge_pb_styles.jsx

@@ -0,0 +1,31 @@
+import React from 'react'
+import gaugeTheme from '../gaugeTheme'
+import Highcharts from "highcharts"
+import HighchartsReact from "highcharts-react-official"
+import HighchartsMore from "highcharts/highcharts-more"
+import SolidGauge from "highcharts/modules/solid-gauge"
+
+HighchartsMore(Highcharts);
+SolidGauge(Highcharts);
+
+const data = [{ name: "Name", y: 45 }]
+
+const baseOptions = {
+  title: { text: "" },
+  series: [{ data: data }],
+};
+
+const GaugePbStyles = () => {
+  const options = Highcharts.merge({}, gaugeTheme, baseOptions);
+
+  return (
+    <div>
+      <HighchartsReact
+          highcharts={Highcharts}
+          options={options}
+      />
+    </div>
+  );
+};
+
+export default GaugePbStyles;

data/app/pb_kits/playbook/pb_gauge/docs/_gauge_pb_styles.md

@@ -0,0 +1 @@
+You don't need to use the Gauge Kit to apply Playbook styles to your Highcharts gauge chart. Just import gaugeTheme.ts and merge it with your chart options—Playbook’s styling will apply automatically.

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

@@ -15,6 +15,7 @@ examples:
 
   react:
   - gauge_default: Default
+  - gauge_pb_styles: Playbook Styles
   - gauge_disable_animation: Disable Animation
   - gauge_title: Title
   - gauge_units: Units

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

@@ -1,4 +1,5 @@
 export { default as GaugeDefault } from './_gauge_default.jsx'
+export { default as GaugePbStyles } from './_gauge_pb_styles.jsx'
 export { default as GaugeDisableAnimation } from './_gauge_disable_animation.jsx'
 export { default as GaugeFullCircle } from './_gauge_full_circle.jsx'
 export { default as GaugeHeight } from './_gauge_height.jsx'

data/app/pb_kits/playbook/pb_gauge/gaugeTheme.ts

@@ -0,0 +1,83 @@
+import colors from '../tokens/exports/_colors.module.scss'
+import typography from '../tokens/exports/_typography.module.scss'
+
+const gaugeTheme = {
+  chart: {
+    type: "solidgauge",
+    events: {
+      render() {
+        this.container
+          const arc = this.container.querySelector('path.gauge-pane');
+          if (arc) arc.setAttribute('stroke-linejoin', 'round');
+      }
+    }
+  },
+  pane: {
+    size: "90%",
+    startAngle: -100,
+    endAngle: 100,
+    background: [
+      {
+        borderWidth: 20,
+        innerRadius: "90%",
+        outerRadius: "90%",
+        shape: "arc",
+        className: "gauge-pane",
+        borderColor: colors.border_light,
+        borderRadius: '50%',
+      },
+    ],
+  },
+  tooltip: {
+    backgroundColor: {
+      linearGradient: { x1: 0, y1: 0, x2: 0, y2: 1 },
+      stops: [
+        [0, colors.bg_dark],
+        [1, colors.bg_dark],
+      ],
+    },
+    pointFormat:
+      '<span style="font-weight: bold; color:{point.color};">●</span>{point.name}: ' +
+      "<b>{point.y}</b>",
+    followPointer: true,
+    shadow: false,
+    borderWidth: 0,
+    borderRadius: 10,
+    style: {
+      fontFamily: typography.font_family_base,
+      color: colors.text_dk_default,
+      fontWeight: typography.regular,
+      fontSize: typography.text_smaller,
+    },
+  },
+  yAxis: {
+    min: 0,
+    max: 100,
+    lineWidth: 0,
+    tickPositions: [] as number[],
+  },
+  plotOptions: {
+    solidgauge: {
+      borderColor: colors.data_1,
+      borderWidth: 20,
+      color: colors.data_1,
+      radius: 90,
+      innerRadius: "90%",
+      y: -26,
+      dataLabels: {
+        borderWidth: 0,
+        color: colors.text_lt_default,
+        enabled: true,
+        format: '<span class="fix">{y:,f}</span>',
+        style: {
+          fontFamily: typography.font_family_base,
+          fontWeight: typography.regular,
+          fontSize: typography.heading_2,
+        },
+        y: -26,
+      },
+    },
+  }
+}
+
+export default gaugeTheme;

data/app/pb_kits/playbook/pb_overlay/_overlay.scss

@@ -88,6 +88,40 @@ $overlay_colors: (
     }
   }
 
+  &.overlay-full-screen {
+    position: fixed;
+    top: 0;
+    left: 0;
+    right: 0;
+    bottom: 0;
+    width: 100vw;
+    height: 100vh;
+    z-index: 9999;
+
+    &.no_gradient {
+      @each $color_name, $color in $overlay_colors {
+        &[data-overlay-color="#{$color_name}"] {
+          &::before {
+            content: "";
+            position: absolute;
+            top: 0;
+            left: 0;
+            right: 0;
+            bottom: 0;
+            background: $color;
+            pointer-events: none;
+          }
+        }
+      }
+    }
+
+    @each $key, $value in $opacity {
+      &.#{$key}::before {
+        opacity: $value;
+      }
+    }
+  }
+
   &.no_gradient {
     @each $color_name, $color in $overlay_colors {
       .overlay_#{$color_name} {