@emuanalytics/flow-rdf-ui 0.0.1 → 0.0.3

package/src/components/input/input.ts

@@ -1,563 +0,0 @@
-/* eslint-disable lit-a11y/no-aria-slot */
-import type { CSSResultGroup } from 'lit';
-import { html } from 'lit';
-import { customElement, property, query, state } from 'lit/decorators.js';
-import { classMap } from 'lit/directives/class-map.js';
-import { ifDefined } from 'lit/directives/if-defined.js';
-import { live } from 'lit/directives/live.js';
-import { defaultValue } from '../../internal/default-value';
-import type { FlowRdfFormControl } from '../../internal/flow-ui-rdf-element';
-import FlowRdfElement from '../../internal/flow-ui-rdf-element';
-import { FormControlController } from '../../internal/form';
-import { HasSlotController } from '../../internal/slot';
-import { watch } from '../../internal/watch';
-import { LocalizeController } from '../../utilities/localize';
-import '../icon/icon';
-import styles from './input.styles';
-
-/**
- * @summary Inputs collect data from the user.
- * @documentation https://developer.emu-analytics.net/docs/flow-ui-rdf/components/input
- * @status stable
- * @since 2.0
- *
- * @dependency flow-ui-icon
- *
- * @slot label - The input's label. Alternatively, you can use the `label` attribute.
- * @slot prefix - Used to prepend a presentational icon or similar element to the input.
- * @slot suffix - Used to append a presentational icon or similar element to the input.
- * @slot clear-icon - An icon to use in lieu of the default clear icon.
- * @slot show-password-icon - An icon to use in lieu of the default show password icon.
- * @slot hide-password-icon - An icon to use in lieu of the default hide password icon.
- * @slot help-text - Text that describes how to use the input. Alternatively, you can use the `help-text` attribute.
- *
- * @event flow-ui-blur - Emitted when the control loses focus.
- * @event flow-ui-change - Emitted when an alteration to the control's value is committed by the user.
- * @event flow-ui-clear - Emitted when the clear button is activated.
- * @event flow-ui-focus - Emitted when the control gains focus.
- * @event flow-ui-input - Emitted when the control receives input.
- * @event flow-ui-invalid - Emitted when the form control has been checked for validity and its constraints aren't satisfied.
- *
- * @csspart form-control - The form control that wraps the label, input, and help text.
- * @csspart form-control-label - The label's wrapper.
- * @csspart form-control-input - The input's wrapper.
- * @csspart form-control-help-text - The help text's wrapper.
- * @csspart base - The component's base wrapper.
- * @csspart input - The internal `<input>` control.
- * @csspart prefix - The container that wraps the prefix.
- * @csspart clear-button - The clear button.
- * @csspart password-toggle-button - The password toggle button.
- * @csspart suffix - The container that wraps the suffix.
- */
-@customElement('flow-ui-input')
-export default class FlowInput extends FlowRdfElement implements FlowRdfFormControl {
-  static styles: CSSResultGroup = styles;
-
-  private readonly formControlController = new FormControlController(this, {
-    assumeInteractionOn: ['flow-ui-blur', 'flow-ui-input']
-  });
-  private readonly hasSlotController = new HasSlotController(this, 'help-text', 'label');
-  private readonly localize = new LocalizeController(this);
-
-  @query('.input__control') input: HTMLInputElement;
-
-  @state() private hasFocus = false;
-  @property() title = ''; // make reactive to pass through
-
-  /**
-   * The type of input. Works the same as a native `<input>` element, but only a subset of types are supported. Defaults
-   * to `text`.
-   */
-  @property({ reflect: true }) type:
-    | 'date'
-    | 'datetime-local'
-    | 'email'
-    | 'number'
-    | 'password'
-    | 'search'
-    | 'tel'
-    | 'text'
-    | 'time'
-    | 'url' = 'text';
-
-  /** The name of the input, submitted as a name/value pair with form data. */
-  @property() name = '';
-
-  /** The current value of the input, submitted as a name/value pair with form data. */
-  @property() value = '';
-
-  /** The default value of the form control. Primarily used for resetting the form control. */
-  @defaultValue() defaultValue = '';
-
-  /** The input's size. */
-  @property({ reflect: true }) size: 'small' | 'medium' | 'large' = 'medium';
-
-  /** Draws a filled input. */
-  @property({ type: Boolean, reflect: true }) filled = false;
-
-  /** Draws a pill-style input with rounded edges. */
-  @property({ type: Boolean, reflect: true }) pill = false;
-
-  /** The input's label. If you need to display HTML, use the `label` slot instead. */
-  @property() label = '';
-
-  /** The input's help text. If you need to display HTML, use the `help-text` slot instead. */
-  @property({ attribute: 'help-text' }) helpText = '';
-
-  /** Adds a clear button when the input is not empty. */
-  @property({ type: Boolean }) clearable = false;
-
-  /** Disables the input. */
-  @property({ type: Boolean, reflect: true }) disabled = false;
-
-  /** Placeholder text to show as a hint when the input is empty. */
-  @property() placeholder = '';
-
-  /** Makes the input readonly. */
-  @property({ type: Boolean, reflect: true }) readonly = false;
-
-  /** Adds a button to toggle the password's visibility. Only applies to password types. */
-  @property({ attribute: 'password-toggle', type: Boolean }) passwordToggle = false;
-
-  /** Determines whether or not the password is currently visible. Only applies to password input types. */
-  @property({ attribute: 'password-visible', type: Boolean }) passwordVisible = false;
-
-  /** Hides the browser's built-in increment/decrement spin buttons for number inputs. */
-  @property({ attribute: 'no-spin-buttons', type: Boolean }) noSpinButtons = false;
-
-  /**
-   * By default, form controls are associated with the nearest containing `<form>` element. This attribute allows you
-   * to place the form control outside of a form and associate it with the form that has this `id`. The form must be in
-   * the same document or shadow root for this to work.
-   */
-  @property({ reflect: true }) form = '';
-
-  /** Makes the input a required field. */
-  @property({ type: Boolean, reflect: true }) required = false;
-
-  /** A regular expression pattern to validate input against. */
-  @property() pattern: string;
-
-  /** The minimum length of input that will be considered valid. */
-  @property({ type: Number }) minlength: number;
-
-  /** The maximum length of input that will be considered valid. */
-  @property({ type: Number }) maxlength: number;
-
-  /** The input's minimum value. Only applies to date and number input types. */
-  @property() min: number | string;
-
-  /** The input's maximum value. Only applies to date and number input types. */
-  @property() max: number | string;
-
-  /**
-   * Specifies the granularity that the value must adhere to, or the special value `any` which means no stepping is
-   * implied, allowing any numeric value. Only applies to date and number input types.
-   */
-  @property() step: number | 'any';
-
-  /** Controls whether and how text input is automatically capitalized as it is entered by the user. */
-  @property() autocapitalize: 'off' | 'none' | 'on' | 'sentences' | 'words' | 'characters';
-
-  /** Indicates whether the browser's autocorrect feature is on or off. */
-  @property() autocorrect: 'off' | 'on';
-
-  /**
-   * Specifies what permission the browser has to provide assistance in filling out form field values. Refer to
-   * [this page on MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete) for available values.
-   */
-  @property() autocomplete: string;
-
-  /** Indicates that the input should receive focus on page load. */
-  @property({ type: Boolean }) autofocus: boolean;
-
-  /** Used to customize the label or icon of the Enter key on virtual keyboards. */
-  @property() enterkeyhint: 'enter' | 'done' | 'go' | 'next' | 'previous' | 'search' | 'send';
-
-  /** Enables spell checking on the input. */
-  @property({
-    type: Boolean,
-    converter: {
-      // Allow "true|false" attribute values but keep the property boolean
-      fromAttribute: value => (!value || value === 'false' ? false : true),
-      toAttribute: value => (value ? 'true' : 'false')
-    }
-  })
-  spellcheck = true;
-
-  /**
-   * Tells the browser what type of data will be entered by the user, allowing it to display the appropriate virtual
-   * keyboard on supportive devices.
-   */
-  @property() inputmode: 'none' | 'text' | 'decimal' | 'numeric' | 'tel' | 'search' | 'email' | 'url';
-
-  //
-  // NOTE: We use an in-memory input for these getters/setters instead of the one in the template because the properties
-  // can be set before the component is rendered.
-  //
-
-  /** Gets or sets the current value as a `Date` object. Returns `null` if the value can't be converted. */
-  get valueAsDate() {
-    const input = document.createElement('input');
-    input.type = 'date';
-    input.value = this.value;
-    return input.valueAsDate;
-  }
-
-  set valueAsDate(newValue: Date | null) {
-    const input = document.createElement('input');
-    input.type = 'date';
-    input.valueAsDate = newValue;
-    this.value = input.value;
-  }
-
-  /** Gets or sets the current value as a number. Returns `NaN` if the value can't be converted. */
-  get valueAsNumber() {
-    const input = document.createElement('input');
-    input.type = 'number';
-    input.value = this.value;
-    return input.valueAsNumber;
-  }
-
-  set valueAsNumber(newValue: number) {
-    const input = document.createElement('input');
-    input.type = 'number';
-    input.valueAsNumber = newValue;
-    this.value = input.value;
-  }
-
-  /** Gets the validity state object */
-  get validity() {
-    return this.input.validity;
-  }
-
-  /** Gets the validation message */
-  get validationMessage() {
-    return this.input.validationMessage;
-  }
-
-  firstUpdated() {
-    this.formControlController.updateValidity();
-  }
-
-  private handleBlur() {
-    this.hasFocus = false;
-    this.emit('flow-ui-blur');
-  }
-
-  private handleChange() {
-    this.value = this.input.value;
-    this.emit('flow-ui-change');
-  }
-
-  private handleClearClick(event: MouseEvent) {
-    this.value = '';
-    this.emit('flow-ui-clear');
-    this.emit('flow-ui-input');
-    this.emit('flow-ui-change');
-    this.input.focus();
-
-    event.stopPropagation();
-  }
-
-  private handleFocus() {
-    this.hasFocus = true;
-    this.emit('flow-ui-focus');
-  }
-
-  private handleInput() {
-    this.value = this.input.value;
-    this.formControlController.updateValidity();
-    this.emit('flow-ui-input');
-  }
-
-  private handleInvalid(event: Event) {
-    this.formControlController.setValidity(false);
-    this.formControlController.emitInvalidEvent(event);
-  }
-
-  private handleKeyDown(event: KeyboardEvent) {
-    const hasModifier = event.metaKey || event.ctrlKey || event.shiftKey || event.altKey;
-
-    // Pressing enter when focused on an input should submit the form like a native input, but we wait a tick before
-    // submitting to allow users to cancel the keydown event if they need to
-    if (event.key === 'Enter' && !hasModifier) {
-      setTimeout(() => {
-        //
-        // When using an Input Method Editor (IME), pressing enter will cause the form to submit unexpectedly. One way
-        // to check for this is to look at event.isComposing, which will be true when the IME is open.
-        //
-        // See https://github.com/shoelace-style/shoelace/pull/988
-        //
-        if (!event.defaultPrevented && !event.isComposing) {
-          this.formControlController.submit();
-        }
-      });
-    }
-
-    // RJS - Added to stop typing in the input triggering global key shortcuts
-    // e.g. in storybook, typing 'f' opens and closes left panel
-    event.stopPropagation();
-  }
-
-  private handlePasswordToggle() {
-    this.passwordVisible = !this.passwordVisible;
-  }
-
-  @watch('disabled', { waitUntilFirstUpdate: true })
-  handleDisabledChange() {
-    // Disabled form controls are always valid
-    this.formControlController.setValidity(this.disabled);
-  }
-
-  @watch('step', { waitUntilFirstUpdate: true })
-  handleStepChange() {
-    // If step changes, the value may become invalid so we need to recheck after the update. We set the new step
-    // imperatively so we don't have to wait for the next render to report the updated validity.
-    this.input.step = String(this.step);
-    this.formControlController.updateValidity();
-  }
-
-  @watch('value', { waitUntilFirstUpdate: true })
-  async handleValueChange() {
-    await this.updateComplete;
-    this.formControlController.updateValidity();
-  }
-
-  /** Sets focus on the input. */
-  focus(options?: FocusOptions) {
-    this.input.focus(options);
-  }
-
-  /** Removes focus from the input. */
-  blur() {
-    this.input.blur();
-  }
-
-  /** Selects all the text in the input. */
-  select() {
-    this.input.select();
-  }
-
-  /** Sets the start and end positions of the text selection (0-based). */
-  setSelectionRange(
-    selectionStart: number,
-    selectionEnd: number,
-    selectionDirection: 'forward' | 'backward' | 'none' = 'none'
-  ) {
-    this.input.setSelectionRange(selectionStart, selectionEnd, selectionDirection);
-  }
-
-  /** Replaces a range of text with a new string. */
-  setRangeText(
-    replacement: string,
-    start?: number,
-    end?: number,
-    selectMode?: 'select' | 'start' | 'end' | 'preserve'
-  ) {
-    // @ts-expect-error - start, end, and selectMode are optional
-    this.input.setRangeText(replacement, start, end, selectMode);
-
-    if (this.value !== this.input.value) {
-      this.value = this.input.value;
-    }
-  }
-
-  /** Displays the browser picker for an input element (only works if the browser supports it for the input type). */
-  showPicker() {
-    if ('showPicker' in HTMLInputElement.prototype) {
-      this.input.showPicker();
-    }
-  }
-
-  /** Increments the value of a numeric input type by the value of the step attribute. */
-  stepUp() {
-    this.input.stepUp();
-    if (this.value !== this.input.value) {
-      this.value = this.input.value;
-    }
-  }
-
-  /** Decrements the value of a numeric input type by the value of the step attribute. */
-  stepDown() {
-    this.input.stepDown();
-    if (this.value !== this.input.value) {
-      this.value = this.input.value;
-    }
-  }
-
-  /** Checks for validity but does not show a validation message. Returns `true` when valid and `false` when invalid. */
-  checkValidity() {
-    return this.input.checkValidity();
-  }
-
-  /** Gets the associated form, if one exists. */
-  getForm(): HTMLFormElement | null {
-    return this.formControlController.getForm();
-  }
-
-  /** Checks for validity and shows the browser's validation message if the control is invalid. */
-  reportValidity() {
-    return this.input.reportValidity();
-  }
-
-  /** Sets a custom validation message. Pass an empty string to restore validity. */
-  setCustomValidity(message: string) {
-    this.input.setCustomValidity(message);
-    this.formControlController.updateValidity();
-  }
-
-  render() {
-    const hasLabelSlot = this.hasSlotController.test('label');
-    const hasHelpTextSlot = this.hasSlotController.test('help-text');
-    const hasLabel = this.label ? true : !!hasLabelSlot;
-    const hasHelpText = this.helpText ? true : !!hasHelpTextSlot;
-    const hasClearIcon =
-      this.clearable && !this.disabled && !this.readonly && (typeof this.value === 'number' || this.value.length > 0);
-
-    return html`
-      <div
-        part="form-control"
-        class=${classMap({
-          'form-control': true,
-          'form-control--small': this.size === 'small',
-          'form-control--medium': this.size === 'medium',
-          'form-control--large': this.size === 'large',
-          'form-control--has-label': hasLabel,
-          'form-control--has-help-text': hasHelpText
-        })}
-      >
-        <label
-          part="form-control-label"
-          class="form-control__label"
-          for="input"
-          aria-hidden=${hasLabel ? 'false' : 'true'}
-        >
-          <slot name="label">${this.label}</slot>
-        </label>
-
-        <div part="form-control-input" class="form-control-input">
-          <div
-            part="base"
-            class=${classMap({
-              input: true,
-
-              // Sizes
-              'input--small': this.size === 'small',
-              'input--medium': this.size === 'medium',
-              'input--large': this.size === 'large',
-
-              // States
-              'input--pill': this.pill,
-              'input--standard': !this.filled,
-              'input--filled': this.filled,
-              'input--disabled': this.disabled,
-              'input--focused': this.hasFocus,
-              'input--empty': !this.value,
-              'input--no-spin-buttons': this.noSpinButtons
-            })}
-          >
-            <slot name="prefix" part="prefix" class="input__prefix"></slot>
-            <input
-              part="input"
-              id="input"
-              class="input__control"
-              type=${this.type === 'password' && this.passwordVisible ? 'text' : this.type}
-              title=${this.title /* An empty title prevents browser validation tooltips from appearing on hover */}
-              name=${ifDefined(this.name)}
-              ?disabled=${this.disabled}
-              ?readonly=${this.readonly}
-              ?required=${this.required}
-              placeholder=${ifDefined(this.placeholder)}
-              minlength=${ifDefined(this.minlength)}
-              maxlength=${ifDefined(this.maxlength)}
-              min=${ifDefined(this.min)}
-              max=${ifDefined(this.max)}
-              step=${ifDefined(this.step as number)}
-              .value=${live(this.value)}
-              autocapitalize=${ifDefined(this.autocapitalize)}
-              autocomplete=${ifDefined(this.autocomplete as any)}
-              autocorrect=${ifDefined(this.autocorrect)}
-              ?autofocus=${this.autofocus}
-              spellcheck=${this.spellcheck}
-              pattern=${ifDefined(this.pattern)}
-              enterkeyhint=${ifDefined(this.enterkeyhint)}
-              inputmode=${ifDefined(this.inputmode)}
-              aria-describedby="help-text"
-              @change=${this.handleChange}
-              @input=${this.handleInput}
-              @invalid=${this.handleInvalid}
-              @keydown=${this.handleKeyDown}
-              @focus=${this.handleFocus}
-              @blur=${this.handleBlur}
-            />
-
-            ${
-              hasClearIcon
-                ? html`
-                    <button
-                      part="clear-button"
-                      class="input__clear"
-                      type="button"
-                      aria-label=${this.localize.term('clearEntry')}
-                      @click=${this.handleClearClick}
-                      tabindex="-1"
-                    >
-                      <slot name="clear-icon">
-                        <flow-ui-icon name="x-circle-fill" library="system"></flow-ui-icon>
-                      </slot>
-                    </button>
-                  `
-                : ''
-            }
-            ${
-              this.passwordToggle && !this.disabled
-                ? html`
-                    <button
-                      part="password-toggle-button"
-                      class="input__password-toggle"
-                      type="button"
-                      aria-label=${this.localize.term(this.passwordVisible ? 'hidePassword' : 'showPassword')}
-                      @click=${this.handlePasswordToggle}
-                      tabindex="-1"
-                    >
-                      ${this.passwordVisible
-                        ? html`
-                            <slot name="show-password-icon">
-                              <flow-ui-icon name="eye-slash" library="system"></flow-ui-icon>
-                            </slot>
-                          `
-                        : html`
-                            <slot name="hide-password-icon">
-                              <flow-ui-icon name="eye" library="system"></flow-ui-icon>
-                            </slot>
-                          `}
-                    </button>
-                  `
-                : ''
-            }
-
-            <slot name="suffix" part="suffix" class="input__suffix"></slot>
-          </div>
-        </div>
-
-        <slot
-          name="help-text"
-          part="form-control-help-text"
-          id="help-text"
-          class="form-control__help-text"
-          aria-hidden=${hasHelpText ? 'false' : 'true'}
-        >
-          ${this.helpText}
-        </slot>
-        </div>
-      </div>
-    `;
-  }
-}
-
-declare global {
-  interface HTMLElementTagNameMap {
-    'flow-ui-input': FlowInput;
-  }
-}

