@openreachtech/furo-vue 1.3.1

package/lib/components/atoms/FuroTextarea/FuroTextareaContext.js

@@ -0,0 +1,322 @@
+import {
+  ref,
+} from 'vue'
+
+import BaseFuroContext from '../../../contexts/BaseFuroContext.js'
+
+import TextareaEmitPayload from './TextareaEmitPayload.js'
+
+/**
+ * Context class for managing FuroTextarea component.
+ *
+ * @extends {BaseFuroContext<null, Props, EmitEventName>}
+ */
+export default class FuroTextareaContext extends BaseFuroContext {
+  /**
+   * Constructor.
+   *
+   * @param {FuroTextareaContextParams} params
+   */
+  constructor ({
+    props,
+    componentContext,
+    refHash,
+  }) {
+    super({
+      props,
+      componentContext,
+    })
+
+    this.refHash = refHash
+  }
+
+  /**
+   * Factory method.
+   *
+   * @template {X extends typeof FuroTextareaContext ? X : never} T, X
+   * @override
+   * @param {FuroTextareaContextFactoryParams} params - Parameters of this factory method.
+   * @returns {InstanceType<T>} An instance of this class.
+   * @this {T}
+   */
+  static create ({
+    props,
+    componentContext,
+
+    refHash = this.buildRefHash(),
+  }) {
+    return /** @type {InstanceType<T>} */ (
+      new this({
+        props,
+        componentContext,
+
+        refHash,
+      })
+    )
+  }
+
+  /**
+   * Get emit event name.
+   *
+   * @override
+   * @returns {Readonly<{
+   *   CHANGE_VALUE: 'change-value'
+   *   COMMIT_VALUE: 'commit-value'
+   *   UPDATE_VALUE: 'update:value'
+   * }>}
+   */
+  static get EMIT_EVENT_NAME () {
+    return {
+      CHANGE_VALUE: 'change-value',
+      COMMIT_VALUE: 'commit-value',
+      UPDATE_VALUE: 'update:value',
+    }
+  }
+
+  /**
+   * Get emit options.
+   *
+   * @returns {{
+   *   'change-value': (payload: import('./TextareaEmitPayload.js').default) => void
+   *   'commit-value': (payload: import('./TextareaEmitPayload.js').default) => void
+   *   'update:value': (payload: string | null) => void
+   * }}
+   */
+  static get EMIT_EVENT_HASH () {
+    return {
+      [this.EMIT_EVENT_NAME.CHANGE_VALUE]: payload => {},
+      [this.EMIT_EVENT_NAME.COMMIT_VALUE]: payload => {},
+      [this.EMIT_EVENT_NAME.UPDATE_VALUE]: payload => {},
+    }
+  }
+
+  /**
+   * get: Constructor of `EmitPayload`
+   *
+   * @returns {typeof TextareaEmitPayload}
+   */
+  static get EmitPayloadCtor () {
+    return TextareaEmitPayload
+  }
+
+  /**
+   * Build ref hash.
+   *
+   * @override
+   */
+  static buildRefHash () {
+    return {
+      internalValueRef: ref(null),
+    }
+  }
+
+  /**
+   * Create an instance of `EmitPayload`
+   *
+   * @param {{
+   *   rawEvent: import('./TextareaEmitPayload.js').TextareaRawEvent
+   * }} params - Parameters.
+   * @returns {InstanceType<typeof TextareaEmitPayload>}
+   */
+  static createEmitPayload ({
+    rawEvent,
+  }) {
+    return this.EmitPayloadCtor.create({
+      rawEvent,
+    })
+  }
+
+  /**
+   * get: Constructor of this class.
+   *
+   * @override
+   * @returns {typeof FuroTextareaContext}
+   */
+  get Ctor () {
+    return /** @type {typeof FuroTextareaContext} */ (this.constructor)
+  }
+
+  /**
+   * Get internal value ref.
+   *
+   * @returns {import('vue').Ref<string | null>}
+   */
+  get internalValueRef () {
+    return this.refHash.internalValueRef
+  }
+
+  /**
+   * Parcel passed from parent via props.
+   *
+   * @override
+   * @returns {Props['parcel']}
+   */
+  get parcel () {
+    return this.props.parcel
+      ?? null
+  }
+
+  /**
+   * Setup component context.
+   *
+   * @template {X extends FuroTextareaContext ? X : never} T, X
+   * @override
+   * @returns {T} - For method chaining.
+   * @this {T}
+   */
+  setupComponent () {
+    this.watch(
+      [
+        () => this.parcel?.value,
+        () => this.attrs?.value,
+      ],
+      ([
+        parcelTextValue = null,
+        attrsTextValue = null,
+      ]) => {
+        const rawValue = parcelTextValue
+          ?? attrsTextValue
+
+        if (rawValue === null) {
+          this.internalValueRef.value = null
+
+          return
+        }
+
+        this.internalValueRef.value = String(rawValue)
+      },
+      {
+        immediate: true,
+      }
+    )
+
+    return this
+  }
+
+  /**
+   * Generate textarea attributes (fallthrough), excluding `type` when present.
+   *
+   * @returns {import('vue').TextareaHTMLAttributes}
+   */
+  generateTextareaAttributes () {
+    const {
+      type,
+      ...restAttributes
+    } = this.attrs
+
+    return restAttributes
+  }
+
+  /**
+   * Whether the textarea is invalid.
+   *
+   * @returns {boolean}
+   */
+  isInvalid () {
+    return Boolean(this.parcel?.invalid)
+  }
+
+  /**
+   * Handle blur event from the native element (`commit-value` is blur-only for textarea).
+   *
+   * @param {{
+   *   rawEvent: FocusEvent
+   * }} params - Parameters.
+   */
+  onCommitValue ({
+    rawEvent,
+  }) {
+    const payload = this.Ctor.EmitPayloadCtor.create({
+      rawEvent,
+    })
+
+    this.emit(
+      this.EMIT_EVENT_NAME.COMMIT_VALUE,
+      payload
+    )
+
+    // To support v-model:value.
+    this.emit(
+      this.EMIT_EVENT_NAME.UPDATE_VALUE,
+      payload.value
+    )
+  }
+
+  /**
+   * Handle input event from the native element.
+   *
+   * @param {{
+   *   rawEvent: InputEvent
+   * }} params - Parameters.
+   */
+  onChangeValue ({
+    rawEvent,
+  }) {
+    const payload = this.Ctor.EmitPayloadCtor.create({
+      rawEvent,
+    })
+
+    this.emit(
+      this.EMIT_EVENT_NAME.CHANGE_VALUE,
+      payload
+    )
+
+    // To support v-model:value.
+    this.emit(
+      this.EMIT_EVENT_NAME.UPDATE_VALUE,
+      payload.value
+    )
+  }
+}
+
+/**
+ * @typedef {import('../../../contexts/BaseFuroContext.js').BaseFuroContextParams & {
+ *   props: Props
+ *   componentContext: ComponentContext
+ *   refHash: {
+ *     internalValueRef: import('vue').Ref<string | null>
+ *   }
+ * }} FuroTextareaContextParams
+ */
+
+/**
+ * @typedef {Omit<FuroTextareaContextParams, 'refHash'> & {
+ *   refHash?: {
+ *     internalValueRef: import('vue').Ref<string | null>
+ *   }
+ * }} FuroTextareaContextFactoryParams
+ */
+
+/**
+ * @typedef {keyof typeof FuroTextareaContext.EMIT_EVENT_NAME} EmitEventName
+ */
+
+/**
+ * @typedef {import('vue').TextareaHTMLAttributes & {
+ *   parcel?: FuroTextareaParcel | null
+ * }} Props
+ */
+
+/**
+ * @typedef {import('vue').SetupContext<FuroTextareaEmitHash>} ComponentContext
+ */
+
+/**
+ * @typedef {{
+ *   value?: string | null
+ *   invalid?: boolean
+ * }} FuroTextareaParcel
+ */
+
+/**
+ * @typedef {typeof FuroTextareaContext.EMIT_EVENT_HASH} FuroTextareaEmitHash
+ */
+
+/**
+ * @typedef {(
+ *   props: Props,
+ *   componentContext: ComponentContext
+ * ) => {
+ *   context: FuroTextareaContext
+ * }} FuroTextareaSetup
+ */

