@lion/ui 0.15.2 → 0.15.3

package/README.md

@@ -26,15 +26,15 @@
 </p>
 
 <p align="center">
-  <a href="https://lion-web.netlify.app">Website</a>
+  <a href="https://lion.js.org">Website</a>
   ·
-  <a href="https://lion-web.netlify.app/fundamentals/">Fundamentals</a>
+  <a href="https://lion.js.org/fundamentals/">Fundamentals</a>
   ·
-  <a href="https://lion-web.netlify.app/guides/">Guides</a>
+  <a href="https://lion.js.org/guides/">Guides</a>
   ·
-  <a href="https://lion-web.netlify.app/components/">Components</a>
+  <a href="https://lion.js.org/components/">Components</a>
   ·
-  <a href="https://lion-web.netlify.app/blog/">Blog</a>
+  <a href="https://lion.js.org/blog/">Blog</a>
 </p>
 
 **Lion is a set of highly performant, accessible and flexible Web Components.!**
@@ -51,9 +51,38 @@ They provide an unopinionated, white-label layer that can be extended to your ow
 > This makes sense as the main use case is to extend those components and if you do you do not want to override existing stylings.
 
 <p align="center">
-  <a href="https://lion-web.netlify.app/guides/"><strong>Explore the Lion Guides&nbsp;&nbsp;▶</strong></a>
+  <a href="https://lion.js.org/guides/"><strong>Explore the Lion Guides&nbsp;&nbsp;▶</strong></a>
 </p>
 
+<details>
+<summary><h2>Table of Contents</h2></summary>
+<ul>
+  <li><a href="#astro-migration"> Astro migration </a>
+  <ul>
+   <li><a href="#astro-how-to"> Astro how to </a></li>
+   <li><a href="#issues-which-are-not-caused-by-the-migration-not-to-be-fixed-now"> Issues which are not caused by migration </a></li>
+  </ul>
+ </li>
+ <li><a href="#how-to-install"> Installation </a></li>
+ <li><a href="#how-to-use"> How to use </a>
+  <ul>
+   <li><a href="#extend-a-web-component"> Extend a web component </a></li>
+   <li><a href="#use-a-javascript-system"> Use a JavaScript system </a></li>
+   <li><a href="#use-a-web-component"> Use a Web Component </a></li>
+  </ul>
+ </li>
+ <li><a href="#issues"> Issues </a></li>
+ <li><a href="#feature-requests"> Feature request </a></li>
+ <li><a href="#content"> Content </a></li>
+ <li><a href="#technologies"> Technologies </a></li>
+ <li><a href="#rationale"> Rationale </a></li>
+ <li><a href="#coding-guidelines"> Coding guidelines </a></li>
+ <li><a href="#how-to-contribute"> How to contribute </a></li>
+ <li><a href="#site-deployment"> Site deployment </a></li>
+ <li><a href="#content"> Contact </a></li>
+</ul>
+</details>
+
 ## Astro migration
 
 - Keep using `/docs` on the root level as we used it in the `master` branch. The documentation is copied into Astro related directories on `npm run start` and when when anything in `/docs` is updated.
@@ -77,8 +106,6 @@ They provide an unopinionated, white-label layer that can be extended to your ow
 
   Note. There is the same error on master. This issue is not caused by the migration
 
-### TODO
-
 ## How to install
 
 ```bash
@@ -184,7 +211,7 @@ This means you only have to apply your own Design System: by delivering styles,
 
 ## Coding guidelines
 
-Check out our [coding guidelines](https://lion-web.netlify.app/guides/principles/definitions-and-terms/) for more detailed information.
+Check out our [coding guidelines](https://lion.js.org/guides/principles/definitions-and-terms/) for more detailed information.
 
 ## How to contribute
 
@@ -193,6 +220,14 @@ Check out our [coding guidelines](https://lion-web.netlify.app/guides/principles
 Lion Web Components are only as good as its contributions.
 Read our [contribution guide](https://github.com/ing-bank/lion/blob/master/CONTRIBUTING.md) and feel free to enhance/improve Lion. We keep feature requests closed while we're not working on them.
 
+## Site deployment
+
+We use [GitHub Pages](https://docs.github.com/en/pages) to host our static website. Collaborators with push permission to the repository branch [`gh-pages`](https://github.com/ing-bank/lion/tree/gh-pages) can trigger a deploy by simply running:
+
+```bash
+npm run deploy
+```
+
 ## Contact
 
 Feel free to create a github issue for any feedback or questions you might have.

package/components/form-core/src/validate/LionValidationFeedback.js

@@ -87,11 +87,11 @@ export class LionValidationFeedback extends LocalizeMixin(LitElement) {
       ${this.feedbackData &&
       this.feedbackData.map(
         ({ message, type, validator }) => html`
