@emuanalytics/flow-rdf-ui 4.1.6 → 4.1.7

package/dist/components/autocomplete/autocomplete.component.mjs

@@ -2,7 +2,7 @@ import { html, nothing } from 'lit';
 import { FlowRdfFormControl } from '../../internal/flow-ui-rdf-element.mjs';
 import { property, state, query } from 'lit/decorators.js';
 import { FormControlController } from '../../internal/form.mjs';
-import { debounce } from '@emuanalytics/flow-rdf-core/utils';
+import { debounce, isStringFull } from '@emuanalytics/flow-rdf-core/utils';
 import { watch } from '../../internal/watch.mjs';
 import { boolean } from '../../internal/boolean.mjs';
 import { classMap } from 'lit-html/directives/class-map.js';
@@ -56,6 +56,7 @@ class FlowUiAutocomplete extends FlowRdfFormControl {
     this.displayWith = (value) => value;
     this.debounceDelay = 0;
     this.clearable = false;
+    this.clearOnFocus = false;
     this.inputText = "";
     this.open = false;
     this.selectedOption = null;
@@ -78,6 +79,8 @@ class FlowUiAutocomplete extends FlowRdfFormControl {
     this.inline = boolean(this.inline, true);
     this.divider = boolean(this.divider, true);
     this.clearable = boolean(this.clearable, true);
+    this.hoist = boolean(this.hoist, true);
+    this.clearOnFocus = boolean(this.clearOnFocus, true);
   }
   /** Gets the associated form, if one exists. */
   getForm() {
@@ -187,10 +190,12 @@ class FlowUiAutocomplete extends FlowRdfFormControl {
     event.preventDefault();
   }
   /** @internal Handle the `mousedown` event from the clear button */
-  handleClearMouseDown(event) {
+  async handleClearMouseDown(event) {
     event.stopPropagation();
     event.preventDefault();
-    this.setValue("", { emitInputEvent: true });
+    this.setValue("", { emitInputEvent: true, emitChangeEvent: true });
+    await waitForEvent(this, "flow-ui-input");
+    this.hasOptions = false;
     this.input.focus({ preventScroll: true });
   }
   /** @internal Handle option selection when an option is clicked on */
@@ -328,6 +333,14 @@ class FlowUiAutocomplete extends FlowRdfFormControl {
       this.hasFocus = true;
       this.input.focus({ preventScroll: true });
       this.emit("flow-ui-focus");
+      if (this.clearOnFocus) {
+        if (isStringFull(this.value)) {
+          this.setValue("", { emitInputEvent: true, emitChangeEvent: true });
+        } else {
+          this.inputText = "";
+        }
+        this.hasOptions = false;
+      }
       this.toggleListbox();
       this.addListenersForDropdown();
     }
@@ -374,8 +387,8 @@ class FlowUiAutocomplete extends FlowRdfFormControl {
     const hasHelpTextSlot = this.hasSlotController.test("help-text");
     const hasLabel = !!this.label || !!hasLabelSlot;
     const hasHelpText = !!this.helpText || !!hasHelpTextSlot;
-    const hasClearIcon = this.clearable && this.value.length > 0;
-    const isPlaceholderVisible = this.placeholder && this.inputText.length === 0;
+    const hasClearIcon = this.clearable && isStringFull(this.value) && !this.disabled;
+    const isPlaceholderVisible = this.placeholder && isStringFull(this.inputText) === false;
     const horizontalPlacement = this.inline ? "end" : "start";
     const placement = `${this.placement}-${horizontalPlacement}`;
     const strategy = this.inline || this.hoist ? "fixed" : "absolute";
@@ -398,12 +411,7 @@ class FlowUiAutocomplete extends FlowRdfFormControl {
       "form-control--pill": this.pill
     })}
       >
-        <label
-          id="label"
-          part="label"
-          class="form-control__label"
-          aria-hidden=${hasLabel ? "false" : "true"}
-        >
+        <label id="label" part="label" class="form-control__label" aria-hidden=${hasLabel ? "false" : "true"}>
           <slot name="label">${this.label}</slot>
         </label>
 
@@ -416,10 +424,7 @@ class FlowUiAutocomplete extends FlowRdfFormControl {
           <slot name="help-text">${this.helpText}</slot>
         </div>
 
-        <div 
-          part="control" 
-          class="form-control__input"
-        >
+        <div part="control" class="form-control__input">
           <flow-ui-popup
             class=${classMap({
       autocomplete: true,
@@ -475,7 +480,7 @@ class FlowUiAutocomplete extends FlowRdfFormControl {
                   .value=${this.inputText}
                   ?disabled=${this.disabled}
                   @focus=${this.handleInputFocus}
-                  @blur=${this.handleInputBlur} 
+                  @blur=${this.handleInputBlur}
                   @input=${this.handleInput}
                   @change=${this.handleInputChange}
                 />
@@ -483,36 +488,36 @@ class FlowUiAutocomplete extends FlowRdfFormControl {
               </div>
 
               ${hasClearIcon ? html`
-                <button
-                  part="clear-button"
-                  class="autocomplete__clear"
-                  type="button"
-                  aria-label=${this.localize.term("clearEntry")}
-                  @mousedown=${this.handleClearMouseDown}
-                  @click=${this.handleClearClick}
-                  tabindex="-1"
-                >
-                  <slot name="clear-icon">
-                    <flow-ui-icon name="x-circle-fill" library="system"></flow-ui-icon>
-                  </slot>
-                </button>
-                ` : nothing}
-              
+                    <button
+                      part="clear-button"
+                      class="autocomplete__clear"
+                      type="button"
+                      aria-label=${this.localize.term("clearEntry")}
+                      @mousedown=${this.handleClearMouseDown}
+                      @click=${this.handleClearClick}
+                      tabindex="-1"
+                    >
+                      <slot name="clear-icon">
+                        <flow-ui-icon name="x-circle-fill" library="system"></flow-ui-icon>
+                      </slot>
+                    </button>
+                  ` : nothing}
+
               <slot part="suffix" name="suffix" class="autocomplete__suffix"></slot>
             </div>
 
             <div
-                id="listbox"
-                role="listbox"
-                part="listbox"
-                class="autocomplete__listbox"
-                aria-labelledby="label"
-                aria-expanded=${this.open ? "true" : "false"}
-                aria-multiselectable="false"
-                @mouseup=${this.handleListboxClick}
-                @slotchange=${this.handleDefaultSlotChange}
+              id="listbox"
+              role="listbox"
+              part="listbox"
+              class="autocomplete__listbox"
+              aria-labelledby="label"
+              aria-expanded=${this.open ? "true" : "false"}
+              aria-multiselectable="false"
+              @mouseup=${this.handleListboxClick}
+              @slotchange=${this.handleDefaultSlotChange}
             >
-                <slot></slot>
+              <slot></slot>
             </div>
           </flow-ui-popup>
         </div>
@@ -578,6 +583,9 @@ __decorateClass([
 __decorateClass([
   property({ type: Boolean, reflect: true })
 ], FlowUiAutocomplete.prototype, "clearable", 2);
+__decorateClass([
+  property({ type: Boolean, reflect: true, attribute: "clear-on-focus" })
+], FlowUiAutocomplete.prototype, "clearOnFocus", 2);
 __decorateClass([
   state()
 ], FlowUiAutocomplete.prototype, "inputText", 2);

package/dist/components/autocomplete/autocomplete.styles.mjs

@@ -177,7 +177,7 @@ const styles = css`
     border: none;
     background: none;
     padding: 0;
-    margin-inline-start: var(--control-spacing);
+    margin-inline-end: var(--control-spacing);
     transition: var(--flow-ui-transition-fast) color;
     cursor: pointer;
   }

package/dist/custom-elements.json

@@ -957,7 +957,7 @@
               "kind": "field",
               "name": "debouncedInput",
               "type": {
-                "text": "((displayValue: string) => void)"
+                "text": "(displayValue: string) => void"
               },
               "privacy": "private"
             },
@@ -1148,7 +1148,6 @@
               "type": {
                 "text": "((value: string) => string) | ((value: string) => Promise<string>)"
               },
-              "default": "(value => value)",
               "description": "Function for determining the `displayValue` for a given `value`.\nBy default, it will show the `value` itself.",
               "attribute": "displayWith"
             },
@@ -1174,6 +1173,17 @@
               "attribute": "clearable",
               "reflects": true
             },
+            {
+              "kind": "field",
+              "name": "clearOnFocus",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Clear the value when the autocomplete is focused on",
+              "attribute": "clear-on-focus",
+              "reflects": true
+            },
             {
               "kind": "field",
               "name": "inputText",
@@ -1514,7 +1524,6 @@
               "type": {
                 "text": "((value: string) => string) | ((value: string) => Promise<string>)"
               },
-              "default": "(value => value)",
               "description": "Function for determining the `displayValue` for a given `value`.\nBy default, it will show the `value` itself.",
               "fieldName": "displayWith"
             },
@@ -1535,6 +1544,15 @@
               "default": "false",
               "description": "Show the option to clear input",
               "fieldName": "clearable"
+            },
+            {
+              "name": "clear-on-focus",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Clear the value when the autocomplete is focused on",
+              "fieldName": "clearOnFocus"
             }
           ],
           "superclass": {
@@ -1584,6 +1602,129 @@
         }
       ]
     },
