@openreachtech/furo-vue 1.3.1

package/lib/components/molecules/FuroCollapsible/FuroCollapsibleContext.js

@@ -0,0 +1,389 @@
+import {
+  ref,
+} from 'vue'
+
+import BaseFuroContext from '../../../contexts/BaseFuroContext.js'
+
+import CollapsibleEmitPayload from './CollapsibleEmitPayload.js'
+
+/**
+ * Furo-owned parcel keys (not forwarded to the underlying primitive root).
+ */
+const FURO_COLLAPSIBLE_PARCEL_KEYS = new Set([
+  'value',
+  'disabled',
+])
+
+/**
+ * Context class for managing FuroCollapsible molecule.
+ *
+ * Single expand/collapse region. The public value is the open boolean
+ * (`v-model:value`, `parcel.value`), mapped to the primitive's own open prop
+ * inside the template. Supports controlled and uncontrolled use.
+ *
+ * @extends {BaseFuroContext<null, Props, EmitEventName>}
+ */
+export default class FuroCollapsibleContext extends BaseFuroContext {
+  /**
+   * Constructor.
+   *
+   * @param {FuroCollapsibleContextParams} params
+   */
+  constructor ({
+    props,
+    componentContext,
+    refHash,
+  }) {
+    super({
+      props,
+      componentContext,
+    })
+
+    this.refHash = refHash
+  }
+
+  /**
+   * Factory method.
+   *
+   * @template {X extends typeof FuroCollapsibleContext ? X : never} T, X
+   * @override
+   * @param {FuroCollapsibleContextFactoryParams} 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,
+      })
+    )
+  }
+
+  /**
+   * Build ref hash.
+   *
+   * @override
+   */
+  static buildRefHash () {
+    return {
+      internalValueRef: ref(false),
+      collapsibleRootElementRef: ref(null),
+    }
+  }
+
+  /**
+   * Get emit event name.
+   *
+   * @override
+   * @returns {Readonly<{
+   *   CHANGE_VALUE: 'change-value'
+   *   UPDATE_VALUE: 'update:value'
+   * }>}
+   */
+  static get EMIT_EVENT_NAME () {
+    return {
+      CHANGE_VALUE: 'change-value',
+      UPDATE_VALUE: 'update:value',
+    }
+  }
+
+  /**
+   * Get emit options.
+   *
+   * @returns {{
+   *   'change-value': (payload: import('./CollapsibleEmitPayload.js').default) => void
+   *   'update:value': (value: FuroCollapsibleValue) => void
+   * }}
+   */
+  static get EMIT_EVENT_HASH () {
+    return {
+      [this.EMIT_EVENT_NAME.CHANGE_VALUE]: payload => {},
+      [this.EMIT_EVENT_NAME.UPDATE_VALUE]: value => {},
+    }
+  }
+
+  /**
+   * get: Constructor of `EmitPayload`.
+   *
+   * @returns {typeof CollapsibleEmitPayload}
+   */
+  static get EmitPayloadCtor () {
+    return CollapsibleEmitPayload
+  }
+
+  /**
+   * get: Constructor of this class.
+   *
+   * @override
+   * @returns {typeof FuroCollapsibleContext}
+   */
+  get Ctor () {
+    return /** @type {typeof FuroCollapsibleContext} */ (
+      this.constructor
+    )
+  }
+
+  /**
+   * Get internal value ref (synced open model).
+   *
+   * @returns {import('vue').Ref<FuroCollapsibleValue>}
+   */
+  get internalValueRef () {
+    return this.refHash.internalValueRef
+  }
+
+  /**
+   * Get collapsible root element ref.
+   *
+   * @returns {import('vue').Ref<HTMLElement | null>}
+   */
+  get collapsibleRootElementRef () {
+    return this.refHash.collapsibleRootElementRef
+  }
+
+  /**
+   * Parcel passed from parent via props (merged with defaults).
+   *
+   * @override
+   * @returns {FuroCollapsibleParcel}
+   */
+  get parcel () {
+    return {
+      disabled: false,
+      ...this.props.parcel,
+    }
+  }
+
+  /**
+   * Whether the parent controls `parcel.value`.
+   *
+   * @returns {boolean}
+   */
+  isControlled () {
+    const { parcel } = this.props
+
+    return parcel !== null
+      && Object.hasOwn(parcel, 'value')
+  }
+
+  /**
+   * Resolve synced open value from parcel or fallthrough attrs.
+   *
+   * @returns {FuroCollapsibleValue}
+   */
+  resolveSyncedValue () {
+    const { parcel: parcelSource } = this.props
+
+    const hasParcelValue = parcelSource !== null
+      && Object.hasOwn(parcelSource, 'value')
+
+    if (hasParcelValue) {
+      return parcelSource.value
+        ?? false
+    }
+
+    const { value: attrsValue } = this.attrs ?? {}
+
+    if (attrsValue !== undefined) {
+      return Boolean(attrsValue)
+    }
+
+    return false
+  }
+
+  /**
+   * Whether the region is disabled.
+   *
+   * @returns {boolean}
+   */
+  isDisabled () {
+    return Boolean(this.parcel.disabled)
+      || this.hasBooleanAttribute({ name: 'disabled' })
+  }
+
+  /**
+   * Whether the region is currently open.
+   *
+   * @returns {boolean}
+   */
+  isOpen () {
+    return this.internalValueRef.value === true
+  }
+
+  /**
+   * Extract CSS class map for the root.
+   *
+   * @returns {Record<string, boolean>}
+   */
+  extractRootClassNames () {
+    return Object.fromEntries([
+      ['unit-collapsible', true],
+      ['disabled', this.isDisabled()],
+    ])
+  }
+
+  /**
+   * Extract root attributes forwarded to the underlying primitive.
+   *
+   * @returns {Record<string, unknown>}
+   */
+  extractRootAttributes () {
+    const parcelEntries = Object.entries(this.parcel)
+
+    return Object.fromEntries(
+      parcelEntries.filter(([key]) => !FURO_COLLAPSIBLE_PARCEL_KEYS.has(key))
+    )
+  }
+
+  /**
+   * Build a custom event for open-state changes.
+   *
+   * @param {{
+   *   name: string
+   *   value: FuroCollapsibleValue
+   * }} params - Parameters.
+   * @returns {import('./CollapsibleEmitPayload.js').CollapsibleRawEvent}
+   */
+  buildCustomEvent ({
+    name,
+    value,
+  }) {
+    return new CustomEvent(
+      name,
+      {
+        detail: {
+          target: this.collapsibleRootElementRef.value,
+          value,
+        },
+      }
+    )
+  }
+
+  /**
+   * Setup component context.
+   *
+   * @template {X extends FuroCollapsibleContext ? X : never} T, X
+   * @override
+   * @returns {T} - For method chaining.
+   * @this {T}
+   */
+  setupComponent () {
+    this.watch(
+      () => this.resolveSyncedValue(),
+      syncedValue => {
+        if (!this.isControlled()) {
+          return
+        }
+
+        this.internalValueRef.value = syncedValue
+      },
+      {
+        immediate: true,
+      }
+    )
+
+    return this
+  }
+
+  /**
+   * Handle open-state update emitted by the underlying primitive.
+   *
+   * @param {{
+   *   rawValue: FuroCollapsibleValue
+   * }} params - Parameters.
+   */
+  onChangeValue ({
+    rawValue,
+  }) {
+    const value = Boolean(rawValue)
+
+    this.internalValueRef.value = value
+
+    const customEvent = this.buildCustomEvent({
+      name: this.EMIT_EVENT_NAME.CHANGE_VALUE,
+      value,
+    })
+
+    const payload = this.Ctor.EmitPayloadCtor.create({
+      rawEvent: customEvent,
+    })
+
+    this.emit(
+      this.EMIT_EVENT_NAME.CHANGE_VALUE,
+      payload
+    )
+
+    this.emit(
+      this.EMIT_EVENT_NAME.UPDATE_VALUE,
+      value
+    )
+  }
+}
+
+/**
+ * @typedef {import('../../../contexts/BaseFuroContext.js').BaseFuroContextParams & {
+ *   props: Props
+ *   componentContext: ComponentContext
+ *   refHash: {
+ *     internalValueRef: import('vue').Ref<FuroCollapsibleValue>
+ *     collapsibleRootElementRef: import('vue').Ref<HTMLElement | null>
+ *   }
+ * }} FuroCollapsibleContextParams
+ */
+
+/**
+ * @typedef {Omit<FuroCollapsibleContextParams, 'refHash'> & {
+ *   refHash?: {
+ *     internalValueRef: import('vue').Ref<FuroCollapsibleValue>
+ *     collapsibleRootElementRef: import('vue').Ref<HTMLElement | null>
+ *   }
+ * }} FuroCollapsibleContextFactoryParams
+ */
+
+/**
+ * @typedef {keyof typeof FuroCollapsibleContext.EMIT_EVENT_NAME} EmitEventName
+ */
+
+/**
+ * Public open model (`v-model:value`, `parcel.value`).
+ *
+ * @typedef {boolean} FuroCollapsibleValue
+ */
+
+/**
+ * @typedef {{
+ *   parcel?: FuroCollapsibleParcel | null
+ * }} Props
+ */
+
+/**
+ * @typedef {{
+ *   value?: FuroCollapsibleValue
+ *   disabled?: boolean
+ * }} FuroCollapsibleParcel
+ */
+
+/**
+ * @typedef {typeof FuroCollapsibleContext.EMIT_EVENT_HASH} FuroCollapsibleEmitHash
+ */
+
+/**
+ * @typedef {import('vue').SetupContext<FuroCollapsibleEmitHash>} ComponentContext
+ */
+
+/**
+ * @typedef {(
+ *   props: Props,
+ *   componentContext: ComponentContext
+ * ) => {
+ *   context: FuroCollapsibleContext
+ * }} FuroCollapsibleSetup
+ */