-          <div class="validation-feedback__type">
+          <span class="validation-feedback__type">
             ${message && type
               ? this._localizeManager.msg(`lion-form-core:validation${capitalize(type)}`)
               : nothing}
-          </div>
+          </span>
           ${this._messageTemplate({ message, type, validator })}
         `,
       )}

package/components/form-core/src/validate/ValidateMixin.js

@@ -1,15 +1,15 @@
 /* eslint-disable class-methods-use-this, camelcase, no-param-reassign, max-classes-per-file */
-import { SlotMixin, DisabledMixin } from '@lion/ui/core.js';
+import { DisabledMixin, SlotMixin } from '@lion/ui/core.js';
 import { dedupeMixin } from '@open-wc/dedupe-mixin';
 // TODO: make form-core independent from localize
 import { getLocalizeManager } from '@lion/ui/localize-no-side-effects.js';
 import { ScopedElementsMixin } from '../../../core/src/ScopedElementsMixin.js';
+import { FormControlMixin } from '../FormControlMixin.js';
 import { AsyncQueue } from '../utils/AsyncQueue.js';
 import { pascalCase } from '../utils/pascalCase.js';
 import { SyncUpdatableMixin } from '../utils/SyncUpdatableMixin.js';
 import { LionValidationFeedback } from './LionValidationFeedback.js';
 import { Unparseable } from './Unparseable.js';
-import { FormControlMixin } from '../FormControlMixin.js';
 // eslint-disable-next-line no-unused-vars
 import { ResultValidator as MetaValidator } from './ResultValidator.js';
 // eslint-disable-next-line no-unused-vars
@@ -399,7 +399,7 @@ export const ValidateMixinImplementation = superclass =>
         this.__validateCompleteResolve = resolve;
       });
 
-      if (this.disabled) {
+      if (this.disabled || this.readOnly) {
         this.__clearValidationResults();
         this.__finishValidationPass();
         this._updateFeedbackComponent();

package/components/form-core/test/validate/lion-validation-feedback.test.js

@@ -61,12 +61,12 @@ describe('lion-validation-feedback', () => {
     await el.updateComplete;
 
     const validationFeedbackType = el.shadowRoot?.querySelector('.validation-feedback__type');
-    expect(validationFeedbackType?.textContent?.trim()).to.equal('Error');
+    expect(validationFeedbackType?.textContent?.trim()).to.equal('Error,');
 
     el.feedbackData = [{ message: 'hello', type: 'info', validator: new AlwaysInvalid() }];
     await el.updateComplete;
 
-    expect(validationFeedbackType?.textContent?.trim()).to.equal('Info');
+    expect(validationFeedbackType?.textContent?.trim()).to.equal('Info,');
   });
 
   it('it does not share the type if there is no message', async () => {

package/components/form-core/test-suites/ValidateMixin.suite.js

@@ -1,26 +1,26 @@
-import { LitElement } from 'lit';
-import { aTimeout, defineCE, expect, fixture, html, unsafeStatic } from '@open-wc/testing';
 import {
-  getFormControlMembers,
-  AsyncAlwaysInvalid,
-  AsyncAlwaysValid,
   AlwaysInvalid,
   AlwaysValid,
+  AsyncAlwaysInvalid,
+  AsyncAlwaysValid,
+  getFormControlMembers,
 } from '@lion/ui/form-core-test-helpers.js';
-import sinon from 'sinon';
 import {
-  ResultValidator,
-  ValidateMixin,
   EqualsLength,
-  Unparseable,
   MaxLength,
   MinLength,
-  Validator,
   Required,
+  ResultValidator,
+  Unparseable,
+  ValidateMixin,
+  Validator,
 } from '@lion/ui/form-core.js';
+import { aTimeout, defineCE, expect, fixture, html, unsafeStatic } from '@open-wc/testing';
+import { LitElement } from 'lit';
+import sinon from 'sinon';
 
-import '@lion/ui/define/lion-validation-feedback.js';
 import '@lion/ui/define/lion-field.js';
+import '@lion/ui/define/lion-validation-feedback.js';
 
 /**
  * @typedef {import('@lion/ui/form-core.js').LionField} LionField
@@ -631,6 +631,18 @@ export function runValidateMixinSuite(customConfig) {
         isCatValidator.param = 'Garfield';
         expect(catSpy.callCount).to.equal(2);
       });
+
+      it('Validators will not be called on readOnly fields', async () => {
+        const el = /** @type {ValidateElement} */ (
+          await fixture(html`
+          <${tag} .validators=${[new IsCat()]}>${lightDom}</${tag}>
+        `)
+        );
+
+        el.readOnly = true;
+        el.modelValue = 'dog';
+        expect(el.validationStates.error.IsCat).to.be.undefined;
+      });
     });
 
     describe('Async Validator Integration', () => {

package/components/form-core/translations/bg.js

@@ -1,6 +1,6 @@
 export default {
-  validationError: 'Грешка',
-  validationWarning: 'Предупреждение',
-  validationSuccess: 'Успех',
-  validationInfo: 'Информация',
+  validationError: 'Грешка,',
+  validationWarning: 'Предупреждение,',
+  validationSuccess: 'Успех,',
+  validationInfo: 'Информация,',
 };

package/components/form-core/translations/cs.js

@@ -1,6 +1,6 @@
 export default {
-  validationError: 'Chyba',
-  validationWarning: 'Varování',
-  validationSuccess: 'Úspěch',
-  validationInfo: 'Informace',
+  validationError: 'Chyba,',
+  validationWarning: 'Varování,',
+  validationSuccess: 'Úspěch,',
+  validationInfo: 'Informace,',
 };

package/components/form-core/translations/de.js

@@ -1,6 +1,6 @@
 export default {
-  validationError: 'Fehler',
-  validationWarning: 'Warnhinweis',
-  validationSuccess: 'Erfolgreich',
-  validationInfo: 'Info',
+  validationError: 'Fehler,',
+  validationWarning: 'Warnhinweis,',
+  validationSuccess: 'Erfolgreich,',
+  validationInfo: 'Info,',
 };

package/components/form-core/translations/en.js

@@ -1,6 +1,6 @@
 export default {
-  validationError: 'Error',
-  validationWarning: 'Warning',
-  validationSuccess: 'Success',
-  validationInfo: 'Info',
+  validationError: 'Error,',
+  validationWarning: 'Warning,',
+  validationSuccess: 'Success,',
+  validationInfo: 'Info,',
 };

package/components/form-core/translations/es.js

@@ -1,6 +1,6 @@
 export default {
-  validationError: 'Error',
-  validationWarning: 'Advertencia',
-  validationSuccess: 'Satisfactorio',
-  validationInfo: 'Información',
+  validationError: 'Error,',
+  validationWarning: 'Advertencia,',
+  validationSuccess: 'Satisfactorio,',
+  validationInfo: 'Información,',
 };

package/components/form-core/translations/fr.js

@@ -1,6 +1,6 @@
 export default {
-  validationError: 'Erreur',
-  validationWarning: 'Avertissement',
-  validationSuccess: 'Succès',
-  validationInfo: 'Info',
+  validationError: 'Erreur,',
+  validationWarning: 'Avertissement,',
+  validationSuccess: 'Succès,',
+  validationInfo: 'Info,',
 };

package/components/form-core/translations/hu.js

@@ -1,6 +1,6 @@
 export default {
-  validationError: 'Hiba',
-  validationWarning: 'Figyelmeztetés',
-  validationSuccess: 'Sikeres',
-  validationInfo: 'Információ',
+  validationError: 'Hiba,',
+  validationWarning: 'Figyelmeztetés,',
+  validationSuccess: 'Sikeres,',
+  validationInfo: 'Információ,',
 };

package/components/form-core/translations/it.js

@@ -1,6 +1,6 @@
 export default {
-  validationError: 'Errore',
-  validationWarning: 'Avvertenza',
-  validationSuccess: 'Operazione riuscita',
-  validationInfo: 'Info',
+  validationError: 'Errore,',
+  validationWarning: 'Avvertenza,',
+  validationSuccess: 'Operazione riuscita,',
+  validationInfo: 'Info,',
 };

package/components/form-core/translations/nl.js

@@ -1,6 +1,6 @@
 export default {
-  validationError: 'Fout',
-  validationWarning: 'Waarschuwing',
-  validationSuccess: 'Succes',
-  validationInfo: 'Informatie',
+  validationError: 'Fout,',
+  validationWarning: 'Waarschuwing,',
+  validationSuccess: 'Succes,',
+  validationInfo: 'Informatie,',
 };

package/components/form-core/translations/pl.js

@@ -1,6 +1,6 @@
 export default {
-  validationError: 'Błąd',
-  validationWarning: 'Ostrzeżenie',
-  validationSuccess: 'Zrealizowano pomyślnie',
-  validationInfo: 'Informacja',
+  validationError: 'Błąd,',
+  validationWarning: 'Ostrzeżenie,',
+  validationSuccess: 'Zrealizowano pomyślnie,',
+  validationInfo: 'Informacja,',
 };

package/components/form-core/translations/ro.js

@@ -1,6 +1,6 @@
 export default {
-  validationError: 'Eroare',
-  validationWarning: 'Atenție',
-  validationSuccess: 'Succes',
-  validationInfo: 'Informații',
+  validationError: 'Eroare,',
+  validationWarning: 'Atenție,',
+  validationSuccess: 'Succes,',
+  validationInfo: 'Informații,',
 };

package/components/form-core/translations/ru.js

@@ -1,6 +1,6 @@
 export default {
-  validationError: 'Ошибка',
-  validationWarning: 'Предупреждение',
-  validationSuccess: 'Успешно',
-  validationInfo: 'Информация',
+  validationError: 'Ошибка,',
+  validationWarning: 'Предупреждение,',
+  validationSuccess: 'Успешно,',
+  validationInfo: 'Информация,',
 };

package/components/form-core/translations/sk.js

@@ -1,6 +1,6 @@
 export default {
-  validationError: 'Chyba',
-  validationWarning: 'Varovanie',
-  validationSuccess: 'Úspešné',
-  validationInfo: 'Info',
+  validationError: 'Chyba,',
+  validationWarning: 'Varovanie,',
+  validationSuccess: 'Úspešné,',
+  validationInfo: 'Info,',
 };

package/components/form-core/translations/uk.js

@@ -1,6 +1,6 @@
 export default {
-  validationError: 'Помилка',
-  validationWarning: 'Попередження',
-  validationSuccess: 'Успішно',
-  validationInfo: 'Інформація',
+  validationError: 'Помилка,',
+  validationWarning: 'Попередження,',
+  validationSuccess: 'Успішно,',
+  validationInfo: 'Інформація,',
 };

package/components/form-core/translations/zh.js

@@ -1,6 +1,6 @@
 export default {
-  validationError: '错误',
-  validationWarning: '警告',
-  validationSuccess: '成功',
-  validationInfo: '信息',
+  validationError: '错误，',
+  validationWarning: '警告，',
+  validationSuccess: '成功，',
+  validationInfo: '信息，',
 };

package/components/input-stepper/src/LionInputStepper.js

@@ -1,4 +1,4 @@
-import { html, css, render } from 'lit';
+import { html, css, render, nothing } from 'lit';
 import { formatNumber, LocalizeMixin, parseNumber } from '@lion/ui/localize-no-side-effects.js';
 import { LionInput } from '@lion/ui/input.js';
 import { IsNumber, MinNumber, MaxNumber } from '@lion/ui/form-core.js';
@@ -96,8 +96,6 @@ export class LionInputStepper extends LocalizeMixin(LionInput) {
 
     this._increment = this._increment.bind(this);
     this._decrement = this._decrement.bind(this);
-    this._onEnterButton = this._onEnterButton.bind(this);
-    this._onLeaveButton = this._onLeaveButton.bind(this);
   }
 
   connectedCallback() {
@@ -244,6 +242,26 @@ export class LionInputStepper extends LocalizeMixin(LionInput) {
       this._inputNode.removeAttribute('aria-valuenow');
       this._inputNode.removeAttribute('aria-valuetext');
     }
+    this._destroyOutputContent();
+  }
+
+  _destroyOutputContent() {
+    const outputElement = /** @type {HTMLElement} */ (
+      this.shadowRoot?.querySelector('.input-stepper__value')
+    );
+
+    const timeoutValue = outputElement?.dataset?.selfDestruct
+      ? Number(outputElement.dataset.selfDestruct)
+      : 2000;
+    clearTimeout(this.timer);
+    if (outputElement) {
+      this.timer = setTimeout(() => {
+        if (outputElement.parentNode) {
+          this.__valueText = nothing;
+          this.requestUpdate();
+        }
+      }, timeoutValue);
+    }
   }
 
   /**
@@ -267,12 +285,19 @@ export class LionInputStepper extends LocalizeMixin(LionInput) {
   _increment() {
     const { step, min, max } = this.values;
     const stepMin = min !== Infinity ? min : 0;
+    const epsilon = 1e-10; // Tolerance for floating-point comparison
 
-    let newValue = this.currentValue + step;
+    let newValue;
 
-    if ((this.currentValue + stepMin) % step !== 0) {
-      // If the value is not aligned to step, align it to the nearest step
-      newValue = Math.floor(this.currentValue / step) * step + step + (stepMin % step);
+    const remainder = (this.currentValue - stepMin) % step;
+    const isAligned = Math.abs(remainder) < epsilon || Math.abs(remainder - step) < epsilon;
+
+    if (!isAligned) {
+      // If the value is not aligned to step, align it to the next valid step
+      newValue = Math.ceil((this.currentValue - stepMin) / step) * step + stepMin;
+    } else {
+      // If the value is aligned, just add the step
+      newValue = this.currentValue + step;
     }
 
     if (newValue <= max || max === Infinity) {
@@ -289,12 +314,19 @@ export class LionInputStepper extends LocalizeMixin(LionInput) {
   _decrement() {
     const { step, max, min } = this.values;
     const stepMin = min !== Infinity ? min : 0;
+    const epsilon = 1e-10; // Tolerance for floating-point comparison
+
+    let newValue;
 
-    let newValue = this.currentValue - step;
+    const remainder = (this.currentValue - stepMin) % step;
+    const isAligned = Math.abs(remainder) < epsilon || Math.abs(remainder - step) < epsilon;
 
-    if ((this.currentValue + stepMin) % step !== 0) {
-      // If the value is not aligned to step, align it to the nearest step
-      newValue = Math.floor(this.currentValue / step) * step + (stepMin % step);
+    if (!isAligned) {
+      // If the value is not aligned to step, align it to the previous valid step
+      newValue = Math.floor((this.currentValue - stepMin) / step) * step + stepMin;
+    } else {
+      // If the value is aligned, just subtract the step
+      newValue = this.currentValue - step;
     }
 
     if (newValue >= min || min === Infinity) {
@@ -380,10 +412,8 @@ export class LionInputStepper extends LocalizeMixin(LionInput) {
       <button
         ?disabled=${this.disabled || this.readOnly}
         @click=${this._decrement}
-        @focus=${this._onEnterButton}
-        @blur=${this._onLeaveButton}
         type="button"
-        aria-label="${this.msgLit('lion-input-stepper:decrease')}"
+        aria-label="${this.msgLit('lion-input-stepper:decrease')} ${this.fieldName}"
       >
         ${this._decrementorSignTemplate()}
       </button>
@@ -400,10 +430,8 @@ export class LionInputStepper extends LocalizeMixin(LionInput) {
       <button
         ?disabled=${this.disabled || this.readOnly}
         @click=${this._increment}
-        @focus=${this._onEnterButton}
-        @blur=${this._onLeaveButton}
         type="button"
-        aria-label="${this.msgLit('lion-input-stepper:increase')}"
+        aria-label="${this.msgLit('lion-input-stepper:increase')} ${this.fieldName}"
       >
         ${this._incrementorSignTemplate()}
       </button>
@@ -413,7 +441,9 @@ export class LionInputStepper extends LocalizeMixin(LionInput) {
   /** @protected */
   _inputGroupTemplate() {
     return html`
