playbook_ui 14.8.0.pre.alpha.play1648heightglobalprops4559 → 14.8.0.pre.alpha.revert3916revert3893PBNTR667railstypeaheadformintegration4565

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba9b61505396d83dda5a66f647455f7300ffc61aa1568378549a848cf0a3e52d
-  data.tar.gz: 9c7a4c59e621094cf9f5c8115529bfcd202615811b3f08e2757b20204951a514
+  metadata.gz: fbcc7537aa0ece4caf4a922f2b49f40be79668e3cb793727a882184285669f05
+  data.tar.gz: 15d4b8d7216b62376bddd4da158f9bbb74b4eb9abbb88b88f7e425af6d0ad8df
 SHA512:
-  metadata.gz: f0e0bad5bbfc8b77967a3c379768451e525e1472e6bd64039070493bd045e1fe836f778f04d3b5a5b18b1af6b871c4182bbe3a3d9f3e1d493972a7394747a038
-  data.tar.gz: f6814ca019c793c26280102244bf5c65a4c9cd44c08f50ca55c8e6b57330714d66972766a6cbdbf29c7ed514e67ee9461158b53be9ab1c41d9e618765e772227
+  metadata.gz: 03e07711563ef5c12a4785ad6f01d1168d9360f9a4881ea8c86bd1a878991c611c9cf4e2a27b14c8355469e18c6516fe2fe0fa6426ed8960ee7e7600631648e5
+  data.tar.gz: ab58d3db94e12e61aac2e00804a200681452b909cbfb4ac17d57a62a56f6003ea23909551e7ebf5739f6840ded08bcb6f08180a8395536aad982eb2683cd0988

data/app/pb_kits/playbook/_playbook.scss

@@ -126,4 +126,3 @@
 @import 'utilities/overflow';
 @import 'utilities/truncate';
 @import 'utilities/vertical_align';
-@import 'utilities/height';

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

@@ -23,7 +23,7 @@
 %>
 
 <%= pb_form_with(scope: :example, url: "", method: :get) do |form| %>
-  <%= form.typeahead :example_user, props: { data: { typeahead_example1: true, user: {} }, placeholder: "Search for a user" } %>
+  <%= form.typeahead :example_typeahead, props: { data: { typeahead_example1: true, user: {} }, label: true, placeholder: "Search for a user" } %>
   <%= form.text_field :example_text_field, props: { label: true } %>
   <%= form.phone_number_field :example_phone_number_field, props: { label: "Example phone field" } %>
   <%= form.email_field :example_email_field, props: { label: true } %>
@@ -92,7 +92,7 @@
     const selectedUserData = JSON.parse(selectedUserJSON)
 
     // set the input field's value
-    event.target.querySelector('input[name=example_user]').value = selectedUserData.login
+    event.target.querySelector('input[name=example_typeahead]').value = selectedUserData.login
 
     // log the selected option's dataset
     console.log('The selected user data:')

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

@@ -1,5 +1,5 @@
 <%= pb_form_with(scope: :example, url: "", method: :get, loading: true) do |form| %>
-  <%= form.text_field :example_text_field, props: { label: true } %>
+  <%= form.text_field :example_text_field_loading, props: { label: true } %>
 
   <%= form.actions do |action| %>
     <%= action.submit %>

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

@@ -22,23 +22,74 @@
 %>
 
 <%= pb_form_with(scope: :example, method: :get, url: "", validate: true) do |form| %>
