@vaadin/login 24.8.4 → 25.0.0-alpha10

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

@@ -39,7 +39,7 @@ export interface LoginFormEventMap extends HTMLElementEventMap, LoginFormCustomE
  * `<vaadin-login-form>` is a Web Component providing an easy way to require users
  * to log in into an application. Note that component has no shadowRoot.
  *
- * ```
+ * ```html
  * <vaadin-login-form></vaadin-login-form>
  * ```
  *
@@ -48,10 +48,7 @@ export interface LoginFormEventMap extends HTMLElementEventMap, LoginFormCustomE
  *
  * ### Styling
  *
- * The component doesn't have a shadowRoot, so the `<form>` and input fields can be styled from a global scope.
- *
- * Use `<vaadin-login-form-wrapper>` themable component to apply styles.
- * The following shadow DOM parts of the `<vaadin-login-form-wrapper>` are available for styling:
+ * The following shadow DOM parts are available for styling:
  *
  * Part name      | Description
  * ---------------|---------------------------------------------------------|

package/src/vaadin-login-form.js

@@ -7,9 +7,11 @@ import '@vaadin/button/src/vaadin-button.js';
 import '@vaadin/text-field/src/vaadin-text-field.js';
 import '@vaadin/password-field/src/vaadin-password-field.js';
 import './vaadin-login-form-wrapper.js';
-import { html, PolymerElement } from '@polymer/polymer/polymer-element.js';
+import { css, html, LitElement } from 'lit';
+import { ifDefined } from 'lit/directives/if-defined.js';
 import { defineCustomElement } from '@vaadin/component-base/src/define.js';
 import { ElementMixin } from '@vaadin/component-base/src/element-mixin.js';
+import { PolylitMixin } from '@vaadin/component-base/src/polylit-mixin.js';
 import { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
 import { LoginFormMixin } from './vaadin-login-form-mixin.js';
 
@@ -17,7 +19,7 @@ import { LoginFormMixin } from './vaadin-login-form-mixin.js';
  * `<vaadin-login-form>` is a Web Component providing an easy way to require users
  * to log in into an application. Note that component has no shadowRoot.
  *
- * ```
+ * ```html
  * <vaadin-login-form></vaadin-login-form>
  * ```
  *
@@ -26,10 +28,7 @@ import { LoginFormMixin } from './vaadin-login-form-mixin.js';
  *
  * ### Styling
  *
- * The component doesn't have a shadowRoot, so the `<form>` and input fields can be styled from a global scope.
- * Use `<vaadin-login-form-wrapper>` themable component to apply styles.
- *
- * The following shadow DOM parts of the `<vaadin-login-form-wrapper>` are available for styling:
+ * The following shadow DOM parts are available for styling:
  *
  * Part name      | Description
  * ---------------|---------------------------------------------------------|
@@ -53,81 +52,47 @@ import { LoginFormMixin } from './vaadin-login-form-mixin.js';
  * @mixes ThemableMixin
  * @mixes LoginFormMixin
  */
