@openreachtech/furo-vue 1.3.1

package/lib/components/atoms/FuroPasswordField/FuroPasswordFieldContext.js

@@ -0,0 +1,311 @@
+import {
+  ref,
+} from 'vue'
+
+import BaseFuroContext from '../../../contexts/BaseFuroContext.js'
+
+import PasswordFieldEmitPayload from './PasswordFieldEmitPayload.js'
+
+/**
+ * Context class for managing FuroPasswordField component.
+ *
+ * @extends {BaseFuroContext<null, Props, EmitEventName>}
+ */
+export default class FuroPasswordFieldContext extends BaseFuroContext {
+  /**
+   * Constructor.
+   *
+   * @param {FuroPasswordFieldContextParams} params
+   */
+  constructor ({
+    props,
+    componentContext,
+    refHash,
+  }) {
+    super({
+      props,
+      componentContext,
+    })
+
+    this.refHash = refHash
+  }
+
+  /**
+   * Factory method.
+   *
+   * @template {X extends typeof FuroPasswordFieldContext ? X : never} T, X
+   * @override
+   * @param {FuroPasswordFieldContextFactoryParams} 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),
+    }
+  }
+
+  /**
+   * 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('./PasswordFieldEmitPayload.js').default) => void
+   *   'commit-value': (payload: import('./PasswordFieldEmitPayload.js').default) => void
+   *   'update:value': (payload: import('./PasswordFieldEmitPayload.js').default) => void
+   * }}
+   */
+  static get EMIT_EVENT_HASH () {
+    return {
+      [this.EMIT_EVENT_NAME.CHANGE_VALUE]: (/** @type {import('./PasswordFieldEmitPayload.js').default} */ payload) => true,
+      [this.EMIT_EVENT_NAME.COMMIT_VALUE]: (/** @type {import('./PasswordFieldEmitPayload.js').default} */ payload) => true,
+      [this.EMIT_EVENT_NAME.UPDATE_VALUE]: (/** @type {import('./PasswordFieldEmitPayload.js').default} */ payload) => true,
+    }
+  }
+
+  /**
+   * get: Constructor of `EmitPayload`
+   *
+   * @returns {typeof PasswordFieldEmitPayload}
+   */
+  static get EmitPayloadCtor () {
+    return PasswordFieldEmitPayload
+  }
+
+  /**
+   * Create an instance of `EmitPayload`
+   *
+   * @param {{
+   *   rawEvent: import('./PasswordFieldEmitPayload.js').PasswordFieldRawEvent
+   * }} params - Parameters.
+   * @returns {InstanceType<typeof PasswordFieldEmitPayload>}
+   */
+  static createEmitPayload ({
+    rawEvent,
+  }) {
+    return this.EmitPayloadCtor.create({
+      rawEvent,
+    })
+  }
+
+  /**
+   * get: Constructor of this class.
+   *
+   * @override
+   * @returns {typeof FuroPasswordFieldContext}
+   */
+  get Ctor () {
+    return /** @type {typeof FuroPasswordFieldContext} */ (this.constructor)
+  }
+
+  /**
+   * Get internal value ref.
+   *
+   * @returns {import('vue').Ref<string | null>}
+   */
+  get internalValueRef () {
+    return this.refHash.internalValueRef
+  }
+
+  /**
+   * Parcel passed from parent via props.
+   *
+   * @returns {Props['parcel']}
+   */
+  get parcel () {
+    return this.props.parcel
+      ?? null
+  }
+
+  /**
+   * Setup component context.
+   *
+   * @template {X extends FuroPasswordFieldContext ? X : never} T, X
+   * @override
+   * @returns {T} - For method chaining.
+   * @this {T}
+   */
+  setupComponent () {
+    const valueAttribute = /** @type {string | null} */ (this.attrs?.value ?? null)
+
+    this.watch(
+      [
+        () => this.parcel?.value,
+        () => valueAttribute,
+      ],
+      ([parcelPasswordValue, attrsPasswordValue]) => {
+        this.internalValueRef.value = parcelPasswordValue ?? attrsPasswordValue ?? null
+      },
+      {
+        immediate: true,
+      }
+    )
+
+    return this
+  }
+
+  /**
+   * Generate input attributes without type attribute.
+   *
+   * @returns {Omit<import('vue').InputHTMLAttributes, 'type'>}
+   */
+  generateInputAttributes () {
+    const {
+      type,
+      ...restAttributes
+    } = this.attrs
+
+    return restAttributes
+  }
+
+  /**
+   * Whether the password field is invalid.
+   *
+   * @returns {boolean}
+   */
+  isInvalid () {
+    return Boolean(this.parcel?.invalid)
+  }
+
+  /**
+   * Handle blur and keypress.enter event from the native element.
+   *
+   * @param {{
+   *   rawEvent: FocusEvent | KeyboardEvent
+   * }} 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>
+ *   }
+ * }} FuroPasswordFieldContextParams
+ */
+
+/**
+ * @typedef {Omit<FuroPasswordFieldContextParams, 'refHash'> & {
+ *   refHash?: {
+ *     internalValueRef: import('vue').Ref<string | null>
+ *   }
+ * }} FuroPasswordFieldContextFactoryParams
+ */
+
+/**
+ * @typedef {keyof typeof FuroPasswordFieldContext.EMIT_EVENT_NAME} EmitEventName
+ */
+
+/**
+ * @typedef {Omit<import('vue').InputHTMLAttributes, 'type'> & {
+ *   parcel?: FuroPasswordFieldParcel | null
+ * }} Props
+ */
+
+/**
+ * @typedef {import('vue').SetupContext<FuroPasswordFieldEmitHash>} ComponentContext
+ */
+
+/**
+ * @typedef {{
+ *   value?: string | null
+ *   invalid?: boolean
+ * }} FuroPasswordFieldParcel
+ */
+
+/**
+ * @typedef {typeof FuroPasswordFieldContext.EMIT_EVENT_HASH} FuroPasswordFieldEmitHash
+ */
+
+/**
+ * @typedef {(
+ *   props: Props,
+ *   componentContext: ComponentContext
+ * ) => {
+ *   context: FuroPasswordFieldContext
+ * }} FuroPasswordFieldSetup
+ */

package/lib/components/atoms/FuroPasswordField/PasswordFieldEmitPayload.js

@@ -0,0 +1,74 @@
+import BaseEmitPayload from '../../../emit-payload/BaseEmitPayload.js'
+
+/**
+ * PasswordFieldEmitPayload.
+ *
+ * @extends {BaseEmitPayload<PasswordFieldRawEvent, HTMLInputElement>}
+ */
+export default class PasswordFieldEmitPayload extends BaseEmitPayload {
+  /**
+   * Current string value of the password field.
+   *
+   * @returns {string | null}
+   */
+  get value () {
+    return this.controlElement?.value
+      ?? null
+  }
+
+  /**
+   * Extract trimmed string value from the password field.
+   *
+   * @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} PasswordFieldRawEvent
+ */

package/lib/components/atoms/FuroRadio/FuroRadio.vue

@@ -0,0 +1,193 @@
+<script>
+import {
+  defineComponent,
+} from 'vue'
+
+import {
+  RadioGroup as RekaRadioGroup,
+} from 'reka-ui/namespaced'
+
+import FuroRadioContext from './FuroRadioContext.js'
+
+export default defineComponent({
+  name: 'FuroRadio',
+
+  components: {
+    RadioGroupRoot: RekaRadioGroup.Root,
+    RadioGroupOption: RekaRadioGroup.Item,
+    RadioGroupIndicator: RekaRadioGroup.Indicator,
+  },
+
+  inheritAttrs: false,
+
+  props: {
+    parcel: {
+      /** @type {import('vue').PropType<import('./FuroRadioContext.js').Props['parcel']>} */
+      type: [
+        Object,
+        null,
+      ],
+      default: null,
+    },
+  },
+
+  emits: FuroRadioContext.EMIT_EVENT_HASH,
+
+  /**
+   * Setup of this component.
+   *
+   * @type {import('./FuroRadioContext.js').FuroRadioSetup}
+   */
+  setup (
+    props,
+    componentContext
+  ) {
+    const context = FuroRadioContext.create({
+      props,
+      componentContext,
+    })
+      .setupComponent()
+
+    return {
+      context,
+    }
+  },
+})
+</script>
+
+<template>
+  <RadioGroupRoot
+    :ref="context.radioRootElementRef"
+    v-bind="{
+      ...context.extractRootAttributes(),
+      ...$attrs,
+    }"
+    class="unit-form-control radio-group"
+    :class="{
+      invalid: context.isInvalid(),
+      disabled: context.isDisabled(),
+    }"
+    :style="context.extractRadioRootStyle()"
+    :aria-invalid="context.isInvalid()"
+    :disabled="context.isDisabled()"
+    :required="context.isRequired()"
+    :model-value="context.internalValueRef.value"
+    @update:model-value="context.onChangeValue({
+      rawValue: $event,
+    })"
+  >
+    <label
+      v-for="option of context.extractOptions()"
+      :key="option.value"
+      class="option"
+      :class="{
+        disabled: context.isOptionDisabled({ option }),
+      }"
+    >
+      <RadioGroupOption
+        class="radio"
+        :value="option.value"
+        :disabled="context.isOptionDisabled({ option })"
+      >
+        <RadioGroupIndicator class="indicator" />
+      </RadioGroupOption>
+
+      <slot
+        name="option-label"
+        v-bind="{ option }"
+      >
+        <span class="label">{{ option.label }}</span>
+      </slot>
+    </label>
+  </RadioGroupRoot>
+</template>
+
+<style scoped>
+@layer furo {
+  .unit-form-control.radio-group {
+    display: flex;
+    flex-direction: column;
+    gap: var(--size-space-small);
+  }
+
+  .unit-form-control.radio-group > .option {
+    display: inline-flex;
+    align-items: center;
+    gap: var(--size-space-small);
+
+    cursor: pointer;
+  }
+
+  .unit-form-control.radio-group > .option.disabled {
+    cursor: not-allowed;
+    opacity: 0.5;
+  }
+
+  .unit-form-control.radio-group > .option > .radio {
+    display: inline-grid;
+    place-content: center;
+
+    flex-shrink: 0;
+
+    width: var(--furo-radio-size, 1.125rem);
+    height: var(--furo-radio-size, 1.125rem);
+
+    border: var(--size-thinnest) solid var(--color-input);
+    border-radius: var(--size-border-radius-full);
+
+    padding: 0;
+
+    background-color: transparent;
+
+    cursor: inherit;
+
+    transition-duration: var(--transition-timer);
+    transition-property: background-color, border-color;
+  }
+
+  .unit-form-control.radio-group > .option > .radio[data-state="checked"] {
+    border-color: var(--color-selected);
+  }
+
+  /* :not(.invalid) so a bare :hover cannot outrank the invalid rule below. */
+  .unit-form-control.radio-group:not(.invalid) > .option:not(.disabled) > .radio[data-state="checked"]:hover {
+    border-color: var(--color-selected-border-darker);
+  }
+
+  .unit-form-control.radio-group > .option > .radio:focus-visible {
+    outline: none;
+    box-shadow: 0 0 0 0.125rem var(--color-ring);
+  }
+
+  .unit-form-control.radio-group.invalid > .option > .radio {
+    border-color: var(--color-destructive);
+  }
+
+  .unit-form-control.radio-group > .option > .radio > .indicator {
+    display: block;
+
+    width: var(--furo-radio-dot-size, 0.5rem);
+    height: var(--furo-radio-dot-size, 0.5rem);
+
+    border-radius: var(--size-border-radius-full);
+
+    background-color: var(--color-selected);
+
+    transition-duration: var(--transition-timer);
+    transition-property: background-color;
+  }
+
+  .unit-form-control.radio-group:not(.invalid) > .option:not(.disabled) > .radio:hover > .indicator {
+    background-color: var(--color-selected-darker);
+  }
+
+  .unit-form-control.radio-group.invalid > .option > .radio > .indicator {
+    background-color: var(--color-destructive);
+  }
+
+  .unit-form-control.radio-group > .option > .label {
+    color: var(--color-foreground);
+    font: var(--font-body-medium);
+  }
+}
+</style>