@openreachtech/furo-vue 1.3.1

package/lib/components/atoms/FuroRadio/FuroRadioContext.js

@@ -0,0 +1,557 @@
+import {
+  ref,
+} from 'vue'
+
+import BaseFuroContext from '../../../contexts/BaseFuroContext.js'
+
+import RadioEmitPayload from './RadioEmitPayload.js'
+
+/**
+ * Furo-owned parcel keys (not forwarded to the underlying group root).
+ */
+const FURO_RADIO_PARCEL_KEYS = new Set([
+  'value',
+  'options',
+  'invalid',
+  'disabled',
+  'required',
+  'size',
+])
+
+/**
+ * Context class for managing FuroRadio component.
+ *
+ * @extends {BaseFuroContext<null, Props, EmitEventName>}
+ */
+export default class FuroRadioContext extends BaseFuroContext {
+  /**
+   * Constructor.
+   *
+   * @param {FuroRadioContextParams} params
+   */
+  constructor ({
+    props,
+    componentContext,
+    refHash,
+  }) {
+    super({
+      props,
+      componentContext,
+    })
+
+    this.refHash = refHash
+  }
+
+  /**
+   * Factory method.
+   *
+   * @template {X extends typeof FuroRadioContext ? X : never} T, X
+   * @override
+   * @param {FuroRadioContextFactoryParams} 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(null),
+      radioRootElementRef: 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('./RadioEmitPayload.js').default) => void
+   *   'update:value': (value: FuroRadioValue | null) => void
+   * }}
+   */
+  static get EMIT_EVENT_HASH () {
+    return {
+      [this.EMIT_EVENT_NAME.CHANGE_VALUE]: payload => {},
+      [this.EMIT_EVENT_NAME.UPDATE_VALUE]: value => {},
+    }
+  }
+
+  /**
+   * Default control size (width and height of one radio circle).
+   *
+   * @returns {string}
+   */
+  static get DEFAULT_RADIO_SIZE () {
+    return '1.125rem'
+  }
+
+  /**
+   * Indicator dot size as a fraction of control size.
+   *
+   * The design draws a dot of 8px inside a control of 18px.
+   *
+   * @returns {number}
+   */
+  static get RADIO_DOT_SIZE_RATIO () {
+    return 4 / 9
+  }
+
+  /**
+   * get: Constructor of `EmitPayload`.
+   *
+   * @returns {typeof RadioEmitPayload}
+   */
+  static get EmitPayloadCtor () {
+    return RadioEmitPayload
+  }
+
+  /**
+   * get: Constructor of this class.
+   *
+   * @override
+   * @returns {typeof FuroRadioContext}
+   */
+  get Ctor () {
+    return /** @type {typeof FuroRadioContext} */ (
+      this.constructor
+    )
+  }
+
+  /**
+   * Get the internal chosen-value ref.
+   *
+   * @returns {import('vue').Ref<FuroRadioValue | null>}
+   */
+  get internalValueRef () {
+    return this.refHash.internalValueRef
+  }
+
+  /**
+   * Get radio group root element ref.
+   *
+   * @returns {import('vue').Ref<HTMLElement | null>}
+   */
+  get radioRootElementRef () {
+    return this.refHash.radioRootElementRef
+  }
+
+  /**
+   * Parcel passed from parent via props (merged with defaults).
+   *
+   * @override
+   * @returns {FuroRadioParcel}
+   */
+  get parcel () {
+    return {
+      options: [],
+      invalid: false,
+      disabled: false,
+      required: 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 the chosen value from parcel or fallthrough attrs.
+   *
+   * @returns {FuroRadioValue | null}
+   */
+  resolveSyncedValue () {
+    if (!this.isControlled()) {
+      return null
+    }
+
+    const { parcel: parcelSource } = this.props
+
+    return parcelSource.value
+      ?? null
+  }
+
+  /**
+   * Extract the options the group renders.
+   *
+   * @returns {Array<FuroRadioOption>}
+   */
+  extractOptions () {
+    return this.parcel.options
+      ?? []
+  }
+
+  /**
+   * Whether the group is invalid.
+   *
+   * @returns {boolean}
+   */
+  isInvalid () {
+    return Boolean(this.parcel.invalid)
+  }
+
+  /**
+   * Whether the whole group is disabled.
+   *
+   * @returns {boolean}
+   */
+  isDisabled () {
+    return Boolean(this.parcel.disabled)
+      || this.hasBooleanAttribute({ name: 'disabled' })
+  }
+
+  /**
+   * Whether the group is required.
+   *
+   * @returns {boolean}
+   */
+  isRequired () {
+    return Boolean(this.parcel.required)
+      || this.hasBooleanAttribute({ name: 'required' })
+  }
+
+  /**
+   * Whether one option is disabled.
+   *
+   * An option follows the group when it says nothing of its own.
+   *
+   * @param {{
+   *   option: FuroRadioOption
+   * }} params - Parameters.
+   * @returns {boolean}
+   */
+  isOptionDisabled ({
+    option,
+  }) {
+    return this.isDisabled()
+      || Boolean(option.disabled)
+  }
+
+  /**
+   * Whether one option is the chosen one.
+   *
+   * @param {{
+   *   option: FuroRadioOption
+   * }} params - Parameters.
+   * @returns {boolean}
+   */
+  isOptionSelected ({
+    option,
+  }) {
+    return this.internalValueRef.value === option.value
+  }
+
+  /**
+   * Parse a simple CSS length (`rem`, `px`, `em`).
+   *
+   * @param {{
+   *   length: string
+   * }} params - Parameters.
+   * @returns {{ amount: number, unit: string } | null}
+   */
+  parseCssLength ({
+    length,
+  }) {
+    const extractUnitRegex = /^([\d.]+)(rem|px|em)$/u
+    const matched = extractUnitRegex.exec(length.trim())
+
+    if (!matched) {
+      return null
+    }
+
+    return {
+      amount: Number(matched.at(1)),
+      unit: matched.at(2) ?? 'rem',
+    }
+  }
+
+  /**
+   * Extract indicator dot size proportional to control size.
+   *
+   * @returns {string}
+   */
+  extractRadioDotSize () {
+    const controlSize = this.parcel.size
+      ?? this.Ctor.DEFAULT_RADIO_SIZE
+
+    const parsedLength = this.parseCssLength({
+      length: controlSize,
+    })
+
+    if (!parsedLength) {
+      return this.extractDefaultRadioDotSize()
+    }
+
+    const dotAmount = parsedLength.amount
+      * this.Ctor.RADIO_DOT_SIZE_RATIO
+
+    return `${dotAmount}${parsedLength.unit}`
+  }
+
+  /**
+   * Extract the dot size derived from the default control size.
+   *
+   * @returns {string}
+   */
+  extractDefaultRadioDotSize () {
+    const parsedLength = this.parseCssLength({
+      length: this.Ctor.DEFAULT_RADIO_SIZE,
+    })
+
+    const dotAmount = Number(parsedLength?.amount)
+      * this.Ctor.RADIO_DOT_SIZE_RATIO
+
+    return `${dotAmount}${parsedLength?.unit}`
+  }
+
+  /**
+   * Extract inline style for radio dimensions (CSS custom properties).
+   *
+   * @returns {{
+   *   '--furo-radio-size': string
+   *   '--furo-radio-dot-size': string
+   * }}
+   */
+  extractRadioRootStyle () {
+    const controlSize = this.parcel.size
+      ?? this.Ctor.DEFAULT_RADIO_SIZE
+
+    return {
+      '--furo-radio-size': controlSize,
+      '--furo-radio-dot-size': this.extractRadioDotSize(),
+    }
+  }
+
+  /**
+   * Extract root attributes forwarded to the underlying group root.
+   *
+   * @returns {Record<string, unknown>}
+   */
+  extractRootAttributes () {
+    const parcelEntries = Object.entries(this.parcel)
+
+    return Object.fromEntries(
+      parcelEntries.filter(([key]) => !FURO_RADIO_PARCEL_KEYS.has(key))
+    )
+  }
+
+  /**
+   * Build a custom event for radio value changes.
+   *
+   * @param {{
+   *   name: string
+   *   value: FuroRadioValue | null
+   * }} params - Parameters.
+   * @returns {import('./RadioEmitPayload.js').RadioRawEvent}
+   */
+  buildCustomEvent ({
+    name,
+    value,
+  }) {
+    return new CustomEvent(
+      name,
+      {
+        detail: {
+          target: this.radioRootElementRef.value,
+          value,
+        },
+      }
+    )
+  }
+
+  /**
+   * Setup component context.
+   *
+   * @template {X extends FuroRadioContext ? 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 a value update emitted by the underlying group root.
+   *
+   * @param {{
+   *   rawValue: FuroRadioValue | null
+   * }} params - Parameters.
+   */
+  onChangeValue ({
+    rawValue,
+  }) {
+    const value = rawValue
+      ?? null
+
+    this.applyInternalValue({
+      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
+    )
+  }
+
+  /**
+   * Apply an interaction result to the internal chosen value.
+   *
+   * A controlled group only follows its parent, never its own interaction.
+   *
+   * @param {{
+   *   value: FuroRadioValue | null
+   * }} params - Parameters.
+   */
+  applyInternalValue ({
+    value,
+  }) {
+    if (this.isControlled()) {
+      return
+    }
+
+    this.internalValueRef.value = value
+  }
+}
+
+/**
+ * @typedef {import('../../../contexts/BaseFuroContext.js').BaseFuroContextParams & {
+ *   props: Props
+ *   componentContext: ComponentContext
+ *   refHash: {
+ *     internalValueRef: import('vue').Ref<FuroRadioValue | null>
+ *     radioRootElementRef: import('vue').Ref<HTMLElement | null>
+ *   }
+ * }} FuroRadioContextParams
+ */
+
+/**
+ * @typedef {Omit<FuroRadioContextParams, 'refHash'> & {
+ *   refHash?: {
+ *     internalValueRef: import('vue').Ref<FuroRadioValue | null>
+ *     radioRootElementRef: import('vue').Ref<HTMLElement | null>
+ *   }
+ * }} FuroRadioContextFactoryParams
+ */
+
+/**
+ * @typedef {keyof typeof FuroRadioContext.EMIT_EVENT_NAME} EmitEventName
+ */
+
+/**
+ * Public chosen model (`v-model:value`, `parcel.value`).
+ *
+ * @typedef {string | number} FuroRadioValue
+ */
+
+/**
+ * @typedef {{
+ *   label: string
+ *   value: FuroRadioValue
+ *   disabled?: boolean
+ * }} FuroRadioOption
+ */
+
+/**
+ * @typedef {{
+ *   parcel?: FuroRadioParcel | null
+ * }} Props
+ */
+
+/**
+ * @typedef {{
+ *   value?: FuroRadioValue | null
+ *   options?: Array<FuroRadioOption>
+ *   invalid?: boolean
+ *   disabled?: boolean
+ *   required?: boolean
+ *   size?: string
+ * }} FuroRadioParcel
+ */
+
+/**
+ * @typedef {import('vue').SetupContext<typeof FuroRadioContext.EMIT_EVENT_HASH>} ComponentContext
+ */
+
+/**
+ * @typedef {typeof FuroRadioContext.EMIT_EVENT_HASH} FuroRadioEmitHash
+ */
+
+/**
+ * @typedef {(
+ *   props: Props,
+ *   componentContext: ComponentContext
+ * ) => {
+ *   context: FuroRadioContext
+ * }} FuroRadioSetup
+ */

package/lib/components/atoms/FuroRadio/RadioEmitPayload.js

@@ -0,0 +1,72 @@
+import BaseEmitPayload from '../../../emit-payload/BaseEmitPayload.js'
+
+/**
+ * RadioEmitPayload.
+ *
+ * @extends {BaseEmitPayload<RadioRawEvent, HTMLElement>}
+ */
+export default class RadioEmitPayload extends BaseEmitPayload {
+  /**
+   * Get the event detail.
+   *
+   * @returns {RadioRawEvent['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
+  }
+
+  /**
+   * Value of the option chosen by the change.
+   *
+   * @returns {FuroRadioValue | null}
+   */
+  get value () {
+    return this.eventDetail?.value
+      ?? null
+  }
+
+  /**
+   * Whether an option is chosen after the change.
+   *
+   * A group with nothing chosen reports a null value, which is distinct from an
+   * option whose own value is null.
+   *
+   * @returns {boolean}
+   */
+  isSelected () {
+    return this.value !== null
+  }
+}
+
+/**
+ * @typedef {import('./FuroRadioContext.js').FuroRadioValue} FuroRadioValue
+ */
+
+/**
+ * @typedef {{
+ *   rawEvent: RadioRawEvent
+ * }} RadioEmitPayloadParams
+ */
+
+/**
+ * @typedef {CustomEvent<{
+ *   target: HTMLElement | null
+ *   value: FuroRadioValue | null
+ * }>} RadioRawEvent
+ */
+
+/**
+ * @typedef {RadioEmitPayloadParams} RadioEmitPayloadFactoryParams
+ */