@kubex/zinc 0.0.2 → 1.0.0

package/src/components/textarea/textarea.component.ts

@@ -0,0 +1,417 @@
+import {classMap} from "lit/directives/class-map.js";
+import {type CSSResultGroup, html, unsafeCSS} from 'lit';
+import {defaultValue} from "../../internal/default-value";
+import {FormControlController} from "../../internal/form";
+import {HasSlotController} from "../../internal/slot";
+import {ifDefined} from "lit/directives/if-defined.js";
+import {live} from "lit/directives/live.js";
+import {property, query, state} from 'lit/decorators.js';
+import {watch} from '../../internal/watch';
+import ZincElement, {type ZincFormControl} from '../../internal/zinc-element';
+
+import styles from './textarea.scss';
+
+/**
+ * @summary Textareas collect data from the user and allow multiple lines of text.
+ * @documentation https://zinc.style/components/textarea
+ * @status stable
+ * @since 2.0
+ *
+ * @slot label - The textareas label. Alternatively, you can use the `label` attribute.
+ * @slot label-tooltip - Used to add text that is displayed in a tooltip next to the label. Alternatively, you can use the `label-tooltip` attribute.
+ * @slot context-note - Used to add contextual text that is displayed above the textarea, on the right. Alternatively, you can use the `context-note` attribute.
+ * @slot help-text - Text that describes how to use the input. Alternatively, you can use the `help-text` attribute.
+ *
+ * @event zn-blur - Emitted when the control loses focus.
+ * @event zn-change - Emitted when an alteration to the control's value is committed by the user.
+ * @event zn-focus - Emitted when the control gains focus.
+ * @event zn-input - Emitted when the control receives input.
+ * @event zn-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 textarea - The internal `<textarea>` control.
+ */
+export default class ZnTextarea extends ZincElement implements ZincFormControl {
+  static styles: CSSResultGroup = unsafeCSS(styles);
+
+  private readonly formControlController = new FormControlController(this, {
+    assumeInteractionOn: ['zn-blur', 'zn-input']
+  });
+  private readonly hasSlotController = new HasSlotController(this, 'help-text', 'label');
+  private resizeObserver: ResizeObserver;
+
+  @query('.form-control-input') formControl: HTMLElement;
+  @query('.textarea__control') input: HTMLTextAreaElement;
+
+  @state() hasFocus = false;
+
+  @property() title = ''; // make reactive to pass through
+
+  /** The name of the textarea, submitted as a name/value pair with form data. */
+  @property() name = '';
+
+  /** The current value of the textarea, submitted as a name/value pair with form data. */
+  @property() value = '';
+
+  /** The text area's size. */
+  @property({reflect: true}) size: 'small' | 'medium' | 'large' = 'medium';
+
+  /**  The textarea label. If you need to display HTML, use the `label` slot instead. */
+  @property() label = '';
+
+  /** Text that appears in a tooltip next to the label. If you need to display HTML in the tooltip, use the `label-tooltip` slot instead. */
+  @property({attribute: 'label-tooltip'}) labelTooltip = '';
+
+  /** Text that appears above the textarea, on the right, to add additional context. If you need to display HTML in this text, use the `context-note` slot instead. */
+  @property({attribute: 'context-note'}) contextNote = '';
+
+  /** The text area's help text. If you need to display HTML, use the `help-text` slot instead. */
+  @property({attribute: 'help-text'}) helpText = '';
+
+  /** Placeholder text to show as a hint when the input is empty. */
+  @property() placeholder = '';
+
+  /** The number of rows to display by default. */
+  @property({type: Number}) rows = 4;
+
+  /** Controls how the textarea can be resized. */
+  @property() resize: 'none' | 'vertical' | 'auto' = 'vertical';
+
+  /** Disables the textarea. */
+  @property({type: Boolean, reflect: true}) disabled = false;
+
+  /** Makes the textarea readonly. */
+  @property({type: Boolean, reflect: true}) readonly = 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 textarea a required field. */
+  @property({type: Boolean, reflect: true}) required = false;
+
+  /** 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;
+
+  /** 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: string;
+
+  /**
+   * 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 textarea. */
+  @property({
+    type: Boolean,
+    converter: {
+      // Allow "true|false" attribute values but keep the property boolean
+      fromAttribute: value => (!(!value || value === 'false')),
+      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';
+
+  /** The default value of the form control. Primarily used for resetting the form control. */
+  @defaultValue() defaultValue = '';
+
+
+  /** Gets the validity state object */
+  get validity() {
+    return this.input?.validity;
+  }
+
+  /** Gets the validation message */
+  get validationMessage() {
+    return this.input.validationMessage;
+  }
+
+  connectedCallback() {
+    super.connectedCallback();
+    this.resizeObserver = new ResizeObserver(() => this.setTextareaHeight());
+
+    this.updateComplete.then(() => {
+      this.resizeObserver.observe(this.input);
+
+      // Set the initial textarea height to maximum available space
+      this.formControl.style.display = 'flex';
+      this.formControl.style.flexGrow = '1';
+    });
+  }
+
+  firstUpdated() {
+    this.formControlController.updateValidity();
+  }
+
+  disconnectedCallback() {
+    super.disconnectedCallback();
+    this.resizeObserver.unobserve(this.input);
+  }
+
+  private handleBlur() {
+    this.hasFocus = false;
+    this.emit('zn-blur');
+  }
+
+  private handleChange() {
+    this.value = this.input.value;
+    this.setTextareaHeight();
+    this.emit('zn-change');
+  }
+
+  private handleFocus() {
+    this.hasFocus = true;
+    this.emit('zn-focus');
+  }
+
+  private handleInput() {
+    this.value = this.input.value;
+    this.emit('zn-input');
+  }
+
+  private handleInvalid(event: Event) {
+    this.formControlController.setValidity(false);
+    this.formControlController.emitInvalidEvent(event);
+  }
+
+  private setTextareaHeight() {
+    if (this.resize === 'auto') {
+      this.input.style.height = 'auto';
+      this.input.style.height = `${this.input.scrollHeight}px`;
+    } else {
+      (this.input.style.height as string | undefined) = undefined;
+    }
+
+    // Force the form control to take up the full height of the textarea
+    this.formControl.style.height = this.input.style.height;
+
+    // Unset flex grow on initial resize
+    if (this.formControl.style.height !== '') {
+      this.formControl.style.flexGrow = '0';
+    }
+  }
+
+  @watch('disabled', {waitUntilFirstUpdate: true})
+  handleDisabledChange() {
+    // Disabled form controls are always valid
+    this.formControlController.setValidity(this.disabled);
+  }
+
+  @watch('rows', {waitUntilFirstUpdate: true})
+  handleRowsChange() {
+    this.setTextareaHeight();
+  }
+
+  @watch('value', {waitUntilFirstUpdate: true})
+  async handleValueChange() {
+    await this.updateComplete;
+    this.formControlController.updateValidity();
+    this.setTextareaHeight();
+  }
+
+  /** Sets focus on the textarea. */
+  focus(options?: FocusOptions) {
+    this.input.focus(options);
+  }
+
+  /** Removes focus from the textarea. */
+  blur() {
+    this.input.blur();
+  }
+
+  /** Selects all the text in the textarea. */
+  select() {
+    this.input.select();
+  }
+
+  /** Gets or sets the textarea scroll position. */
+  scrollPosition(position?: { top?: number; left?: number }): { top: number; left: number } | undefined {
+    if (position) {
+      if (typeof position.top === 'number') this.input.scrollTop = position.top;
+      if (typeof position.left === 'number') this.input.scrollLeft = position.left;
+      return undefined;
+    }
+
+    return {
+      top: this.input.scrollTop,
+      left: this.input.scrollLeft
+    };
+  }
+
+  /** 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' = 'preserve'
+  ) {
+    const selectionStart = start ?? this.input.selectionStart;
+    const selectionEnd = end ?? this.input.selectionEnd;
+
+    this.input.setRangeText(replacement, selectionStart, selectionEnd, selectMode);
+
+    if (this.value !== this.input.value) {
+      this.value = this.input.value;
+      this.setTextareaHeight();
+    }
+  }
+
+
+  /** 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 hasLabelTooltipSlot = this.hasSlotController.test('label-tooltip');
+    const hasContextNoteSlot = this.hasSlotController.test('context-note');
+    const hasHelpTextSlot = this.hasSlotController.test('help-text');
+    const hasLabel = this.label ? true : hasLabelSlot;
+    const hasLabelTooltip = this.labelTooltip ? true : hasLabelTooltipSlot;
+    const hasContextNote = this.contextNote ? true : hasContextNoteSlot;
+    const hasHelpText = this.helpText ? true : hasHelpTextSlot;
+
+    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-label-tooltip': hasLabelTooltip,
+          'form-control--has-context-note': hasContextNote,
+          '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>
+          ${hasLabelTooltip
+            ? html`
+              <zn-tooltip class="form-control--label-tooltip">
+                <div slot="content">
+                  <slot name="label-tooltip">${this.labelTooltip}</slot>
+                </div>
+                <zn-icon library="fa" src="info"></zn-icon>
+              </zn-tooltip>`
+            : ''}
+        </label>
+        ${hasContextNote
+          ? html`<span class="form-control__label-context-note"><slot
+            name="context-note">${this.contextNote}</slot></span>`
+          : ''}
+
+        <div part="form-control-input" class="form-control-input">
+          <div
+            part="base"
+            class=${classMap({
+              textarea: true,
+              'textarea--standard': true,
+              'textarea--small': this.size === 'small',
+              'textarea--medium': this.size === 'medium',
+              'textarea--large': this.size === 'large',
+              'textarea--disabled': this.disabled,
+              'textarea--focused': this.hasFocus,
+              'textarea--empty': !this.value,
+              'textarea--resize-none': this.resize === 'none',
+              'textarea--resize-vertical': this.resize === 'vertical',
+              'textarea--resize-auto': this.resize === 'auto'
+            })}>
+            <textarea
+              part="textarea"
+              id="input"
+              class="textarea__control"
+              title=${this.title /* An empty title prevents browser validation tooltips from appearing on hover */}
+              name=${ifDefined(this.name)}
+              .value=${live(this.value)}
+              ?disabled=${this.disabled}
+              ?readonly=${this.readonly}
+              ?required=${this.required}
+              placeholder=${ifDefined(this.placeholder)}
+              rows=${ifDefined(this.rows)}
+              minlength=${ifDefined(this.minlength)}
+              maxlength=${ifDefined(this.maxlength)}
+              autocapitalize=${ifDefined(this.autocapitalize)}
+              autocorrect=${ifDefined(this.autocorrect)}
+              ?autofocus=${this.autofocus}
+              spellcheck=${ifDefined(this.spellcheck)}
+              enterkeyhint=${ifDefined(this.enterkeyhint)}
+              inputmode=${ifDefined(this.inputmode)}
+              aria-describedby="help-text"
+              @change=${this.handleChange}
+              @input=${this.handleInput}
+              @invalid=${this.handleInvalid}
+              @focus=${this.handleFocus}
+              @blur=${this.handleBlur}
+            ></textarea>
+          </div>
+        </div>
+
+        <div
+          part="form-control-help-text"
+          id="help-text"
+          class="form-control__help-text"
+          aria-hidden=${hasHelpText ? 'false' : 'true'}>
+          <slot name="help-text">${this.helpText}</slot>
+        </div>
+      </div>`;
+  }
+}

package/src/components/textarea/textarea.scss

@@ -0,0 +1,152 @@
+@use "../../wc";
+@use "../../form-control";
+
+:host {
+  display: block;
+}
+
+.form-control {
+  display: flex;
+  flex-direction: column;
+  height: 100%;
+}
+
+.textarea {
+  display: flex;
+  align-items: center;
+  position: relative;
+  width: 100%;
+  box-shadow: var(--zn-shadow-medium);
+  font-family: var(--zn-input-font-family);
+  font-weight: var(--zn-input-font-weight);
+  line-height: var(--zn-line-height-normal);
+  letter-spacing: var(--zn-input-letter-spacing);
+  vertical-align: middle;
+  transition: var(--zn-transition-fast) color,
+  var(--zn-transition-fast) border,
+  var(--zn-transition-fast) box-shadow,
+  var(--zn-transition-fast) background-color;
+  cursor: text;
+}
+
+/* Standard textareas */
+.textarea--standard {
+  background-color: var(--zn-input-background-color);
+  border: solid var(--zn-input-border-width) var(--zn-input-border-color);
+}
+
+.textarea--standard:hover:not(.textarea--disabled) {
+  background-color: var(--zn-input-background-color-hover);
+  border-color: var(--zn-input-border-color-hover);
+}
+
+.textarea--standard:hover:not(.textarea--disabled) .textarea__control {
+  color: var(--zn-input-color-hover);
+}
+
+.textarea--standard.textarea--focused:not(.textarea--disabled) {
+  background-color: var(--zn-input-background-color-focus);
+  border-color: var(--zn-input-border-color-focus);
+  color: var(--zn-input-color-focus);
+  box-shadow: 0 0 0 var(--zn-focus-ring-width) var(--zn-input-focus-ring-color);
+}
+
+.textarea--standard.textarea--focused:not(.textarea--disabled) .textarea__control {
+  color: var(--zn-input-color-focus);
+}
+
+.textarea--standard.textarea--disabled {
+  background-color: var(--zn-input-background-color-disabled);
+  border-color: var(--zn-input-border-color-disabled);
+  opacity: 0.5;
+  cursor: not-allowed;
+}
+
+.textarea--standard.textarea--disabled .textarea__control {
+  color: var(--zn-input-color-disabled);
+}
+
+.textarea--standard.textarea--disabled .textarea__control::placeholder {
+  color: var(--zn-input-placeholder-color-disabled);
+}
+
+.textarea__control {
+  flex: 1 1 auto;
+  font-family: inherit;
+  font-size: inherit;
+  font-weight: inherit;
+  line-height: 1.4;
+  color: var(--zn-input-color);
+  border: none;
+  background: none;
+  box-shadow: var(--zn-shadow-small);
+  cursor: inherit;
+  -webkit-appearance: none;
+  height: 100%;
+}
+
+.textarea__control::-webkit-search-decoration,
+.textarea__control::-webkit-search-cancel-button,
+.textarea__control::-webkit-search-results-button,
+.textarea__control::-webkit-search-results-decoration {
+  -webkit-appearance: none;
+}
+
+.textarea__control::placeholder {
+  color: var(--zn-input-placeholder-color);
+  user-select: none;
+  -webkit-user-select: none;
+}
+
+.textarea__control:focus {
+  outline: none;
+}
+
+/*
+ * Size modifiers
+ */
+
+.textarea--small {
+  border-radius: var(--zn-input-border-radius-small);
+  font-size: var(--zn-input-font-size-small);
+}
+
+.textarea--small .textarea__control {
+  padding: 0.5em var(--zn-input-spacing-small);
+}
+
+.textarea--medium {
+  border-radius: var(--zn-input-border-radius-medium);
+  font-size: var(--zn-input-font-size-medium);
+}
+
+.textarea--medium .textarea__control {
+  padding: 0.75em var(--zn-input-spacing-medium);
+}
+
+.textarea--large {
+  border-radius: var(--zn-input-border-radius-large);
+  font-size: var(--zn-input-font-size-large);
+}
+
+.textarea--large .textarea__control {
+  padding: 0.75em var(--zn-input-spacing-large);
+}
+
+/*
+ * Resize types
+ */
+
+.textarea--resize-none .textarea__control {
+  resize: none;
+}
+
+.textarea--resize-vertical .textarea__control {
+  resize: vertical;
+}
+
+.textarea--resize-auto .textarea__control {
+  height: auto;
+  resize: none;
+  overflow-y: hidden;
+}

package/src/components/textarea/textarea.test.ts

@@ -0,0 +1,10 @@
+import '../../../dist/zn.min.js';
+import { expect, fixture, html } from '@open-wc/testing';
+
+describe('<zn-text-area>', () => {
+  it('should render a component', async () => {
+    const el = await fixture(html` <zn-text-area></zn-text-area> `);
+
+    expect(el).to.exist;
+  });
+});

package/src/components/tile/index.ts

@@ -0,0 +1,12 @@
+import ZnTile from './tile.component';
+
+export * from './tile.component';
+export default ZnTile;
+
+ZnTile.define('zn-tile');
+
+declare global {
+  interface HTMLElementTagNameMap {
+    'zn-tile': ZnTile;
+  }
+}

package/src/components/tile/tile.component.ts

@@ -0,0 +1,105 @@
+import {classMap} from "lit/directives/class-map.js";
+import {type CSSResultGroup, unsafeCSS} from 'lit';
+import {HasSlotController} from "../../internal/slot";
+import {html, literal} from "lit/static-html.js";
+import {ifDefined} from "lit/directives/if-defined.js";
+import {property} from 'lit/decorators.js';
+import ZincElement from '../../internal/zinc-element';
+
+import styles from './tile.scss';
+
+/**
+ * @summary Short summary of the component's intended use.
+ * @documentation https://zinc.style/components/tile
+ * @status experimental
+ * @since 1.0
+ *
+ * @dependency zn-example
+ *
+ * @event zn-event-name - Emitted as an example.
+ *
+ * @slot - The default slot.
+ * @slot example - An example slot.
+ *
+ * @csspart base - The component's base wrapper.
+ *
+ * @cssproperty --example - An example CSS custom property.
+ */
+export default class ZnTile extends ZincElement {
+  static styles: CSSResultGroup = unsafeCSS(styles);
+
+  private readonly hasSlotController = new HasSlotController(this, '[default]');
+
+  @property({attribute: 'caption'}) caption: string;
+
+  @property({attribute: 'description'}) description: string;
+
+  @property({attribute: 'href'}) href: string;
+
+  @property({attribute: 'data-target'}) dataTarget: string;
+
+  @property({attribute: 'gaid'}) gaid: string;
+
+  @property({attribute: 'data-uri'}) dataUri: string;
+
+  @property({type: Boolean}) flush: boolean;
+
+  @property({attribute: 'flush-x', type: Boolean}) flushX: boolean;
+
+  @property({attribute: 'flush-y', type: Boolean}) flushY: boolean;
+
+  @property({type: Boolean}) inline: boolean;
+
+  private _isLink() {
+    return this.href || this.dataUri;
+  }
+
+  render() {
+    const isLink = this._isLink();
+    const tag = isLink ? literal`a` : literal`div`;
+    const hasCaption = this.caption && this.caption.length > 0;
+    const hasDescription = this.description && this.description.length > 0;
+    const hasProperties = this.hasSlotController.test('properties');
+    const hasActions = this.hasSlotController.test('actions');
+    const hasImage = this.hasSlotController.test('image');
+
+    return html`
+      <${tag}
+        href="${ifDefined(this.href)}"
+        data-uri="${ifDefined(this.dataUri)}"
+        gaid="${ifDefined(this.gaid)}"
+        data-target="${ifDefined(this.dataTarget)}"
+        class="${classMap({
+          tile: true,
+          'tile--flush': this.flush,
+          'tile--flush-x': this.flushX,
+          'tile--flush-y': this.flushY,
+          'tile--inline': this.inline,
+          'tile--has-href': isLink,
+          'tile--has-caption': hasCaption,
+          'tile--has-description': hasDescription,
+          'tile--has-properties': hasProperties,
+          'tile--has-actions': hasActions,
+          'tile--has-image': hasImage,
+        })}">
+        ${!hasCaption && !hasDescription && !hasProperties && !hasActions ? html`
+          <slot></slot>
+        ` : html`
+          <div
+            class="tile__link">
+            <div class="tile__left">
+              <slot name="image" part="image" class="tile__image"></slot>
+              <div class="tile__content">
+                <p part="caption" class="tile__caption">${this.caption}</p>
+                <p part="description" class="tile__description">${this.description}</p>
+              </div>
+            </div>
+          </div>
+
+          <div class="tile__right">
+            <slot name="properties" part="properties" class="tile__properties"></slot>
+            <slot name="actions" part="actions" class="tile__actions"></slot>
+          </div>`}
+      </${tag}>`;
+  }
+}