@openreachtech/furo-vue 1.3.1

package/lib/components/atoms/FuroToggle/FuroToggleContext.js

@@ -0,0 +1,410 @@
+import {
+  ref,
+} from 'vue'
+
+import BaseFuroContext from '../../../contexts/BaseFuroContext.js'
+
+import ToggleEmitPayload from './ToggleEmitPayload.js'
+
+/**
+ * Furo-owned parcel keys (not forwarded to Reka Toggle).
+ */
+const FURO_TOGGLE_PARCEL_KEYS = new Set([
+  'value',
+  'variant',
+  'size',
+  'disabled',
+])
+
+/**
+ * Context class for managing FuroToggle component.
+ *
+ * @extends {BaseFuroContext<null, Props, EmitEventName>}
+ */
+export default class FuroToggleContext extends BaseFuroContext {
+  /**
+   * Constructor.
+   *
+   * @param {FuroToggleContextParams} params
+   */
+  constructor ({
+    props,
+    componentContext,
+    refHash,
+  }) {
+    super({
+      props,
+      componentContext,
+    })
+
+    this.refHash = refHash
+  }
+
+  /**
+   * Factory method.
+   *
+   * @template {X extends typeof FuroToggleContext ? X : never} T, X
+   * @override
+   * @param {FuroToggleContextFactoryParams} 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),
+      toggleRootElementRef: 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('./ToggleEmitPayload.js').default) => void
+   *   'update:value': (value: FuroToggleValue) => 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 ToggleEmitPayload}
+   */
+  static get EmitPayloadCtor () {
+    return ToggleEmitPayload
+  }
+
+  /**
+   * get: Constructor of this class.
+   *
+   * @override
+   * @returns {typeof FuroToggleContext}
+   */
+  get Ctor () {
+    return /** @type {typeof FuroToggleContext} */ (
+      this.constructor
+    )
+  }
+
+  /**
+   * Get internal value ref (Reka pressed model).
+   *
+   * @returns {import('vue').Ref<FuroToggleValue>}
+   */
+  get internalValueRef () {
+    return this.refHash.internalValueRef
+  }
+
+  /**
+   * Get toggle root element ref.
+   *
+   * @returns {import('vue').Ref<HTMLElement | null>}
+   */
+  get toggleRootElementRef () {
+    return this.refHash.toggleRootElementRef
+  }
+
+  /**
+   * Parcel passed from parent via props (merged with defaults).
+   *
+   * @override
+   * @returns {FuroToggleParcel}
+   */
+  get parcel () {
+    return {
+      variant: 'default',
+      size: 'default',
+      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 pressed value from parcel or fallthrough attrs.
+   *
+   * @returns {FuroToggleValue}
+   */
+  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 toggle is disabled.
+   *
+   * @returns {boolean}
+   */
+  isDisabled () {
+    return Boolean(this.parcel.disabled)
+      || this.hasBooleanAttribute({ name: 'disabled' })
+  }
+
+  /**
+   * Extract CSS class map for the toggle root.
+   *
+   * @returns {Record<string, boolean>}
+   */
+  extractRootClassNames () {
+    const variant = this.parcel.variant
+      ?? 'default'
+
+    const size = this.parcel.size
+      ?? 'default'
+
+    const sizeClassEntries = size === 'default'
+      ? []
+      : [[`size-${size}`, true]]
+
+    return Object.fromEntries([
+      ['unit-toggle', true],
+      [variant, true],
+      ...sizeClassEntries,
+      ['disabled', this.isDisabled()],
+    ])
+  }
+
+  /**
+   * Extract root attributes forwarded to Reka Toggle.
+   *
+   * @returns {Record<string, unknown>}
+   */
+  extractRootAttributes () {
+    const parcelEntries = Object.entries(this.parcel)
+
+    return Object.fromEntries(
+      parcelEntries.filter(([key]) => !FURO_TOGGLE_PARCEL_KEYS.has(key))
+    )
+  }
+
+  /**
+   * Build a custom event for toggle value changes.
+   *
+   * @param {{
+   *   name: string
+   *   value: FuroToggleValue
+   * }} params - Parameters.
+   * @returns {import('./ToggleEmitPayload.js').ToggleRawEvent}
+   */
+  buildCustomEvent ({
+    name,
+    value,
+  }) {
+    return new CustomEvent(
+      name,
+      {
+        detail: {
+          target: this.toggleRootElementRef.value,
+          value,
+        },
+      }
+    )
+  }
+
+  /**
+   * Setup component context.
+   *
+   * @template {X extends FuroToggleContext ? 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 value update emitted by Reka Toggle.
+   *
+   * @param {{
+   *   rawValue: FuroToggleValue
+   * }} 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
+    )
+  }
+
+  /**
+   * Whether the toggle is pressed.
+   *
+   * @returns {boolean}
+   */
+  isPressed () {
+    return this.internalValueRef.value === true
+  }
+}
+
+/**
+ * @typedef {import('../../../contexts/BaseFuroContext.js').BaseFuroContextParams & {
+ *   props: Props
+ *   componentContext: ComponentContext
+ *   refHash: {
+ *     internalValueRef: import('vue').Ref<FuroToggleValue>
+ *     toggleRootElementRef: import('vue').Ref<HTMLElement | null>
+ *   }
+ * }} FuroToggleContextParams
+ */
+
+/**
+ * @typedef {Omit<FuroToggleContextParams, 'refHash'> & {
+ *   refHash?: {
+ *     internalValueRef: import('vue').Ref<FuroToggleValue>
+ *     toggleRootElementRef: import('vue').Ref<HTMLElement | null>
+ *   }
+ * }} FuroToggleContextFactoryParams
+ */
+
+/**
+ * @typedef {keyof typeof FuroToggleContext.EMIT_EVENT_NAME} EmitEventName
+ */
+
+/**
+ * Public pressed model (`v-model:value`, `parcel.value`).
+ *
+ * @typedef {boolean} FuroToggleValue
+ */
+
+/**
+ * @typedef {'default' | 'outline'} FuroToggleVariant
+ */
+
+/**
+ * @typedef {'default' | 'sm' | 'lg'} FuroToggleSize
+ */
+
+/**
+ * @typedef {{
+ *   parcel?: FuroToggleParcel | null
+ * }} Props
+ */
+
+/**
+ * @typedef {{
+ *   value?: FuroToggleValue
+ *   variant?: FuroToggleVariant
+ *   size?: FuroToggleSize
+ *   disabled?: boolean
+ * }} FuroToggleParcel
+ */
+
+/**
+ * @typedef {typeof FuroToggleContext.EMIT_EVENT_HASH} FuroToggleEmitHash
+ */
+
+/**
+ * @typedef {import('vue').SetupContext<FuroToggleEmitHash>} ComponentContext
+ */
+
+/**
+ * @typedef {(
+ *   props: Props,
+ *   componentContext: ComponentContext
+ * ) => {
+ *   context: FuroToggleContext
+ * }} FuroToggleSetup
+ */

package/lib/components/atoms/FuroToggle/ToggleEmitPayload.js

@@ -0,0 +1,86 @@
+import BaseEmitPayload from '../../../emit-payload/BaseEmitPayload.js'
+
+/**
+ * ToggleEmitPayload.
+ *
+ * @extends {BaseEmitPayload<ToggleRawEvent, HTMLElement>}
+ */
+export default class ToggleEmitPayload extends BaseEmitPayload {
+  /**
+   * Get the event detail.
+   *
+   * @returns {ToggleRawEvent['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
+  }
+
+  /**
+   * Current pressed state after the change.
+   *
+   * @returns {FuroToggleValue | null}
+   */
+  get value () {
+    return this.eventDetail?.value
+      ?? null
+  }
+
+  /**
+   * Whether the toggle is pressed after the change.
+   *
+   * @returns {boolean | null}
+   */
+  isPressed () {
+    if (typeof this.value !== 'boolean') {
+      return null
+    }
+
+    return this.value
+  }
+
+  /**
+   * Whether the toggle is released after the change.
+   *
+   * @returns {boolean | null}
+   */
+  isReleased () {
+    if (typeof this.value !== 'boolean') {
+      return null
+    }
+
+    return !this.value
+  }
+}
+
+/**
+ * @typedef {import('./FuroToggleContext.js').FuroToggleValue} FuroToggleValue
+ */
+
+/**
+ * @typedef {{
+ *   rawEvent: ToggleRawEvent
+ * }} ToggleEmitPayloadParams
+ */
+
+/**
+ * @typedef {CustomEvent<{
+ *   target: HTMLElement | null
+ *   value: FuroToggleValue | null
+ * }>} ToggleRawEvent
+ */
+
+/**
+ * @typedef {ToggleEmitPayloadParams} ToggleEmitPayloadFactoryParams
+ */

package/lib/components/molecules/FuroAccordion/AccordionEmitPayload.js

@@ -0,0 +1,80 @@
+import BaseEmitPayload from '../../../emit-payload/BaseEmitPayload.js'
+
+/**
+ * AccordionEmitPayload.
+ *
+ * @extends {BaseEmitPayload<AccordionRawEvent, HTMLElement>}
+ */
+export default class AccordionEmitPayload extends BaseEmitPayload {
+  /**
+   * Get the event detail.
+   *
+   * @returns {AccordionRawEvent['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
+  }
+
+  /**
+   * Expanded value(s) after the change.
+   *
+   * @returns {FuroAccordionValue | null}
+   */
+  get value () {
+    return this.eventDetail?.value
+      ?? null
+  }
+
+  /**
+   * Whether the given section value is expanded after the change.
+   *
+   * @param {{
+   *   value: string
+   * }} params - Parameters.
+   * @returns {boolean}
+   */
+  isExpanded ({
+    value,
+  }) {
+    const expandedValue = this.value
+
+    if (Array.isArray(expandedValue)) {
+      return expandedValue.includes(value)
+    }
+
+    return expandedValue === value
+  }
+}
+
+/**
+ * @typedef {import('./FuroAccordionContext.js').FuroAccordionValue} FuroAccordionValue
+ */
+
+/**
+ * @typedef {{
+ *   rawEvent: AccordionRawEvent
+ * }} AccordionEmitPayloadParams
+ */
+
+/**
+ * @typedef {CustomEvent<{
+ *   target: HTMLElement | null
+ *   value: FuroAccordionValue | null
+ * }>} AccordionRawEvent
+ */
+
+/**
+ * @typedef {AccordionEmitPayloadParams} AccordionEmitPayloadFactoryParams
+ */