+    {
+      "kind": "javascript-module",
+      "path": "components/breadcrumb/breadcrumb.component.js",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "",
+          "name": "FlowUiBreadcrumb",
+          "cssParts": [
+            {
+              "description": "The component's base wrapper.",
+              "name": "base"
+            }
+          ],
+          "slots": [
+            {
+              "description": "One or more breadcrumb items to display.",
+              "name": ""
+            },
+            {
+              "description": "The separator to use between breadcrumb items. Works best with `<flow-ui-icon>`.",
+              "name": "separator"
+            }
+          ],
+          "members": [
+            {
+              "kind": "field",
+              "name": "localize",
+              "privacy": "private",
+              "readonly": true,
+              "default": "new LocalizeController(this)"
+            },
+            {
+              "kind": "field",
+              "name": "separatorDir",
+              "privacy": "private"
+            },
+            {
+              "kind": "field",
+              "name": "defaultSlot",
+              "type": {
+                "text": "HTMLSlotElement"
+              },
+              "privacy": "private"
+            },
+            {
+              "kind": "field",
+              "name": "separatorSlot",
+              "type": {
+                "text": "HTMLSlotElement"
+              },
+              "privacy": "private"
+            },
+            {
+              "kind": "field",
+              "name": "label",
+              "type": {
+                "text": "string"
+              },
+              "default": "''",
+              "description": "The label to use for the breadcrumb control. This will not be shown on the screen, but it will be announced by\nscreen readers and other assistive devices to provide more context for users.",
+              "attribute": "label"
+            },
+            {
+              "kind": "method",
+              "name": "getSeparator",
+              "privacy": "private"
+            },
+            {
+              "kind": "method",
+              "name": "handleSlotChange",
+              "privacy": "private"
+            }
+          ],
+          "attributes": [
+            {
+              "name": "label",
+              "type": {
+                "text": "string"
+              },
+              "default": "''",
+              "description": "The label to use for the breadcrumb control. This will not be shown on the screen, but it will be announced by\nscreen readers and other assistive devices to provide more context for users.",
+              "fieldName": "label"
+            }
+          ],
+          "superclass": {
+            "name": "FlowRdfElement",
+            "module": "/src/internal/flow-ui-rdf-element"
+          },
+          "tagName": "flow-ui-breadcrumb",
+          "summary": "Breadcrumbs provide a group of links so users can easily navigate a website's hierarchy.",
+          "dependencies": [
+            "flow-ui-icon"
+          ],
+          "customElement": true
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "default",
+          "declaration": {
+            "name": "FlowUiBreadcrumb",
+            "module": "components/breadcrumb/breadcrumb.component.js"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "components/breadcrumb/breadcrumb.js",
+      "declarations": [],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "default",
+          "declaration": {
+            "name": "FlowUiBreadcrumb",
+            "module": "components/breadcrumb/breadcrumb.js"
+          }
+        }
+      ]
+    },
     {
       "kind": "javascript-module",
       "path": "components/base-control/base-control.component.js",
@@ -2184,129 +2325,6 @@
         }
       ]
     },