-  <%= form.text_field :example_text_field, props: { label: true, required: true } %>
-  <%= form.phone_number_field :example_phone_number_field, props: { label: "Example phone field" } %>
-  <%= form.email_field :example_email_field, props: { label: true, required: true } %>
-  <%= form.number_field :example_number_field, props: { label: true, required: true } %>
-  <%= form.search_field :example_project_number, props: { label: true, required: true, validation: { pattern: "[0-9]{2}-[0-9]{5}", message: "Please enter a valid project number (example: 33-12345)." } } %>
-  <%= form.password_field :example_password_field, props: { label: true, required: true } %>
-  <%= form.url_field :example_url_field, props: { label: true, required: true } %>
-  <%= form.text_area :example_text_area, props: { label: true, required: true } %>
-  <%= form.dropdown_field :example_dropdown, props: { label: true, options: example_dropdown_options, required: true } %>
-  <%= form.select :example_select, [ ["Yes", 1], ["No", 2] ], props: { label: true, blank_selection: "Select One...", required: true } %>
-  <%= form.collection_select :example_collection_select, example_collection, :value, :name, props: { label: true, blank_selection: "Select One...", required: true } %>
+  <%= form.typeahead :example_typeahead_validation, props: { data: { typeahead_example2: true, user: {} }, label: true, placeholder: "Search for a user", required: true, validation: { message: "Please select a user." } } %>
+  <%= form.text_field :example_text_field_validation, props: { label: true, required: true } %>
+  <%= form.phone_number_field :example_phone_number_field_validation, props: { label: "Example phone field" } %>
+  <%= form.email_field :example_email_field_validation, props: { label: true, required: true } %>
+  <%= form.number_field :example_number_field_validation, props: { label: true, required: true } %>
+  <%= form.search_field :example_project_number_validation, props: { label: true, required: true, validation: { pattern: "[0-9]{2}-[0-9]{5}", message: "Please enter a valid project number (example: 33-12345)." } } %>
+  <%= form.password_field :example_password_field_validation, props: { label: true, required: true } %>
+  <%= form.url_field :example_url_field_validation, props: { label: true, required: true } %>
+  <%= form.text_area :example_text_area_validation, props: { label: true, required: true } %>
+  <%= form.dropdown_field :example_dropdown_validation, props: { label: true, options: example_dropdown_options, required: true } %>
+  <%= form.select :example_select_validation, [ ["Yes", 1], ["No", 2] ], props: { label: true, blank_selection: "Select One...", required: true } %>
+  <%= form.collection_select :example_collection_select_validation, example_collection, :value, :name, props: { label: true, blank_selection: "Select One...", required: true } %>
   <%= form.check_box :example_checkbox, props: { text: "Example Checkbox", label: true, required: true } %>
   <%= form.date_picker :example_date_picker_2, props: { label: true, required: true } %>
-  <%= form.star_rating_field :example_star_rating, props: { variant: "interactive", label: true, required: true } %>
+  <%= form.star_rating_field :example_star_rating_validation, props: { variant: "interactive", label: true, required: true } %>
 
   <%= form.actions do |action| %>
     <%= action.submit %>
     <%= action.button props: { type: "reset", text: "Cancel", variant: "secondary" } %>
   <% end %>
 <% end %>
+
+<!-- form.typeahead user results example template -->
+<template data-typeahead-example-result-option>
+  <%= pb_rails("user", props: {
+    name: tag(:slot, name: "name"),
+    orientation: "horizontal",
+    align: "left",
+    avatar_url: "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR4nGP6zwAAAgcBApocMXEAAAAASUVORK5CYII=",
+    avatar: true
+    }) %>
+</template>
+
+<!-- form.typeahead JS example implementation -->
+<%= javascript_tag defer: "defer" do %>
+  document.addEventListener("pb-typeahead-kit-search", function(event) {
+    if (!event.target.dataset || !event.target.dataset.typeaheadExample2) return
+
+    fetch(`https://api.github.com/search/users?q=${encodeURIComponent(event.detail.searchingFor)}`)
+      .then(response => response.json())
+      .then((result) => {
+        const resultOptionTemplate = document.querySelector("[data-typeahead-example-result-option]")
+
+        event.detail.setResults((result.items || []).map((user) => {
+          const wrapper = resultOptionTemplate.content.cloneNode(true)
+          wrapper.children[0].dataset.user = JSON.stringify(user)
+          wrapper.querySelector('slot[name="name"]').replaceWith(user.login)
+          wrapper.querySelector('img').dataset.src = user.avatar_url
+          return wrapper
+        }))
+      })
+  })
+
+
+  document.addEventListener("pb-typeahead-kit-result-option-selected", function(event) {
+    if (!event.target.dataset.typeaheadExample2) return
+
+    const selectedUserJSON = event.detail.selected.firstElementChild.dataset.user
+    const selectedUserData = JSON.parse(selectedUserJSON)
+
+    // set the input field's value
+    event.target.querySelector('input[name=example_typeahead_validation]').value = selectedUserData.login
+
+    // log the selected option's dataset
+    console.log('The selected user data:')
+    console.dir(selectedUserData)
+
+    // do even more with the data later - TBD
+    event.target.dataset.user = selectedUserJSON
+  })
+<% end %>