package/src/components/menu/menu.styles.ts

@@ -1,21 +0,0 @@
-import { css } from 'lit';
-import componentStyles from '../../styles/component.styles';
-
-export default css`
-  ${componentStyles}
-
-  :host {
-    display: block;
-    position: relative;
-    background: var(--flow-ui-panel-background-color);
-    border: solid var(--flow-ui-panel-border-width) var(--flow-ui-panel-border-color);
-    border-radius: var(--flow-ui-border-radius-medium);
-    padding: var(--flow-ui-spacing-x-small) 0;
-    overflow: auto;
-    overscroll-behavior: none;
-  }
-
-  ::slotted(flow-ui-divider) {
-    --spacing: var(--flow-ui-spacing-x-small);
-  }
-`;

package/src/components/menu/menu.test.ts

@@ -1,102 +0,0 @@
-import { expect, fixture } from '@open-wc/testing';
-import { sendKeys } from '@web/test-runner-commands';
-import { html } from 'lit';
-import sinon from 'sinon';
-import type FlowSelectEvent from '../../events/flow-ui-select';
-import { clickOnElement } from '../../internal/test';
-import type FlowMenu from './menu';
-
-describe('<flow-ui-menu>', () => {
-  it('emits flow-ui-select with the correct event detail when clicking an item', async () => {
-    const menu = await fixture<FlowMenu>(html`
-      <flow-ui-menu>
-        <flow-ui-menu-item value="item-1">Item 1</flow-ui-menu-item>
-        <flow-ui-menu-item value="item-2">Item 2</flow-ui-menu-item>
-        <flow-ui-menu-item value="item-3">Item 3</flow-ui-menu-item>
-        <flow-ui-menu-item value="item-4">Item 4</flow-ui-menu-item>
-      </flow-ui-menu>
-    `);
-    const item2 = menu.querySelectorAll('flow-ui-menu-item')[1];
-    const selectHandler = sinon.spy((event: FlowSelectEvent) => {
-      const item = event.detail.item;
-      if (item !== item2) {
-        expect.fail('Incorrect event detail emitted with flow-ui-select');
-      }
-    });
-
-    menu.addEventListener('flow-ui-select', selectHandler);
-    await clickOnElement(item2);
-
-    expect(selectHandler).to.have.been.calledOnce;
-  });
-
-  it('can be selected via keyboard', async () => {
-    const menu = await fixture<FlowMenu>(html`
-      <flow-ui-menu>
-        <flow-ui-menu-item value="item-1">Item 1</flow-ui-menu-item>
-        <flow-ui-menu-item value="item-2">Item 2</flow-ui-menu-item>
-        <flow-ui-menu-item value="item-3">Item 3</flow-ui-menu-item>
-        <flow-ui-menu-item value="item-4">Item 4</flow-ui-menu-item>
-      </flow-ui-menu>
-    `);
-    const [item1, item2] = menu.querySelectorAll('flow-ui-menu-item');
-    const selectHandler = sinon.spy((event: FlowSelectEvent) => {
-      const item = event.detail.item;
-      if (item !== item2) {
-        expect.fail('Incorrect item selected');
-      }
-    });
-
-    menu.addEventListener('flow-ui-select', selectHandler);
-
-    item1.focus();
-    await item1.updateComplete;
-    await sendKeys({ press: 'ArrowDown' });
-    await sendKeys({ press: 'Enter' });
-
-    expect(selectHandler).to.have.been.calledOnce;
-  });
-
-  it('does not select disabled items when clicking', async () => {
-    const menu = await fixture<FlowMenu>(html`
-      <flow-ui-menu>
-        <flow-ui-menu-item value="item-1">Item 1</flow-ui-menu-item>
-        <flow-ui-menu-item value="item-2" disabled>Item 2</flow-ui-menu-item>
-        <flow-ui-menu-item value="item-3">Item 3</flow-ui-menu-item>
-        <flow-ui-menu-item value="item-4">Item 4</flow-ui-menu-item>
-      </flow-ui-menu>
-    `);
-    const item2 = menu.querySelectorAll('flow-ui-menu-item')[1];
-    const selectHandler = sinon.spy();
-
-    menu.addEventListener('flow-ui-select', selectHandler);
-
-    await clickOnElement(item2);
-
-    expect(selectHandler).to.not.have.been.calledOnce;
-  });
-
-  it('does not select disabled items when pressing enter', async () => {
-    const menu = await fixture<FlowMenu>(html`
-      <flow-ui-menu>
-        <flow-ui-menu-item value="item-1">Item 1</flow-ui-menu-item>
-        <flow-ui-menu-item value="item-2" disabled>Item 2</flow-ui-menu-item>
-        <flow-ui-menu-item value="item-3">Item 3</flow-ui-menu-item>
-        <flow-ui-menu-item value="item-4">Item 4</flow-ui-menu-item>
-      </flow-ui-menu>
-    `);
-    const [item1, item2] = menu.querySelectorAll('flow-ui-menu-item');
-    const selectHandler = sinon.spy();
-
-    menu.addEventListener('flow-ui-select', selectHandler);
-
-    item1.focus();
-    await item1.updateComplete;
-    await sendKeys({ press: 'ArrowDown' });
-    expect(document.activeElement).to.equal(item2);
-    await sendKeys({ press: 'Enter' });
-    await item2.updateComplete;
-
-    expect(selectHandler).to.not.have.been.called;
-  });
-});