playbook_ui 16.1.0.pre.alpha.PLAY276913866 → 16.1.0.pre.alpha.play2724typeaheadindicator13970

data/app/pb_kits/playbook/pb_passphrase/passphrase.test.jsx

@@ -1,5 +1,5 @@
 import React from 'react'
-import { render, screen } from '../utilities/test-utils'
+import { render, screen, within } from '../utilities/test-utils'
 import { Passphrase } from 'playbook-ui'
 
 const testId = 'text-input1',
@@ -86,3 +86,32 @@ test('popover target does not show when tips are not given', () => {
   const kit = screen.getByTestId(testId)
   expect(kit.querySelector('[class^=pb_popover_reference_wrapper]')).toBeNull()
 })
+
+test('renders required indicator asterisk when requiredIndicator is true', () => {
+  render(
+    <Passphrase
+        data={{ testid: testId }}
+        label="Passphrase"
+        requiredIndicator
+    />
+  )
+
+  const kit = screen.getByTestId(testId)
+  const label = within(kit).getByText(/Passphrase/)
+  expect(label).toBeInTheDocument()
+  expect(kit).toHaveTextContent('*')
+})
+
+test('does not render required indicator asterisk when requiredIndicator is false', () => {
+  render(
+    <Passphrase
+        data={{ testid: testId }}
+        label="Passphrase"
+    />
+  )
+
+  const kit = screen.getByTestId(testId)
+  const label = within(kit).getByText(/Passphrase/)
+  expect(label).toBeInTheDocument()
+  expect(kit).not.toHaveTextContent('*')
+})

data/app/pb_kits/playbook/pb_phone_number_input/_phone_number_input.tsx

@@ -36,6 +36,7 @@ type PhoneNumberInputProps = {
   excludeCountries: string[],
   preferredCountries?: string[],
   required?: boolean,
+  requiredIndicator?: boolean,
   value?: string,
   formatAsYouType?: boolean,
   strictMode?: boolean,
@@ -91,6 +92,7 @@ const PhoneNumberInput = (props: PhoneNumberInputProps, ref?: React.Ref<unknown>
     onlyCountries = [],
     excludeCountries = [],
     required = false,
+    requiredIndicator = false,
     preferredCountries = [],
     value = "",
     formatAsYouType = false,
@@ -533,6 +535,7 @@ const PhoneNumberInput = (props: PhoneNumberInputProps, ref?: React.Ref<unknown>
       validateErrors()
     },
     onChange: formatAsYouType ? undefined : handleOnChange,
+    requiredIndicator,
     value: inputValue
   }
 

data/app/pb_kits/playbook/pb_phone_number_input/docs/_phone_number_input_required_indicator.html.erb

@@ -0,0 +1,5 @@
+<%= pb_rails("phone_number_input", props: {
+  id: "phone_number_input_required_indicator",
+  label: "Required Phone Number",
+  required_indicator: true,
+}) %>

data/app/pb_kits/playbook/pb_phone_number_input/docs/_phone_number_input_required_indicator.jsx

@@ -0,0 +1,14 @@
+import React from 'react'
+import PhoneNumberInput from '../../pb_phone_number_input/_phone_number_input'
+
+const PhoneNumberInputRequiredIndicator = (props) => (
+    <>
+        <PhoneNumberInput
+            id='phone_number_input_required_indicator'
+            label='Phone Number'
+            requiredIndicator
+            {...props} />
+    </>
+)
+
+export default PhoneNumberInputRequiredIndicator

data/app/pb_kits/playbook/pb_phone_number_input/docs/_phone_number_input_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_phone_number_input/docs/example.yml

@@ -12,6 +12,7 @@ examples:
   - phone_number_input_format: Format as You Type
   - phone_number_input_strict_mode: Strict Mode
   - phone_number_input_country_search: Country Search
+  - phone_number_input_required_indicator: Required Indicator
 
   rails:
   - phone_number_input_default: Default
@@ -24,3 +25,4 @@ examples:
   - phone_number_input_strict_mode: Strict Mode
   - phone_number_input_hidden_inputs: Hidden Inputs
   - phone_number_input_country_search: Country Search
+  - phone_number_input_required_indicator: Required Indicator

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

@@ -9,3 +9,4 @@ export { default as PhoneNumberInputAccessInputElement } from './_phone_number_i
 export { default as PhoneNumberInputFormat } from './_phone_number_input_format'
 export { default as PhoneNumberInputStrictMode } from './_phone_number_input_strict_mode'
 export { default as PhoneNumberInputCountrySearch } from './_phone_number_input_country_search'
+export { default as PhoneNumberInputRequiredIndicator } from './_phone_number_input_required_indicator.jsx'

data/app/pb_kits/playbook/pb_phone_number_input/phone_number_input.rb

@@ -7,6 +7,8 @@ module Playbook
                       default: false
       prop :required, type: Playbook::Props::Boolean,
                       default: false
+      prop :required_indicator, type: Playbook::Props::Boolean,
+                                default: false
       prop :initial_country, type: Playbook::Props::String,
                              default: ""
       prop :label, type: Playbook::Props::String,
@@ -52,6 +54,7 @@ module Playbook
           excludeCountries: exclude_countries,
           preferredCountries: preferred_countries,
           required: required,
+          requiredIndicator: required_indicator,
           value: value,
           countrySearch: country_search,
         }