-    {
-      "kind": "javascript-module",
-      "path": "components/breadcrumb/breadcrumb.component.js",
-      "declarations": [
-        {
-          "kind": "class",
-          "description": "",
-          "name": "FlowUiBreadcrumb",
-          "cssParts": [
-            {
-              "description": "The component's base wrapper.",
-              "name": "base"
-            }
-          ],
-          "slots": [
-            {
-              "description": "One or more breadcrumb items to display.",
-              "name": ""
-            },
-            {
-              "description": "The separator to use between breadcrumb items. Works best with `<flow-ui-icon>`.",
-              "name": "separator"
-            }
-          ],
-          "members": [
-            {
-              "kind": "field",
-              "name": "localize",
-              "privacy": "private",
-              "readonly": true,
-              "default": "new LocalizeController(this)"
-            },
-            {
-              "kind": "field",
-              "name": "separatorDir",
-              "privacy": "private"
-            },
-            {
-              "kind": "field",
-              "name": "defaultSlot",
-              "type": {
-                "text": "HTMLSlotElement"
-              },
-              "privacy": "private"
-            },
-            {
-              "kind": "field",
-              "name": "separatorSlot",
-              "type": {
-                "text": "HTMLSlotElement"
-              },
-              "privacy": "private"
-            },
-            {
-              "kind": "field",
-              "name": "label",
-              "type": {
-                "text": "string"
-              },
-              "default": "''",
-              "description": "The label to use for the breadcrumb control. This will not be shown on the screen, but it will be announced by\nscreen readers and other assistive devices to provide more context for users.",
-              "attribute": "label"
-            },
-            {
-              "kind": "method",
-              "name": "getSeparator",
-              "privacy": "private"
-            },
-            {
-              "kind": "method",
-              "name": "handleSlotChange",
-              "privacy": "private"
-            }
-          ],
-          "attributes": [
-            {
-              "name": "label",
-              "type": {
-                "text": "string"
-              },
-              "default": "''",
-              "description": "The label to use for the breadcrumb control. This will not be shown on the screen, but it will be announced by\nscreen readers and other assistive devices to provide more context for users.",
-              "fieldName": "label"
-            }
-          ],
-          "superclass": {
-            "name": "FlowRdfElement",
-            "module": "/src/internal/flow-ui-rdf-element"
-          },
-          "tagName": "flow-ui-breadcrumb",
-          "summary": "Breadcrumbs provide a group of links so users can easily navigate a website's hierarchy.",
-          "dependencies": [
-            "flow-ui-icon"
-          ],
-          "customElement": true
-        }
-      ],
-      "exports": [
-        {
-          "kind": "js",
-          "name": "default",
-          "declaration": {
-            "name": "FlowUiBreadcrumb",
-            "module": "components/breadcrumb/breadcrumb.component.js"
-          }
-        }
-      ]
-    },
-    {
-      "kind": "javascript-module",
-      "path": "components/breadcrumb/breadcrumb.js",
-      "declarations": [],
-      "exports": [
-        {
-          "kind": "js",
-          "name": "default",
-          "declaration": {
-            "name": "FlowUiBreadcrumb",
-            "module": "components/breadcrumb/breadcrumb.js"
-          }
-        }
-      ]
-    },
     {
       "kind": "javascript-module",
       "path": "components/breadcrumb-item/breadcrumb-item.component.js",
@@ -25718,6 +25736,6 @@
   ],
   "package": {
     "name": "@emuanalytics/flow-rdf-ui",
-    "version": "4.1.6"
+    "version": "4.1.7"
   }
 }

