@vaadin/form-layout 22.0.0-rc1 → 23.0.0-alpha2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vaadin/form-layout",
-  "version": "22.0.0-rc1",
+  "version": "23.0.0-alpha2",
   "publishConfig": {
     "access": "public"
   },
@@ -34,16 +34,17 @@
   "dependencies": {
     "@polymer/iron-resizable-behavior": "^3.0.0",
     "@polymer/polymer": "^3.0.0",
-    "@vaadin/component-base": "22.0.0-rc1",
-    "@vaadin/vaadin-lumo-styles": "22.0.0-rc1",
-    "@vaadin/vaadin-material-styles": "22.0.0-rc1",
-    "@vaadin/vaadin-themable-mixin": "22.0.0-rc1"
+    "@vaadin/component-base": "23.0.0-alpha2",
+    "@vaadin/vaadin-lumo-styles": "23.0.0-alpha2",
+    "@vaadin/vaadin-material-styles": "23.0.0-alpha2",
+    "@vaadin/vaadin-themable-mixin": "23.0.0-alpha2"
   },
   "devDependencies": {
     "@esm-bundle/chai": "^4.3.4",
+    "@vaadin/custom-field": "23.0.0-alpha2",
     "@vaadin/testing-helpers": "^0.3.2",
-    "@vaadin/text-field": "22.0.0-rc1",
+    "@vaadin/text-field": "23.0.0-alpha2",
     "sinon": "^9.2.1"
   },
-  "gitHead": "7b6f44bcd2c0fd415028ace666feeb0fedb1d540"
+  "gitHead": "070f586dead02ca41b66717820c647f48bf1665f"
 }

package/src/vaadin-form-item.d.ts