package/lib/components/molecules/FuroControlBlock/FuroControlBlock.vue

@@ -0,0 +1,149 @@
+<script>
+import {
+  defineComponent,
+} from 'vue'
+
+import FuroControlBlockContext from './FuroControlBlockContext.js'
+
+export default defineComponent({
+  name: 'FuroControlBlock',
+  inheritAttrs: false,
+
+  props: {
+    parcel: {
+      /** @type {import('vue').PropType<import('./FuroControlBlockContext.js').Props['parcel']>} */
+      type: [
+        Object,
+        null,
+      ],
+      default: null,
+    },
+  },
+
+  /**
+   * Setup of this component.
+   *
+   * @param {import('./FuroControlBlockContext.js').Props} props - Props.
+   * @param {import('vue').SetupContext} componentContext - Setup context.
+   * @returns {{ context: FuroControlBlockContext }} Render context.
+   */
+  setup (
+    props,
+    componentContext
+  ) {
+    const context = FuroControlBlockContext.create({
+      props,
+      componentContext,
+    })
+      .setupComponent()
+
+    return {
+      context,
+    }
+  },
+})
+</script>
+
+<template>
+  <div
+    class="unit-form-control-block"
+    :class="[
+      $attrs.class,
+      context.orientation,
+      {
+        invalid: context.isInvalid(),
+      },
+    ]"
+    :style="$attrs.style"
+  >
+    <label
+      v-if="context.label"
+      class="label"
+      :for="context.controlId ?? undefined"
+    >
+      {{ context.label }}
+      <span
+        v-if="context.isRequired()"
+        class="required-mark"
+        aria-hidden="true"
+      >*</span>
+    </label>
+
+    <div class="control">
+      <slot />
+    </div>
+
+    <!-- ponytail: error region carries role="alert" only; no aria-describedby
+         wiring into the slotted control (the block cannot set attrs on a slot
+         child). Upgrade path: expose an errorId getter for consumers to bind. -->
+    <ul
+      v-if="context.isInvalid()"
+      class="error"
+      role="alert"
+    >
+      <li
+        v-for="(message, index) in context.errorMessages"
+        :key="index"
+      >
+        {{ message }}
+      </li>
+    </ul>
+  </div>
+</template>
+
+<style>
+@layer furo {
+  .unit-form-control-block {
+    display: flex;
+  }
+
+  .unit-form-control-block.vertical {
+    flex-direction: column;
+
+    gap: var(--size-space-tiny);
+  }
+
+  .unit-form-control-block.horizontal {
+    flex-direction: row;
+    flex-wrap: wrap;
+    align-items: baseline;
+
+    gap: var(--size-space-small);
+  }
+
+  .unit-form-control-block > .label {
+    color: var(--color-foreground);
+    font: var(--font-label-small);
+  }
+
+  .unit-form-control-block.horizontal > .label {
+    flex: 0 0 auto;
+
+    width: 9rem;
+  }
+
+  .unit-form-control-block > .label > .required-mark {
+    margin-inline-start: 0.125rem;
+
+    color: var(--color-destructive);
+  }
+
+  .unit-form-control-block.horizontal > .control {
+    flex: 1 1 0;
+  }
+
+  .unit-form-control-block > .error {
+    margin-block: 0;
+    padding-inline-start: 0;
+
+    list-style: none;
+
+    color: var(--color-destructive);
+    font: var(--font-body-small);
+  }
+
+  .unit-form-control-block.horizontal > .error {
+    flex-basis: 100%;
+  }
+}
+</style>

