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

data/app/pb_kits/playbook/pb_rich_text_editor/rich_text_editor.test.js

@@ -1,5 +1,5 @@
 import React from 'react'
-import { render, screen, fireEvent, waitFor } from '../utilities/test-utils'
+import { render, screen, fireEvent, waitFor, within } from '../utilities/test-utils'
 import { useEditor, EditorContent } from "@tiptap/react"
 import StarterKit from "@tiptap/starter-kit"
 
@@ -89,14 +89,14 @@ const TestAdvancedEditor = ({ toolbarOnFocus = false, ...props }) => {
 describe('Advanced TipTap Editor works as expected', () => {
   test('renders advanced editor with toolbar', () => {
     render(<TestAdvancedEditor />)
-    
+
     const kit = screen.getByTestId(testId)
     expect(kit).toHaveClass(kitClass)
-    
+
     // Check for advanced container
     const advancedContainer = kit.querySelector('.pb_rich_text_editor_advanced_container')
     expect(advancedContainer).toBeInTheDocument()
-    
+
     // Check for toolbar
     const toolbar = kit.querySelector('.toolbar')
     expect(toolbar).toBeInTheDocument()
@@ -104,7 +104,7 @@ describe('Advanced TipTap Editor works as expected', () => {
 
   test('renders advanced editor without toolbar when advancedEditorToolbar is false', () => {
     render(<TestAdvancedEditor advancedEditorToolbar={false} />)
-    
+
     const kit = screen.getByTestId(testId)
     const toolbar = kit.querySelector('.toolbar')
     expect(toolbar).not.toBeInTheDocument()
@@ -112,17 +112,17 @@ describe('Advanced TipTap Editor works as expected', () => {
 
   test('shows/hides toolbar on focus when focus is enabled', async () => {
     render(<TestAdvancedEditor focus />)
-    
+
     const kit = screen.getByTestId(testId)
-    
+
     // Initially toolbar should be hidden
     let toolbar = kit.querySelector('.toolbar')
     expect(toolbar).not.toBeInTheDocument()
-    
+
     const editorElement = kit.querySelector('.ProseMirror')
     // Focus the editor
     fireEvent.focus(editorElement)
-    
+
     // Toolbar should now be visible
     await waitFor(() => {
       toolbar = kit.querySelector('.toolbar')
@@ -133,7 +133,7 @@ describe('Advanced TipTap Editor works as expected', () => {
 
   test('supports simple prop with advanced editor', () => {
     render(<TestAdvancedEditor simple />)
-    
+
     const kit = screen.getByTestId(testId)
     const toolbar = kit.querySelector('.toolbar')
     expect(toolbar).toBeInTheDocument()
@@ -144,7 +144,7 @@ describe('Advanced TipTap Editor works as expected', () => {
 
     test('supports sticky prop with advanced editor', () => {
     render(<TestAdvancedEditor sticky />)
-    
+
     const kit = screen.getByTestId(testId)
     const stickyToolbar = kit.querySelector('.pb_rich_text_editor_tiptap_toolbar_sticky')
     expect(stickyToolbar).toBeInTheDocument()
@@ -154,37 +154,52 @@ describe('Advanced TipTap Editor works as expected', () => {
   test('applies aria-label when provided', () => {
     const ariaLabel = 'Rich Text Editor'
     render(<TestAdvancedEditor aria={{ label: ariaLabel }} />)
-    
+
     const kit = screen.getByTestId(testId)
     expect(kit).toHaveAttribute('aria-label', ariaLabel)
   })
 
   test('supports inline prop with advanced editor', () => {
     render(<TestAdvancedEditor inline />)
-    
+
     const kit = screen.getByTestId(testId)
     const toolbar = kit.querySelector('.toolbar')
     expect(toolbar).toBeInTheDocument()
     expect(kit).toHaveClass(`${kitClass} inline`)
   })
 
+  test('renders required indicator asterisk when requiredIndicator is true', () => {
+    render(
+      <RichTextEditor
+          data={{ testid: testId }}
+          label="Label"
+          requiredIndicator
+      />
+    )
+
+    const kit = screen.getByTestId(testId)
+    const label = within(kit).getByText(/Label/)
+
+    expect(label).toBeInTheDocument()
+    expect(kit).toHaveTextContent('*')
+  })
+
 describe('TipTap Editor Functionality', () => {
   test('can type and update content', async () => {
     render(<TestAdvancedEditor />)
-    
+
     const kit = screen.getByTestId(testId)
     const editorContent = kit.querySelector('.ProseMirror')
-    
+
     // Focus and type in the editor
     fireEvent.focus(editorContent)
-    fireEvent.input(editorContent, { 
+    fireEvent.input(editorContent, {
       target: { textContent: 'New content' }
     })
-    
+
     await waitFor(() => {
       expect(editorContent).toHaveTextContent('New content')
     })
   })
 })
 })
-

data/app/pb_kits/playbook/pb_textarea/_textarea.tsx

@@ -13,6 +13,7 @@ import Body from '../pb_body/_body'
 import Caption from '../pb_caption/_caption'
 import Flex from '../pb_flex/_flex'
 import FlexItem from '../pb_flex/_flex_item'
+import colors from '../tokens/exports/_colors.module.scss'
 
 import { stripEmojisForPaste, applyEmojiMask } from '../utilities/emojiMask'
 
@@ -36,6 +37,7 @@ type TextareaProps = {
   value?: string,
   name?: string,
   required?: boolean,
+  requiredIndicator?: boolean,
   rows?: number,
   resize: "none" | "both" | "horizontal" | "vertical" | "auto",
   onChange?: InputCallback<HTMLTextAreaElement>,
@@ -50,6 +52,7 @@ const Textarea = ({
   disabled,
   emojiMask = false,
   htmlOptions = {},
+  id,
   inline = false,
   resize = 'none',
   error,
@@ -60,6 +63,7 @@ const Textarea = ({
   onChange = () => {},
   placeholder,
   required,
+  requiredIndicator = false,
   rows = 4,
   value,
   ...props
@@ -84,7 +88,7 @@ const Textarea = ({
     if (emojiMask) {
       const pastedText = e.clipboardData.getData('text')
       const filteredText = stripEmojisForPaste(pastedText)
-      
+
       if (pastedText !== filteredText) {
         e.preventDefault()
         const textarea = e.currentTarget
@@ -93,10 +97,10 @@ const Textarea = ({
         const currentValue = textarea.value
         const newValue = currentValue.slice(0, start) + filteredText + currentValue.slice(end)
         const newCursorPosition = start + filteredText.length
-        
+
         textarea.value = newValue
         textarea.selectionStart = textarea.selectionEnd = newCursorPosition
-        
+
         onChange({ ...e, target: textarea, currentTarget: textarea } as unknown as ChangeEvent<HTMLTextAreaElement>)
       }
     }
@@ -124,7 +128,21 @@ const Textarea = ({
         {...htmlProps}
         className={classes}
     >
-      <Caption text={label} />
+    {label && (
+      <label htmlFor={id}>
+      {
+        requiredIndicator ? (
+          <Caption className="pb_text_input_kit_label">
+            {label} <span style={{ color: `${colors.error}` }}>*</span>
+          </Caption>
+        ) : (
+          <Caption  className="pb_text_input_kit_label"
+              text={label}
+          />
+        )
+      }
+      </label>
+    )}
       {children || (
         <textarea
             disabled={disabled}
@@ -143,19 +161,19 @@ const Textarea = ({
       {error ? (
         <>
           {characterCount ? (
-            <Flex 
-                spacing="between" 
+            <Flex
+                spacing="between"
                 vertical="center"
             >
               <FlexItem>
-                <Body 
+                <Body
                     margin="none"
                     status="negative"
-                    text={error} 
+                    text={error}
                 />
               </FlexItem>
               <FlexItem>
-                <Caption 
+                <Caption
                     margin="none"
                     size="xs"
                     text={characterCounter()}
@@ -163,7 +181,7 @@ const Textarea = ({
               </FlexItem>
             </Flex>
           ) : (
-            <Body 
+            <Body
                 status="negative"
                 text={error}
             />
@@ -171,7 +189,7 @@ const Textarea = ({
         </>
       ) : (
          noCount && (
-          <Caption 
+          <Caption
               margin="none"
               size="xs"
               text={characterCounter()}

data/app/pb_kits/playbook/pb_textarea/docs/_textarea_required_indicator.html.erb

@@ -0,0 +1,5 @@
+<%= pb_rails("textarea", props: {
+  label: "Label",
+  placeholder: "Placeholder text",
+  required_indicator: true
+}) %>

data/app/pb_kits/playbook/pb_textarea/docs/_textarea_required_indicator.jsx

@@ -0,0 +1,25 @@
+import React, {useState} from 'react'
+
+import Textarea from '../_textarea'
+
+const TextareaRequiredIndicator = (props) => {
+  const [value, setValue] = useState('Default value text')
+  const handleChange = (event) => {
+    setValue(event.target.value)
+  }
+  return (
+    <div>
+      <Textarea
+          label="Label"
+          name="comment"
+          onChange={(e) => handleChange(e)}
+          placeholder="Placeholder text"
+          requiredIndicator
+          value={value}
+          {...props}
+      />
+    </div>
+  )
+}
+
+export default TextareaRequiredIndicator

data/app/pb_kits/playbook/pb_textarea/docs/_textarea_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_textarea/docs/example.yml

@@ -8,6 +8,7 @@ examples:
   - textarea_character_counter: Character Counter
   - textarea_inline: Inline
   - textarea_emoji_mask: Emoji Mask
+  - textarea_required_indicator: Required Indicator
   - textarea_input_options: Input Options
 
   react:
@@ -18,8 +19,9 @@ examples:
   - textarea_character_counter: Character Counter
   - textarea_inline: Inline
   - textarea_emoji_mask: Emoji Mask
+  - textarea_required_indicator: Required Indicator
 
   swift:
   - textarea_default_swift: Default
   - textarea_error_swift: Textarea w/ Error
-  - textarea_props_swift: ""
+  - textarea_props_swift: ""

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

@@ -5,3 +5,4 @@ export { default as TextareaError } from './_textarea_error.jsx'
 export { default as TextareaCharacterCounter } from './_textarea_character_counter.jsx'
 export { default as TextareaInline } from './_textarea_inline.jsx'
 export { default as TextareaEmojiMask } from './_textarea_emoji_mask.jsx'
+export { default as TextareaRequiredIndicator } from './_textarea_required_indicator.jsx'

data/app/pb_kits/playbook/pb_textarea/index.ts

@@ -11,18 +11,21 @@ export default class PbTextarea extends PbEnhancedElement {
   }
 
   hasEmojiMask(): boolean {
+    if (!this.element) return false
     return (this.element as HTMLElement).dataset.pbEmojiMask === "true"
   }
 
-  onInput(): void {
+  onInput = (): void => {
+    if (!this.element) return
+    
     if ((this.element as HTMLElement).closest('.resize_auto')) {
-      this.style.height = 'auto'
-      this.style.height = (this.scrollHeight) + 'px'
+      (this.element as HTMLTextAreaElement).style.height = 'auto';
+      (this.element as HTMLTextAreaElement).style.height = (this.element as HTMLTextAreaElement).scrollHeight + 'px'
     }
   }
 
   handleEmojiInput = (): void => {
-    if (!this.hasEmojiMask()) return
+    if (!this.element || !this.hasEmojiMask()) return
     
     if (this.skipNextEmojiFilter) {
       this.skipNextEmojiFilter = false
@@ -33,7 +36,7 @@ export default class PbTextarea extends PbEnhancedElement {
   }
 
   handleEmojiPaste = (event: ClipboardEvent): void => {
-    if (!this.hasEmojiMask()) return
+    if (!this.element || !this.hasEmojiMask()) return
 
     const pastedText = event.clipboardData?.getData('text') || ''
     const filteredText = stripEmojisForPaste(pastedText)
@@ -57,6 +60,8 @@ export default class PbTextarea extends PbEnhancedElement {
   }
 
   connect(): void {
+    if (!this.element) return
+    
     if ((this.element as HTMLElement).closest('.resize_auto')) {
       this.element.setAttribute('style', 'height:' + (this.element as HTMLTextAreaElement).scrollHeight + 'px;overflow-y:hidden;')
       this.element.addEventListener('input', this.onInput, false)
@@ -69,6 +74,8 @@ export default class PbTextarea extends PbEnhancedElement {
   }
 
   disconnect(): void {
+    if (!this.element) return
+    
     this.element.removeEventListener('input', this.onInput, false)
     this.element.removeEventListener('input', this.handleEmojiInput, false)
     this.element.removeEventListener('paste', this.handleEmojiPaste as EventListener, false)

data/app/pb_kits/playbook/pb_textarea/textarea.html.erb

@@ -1,6 +1,12 @@
 <%= pb_content_tag do %>
   <% if object.label.present? %>
+    <% if object.required_indicator %>
+      <%= pb_rails("caption", props: { text: object.label, dark: object.dark }) do %>
+        <%= object.label %><span style="color: #DA0014;"> *</span>
+      <% end %>
+    <% else %>
     <%= pb_rails("caption", props: {text: object.label, dark: object.dark}) %>
+    <% end %>
   <% end %>
   <% if content.present? %>
     <%= content %>

data/app/pb_kits/playbook/pb_textarea/textarea.rb

@@ -23,6 +23,8 @@ module Playbook
       prop :character_count
       prop :onkeyup
       prop :max_characters
+      prop :required_indicator, type: Playbook::Props::Boolean,
+                                default: false
 
       def classname
         generate_classname("pb_textarea_kit") + error_class + resize_class + inline_class

data/app/pb_kits/playbook/pb_textarea/textarea.test.js

@@ -1,5 +1,5 @@
 import React, { useState } from "react"
-import { render, screen, fireEvent } from "../utilities/test-utils"
+import { render, screen, fireEvent, within } from "../utilities/test-utils"
 
 import Textarea from "./_textarea"
 
@@ -265,4 +265,21 @@ describe("Textarea Emoji Mask", () => {
     fireEvent.change(textarea, { target: { value: 'àëǒüñ' } })
     expect(textarea.value).toBe('àëǒüñ')
   })
+
+  test('renders required indicator asterisk when requiredIndicator is true', () => {
+    render(
+      <Textarea
+          data={{ testid: testId }}
+          label="Name"
+          required
+          requiredIndicator
+      />
+    )
+
+    const kit = screen.getByTestId(testId)
+    const label = within(kit).getByText(/Name/)
+
+    expect(label).toBeInTheDocument()
+    expect(kit).toHaveTextContent('*')
+  })
 })