data/app/pb_kits/playbook/pb_selectable_card/docs/_selectable_card_default.html.erb

@@ -6,7 +6,6 @@
     value: "selected_with_icon",
     checked: true,
     icon: true,
-
   }) do %>
     Selected, with icon
   <% end %>
@@ -37,4 +36,4 @@
     Disabled
   <% end %>
 
-</div>
+</div>

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

@@ -4,11 +4,12 @@ import { debounce } from 'lodash'
 export default class PbTypeahead extends PbEnhancedElement {
   _searchInput: HTMLInputElement
   _resultsElement: HTMLElement
-  _debouncedSearch: Function
+  _debouncedSearch: () => void // changed - diff
   _resultsLoadingIndicator: HTMLElement
   _resultOptionTemplate: HTMLElement
   _resultsOptionCache: Map<string, Array<DocumentFragment>>
   _searchContext: string
+  _validSelection: boolean // changed - new
 
   static get selector() {
     return '[data-pb-typeahead-kit]'
@@ -19,6 +20,7 @@ export default class PbTypeahead extends PbEnhancedElement {
     this.searchInput.addEventListener('focus', () => this.debouncedSearch())
     this.searchInput.addEventListener('input', () => this.debouncedSearch())
     this.resultsElement.addEventListener('click', (event: MouseEvent) => this.optionSelected(event))
+    // this.element.closest('form')?.addEventListener('submit', (event) => this.handleFormSubmission(event)) // changed - new
   }
 
   handleKeydown(event: KeyboardEvent) {
@@ -86,12 +88,44 @@ export default class PbTypeahead extends PbEnhancedElement {
     const resultOption = (event.target as Element).closest('[data-result-option-item]')
     if (!resultOption) return
 
+    this._validSelection = true // changed - new
+    this.removeValidationError() // changed - new
+
     this.resultsCacheClear()
     this.searchInputClear()
     this.clearResults()
 
     this.element.dispatchEvent(new CustomEvent('pb-typeahead-kit-result-option-selected', { bubbles: true, detail: { selected: resultOption, typeahead: this } }))
   }
+  // changed - new
+  removeValidationError() {
+    const inputWrapper = this.searchInput.closest('.text_input_wrapper')
+    if (inputWrapper) {
+      const errorMessage = inputWrapper.querySelector('.pb_body_kit_negative') as HTMLElement
+      if (errorMessage) {
+        errorMessage.style.display = 'none'
+      }
+      this.searchInput.classList.remove('error')
+    }
+  }
+  // changed - new
+  showValidationError() {
+    const inputWrapper = this.searchInput.closest('.text_input_wrapper')
+    if (inputWrapper) {
+      const errorMessage = inputWrapper.querySelector('.pb_body_kit_negative') as HTMLElement
+      if (errorMessage) {
+        errorMessage.style.display = 'block'
+      }
+      this.searchInput.classList.add('error')
+    }
+  }
+  // changed - new
+  // handleFormSubmission(event: Event) {
+  //   if (!this._validSelection) {
+  //     this.showValidationError()
+  //     event.preventDefault()
+  //   }
+  // }
 
   clearResults() {
     this.resultsElement.innerHTML = ''
@@ -201,8 +235,263 @@ export default class PbTypeahead extends PbEnhancedElement {
   }
 
   toggleResultsLoadingIndicator(visible: boolean) {
-    var visibilityProperty = '0'
+    let visibilityProperty = '0' // changed - diff
     if (visible) visibilityProperty = '1'
     this.resultsLoadingIndicator.style.opacity = visibilityProperty
   }
 }
+
+// import PbEnhancedElement from '../pb_enhanced_element';
+// import { debounce } from 'lodash';
+
+// export default class PbTypeahead extends PbEnhancedElement {
+//   _searchInput: HTMLInputElement;
+//   _resultsElement: HTMLElement;
+//   _debouncedSearch: () => void;
+//   _resultsLoadingIndicator: HTMLElement;
+//   _resultOptionTemplate: HTMLElement;
+//   _resultsOptionCache: Map<string, Array<DocumentFragment>>;
+//   _searchContext: string;
+//   _validSelection: boolean;
+
+//   static get selector() {
+//     return '[data-pb-typeahead-kit]';
+//   }
+
+//   connect() {
+//     this.element.addEventListener('keydown', (event: KeyboardEvent) => this.handleKeydown(event));
+//     this.searchInput.addEventListener('focus', () => this.debouncedSearch());
+//     this.searchInput.addEventListener('input', () => this.debouncedSearch());
+//     this.resultsElement.addEventListener('click', (event: MouseEvent) => this.optionSelected(event));
+//     // this.attachFormSubmissionHandler();
+//   }
+
+//   // attachFormSubmissionHandler() {
+//   //   const formElement = this.element.closest('form');
+//   //   if (formElement) {
+//   //     formElement.addEventListener('submit', (event: Event) => {
+//   //       if (!this._validSelection) {
+//   //         this.showValidationError();
+//   //         event.preventDefault();
+//   //       }
+//   //     });
+//   //   }
+//   // }
+
+//   handleKeydown(event: KeyboardEvent) {
+//     if (event.key === 'ArrowUp') {
+//       event.preventDefault();
+//       this.focusPreviousOption();
+//     } else if (event.key === 'ArrowDown') {
+//       event.preventDefault();
+//       this.focusNextOption();
+//     }
+//   }
+
+//   search() {
+//     if (this.searchTerm.length < parseInt(this.searchTermMinimumLength)) {
+//       return this.clearResults();
+//     }
+
+//     this.toggleResultsLoadingIndicator(true);
+//     this.showResults();
+
+//     const searchTerm = this.searchTerm;
+//     const searchContext = this.searchContext;
+//     const search = {
+//       searchingFor: searchTerm,
+//       searchingContext: searchContext,
+//       setResults: (results: Array<DocumentFragment>) => {
+//         this.resultsCacheUpdate(searchTerm, searchContext, results);
+//       },
+//     };
+//     this.element.dispatchEvent(new CustomEvent('pb-typeahead-kit-search', { bubbles: true, detail: search }));
+//   }
+
+//   resultsCacheUpdate(searchTerm: string, searchContext: string, results: Array<DocumentFragment>) {
+//     const searchTermAndContext = this.cacheKeyFor(searchTerm, searchContext);
+//     if (this.resultsOptionCache.has(searchTermAndContext)) {
+//       this.resultsOptionCache.delete(searchTermAndContext);
+//     }
+//     if (this.resultsOptionCache.size > 32) {
+//       this.resultsOptionCache.delete(this.resultsOptionCache.keys().next().value);
+//     }
+
+//     this.resultsOptionCache.set(searchTermAndContext, results);
+//     this.showResults();
+//   }
+
+//   resultsCacheClear() {
+//     this.resultsOptionCache.clear();
+//   }
+
+//   get debouncedSearch() {
+//     return this._debouncedSearch = (
+//       this._debouncedSearch ||
+//       debounce(this.search, parseInt(this.searchDebounceTimeout)).bind(this)
+//     );
+//   }
+
+//   showResults() {
+//     if (!this.resultsOptionCache.has(this.searchTermAndContext)) return;
+
+//     this.toggleResultsLoadingIndicator(false);
+//     this.clearResults();
+//     for (const result of this.resultsOptionCache.get(this.searchTermAndContext)) {
+//       this.resultsElement.appendChild(this.newResultOption(result.cloneNode(true)));
+//     }
+//     for (const result of this.resultsElement.querySelectorAll('[data-result-option-item]')) {
+//       result.addEventListener('mousedown', (event: MouseEvent) => this.optionSelected(event));
+//     }
+//   }
+
+//   optionSelected(event: MouseEvent) {
+//     const resultOption = (event.target as Element).closest('[data-result-option-item]');
+//     if (!resultOption) return;
+
+//     this._validSelection = true;
+//     this.removeValidationError();
+
+//     this.resultsCacheClear();
+//     this.searchInputClear();
+//     this.clearResults();
+
+//     this.element.dispatchEvent(new CustomEvent('pb-typeahead-kit-result-option-selected', {
+//       bubbles: true,
+//       detail: { selected: resultOption, typeahead: this },
+//     }));
+//   }
+
+//   removeValidationError() {
+//     const inputWrapper = this.searchInput.closest('.text_input_wrapper');
+//     if (inputWrapper) {
+//       const errorMessage = inputWrapper.querySelector('.pb_body_kit_negative') as HTMLElement;
+//       if (errorMessage) {
+//         errorMessage.style.display = 'none';
+//       }
+//       this.searchInput.classList.remove('error');
+//     }
+//   }
+
+//   showValidationError() {
+//     const inputWrapper = this.searchInput.closest('.text_input_wrapper');
+//     if (inputWrapper) {
+//       const errorMessage = inputWrapper.querySelector('.pb_body_kit_negative') as HTMLElement;
+//       if (errorMessage) {
+//         errorMessage.style.display = 'block';
+//       }
+//       this.searchInput.classList.add('error');
+//     }
+//   }
+
+//   clearResults() {
+//     this.resultsElement.innerHTML = '';
+//   }
+
+//   newResultOption(content: DocumentFragment) {
+//     const resultOption = (this.resultOptionTemplate as HTMLTemplateElement).content.cloneNode(true) as Element;
+//     resultOption.querySelector('slot[name="content"]').replaceWith(content);
+//     return resultOption;
+//   }
+
+//   focusPreviousOption() {
+//     const currentIndex = this.resultOptionItems.indexOf(this.currentSelectedResultOptionItem);
+//     const previousIndex = currentIndex - 1;
+//     const previousOptionItem = (
+//       this.resultOptionItems[previousIndex] ||
+//       this.resultOptionItems[this.resultOptionItems.length - 1]
+//     );
+//     (previousOptionItem as HTMLElement).focus();
+//   }
+
+//   focusNextOption() {
+//     const currentIndex = this.resultOptionItems.indexOf(this.currentSelectedResultOptionItem);
+//     const nextIndex = currentIndex + 1;
+//     const nextOptionItem = (
+//       this.resultOptionItems[nextIndex] ||
+//       this.resultOptionItems[0]
+//     );
+//     (nextOptionItem as HTMLElement).focus();
+//   }
+
+//   get resultOptionItems() {
+//     return Array.from(this.resultsElement.querySelectorAll('[data-result-option-item]'));
+//   }
+
+//   get currentSelectedResultOptionItem() {
+//     return document.activeElement.closest('[data-result-option-item]');
+//   }
+
+//   get searchInput() {
+//     return this._searchInput = (this._searchInput || this.element.querySelector('input[type="search"]'));
+//   }
+
+//   get searchTerm() {
+//     return this.searchInput.value;
+//   }
+
+//   get searchContext() {
+//     if (this._searchContext) return this._searchContext;
+
+//     const selector = (this.element as HTMLElement).dataset.searchContextValueSelector;
+//     if (selector) return ((
+//       this.element.parentNode.querySelector(selector) ||
+//       this.element.closest(selector)
+//     ) as HTMLInputElement).value;
+
+//     return null;
+//   }
+
+//   set searchContext(value) {
+//     this._searchContext = value;
+//   }
+
+//   get searchTermAndContext() {
+//     return this.cacheKeyFor(this.searchTerm, this.searchContext);
+//   }
+
+//   cacheKeyFor(searchTerm: string, searchContext: string) {
+//     return [searchTerm, JSON.stringify(searchContext)].join();
+//   }
+
+//   searchInputClear() {
+//     this.searchInput.value = '';
+//   }
+
+//   get searchTermMinimumLength() {
+//     return (this.element as HTMLElement).dataset.pbTypeaheadKitSearchTermMinimumLength;
+//   }
+
+//   get searchDebounceTimeout() {
+//     return (this.element as HTMLElement).dataset.pbTypeaheadKitSearchDebounceTimeout;
+//   }
+
+//   get resultsElement() {
+//     return this._resultsElement = (this._resultsElement || this.element.querySelector('[data-pb-typeahead-kit-results]'));
+//   }
+
+//   get resultOptionTemplate() {
+//     return this._resultOptionTemplate = (
+//       this._resultOptionTemplate ||
+//       this.element.querySelector('template[data-pb-typeahead-kit-result-option]')
+//     );
+//   }
+
+//   get resultsOptionCache() {
+//     return this._resultsOptionCache = (
+//       this._resultsOptionCache ||
+//       new Map
+//     );
+//   }
+
+//   get resultsLoadingIndicator() {
+//     return this._resultsLoadingIndicator = (
+//       this._resultsLoadingIndicator ||
+//       this.element.querySelector('[data-pb-typeahead-kit-loading-indicator]')
+//     );
+//   }
+
+//   toggleResultsLoadingIndicator(visible: boolean) {
+//     this.resultsLoadingIndicator.style.opacity = visible ? '1' : '0';
+//   }
+// }

data/app/pb_kits/playbook/pb_typeahead/typeahead.html.erb

@@ -17,11 +17,14 @@
       <%= pb_rails("text_input", props: {
         type: "search",
         input_options: object.input_options,
-        label: object.label,
         name: object.name,
         value: object.value,
         placeholder: object.placeholder,
         margin_bottom: "none",
+        required: object.required,
+        validation: object.validation,
+        label: object.label,
+        id: object.input_options[:id],
       }) %>
       <%= pb_rails("list", props: { ordered: false, borderless: false, xpadding: true, role: "status", aria: { live: "polite" }, data: { pb_typeahead_kit_results: true } }) do %>
       <% end %>
@@ -33,4 +36,4 @@
       <% end %>
     </template>
   <% end %>
-<% end %>
+<% end %>

data/app/pb_kits/playbook/pb_typeahead/typeahead.rb

@@ -40,6 +40,10 @@ module Playbook
       prop :pill_color, type: Playbook::Props::Enum,
                         values: %w[primary neutral success warning error info data_1 data_2 data_3 data_4 data_5 data_6 data_7 data_8 windows siding roofing doors gutters solar insulation accessories],
                         default: "primary"
+      prop :required, type: Playbook::Props::Boolean,
+                      default: false
+      prop :validation, type: Playbook::Props::HashProp,
+                        default: {}
 
       def classname
         default_margin_bottom = margin_bottom.present? ? "" : " mb_sm"

data/app/pb_kits/playbook/utilities/globalPropNames.mjs

@@ -7,6 +7,7 @@ export default [
   "right",
   "top",
   "hover",
+  "groupHover",
   "zIndex",
   "verticalAlign",
   "truncate",

data/app/pb_kits/playbook/utilities/globalProps.ts

@@ -361,21 +361,6 @@ const PROP_CATEGORIES: {[key:string]: (props: {[key: string]: any}) => string} =
     css += maxWidth ? `max_width_${filterClassName(maxWidth)} ` : ''
     return css.trimEnd()
   },
-  minHeightProps: ({ minHeight }: MinHeight) => {
-    let css = ''
-    css += minHeight ? `min_height_${filterClassName(minHeight)} ` : ''
-    return css.trimEnd()
-  },
-  maxHeightProps: ({ maxHeight }: MaxHeight) => {
-    let css = ''
-    css += maxHeight ? `max_height_${filterClassName(maxHeight)} ` : ''
-    return css.trimEnd()
-  },
-  heightProps: ({ height }: Height) => {
-    let css = ''
-    css += height ? `height_${filterClassName(height)} ` : ''
-    return css.trimEnd()
-  },
   zIndexProps: (zIndex: ZIndex) => {
     let css = ''
     Object.entries(zIndex).forEach((zIndexEntry) => {