data/app/pb_kits/playbook/pb_phone_number_input/phone_number_input.test.js

@@ -1,5 +1,5 @@
 import React from "react";
-import { render, screen, act } from "../utilities/test-utils";
+import { render, screen, act, within } from "../utilities/test-utils";
 import PhoneNumberInput from "./_phone_number_input";
 
 const testId = "phoneNumberInput";
@@ -129,7 +129,7 @@ test("should format phone number as '555-555-5555' with formatAsYouType and 'us'
     };
 
     render(<PhoneNumberInput {...props} />);
-    
+
     const input = screen.getByRole("textbox");
     
     act(() => {
@@ -154,7 +154,38 @@ test("should pass countrySearch prop to component", () => {
     };
   
     render(<PhoneNumberInput {...props} />);
-    
+
     const wrapper = screen.getByTestId('phone-input-with-search');
     expect(wrapper).toBeInTheDocument();
 });
+
+test("renders required indicator asterisk when requiredIndicator is true", () => {
+    const props = {
+        data: { testid: testId },
+        id: testId,
+        label: "Required Phone Number",
+        requiredIndicator: true,
+    };
+
+    render(<PhoneNumberInput {...props} />);
+
+    const kit = screen.getByTestId(testId);
+    const label = within(kit).getByText(/Required Phone Number/);
+    expect(label).toBeInTheDocument();
+    expect(kit).toHaveTextContent("*");
+});
+
+test("does not render required indicator asterisk when requiredIndicator is false", () => {
+    const props = {
+        data: { testid: testId },
+        id: testId,
+        label: "Phone Number",
+    };
+
+    render(<PhoneNumberInput {...props} />);
+
+    const kit = screen.getByTestId(testId);
+    const label = within(kit).getByText(/Phone Number/);
+    expect(label).toBeInTheDocument();
+    expect(kit).not.toHaveTextContent("*");
+});  

data/app/pb_kits/playbook/pb_text_input/text_input.html.erb

@@ -1,15 +1,16 @@
-<%= pb_content_tag(:div, id: nil ) do  %>
+<%= pb_content_tag(:div, id: nil) do %>
   <% if object.label.present? %>
-  <label for="<%= object.input_options[:id] || object.id %>" >
-    <% if object.required_indicator %>
-      <%= pb_rails("caption", props: { dark: object.dark, classname: "pb_text_input_kit_label" }) do %>
-        <%= object.label %><span style="color: #DA0014;"> *</span>
+    <label for="<%= object.input_options[:id] || object.id %>">
+      <% if object.required_indicator %>
+        <%= pb_rails("caption", props: { dark: object.dark, classname: "pb_text_input_kit_label" }) do %>
+          <%= object.label %><span style="color: #DA0014;"> *</span>
+        <% end %>
+      <% else %>
+        <%= pb_rails("caption", props: { text: object.label, dark: object.dark, classname: "pb_text_input_kit_label" }) %>
       <% end %>
-    <% else %>
-    <%= pb_rails("caption", props: { text: object.label, dark: object.dark, classname: "pb_text_input_kit_label" }) %>
-    <% end %>
-  </label>
+    </label>
   <% end %>
+
   <%= content_tag(:div, class: "#{add_on_class} text_input_wrapper") do %>
     <% if content.present? %>
       <%= content %>
@@ -26,4 +27,3 @@
     <%= pb_rails("body", props: {dark: object.dark, status: "negative", text: object.error, id: object.error_id, aria: { atomic: "true", live: "polite" }, html_options: { role: "alert" }}) if object.error %>
   <% end %>
 <% end %>
-

data/app/pb_kits/playbook/pb_typeahead/_typeahead.test.jsx

@@ -290,4 +290,27 @@ test('input display none shows number of selected items', () => {
   const kit = screen.getByTestId('input-display-none-test')
   const inputDisplayDiv = kit.querySelector(".pb_typeahead_selection_count")
   expect(inputDisplayDiv).toHaveTextContent("2 items selected") 
-})
+})
+
+test('typeahead with pills that use name instead of label', () => {
+  const customOptions = [
+    { name: 'Nihar', value: '1' },
+    { name: 'kylehgousel', value: '2' },
+  ]
+
+  render(
+    <Typeahead
+        data={{ testid: 'pills-custom-fields-test' }}
+        defaultValue={[{ name: 'Nihar', value: '1' }]}
+        getOptionLabel={(option) => option.name}
+        getOptionValue={(option) => option.value}
+        isMulti
+        options={customOptions}
+    />
+  )
+
+  const kit = screen.getByTestId('pills-custom-fields-test')
+  const pill = kit.querySelector(".pb_form_pill_kit.pb_form_pill_primary")
+  expect(pill).toBeInTheDocument()
+  expect(pill).toHaveTextContent("Nihar")
+})