package/lib/components/molecules/FuroControlBlock/FuroControlBlockContext.js

@@ -0,0 +1,81 @@
+import BaseFuroContext from '../../../contexts/BaseFuroContext.js'
+
+/**
+ * Context class for FuroControlBlock molecule.
+ *
+ * Presentational wrapper that frames a slotted control with a label and error
+ * messages. Emits nothing — the slotted control owns its own events.
+ *
+ * @extends {BaseFuroContext<null, Props, null>}
+ */
+export default class FuroControlBlockContext extends BaseFuroContext {
+  /**
+   * get: id of the slotted control, for the `<label for>` association.
+   *
+   * @returns {string | null} Control id, or null when unset.
+   */
+  get controlId () {
+    return this.parcel?.controlId
+      ?? null
+  }
+
+  /**
+   * get: error messages for the control.
+   *
+   * @returns {Array<string>} Error messages; empty array when none.
+   */
+  get errorMessages () {
+    return this.parcel?.errorMessages
+      ?? []
+  }
+
+  /**
+   * get: label text.
+   *
+   * @returns {string | null} Label text, or null when unset.
+   */
+  get label () {
+    return this.parcel?.label
+      ?? null
+  }
+
+  /**
+   * get: layout orientation.
+   *
+   * @returns {'vertical' | 'horizontal'} Orientation; defaults to vertical.
+   */
+  get orientation () {
+    return this.parcel?.orientation
+      ?? 'vertical'
+  }
+
+  /**
+   * Whether the control has error messages.
+   *
+   * @returns {boolean} true when at least one error message exists.
+   */
+  isInvalid () {
+    return this.errorMessages.length > 0
+  }
+
+  /**
+   * Whether the control is required.
+   *
+   * @returns {boolean} true when the parcel marks it required.
+   */
+  isRequired () {
+    return Boolean(this.parcel?.required)
+  }
+}
+
+/**
+ * @typedef {{
+ *   parcel: {
+ *     label?: string | null
+ *     controlId?: string | null
+ *     errorMessages?: Array<string>
+ *     required?: boolean
+ *     orientation?: 'vertical' | 'horizontal'
+ *   } | null
+ * }} Props
+ */