package/lib/components/atoms/FuroTextarea/TextareaEmitPayload.js

@@ -0,0 +1,83 @@
+import BaseEmitPayload from '../../../emit-payload/BaseEmitPayload.js'
+
+/**
+ * TextareaEmitPayload.
+ *
+ * @extends {BaseEmitPayload<TextareaRawEvent, HTMLTextAreaElement>}
+ */
+export default class TextareaEmitPayload extends BaseEmitPayload {
+  /**
+   * Current string value of the textarea.
+   *
+   * @returns {string | null}
+   */
+  get value () {
+    return this.controlElement?.value
+      ?? null
+  }
+
+  /**
+   * Whitespace-trimmed string value of the textarea.
+   *
+   * @returns {string | null}
+   */
+  get trimmedValue () {
+    return this.extractTrimmedValue()
+  }
+
+  /**
+   * Extract trimmed string value from the textarea.
+   *
+   * @returns {string | null}
+   */
+  extractTrimmedValue () {
+    return this.value?.trim()
+      ?? null
+  }
+
+  /**
+   * Whether the raw field value is empty (missing control is treated as empty).
+   *
+   * @returns {boolean}
+   */
+  hasEmptyText () {
+    return this.value
+      ? this.value.length === 0
+      : true
+  }
+
+  /**
+   * Whether the trimmed field value is empty (missing control is treated as empty).
+   *
+   * @returns {boolean}
+   */
+  hasEmptyTrimmedText () {
+    const trimmedFieldValue = this.extractTrimmedValue()
+
+    return trimmedFieldValue
+      ? trimmedFieldValue.length === 0
+      : true
+  }
+
+  /**
+   * Whether the raw field value has at least one character (whitespace counts).
+   *
+   * @returns {boolean}
+   */
+  hasEnteredText () {
+    return !this.hasEmptyText()
+  }
+
+  /**
+   * Whether the trimmed field value has at least one non-whitespace character.
+   *
+   * @returns {boolean}
+   */
+  hasEnteredTrimmedText () {
+    return !this.hasEmptyTrimmedText()
+  }
+}
+
+/**
+ * @typedef {InputEvent | FocusEvent | KeyboardEvent} TextareaRawEvent
+ */