@@ -97,7 +97,16 @@ import { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mix
  *
  * See [Styling Components](https://vaadin.com/docs/latest/ds/customization/styling-components) documentation.
  */
-declare class FormItem extends ThemableMixin(HTMLElement) {}
+declare class FormItem extends ThemableMixin(HTMLElement) {
+  /**
+   * Returns a target element to add ARIA attributes to for a field.
+   *
+   * - For Vaadin field components, the method returns an element
+   * obtained through the `ariaTarget` property defined in `FieldMixin`.
+   * - In other cases, the method returns the field element itself.
+   */
+  protected _getFieldAriaTarget(field: HTMLElement): HTMLElement;
+}
 
 declare global {
   interface HTMLElementTagNameMap {

package/src/vaadin-form-item.js

@@ -4,6 +4,7 @@
  * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
  */
 import { html, PolymerElement } from '@polymer/polymer/polymer-element.js';
+import { addValueToAttribute, removeValueFromAttribute } from '@vaadin/field-base/src/utils.js';
 import { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
 
 /**
@@ -145,12 +146,13 @@ class FormItem extends ThemableMixin(PolymerElement) {
           min-width: 0;
         }
       </style>
-      <div id="label" part="label" on-click="_onLabelClick">
-        <slot name="label" id="labelSlot"></slot>
+      <div id="label" part="label" on-click="__onLabelClick">
+        <slot name="label" id="labelSlot" on-slotchange="__onLabelSlotChange"></slot>
+        <span part="required-indicator" aria-hidden="true"></span>
       </div>
       <div id="spacing"></div>
       <div id="content">
-        <slot id="contentSlot"></slot>
+        <slot id="contentSlot" on-slotchange="__onContentSlotChange"></slot>
       </div>
     `;
   }
@@ -159,17 +161,173 @@ class FormItem extends ThemableMixin(PolymerElement) {
     return 'vaadin-form-item';
   }
 
+  constructor() {
+    super();
+    this.__updateInvalidState = this.__updateInvalidState.bind(this);
+
+    /**
+     * An observer for a field node to reflect its `required` and `invalid` attributes to the component.
+     *
+     * @type {MutationObserver}
+     * @private
+     */
+    this.__fieldNodeObserver = new MutationObserver(() => this.__updateRequiredState(this.__fieldNode.required));
+
+    /**
+     * The first label node in the label slot.
+     *
+     * @type {HTMLElement | null}
+     * @private
+     */
+    this.__labelNode = null;
+
+    /**
+     * The first field node in the content slot.
+     *
+     * An element is considered a field when it has the `checkValidity` or `validate` method.
+     *
+     * @type {HTMLElement | null}
+     * @private
+     */
+    this.__fieldNode = null;
+
+    // Ensure every instance has unique ID
+    const uniqueId = (FormItem._uniqueLabelId = 1 + FormItem._uniqueLabelId || 0);
+    this.__labelId = `label-${this.localName}-${uniqueId}`;
+  }
+
+  /**
+   * Returns a target element to add ARIA attributes to for a field.
+   *
+   * - For Vaadin field components, the method returns an element
+   * obtained through the `ariaTarget` property defined in `FieldMixin`.
+   * - In other cases, the method returns the field element itself.
+   *
+   * @param {HTMLElement} field
+   * @protected
+   */
+  _getFieldAriaTarget(field) {
+    return field.ariaTarget || field;
+  }
+
+  /**
+   * Links the label to a field by adding the label id to
+   * the `aria-labelledby` attribute of the field's ARIA target element.
+   *
+   * @param {HTMLElement} field
+   * @private
+   */
+  __linkLabelToField(field) {
+    addValueToAttribute(this._getFieldAriaTarget(field), 'aria-labelledby', this.__labelId);
+  }
+
+  /**
+   * Unlinks the label from a field by removing the label id from
+   * the `aria-labelledby` attribute of the field's ARIA target element.
+   *
+   * @param {HTMLElement} field
+   * @private
+   */
+  __unlinkLabelFromField(field) {
+    removeValueFromAttribute(this._getFieldAriaTarget(field), 'aria-labelledby', this.__labelId);
+  }
+
   /** @private */
-  _onLabelClick() {
-    const firstContentElementChild = Array.prototype.find.call(
-      this.$.contentSlot.assignedNodes(),
-      (e) => e.nodeType === Node.ELEMENT_NODE
-    );
-    if (firstContentElementChild) {
-      firstContentElementChild.focus();
-      firstContentElementChild.click();
+  __onLabelClick() {
+    const fieldNode = this.__fieldNode;
+    if (fieldNode) {
+      fieldNode.focus();
+      fieldNode.click();
     }
   }
+
+  /** @private */
+  __getValidateFunction(field) {
+    return field.validate || field.checkValidity;
+  }
+
+  /**
+   * A `slotchange` event handler for the label slot.
+   *
+   * - Ensures the label id is only assigned to the first label node.
+   * - Ensures the label node is linked to the first field node via the `aria-labelledby` attribute
+   * if both nodes are provided, and unlinked otherwise.
+   *
+   * @private
+   */
+  __onLabelSlotChange() {
+    if (this.__labelNode) {
+      this.__labelNode.id = '';
+      this.__labelNode = null;
+
+      if (this.__fieldNode) {
+        this.__unlinkLabelFromField(this.__fieldNode);
+      }
+    }
+
+    const newLabelNode = this.$.labelSlot.assignedElements()[0];
+    if (newLabelNode) {
+      this.__labelNode = newLabelNode;
+      this.__labelNode.id = this.__labelId;
+
+      if (this.__fieldNode) {
+        this.__linkLabelToField(this.__fieldNode);
+      }
+    }
+  }
+
+  /**
+   * A `slotchange` event handler for the content slot.
+   *
+   * - Ensures the label node is only linked to the first field node via the `aria-labelledby` attribute.
+   * - Sets up an observer for the `required` attribute changes on the first field
+   * to reflect the attribute on the component. Ensures the observer is disconnected from the field
+   * as soon as it is removed or replaced by another one.
+   *
+   * @private
+   */
+  __onContentSlotChange() {
+    if (this.__fieldNode) {
+      // Discard the old field
+      this.__unlinkLabelFromField(this.__fieldNode);
+      this.__updateRequiredState(false);
+      this.__fieldNodeObserver.disconnect();
+      this.__fieldNode = null;
+    }
+
+    const newFieldNode = this.$.contentSlot.assignedElements().find((field) => {
+      return !!this.__getValidateFunction(field);
+    });
+    if (newFieldNode) {
+      this.__fieldNode = newFieldNode;
+      this.__updateRequiredState(this.__fieldNode.required);
+      this.__fieldNodeObserver.observe(this.__fieldNode, { attributes: true, attributeFilter: ['required'] });
+
+      if (this.__labelNode) {
+        this.__linkLabelToField(this.__fieldNode);
+      }
+    }
+  }
+
+  /** @private */
+  __updateRequiredState(required) {
+    if (required) {
+      this.setAttribute('required', '');
+      this.__fieldNode.addEventListener('blur', this.__updateInvalidState);
+      this.__fieldNode.addEventListener('change', this.__updateInvalidState);
+    } else {
+      this.removeAttribute('invalid');
+      this.removeAttribute('required');
+      this.__fieldNode.removeEventListener('blur', this.__updateInvalidState);
+      this.__fieldNode.removeEventListener('change', this.__updateInvalidState);
+    }
+  }
+
+  /** @private */
+  __updateInvalidState() {
+    const isValid = this.__getValidateFunction(this.__fieldNode).call(this.__fieldNode);
+    this.toggleAttribute('invalid', isValid === false);
+  }
 }
 
 customElements.define(FormItem.is, FormItem);

package/theme/lumo/vaadin-form-item-styles.js

@@ -23,6 +23,24 @@ registerStyles(
       transition: color 0.4s;
       line-height: 1.333;
     }
+
+    [part='required-indicator']::after {
+      content: var(--lumo-required-field-indicator, '•');
+      transition: opacity 0.2s;
+      opacity: 0;
+      color: var(--lumo-required-field-indicator-color, var(--lumo-primary-text-color));
+      position: relative;
+      width: 1em;
+      text-align: center;
+    }
+
+    :host([required]) [part='required-indicator']::after {
+      opacity: 1;
+    }
+
+    :host([invalid]) [part='required-indicator']::after {
+      color: var(--lumo-required-field-indicator-color, var(--lumo-error-text-color));
+    }
   `,
   { moduleId: 'lumo-form-item' }
 );

package/theme/material/vaadin-form-item-styles.js

@@ -14,6 +14,15 @@ registerStyles(
       margin-top: 16px;
       margin-bottom: 8px;
     }
+
+    :host([required]) [part='required-indicator']::after {
+      content: ' *';
+      color: inherit;
+    }
+
+    :host([invalid]) [part='label'] {
+      color: var(--material-error-text-color);
+    }
   `,
   { moduleId: 'material-form-item' }
 );