package/dist/index.d.mts

@@ -2032,6 +2032,8 @@ declare class FlowUiAutocomplete extends FlowRdfFormControl {
     debounceDelay: number;
     /** Show the option to clear input */
     clearable: boolean;
+    /** Clear the value when the autocomplete is focused on */
+    clearOnFocus: boolean;
     /** Current value displayed by the control; this can be what the user is typing or the label of the selected option */
     private inputText;
     /** @internal Is the listbox open or not */
@@ -2093,7 +2095,7 @@ declare class FlowUiAutocomplete extends FlowRdfFormControl {
     private handleInputBlur;
     handleClearClick(event: MouseEvent): void;
     /** @internal Handle the `mousedown` event from the clear button */
-    handleClearMouseDown(event: MouseEvent): void;
+    handleClearMouseDown(event: MouseEvent): Promise<void>;
     /** @internal Handle option selection when an option is clicked on */
     private handleListboxClick;
     /** @internal Handle mouse and keyboard events in the document, outside the control. */

package/dist/index.d.ts

@@ -2032,6 +2032,8 @@ declare class FlowUiAutocomplete extends FlowRdfFormControl {
     debounceDelay: number;
     /** Show the option to clear input */
     clearable: boolean;
+    /** Clear the value when the autocomplete is focused on */
+    clearOnFocus: boolean;
     /** Current value displayed by the control; this can be what the user is typing or the label of the selected option */
     private inputText;
     /** @internal Is the listbox open or not */
@@ -2093,7 +2095,7 @@ declare class FlowUiAutocomplete extends FlowRdfFormControl {
     private handleInputBlur;
     handleClearClick(event: MouseEvent): void;
     /** @internal Handle the `mousedown` event from the clear button */
-    handleClearMouseDown(event: MouseEvent): void;
+    handleClearMouseDown(event: MouseEvent): Promise<void>;
     /** @internal Handle option selection when an option is clicked on */
     private handleListboxClick;
     /** @internal Handle mouse and keyboard events in the document, outside the control. */

package/dist/package.json.mjs

@@ -1,3 +1,3 @@
-const version = "4.1.6";
+const version = "4.1.7";
 
 export { version };

package/dist/vscode.html-custom-data.json

@@ -228,6 +228,23 @@
           "name": "clearable",
           "description": "Show the option to clear input",
           "values": []
+        },
+        {
+          "name": "clear-on-focus",
+          "description": "Clear the value when the autocomplete is focused on",
+          "values": []
+        }
+      ],
+      "references": []
+    },
+    {
+      "name": "flow-ui-breadcrumb",
+      "description": "Breadcrumbs provide a group of links so users can easily navigate a website's hierarchy.\n\n\n---\n\n\n\n\n### **Slots:**\n - _default_ - One or more breadcrumb items to display.\n- **separator** - The separator to use between breadcrumb items. Works best with `<flow-ui-icon>`.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.",
+      "attributes": [
+        {
+          "name": "label",
+          "description": "The label to use for the breadcrumb control. This will not be shown on the screen, but it will be announced by\nscreen readers and other assistive devices to provide more context for users.",
+          "values": []
         }
       ],
       "references": []
@@ -331,18 +348,6 @@
       ],
       "references": []
     },