package/lib/components/atoms/FuroToggle/FuroToggle.vue

@@ -0,0 +1,172 @@
+<script>
+import {
+  defineComponent,
+} from 'vue'
+
+import {
+  Toggle as RekaToggle,
+} from 'reka-ui'
+
+import FuroToggleContext from './FuroToggleContext.js'
+
+export default defineComponent({
+  name: 'FuroToggle',
+
+  components: {
+    RekaToggle,
+  },
+
+  inheritAttrs: false,
+
+  props: {
+    parcel: {
+      /** @type {import('vue').PropType<import('./FuroToggleContext.js').Props['parcel']>} */
+      type: [
+        Object,
+        null,
+      ],
+      default: null,
+    },
+  },
+
+  emits: FuroToggleContext.EMIT_EVENT_HASH,
+
+  /**
+   * Setup of this component.
+   *
+   * @type {import('./FuroToggleContext.js').FuroToggleSetup}
+   */
+  setup (
+    props,
+    componentContext
+  ) {
+    const context = FuroToggleContext.create({
+      props,
+      componentContext,
+    })
+      .setupComponent()
+
+    return {
+      context,
+    }
+  },
+})
+</script>
+
+<template>
+  <RekaToggle
+    :ref="context.toggleRootElementRef"
+    v-bind="{
+      ...context.extractRootAttributes(),
+      ...$attrs,
+    }"
+    :class="context.extractRootClassNames()"
+    :disabled="context.isDisabled()"
+    :model-value="context.internalValueRef.value"
+    @update:model-value="context.onChangeValue({
+      rawValue: $event,
+    })"
+  >
+    <slot :pressed="context.isPressed()" />
+  </RekaToggle>
+</template>
+
+<style scoped>
+@layer furo {
+  .unit-toggle {
+    display: inline-flex;
+    align-items: center;
+    justify-content: center;
+    gap: var(--size-space-small);
+
+    min-width: 0;
+
+    border: var(--size-thinnest) solid transparent;
+    /* The design's "Toggle" is a switch: a track with a sliding knob. This is a
+       pressed/unpressed button carrying text, so the switch's fully rounded
+       corner is not its counterpart. Held at the medium step until the design's
+       toolbar button is read. See #220. */
+    border-radius: var(--size-border-radius-medium);
+
+    padding-block: 0.5rem;
+    padding-inline: 0.75rem;
+
+    height: var(--size-input-height);
+
+    background-color: transparent;
+
+    color: var(--color-foreground);
+    font: inherit;
+    font-size: var(--font-size);
+    font-weight: var(--font-weight-medium, 500);
+    line-height: var(--font-line-height-body, 1.4);
+    white-space: nowrap;
+
+    cursor: pointer;
+
+    transition-duration: var(--transition-timer);
+    transition-property: color, background-color, border-color, box-shadow;
+  }
+
+  .unit-toggle:focus-visible {
+    outline: none;
+    box-shadow: 0 0 0 0.125rem var(--color-ring);
+  }
+
+  .unit-toggle.disabled {
+    cursor: not-allowed;
+    opacity: 0.5;
+    pointer-events: none;
+  }
+
+  .unit-toggle.default:hover {
+    background-color: var(--color-muted);
+    color: var(--color-muted-foreground);
+  }
+
+  .unit-toggle.outline {
+    border-color: var(--color-border);
+  }
+
+  .unit-toggle.outline:hover {
+    background-color: var(--color-muted);
+    color: var(--color-muted-foreground);
+  }
+
+  /* Pressed state wins over hover (declared after the :hover rules). */
+  .unit-toggle.default[data-state="on"],
+  .unit-toggle.outline[data-state="on"] {
+    background-color: var(--color-accent);
+    color: var(--color-accent-foreground);
+  }
+
+  .unit-toggle.outline[data-state="on"] {
+    border-color: var(--color-primary);
+  }
+
+  .unit-toggle.default[data-state="on"]:hover,
+  .unit-toggle.outline[data-state="on"]:hover {
+    background-color: var(--color-accent);
+    color: var(--color-accent-foreground);
+    filter: brightness(0.95);
+  }
+
+  .unit-toggle.size-sm {
+    height: 2rem;
+
+    padding-block: 0.25rem;
+    padding-inline: 0.5rem;
+
+    font-size: var(--font-size-small);
+  }
+
+  .unit-toggle.size-lg {
+    height: 2.75rem;
+
+    padding-block: 0.625rem;
+    padding-inline: 1rem;
+
+    font-size: var(--font-size-large);
+  }
+}
+</style>