-      <div class="input-stepper__value">${this.__valueText}</div>
+      <output for="${this._inputId}" data-self-destruct="2000" class="input-stepper__value"
+        >${this.__valueText}</output
+      >
       <div class="input-group">
         ${this._inputGroupBeforeTemplate()}
         <div class="input-group__container">
@@ -424,38 +454,4 @@ export class LionInputStepper extends LocalizeMixin(LionInput) {
       </div>
     `;
   }
-
-  /**
-   * @protected
-   * @param {Event} ev
-   */
-  // eslint-disable-next-line no-unused-vars
-  _onEnterButton(ev) {
-    const valueNode = /** @type {HTMLElement} */ (
-      this.shadowRoot?.querySelector('.input-stepper__value')
-    );
-    valueNode.setAttribute('aria-live', 'assertive');
-  }
-
-  /**
-   * Redispatch leave event on host when catching leave event
-   * on the incrementor and decrementor button.
-   *
-   * This redispatched leave event will be caught by
-   * InteractionStateMixin to set "touched" state to true.
-   *
-   * Interacting with the buttons is "user interactions"
-   * the same way as focusing + blurring the field (native input)
-   *
-   * @protected
-   * @param {Event} ev
-   */
-  // eslint-disable-next-line no-unused-vars
-  _onLeaveButton(ev) {
-    const valueNode = /** @type {HTMLElement} */ (
-      this.shadowRoot?.querySelector('.input-stepper__value')
-    );
-    valueNode.removeAttribute('aria-live');
-    this.dispatchEvent(new Event(this._leaveEvent));
-  }
 }