-    {
-      "name": "flow-ui-breadcrumb",
-      "description": "Breadcrumbs provide a group of links so users can easily navigate a website's hierarchy.\n\n\n---\n\n\n\n\n### **Slots:**\n - _default_ - One or more breadcrumb items to display.\n- **separator** - The separator to use between breadcrumb items. Works best with `<flow-ui-icon>`.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.",
-      "attributes": [
-        {
-          "name": "label",
-          "description": "The label to use for the breadcrumb control. This will not be shown on the screen, but it will be announced by\nscreen readers and other assistive devices to provide more context for users.",
-          "values": []
-        }
-      ],
-      "references": []
-    },
     {
       "name": "flow-ui-breadcrumb-item",
       "description": "Breadcrumb Items are used inside [breadcrumbs](./flow-ui-breadcrumb) to represent different links.\n\n\n---\n\n\n\n\n### **Slots:**\n - _default_ - The breadcrumb item's label.\n- **prefix** - An optional prefix, usually an icon or icon button.\n- **suffix** - An optional suffix, usually an icon or icon button.\n- **separator** - The separator to use for the breadcrumb item. This will only change the separator for this item. If you want to change it for all items in the group, set the separator on `<flow-ui-breadcrumb>` instead.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **label** - The breadcrumb item's label.\n- **prefix** - The container that wraps the prefix.\n- **suffix** - The container that wraps the suffix.\n- **separator** - The container that wraps the separator.",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@emuanalytics/flow-rdf-ui",
-  "version": "4.1.6",
+  "version": "4.1.7",
   "type": "module",
   "module": "dist/index.mjs",
   "types": "dist/index.d.ts",