package/lib/components/molecules/FuroDatePicker/DatePickerEmitPayload.js

@@ -0,0 +1,74 @@
+import BaseEmitPayload from '../../../emit-payload/BaseEmitPayload.js'
+
+/**
+ * DatePickerEmitPayload.
+ *
+ * @extends {BaseEmitPayload<DatePickerRawEvent, HTMLElement>}
+ */
+export default class DatePickerEmitPayload extends BaseEmitPayload {
+  /**
+   * Get the event detail.
+   *
+   * @returns {DatePickerRawEvent['detail'] | null}
+   */
+  get eventDetail () {
+    return this.rawEvent?.detail
+      ?? null
+  }
+
+  /**
+   * Get the control element from the raw event.
+   *
+   * @override
+   * @returns {HTMLElement | null}
+   */
+  get controlElement () {
+    return this.eventDetail?.target
+      ?? null
+  }
+
+  /**
+   * Selected date as ISO `YYYY-MM-DD` string, or `null` when cleared.
+   *
+   * @returns {string | null}
+   */
+  get value () {
+    return this.eventDetail?.value
+      ?? null
+  }
+
+  /**
+   * Whether the payload carries an empty (null) value.
+   *
+   * @returns {boolean}
+   */
+  hasEmptyValue () {
+    return this.value === null
+  }
+
+  /**
+   * Whether the payload carries a non-null date value.
+   *
+   * @returns {boolean}
+   */
+  hasValue () {
+    return !this.hasEmptyValue()
+  }
+}
+
+/**
+ * @typedef {CustomEvent<{
+ *   target: HTMLElement | null
+ *   value: string | null
+ * }>} DatePickerRawEvent
+ */
+
+/**
+ * @typedef {{
+ *   rawEvent: DatePickerRawEvent
+ * }} DatePickerEmitPayloadParams
+ */
+
+/**
+ * @typedef {DatePickerEmitPayloadParams} DatePickerEmitPayloadFactoryParams
+ */