-class LoginForm extends LoginFormMixin(ElementMixin(ThemableMixin(PolymerElement))) {
-  static get template() {
-    return html`
-      <style>
-        vaadin-login-form-wrapper > form > * {
-          width: 100%;
-        }
-      </style>
-      <vaadin-login-form-wrapper
-        id="vaadinLoginFormWrapper"
-        theme$="[[_theme]]"
-        error="[[error]]"
-        i18n="[[__effectiveI18n]]"
-        heading-level="[[headingLevel]]"
-      >
-        <form method="POST" action$="[[action]]" on-formdata="_onFormData" slot="form">
-          <input id="csrf" type="hidden" />
-          <vaadin-text-field
-            name="username"
-            label="[[__effectiveI18n.form.username]]"
-            error-message="[[__effectiveI18n.errorMessage.username]]"
-            id="vaadinLoginUsername"
-            required
-            on-keydown="_handleInputKeydown"
-            autocapitalize="none"
-            autocorrect="off"
-            spellcheck="false"
-            autocomplete="username"
-            manual-validation
-          >
-            <input type="text" slot="input" on-keyup="_handleInputKeyup" />
-          </vaadin-text-field>
-
-          <vaadin-password-field
-            name="password"
-            label="[[__effectiveI18n.form.password]]"
-            error-message="[[__effectiveI18n.errorMessage.password]]"
-            id="vaadinLoginPassword"
-            required
-            on-keydown="_handleInputKeydown"
-            spellcheck="false"
-            autocomplete="current-password"
-            manual-validation
-          >
-            <input type="password" slot="input" on-keyup="_handleInputKeyup" />
-          </vaadin-password-field>
-        </form>
+class LoginForm extends LoginFormMixin(ElementMixin(ThemableMixin(PolylitMixin(LitElement)))) {
+  static get is() {
+    return 'vaadin-login-form';
+  }
 
-        <vaadin-button slot="submit" theme="primary contained submit" on-click="submit" disabled$="[[disabled]]">
-          [[__effectiveI18n.form.submit]]
-        </vaadin-button>
+  static get styles() {
+    return css`
+      :host {
+        display: block;
+        max-width: max-content;
+      }
 
-        <vaadin-button
-          slot="forgot-password"
-          theme="tertiary small"
-          on-click="_onForgotPasswordClick"
-          hidden$="[[noForgotPassword]]"
-        >
-          [[__effectiveI18n.form.forgotPassword]]
-        </vaadin-button>
-      </vaadin-login-form-wrapper>
+      :host([hidden]) {
+        display: none !important;
+      }
     `;
   }
 
-  static get is() {
-    return 'vaadin-login-form';
-  }
-
-  /**
-   * @param {StampedTemplate} dom
-   * @return {null}
-   * @protected
-   */
-  _attachDom(dom) {
-    this.appendChild(dom);
+  /** @protected */
+  render() {
+    return html`
+      <vaadin-login-form-wrapper
+        id="form"
+        theme="${ifDefined(this._theme)}"
+        .error="${this.error}"
+        .i18n="${this.__effectiveI18n}"
+        part="form"
+        role="region"
+        aria-labelledby="title"
+        exportparts="error-message, error-message-title, error-message-description, footer"
+      >
+        <div id="title" slot="form-title" part="form-title" role="heading" aria-level="${this.headingLevel}">
+          ${this.__effectiveI18n.form.title}
+        </div>
+        <slot name="form" slot="form"></slot>
+        <slot name="custom-form-area" slot="custom-form-area"></slot>
+        <slot name="submit" slot="submit"></slot>
+        <slot name="forgot-password" slot="forgot-password"></slot>
+        <slot name="footer" slot="footer"></slot>
+      </vaadin-login-form-wrapper>
+    `;
   }
 }
 

package/src/vaadin-login-overlay-mixin.d.ts

@@ -5,11 +5,10 @@
  */
 import type { Constructor } from '@open-wc/dedupe-mixin';
 import type { OverlayClassMixinClass } from '@vaadin/component-base/src/overlay-class-mixin.js';
-import type { LoginMixinClass } from './vaadin-login-mixin.js';
 
 export declare function LoginOverlayMixin<T extends Constructor<HTMLElement>>(
   base: T,
-): Constructor<LoginMixinClass> & Constructor<LoginOverlayMixinClass> & Constructor<OverlayClassMixinClass> & T;
+): Constructor<LoginOverlayMixinClass> & Constructor<OverlayClassMixinClass> & T;
 
 export declare class LoginOverlayMixinClass {
   /**

package/src/vaadin-login-overlay-mixin.js

@@ -4,15 +4,14 @@
  * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
  */
 import { OverlayClassMixin } from '@vaadin/component-base/src/overlay-class-mixin.js';
-import { LoginMixin } from './vaadin-login-mixin.js';
+import { TitleController } from './title-controller.js';
 
 /**
  * @polymerMixin
- * @mixes LoginMixin
  * @mixes OverlayClassMixin
  */
 export const LoginOverlayMixin = (superClass) =>
-  class LoginOverlayMixin extends OverlayClassMixin(LoginMixin(superClass)) {
+  class LoginOverlayMixin extends OverlayClassMixin(superClass) {
     static get properties() {
       return {
         /**
@@ -32,7 +31,8 @@ export const LoginOverlayMixin = (superClass) =>
         opened: {
           type: Boolean,
           value: false,
-          observer: '_onOpenedChange',
+          reflectToAttribute: true,
+          sync: true,
         },
 
         /**
@@ -46,15 +46,43 @@ export const LoginOverlayMixin = (superClass) =>
       };
     }
 
-    static get observers() {
-      return ['__i18nChanged(__effectiveI18n)'];
+    /** @protected */
+    firstUpdated() {
+      super.firstUpdated();
+
+      this.setAttribute('role', 'dialog');
+
+      this.__titleController = new TitleController(this);
+      this.addController(this.__titleController);
+
+      this._overlayElement = this.$.overlay;
     }
 
     /** @protected */
-    ready() {
-      super.ready();
+    willUpdate(props) {
+      super.willUpdate(props);
+
+      if (props.has('__effectiveI18n') && this.__effectiveI18n.header) {
+        this.title = this.__effectiveI18n.header.title;
+        this.description = this.__effectiveI18n.header.description;
+      }
+    }
+
+    /** @protected */
+    updated(props) {
+      super.updated(props);
+
+      if (props.has('title') || props.has('__effectiveI18n')) {
+        this.__titleController.setTitle(this.title);
+      }
 
-      this._overlayElement = this.$.vaadinLoginOverlayWrapper;
+      if (props.has('headingLevel')) {
+        this.__titleController.setLevel(this.headingLevel);
+      }
+
+      if (props.has('opened')) {
+        this._openedChanged(this.opened);
+      }
     }
 
     /** @protected */
@@ -71,19 +99,14 @@ export const LoginOverlayMixin = (superClass) =>
     disconnectedCallback() {
       super.disconnectedCallback();
 
-      // Close overlay and memorize opened state
-      this.__restoreOpened = this.opened;
-      this.opened = false;
-    }
-
-    /** @private */
-    __i18nChanged(effectiveI18n) {
-      const header = effectiveI18n && effectiveI18n.header;
-      if (!header) {
-        return;
-      }
-      this.title = header.title;
-      this.description = header.description;
+      // Using a timeout to avoid toggling opened state
+      // when just moving the overlay in the DOM
+      setTimeout(() => {
+        if (!this.isConnected) {
+          this.__restoreOpened = this.opened;
+          this.opened = false;
+        }
+      });
     }
 
     /** @protected */
@@ -91,77 +114,28 @@ export const LoginOverlayMixin = (superClass) =>
       e.preventDefault();
     }
 
-    /**
-     * @param {!Event} e
-     * @protected
-     */
-    _retargetEvent(e) {
-      e.stopPropagation();
-      const { detail, composed, cancelable, bubbles } = e;
-
-      const firedEvent = this.dispatchEvent(new CustomEvent(e.type, { bubbles, cancelable, composed, detail }));
-      // Check if `eventTarget.preventDefault()` was called to prevent default in the original event
-      if (!firedEvent) {
-        e.preventDefault();
-      }
+    /** @private */
+    __handleOverlayClosed() {
+      this.dispatchEvent(new CustomEvent('closed'));
     }
 
     /** @private */
-    _onOpenedChange() {
-      const form = this.$.vaadinLoginForm;
-
-      if (!this.opened) {
-        form.$.vaadinLoginUsername.value = '';
-        form.$.vaadinLoginPassword.value = '';
+    _openedChanged(opened, oldOpened) {
+      if (oldOpened) {
+        this._userNameField.value = '';
+        this._passwordField.value = '';
         this.disabled = false;
-
-        if (this._undoTitleTeleport) {
-          this._undoTitleTeleport();
-        }
-
-        if (this._undoFieldsTeleport) {
-          this._undoFieldsTeleport();
-        }
-
-        if (this._undoFooterTeleport) {
-          this._undoFooterTeleport();
-        }
-      } else {
-        this._undoTitleTeleport = this._teleport('title', this.$.vaadinLoginOverlayWrapper);
-
-        this._undoFieldsTeleport = this._teleport(
-          'custom-form-area',
-          form.$.vaadinLoginFormWrapper,
-          form.querySelector('vaadin-button'),
-        );
-
-        this._undoFooterTeleport = this._teleport('footer', form.$.vaadinLoginFormWrapper);
-
+      } else if (opened) {
         // Overlay sets pointerEvents on body to `none`, which breaks LastPass popup
         // Reverting it back to the previous state
         // https://github.com/vaadin/vaadin-overlay/blob/041cde4481b6262eac68d3a699f700216d897373/src/vaadin-overlay.html#L660
-        document.body.style.pointerEvents = this.$.vaadinLoginOverlayWrapper._previousDocumentPointerEvents;
+        document.body.style.pointerEvents = this.$.overlay._previousDocumentPointerEvents;
       }
     }
 
-    /** @private */
-    _teleport(slot, target, refNode) {
-      const teleported = [...this.querySelectorAll(`[slot="${slot}"]`)].map((el) => {
-        if (refNode) {
-          target.insertBefore(el, refNode);
-        } else {
-          target.appendChild(el);
-        }
-        return el;
-      });
-      // Function to undo the teleport
-      return () => {
-        this.append(...teleported);
-      };
-    }
-
-    /** @private */
-    __computeHeadingLevel(headingLevel) {
-      return headingLevel + 1;
-    }
+    /**
+     * Fired when the overlay is closed.
+     *
+     * @event closed
+     */
   };

package/src/vaadin-login-overlay-wrapper.js

@@ -3,43 +3,64 @@
  * Copyright (c) 2018 - 2025 Vaadin Ltd.
  * 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 { html, LitElement } from 'lit';
 import { defineCustomElement } from '@vaadin/component-base/src/define.js';
-import { overlayStyles } from '@vaadin/overlay/src/vaadin-overlay-styles.js';
-import { registerStyles, ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
-import { LoginOverlayWrapperMixin } from './vaadin-login-overlay-wrapper-mixin.js';
-import { loginOverlayWrapperStyles } from './vaadin-login-overlay-wrapper-styles.js';
-
-registerStyles('vaadin-login-overlay-wrapper', [overlayStyles, loginOverlayWrapperStyles], {
-  moduleId: 'vaadin-login-overlay-wrapper-styles',
-});
+import { DirMixin } from '@vaadin/component-base/src/dir-mixin.js';
+import { PolylitMixin } from '@vaadin/component-base/src/polylit-mixin.js';
+import { OverlayMixin } from '@vaadin/overlay/src/vaadin-overlay-mixin.js';
+import { LumoInjectionMixin } from '@vaadin/vaadin-themable-mixin/lumo-injection-mixin.js';
+import { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
+import { loginOverlayWrapperStyles } from './styles/vaadin-login-overlay-wrapper-core-styles.js';
 
 /**
  * An element used internally by `<vaadin-login-overlay>`. Not intended to be used separately.
  *
  * @extends HTMLElement
- * @mixes LoginOverlayWrapperMixin
+ * @mixes DirMixin
+ * @mixes OverlayMixin
  * @mixes ThemableMixin
  * @private
  */
-class LoginOverlayWrapper extends LoginOverlayWrapperMixin(ThemableMixin(PolymerElement)) {
+class LoginOverlayWrapper extends OverlayMixin(DirMixin(ThemableMixin(PolylitMixin(LumoInjectionMixin(LitElement))))) {
   static get is() {
     return 'vaadin-login-overlay-wrapper';
   }
 
-  static get template() {
+  static get styles() {
+    return loginOverlayWrapperStyles;
+  }
+
+  static get properties() {
+    return {
+      /**
+       * Application description. Displayed under the title.
+       */
+      description: {
+        type: String,
+      },
+    };
+  }
+
+  /**
+   * @protected
+   * @override
+   */
+  get _modalRoot() {
+    return this.owner;
+  }
+
+  /** @protected */
+  render() {
     return html`
-      <div id="backdrop" part="backdrop" hidden$="[[!withBackdrop]]"></div>
+      <div id="backdrop" part="backdrop" ?hidden="${!this.withBackdrop}"></div>
       <div part="overlay" id="overlay" tabindex="0">
         <div part="content" id="content">
           <section part="card">
             <div part="brand">
-              <slot name="title">
-                <div part="title" role="heading" aria-level$="[[headingLevel]]">[[title]]</div>
-              </slot>
-              <p part="description">[[description]]</p>
+              <slot name="title"></slot>
+              <div part="description">${this.description}</div>
             </div>
-            <div part="form">
+            <div part="form-wrapper">
               <slot></slot>
             </div>
           </section>

package/src/vaadin-login-overlay.d.ts

@@ -5,6 +5,7 @@
  */
 import { ElementMixin } from '@vaadin/component-base/src/element-mixin.js';
 import { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
+import { LoginFormMixin } from './vaadin-login-form-mixin.js';
 import { LoginOverlayMixin } from './vaadin-login-overlay-mixin.js';
 
 export { LoginI18n } from './vaadin-login-mixin.js';
@@ -33,6 +34,11 @@ export type LoginOverlayLoginEvent = CustomEvent<{
   custom?: Record<string, unknown>;
 }>;
 
+/**
+ * Fired when the overlay is closed.
+ */
+export type LoginOverlayClosedEvent = CustomEvent;
+
 export interface LoginOverlayCustomEventMap {
   'description-changed': LoginOverlayDescriptionChangedEvent;
 
@@ -43,44 +49,48 @@ export interface LoginOverlayCustomEventMap {
   'forgot-password': Event;
 
   login: LoginOverlayLoginEvent;
+
+  closed: LoginOverlayClosedEvent;
 }
 
 export interface LoginOverlayEventMap extends HTMLElementEventMap, LoginOverlayCustomEventMap {}
 
 /**
- * `<vaadin-login-overlay>` is a wrapper of the `<vaadin-login-form>` which opens a login form in an overlay and
- * having an additional `brand` part for application title and description. Using `<vaadin-login-overlay>` allows
- * password managers to work with login form.
+ * `<vaadin-login-overlay>` is a web component which renders a login form in an overlay and
+ * provides an additional `brand` part for application title and description.
  *
- * ```
+ * ```html
  * <vaadin-login-overlay opened></vaadin-login-overlay>
  * ```
  *
  * ### Styling
  *
- * The component doesn't have a shadowRoot, so the `<form>` and input fields can be styled from a global scope.
- * Use `<vaadin-login-overlay-wrapper>` and `<vaadin-login-form-wrapper>` to apply styles.
- *
- * The following Shadow DOM parts of the `<vaadin-login-overlay-wrapper>` are available for styling:
- *
- * Part name       | Description
- * ----------------|---------------------------------------------------------|
- * `card`          | Container for the entire component's content
- * `brand`         | Container for application title and description
- * `form`          | Container for the `<vaadin-login-form>` component
- *
- * See [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.
+ * The following shadow DOM parts are available for styling:
  *
- * See [`<vaadin-login-form>`](#/elements/vaadin-login-form)
- * documentation for  `<vaadin-login-form-wrapper>` stylable parts.
+ * Part name                    | Description
+ * -----------------------------|--------------------------------
+ * `backdrop`                   | Backdrop of the overlay
+ * `overlay`                    | The overlay container element
+ * `content`                    | The overlay content element
+ * `card`                       | Container for the brand and form wrapper
+ * `brand`                      | Container for application title and description
+ * `description`                | The application description
+ * `form-wrapper`               | The login form wrapper element
+ * `form`                       | The login form element
+ * `form-title`                 | Title of the login form
+ * `error-message`              | Container for error message
+ * `error-message-title`        | Container for error message title
+ * `error-message-description`  | Container for error message description
+ * `footer`                     | Container for the footer element
  *
  * @fires {CustomEvent} description-changed - Fired when the `description` property changes.
  * @fires {CustomEvent} disabled-changed - Fired when the `disabled` property changes.
  * @fires {CustomEvent} error-changed - Fired when the `error` property changes.
  * @fires {CustomEvent} forgot-password - Fired when user clicks on the "Forgot password" button.
  * @fires {CustomEvent} login - Fired when a user submits the login.
+ * @fires {CustomEvent} closed - Fired when the overlay is closed.
  */
-declare class LoginOverlay extends LoginOverlayMixin(ElementMixin(ThemableMixin(HTMLElement))) {
+declare class LoginOverlay extends LoginFormMixin(LoginOverlayMixin(ElementMixin(ThemableMixin(HTMLElement)))) {
   addEventListener<K extends keyof LoginOverlayEventMap>(
     type: K,
     listener: (this: LoginOverlay, ev: LoginOverlayEventMap[K]) => void,