@byyuurin/ui 0.0.9 → 0.0.11

package/dist/runtime/components/Form.vue.d.ts

@@ -0,0 +1,78 @@
+import type { ComputedRef, DeepReadonly, Ref } from 'vue';
+import type { form } from '../theme/index.js';
+import type { ComponentAttrs, FormError, FormErrorEvent, FormErrorWithId, FormInputEvents, FormSchema, FormSubmitEvent, FormValidateOptions } from '../types/index.js';
+export interface FormEmits<T extends object> {
+    submit: [payload: FormSubmitEvent<T>];
+    error: [payload: FormErrorEvent];
+}
+export interface FormSlots {
+    default?: (props?: {
+        errors: FormError[];
+    }) => any;
+}
+export interface FormExpose<T extends object> {
+    validate: (options?: FormValidateOptions<T>) => Promise<T | false>;
+    clear: (path?: string) => void;
+    errors: Ref<FormError[]>;
+    setErrors: (errors: FormError[], name?: keyof T) => void;
+    getErrors: (name?: keyof T) => FormError[];
+    submit: () => Promise<void>;
+    disabled: ComputedRef<boolean>;
+    dirty: ComputedRef<boolean>;
+    dirtyFields: DeepReadonly<Set<keyof T>>;
+    touchedFields: DeepReadonly<Set<keyof T>>;
+    blurredFields: DeepReadonly<Set<keyof T>>;
+}
+export interface FormProps<T extends object> extends Omit<ComponentAttrs<typeof form>, 'ui'> {
+    id?: string | number;
+    /**  Schema to validate the form state. */
+    schema?: FormSchema<T>;
+    /** An object representing the current state of the form. */
+    state: Partial<T>;
+    /**
+     * Custom validation function to validate the form state.
+     * @param state - The current state of the form.
+     * @returns A promise that resolves to an array of FormError objects, or an array of FormError objects directly.
+     */
+    validate?: (state: Partial<T>) => Promise<FormError[]> | FormError[];
+    /**
+     * The list of input events that trigger the form validation.
+     * @default ["blur", "change", "input"]
+     */
+    validateOn?: FormInputEvents[];
+    /** Disable all inputs inside the form. */
+    disabled?: boolean;
+    /**
+     * Delay in milliseconds before validating the form on input events.
+     * @default 300
+     */
+    validateOnInputDelay?: number;
+    /**
+     * If true, schema transformations will be applied to the state on submit.
+     * @default true
+     */
+    transform?: boolean;
+    onSubmit?: ((event: FormSubmitEvent<T>) => void | Promise<void>) | (() => void | Promise<void>);
+}
+export declare class FormValidationExceptionError extends Error {
+    formId: string | number;
+    errors: FormErrorWithId[];
+    children?: FormValidationExceptionError[];
+    constructor(formId: string | number, errors: FormErrorWithId[], childErrors?: FormValidationExceptionError[]);
+}
+declare const _default: <T extends object>(__VLS_props: NonNullable<Awaited<typeof __VLS_setup>>["props"], __VLS_ctx?: __VLS_PrettifyLocal<Pick<NonNullable<Awaited<typeof __VLS_setup>>, "attrs" | "emit" | "slots">>, __VLS_expose?: NonNullable<Awaited<typeof __VLS_setup>>["expose"], __VLS_setup?: Promise<{
+    props: __VLS_PrettifyLocal<Pick<Partial<{}> & Omit<{
+        readonly onError?: ((payload: FormErrorEvent) => any) | undefined;
+        readonly onSubmit?: ((payload: FormSubmitEvent<T>) => any) | undefined;
+    } & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, never>, "onSubmit" | "onError"> & FormProps<T> & Partial<{}>> & import("vue").PublicProps;
+    expose(exposed: import("vue").ShallowUnwrapRef<FormExpose<T>>): void;
+    attrs: any;
+    slots: FormSlots;
+    emit: ((evt: "error", payload: FormErrorEvent) => void) & ((evt: "submit", payload: FormSubmitEvent<T>) => void);
+}>) => import("vue").VNode & {
+    __ctx?: Awaited<typeof __VLS_setup>;
+};
+export default _default;
+type __VLS_PrettifyLocal<T> = {
+    [K in keyof T]: T[K];
+} & {};

package/dist/runtime/components/FormItem.vue

@@ -0,0 +1,90 @@
+<script>
+
+</script>
+
+<script setup>
+import { Label, Primitive } from "reka-ui";
+import { computed, ref, useId } from "vue";
+import { injectFormErrors, provideFormInputId, provideFormItem } from "../app/injections";
+import { useTheme } from "../composables/useTheme";
+const props = defineProps({
+  as: { type: null, required: false },
+  name: { type: String, required: false },
+  errorPattern: { type: null, required: false },
+  label: { type: String, required: false },
+  description: { type: String, required: false },
+  help: { type: String, required: false },
+  error: { type: [String, Boolean], required: false },
+  hint: { type: String, required: false },
+  size: { type: null, required: false },
+  required: { type: Boolean, required: false },
+  eagerValidation: { type: Boolean, required: false },
+  validateOnInputDelay: { type: Number, required: false },
+  class: { type: null, required: false },
+  ui: { type: null, required: false }
+});
+const slots = defineSlots();
+const id = ref(useId());
+const ariaId = id.value;
+provideFormInputId(id);
+const formErrors = injectFormErrors();
+const error = computed(() => {
+  if (props.error)
+    return props.error;
+  const formError = formErrors?.value.find((error2) => {
+    if (error2.name && error2.name === props.name)
+      return true;
+    if (error2.name && props.errorPattern)
+      return error2.name.match(props.errorPattern);
+    return false;
+  });
+  return formError?.message;
+});
+provideFormItem(computed(() => ({
+  ...props,
+  error: error.value,
+  ariaId
+})));
+const { generateStyle } = useTheme();
+const style = computed(() => generateStyle("formItem", props));
+</script>
+
+<template>
+  <Primitive :as="props.as" :class="style.root({ class: [props.class, props.ui?.root] })" data-part="root">
+    <div :class="style.wrapper({ class: props.ui?.wrapper })" data-part="wrapper">
+      <div v-if="props.label || slots.label" :class="style.labelWrapper({ class: props.ui?.labelWrapper })" data-part="label-wrapper">
+        <Label :for="id" :class="style.label({ class: props.ui?.label })" data-part="label">
+          <slot name="label" :label="props.label">
+            {{ props.label }}
+          </slot>
+        </Label>
+        <span v-if="props.hint || slots.hint" :id="`${ariaId}-hint`" :class="style.hint({ class: props.ui?.hint })" data-part="hint">
+          <slot name="hint" :hint="props.hint">
+            {{ props.hint }}
+          </slot>
+        </span>
+      </div>
+
+      <p v-if="props.description || slots.description" :id="`${ariaId}-description`" :class="style.description({ class: props.ui?.description })" data-part="description">
+        <slot name="description" :description="props.description">
+          {{ props.description }}
+        </slot>
+      </p>
+    </div>
+
+    <div :class="(props.label || slots.label || props.description || slots.description) && style.container({ class: props.ui?.container })" data-part="container">
+      <slot :error="error"></slot>
+
+      <p v-if="typeof error === 'string' && error || slots.error" :id="`${ariaId}-error`" :class="style.error({ class: props.ui?.error })" data-part="error">
+        <slot name="error" :error="error">
+          {{ error }}
+        </slot>
+      </p>
+      <p v-else :class="style.help({ class: props.ui?.help })" data-part="help">
+        <slot name="help" :help="props.help">
+          {{ help }}
+        </slot>
+      </p>
+    </div>
+  </Primitive>
+</template>

package/dist/runtime/components/FormItem.vue.d.ts

@@ -0,0 +1,60 @@
+import type { VariantProps } from '@byyuurin/ui-kit';
+import type { PrimitiveProps } from 'reka-ui';
+import type { formItem } from '../theme/index.js';
+import type { ComponentAttrs } from '../types/index.js';
+export interface FormFieldSlots {
+    label?: (props: {
+        label?: string;
+    }) => any;
+    hint?: (props: {
+        hint?: string;
+    }) => any;
+    description?: (props: {
+        description?: string;
+    }) => any;
+    help?: (props: {
+        help?: string;
+    }) => any;
+    error?: (props: {
+        error?: string | boolean;
+    }) => any;
+    default?: (props: {
+        error?: string | boolean;
+    }) => any;
+}
+type FormItemVariants = VariantProps<typeof formItem>;
+export interface FormItemProps extends ComponentAttrs<typeof formItem> {
+    /**
+     * The element or component this component should render as.
+     * @default "div"
+     */
+    as?: PrimitiveProps['as'];
+    /** The name of the FormItem. Also used to match form errors. */
+    name?: string;
+    /** A regular expression to match form error names. */
+    errorPattern?: RegExp;
+    label?: string;
+    description?: string;
+    help?: string;
+    error?: string | boolean;
+    hint?: string;
+    /**
+     * @default 'md'
+     */
+    size?: FormItemVariants['size'];
+    required?: boolean;
+    /** If true, validation on input will be active immediately instead of waiting for a blur event. */
+    eagerValidation?: boolean;
+    /**
+     * Delay in milliseconds before validating the form on input events.
+     * @default 300
+     */
+    validateOnInputDelay?: number;
+}
+declare const _default: __VLS_WithSlots<import("vue").DefineComponent<FormItemProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<FormItemProps> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>, FormFieldSlots>;
+export default _default;
+type __VLS_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/runtime/components/Input.vue

@@ -1,173 +1,151 @@
-<script lang="ts">
-import type { VariantProps } from '@byyuurin/ui-kit'
-import type { PrimitiveProps } from 'reka-ui'
-import type { InputHTMLAttributes } from 'vue'
-import type { UseComponentIconsProps } from '../composables/useComponentIcons'
-import type { input } from '../theme'
-import type { ComponentAttrs } from '../types'
+<script>
 
-export interface InputEmits {
-  (e: 'update:modelValue', payload: string | number): void
-  (e: 'blur', event: FocusEvent): void
-  (e: 'change', event: Event): void
-}
-
-export interface InputSlots {
-  leading?: (props?: {}) => any
-  default?: (props?: {}) => any
-  trailing?: (props?: {}) => any
-}
-
-type InputVariants = VariantProps<typeof input>
-
-export interface InputProps extends ComponentAttrs<typeof input>, UseComponentIconsProps {
-  /**
-   * The element or component this component should render as.
-   * @default "div"
-   */
-  as?: PrimitiveProps['as']
-  id?: string
-  name?: string
-  type?: InputHTMLAttributes['type']
-  placeholder?: string
-  size?: InputVariants['size']
-  variant?: InputVariants['variant']
-  loading?: boolean
-  highlight?: boolean
-  underline?: boolean
-  required?: boolean
-  autocomplete?: InputHTMLAttributes['autocomplete']
-  autofocus?: boolean
-  autofocusDelay?: number
-  disabled?: boolean
-}
 </script>
 
-<script setup lang="ts">
-import { Primitive } from 'reka-ui'
-import { computed, onMounted, ref } from 'vue'
-import { useButtonGroup } from '../composables/useButtonGroup'
-import { useComponentIcons } from '../composables/useComponentIcons'
-import { useTheme } from '../composables/useTheme'
-import { looseToNumber } from '../utils'
-
+<script setup>
+import { Primitive } from "reka-ui";
+import { computed, onMounted, ref } from "vue";
+import { useButtonGroup } from "../composables/useButtonGroup";
+import { useComponentIcons } from "../composables/useComponentIcons";
+import { useFormItem } from "../composables/useFormItem";
+import { useTheme } from "../composables/useTheme";
+import { looseToNumber } from "../utils";
 defineOptions({
-  inheritAttrs: false,
-})
-
-const props = withDefaults(defineProps<InputProps>(), {
-  type: 'text',
-  variant: 'outline',
-  autocomplete: 'off',
-  autofocusDelay: 0,
-})
-
-const emit = defineEmits<InputEmits>()
-const slots = defineSlots<InputSlots>()
-const [modelValue, modelModifiers] = defineModel<string | number>()
-
-const inputRef = ref<HTMLInputElement | null>(null)
-
-const { size, orientation } = useButtonGroup(props)
-const { isLeading, leadingIconName, isTrailing, trailingIconName } = useComponentIcons(props)
-
-const { generateStyle } = useTheme()
-const style = computed(() => generateStyle('input', {
+  inheritAttrs: false
+});
+const props = defineProps({
+  as: { type: null, required: false },
+  id: { type: String, required: false },
+  name: { type: String, required: false },
+  type: { type: null, required: false, default: "text" },
+  placeholder: { type: String, required: false },
+  size: { type: null, required: false },
+  variant: { type: null, required: false, default: "outline" },
+  loading: { type: Boolean, required: false },
+  highlight: { type: Boolean, required: false },
+  underline: { type: Boolean, required: false },
+  required: { type: Boolean, required: false },
+  autocomplete: { type: null, required: false, default: "off" },
+  autofocus: { type: Boolean, required: false },
+  autofocusDelay: { type: Number, required: false, default: 0 },
+  disabled: { type: Boolean, required: false },
+  class: { type: null, required: false },
+  ui: { type: null, required: false },
+  icon: { type: String, required: false },
+  leading: { type: Boolean, required: false },
+  leadingIcon: { type: String, required: false },
+  trailing: { type: Boolean, required: false },
+  trailingIcon: { type: String, required: false },
+  loadingIcon: { type: String, required: false }
+});
+const emit = defineEmits(["update:modelValue", "blur", "change"]);
+const slots = defineSlots();
+const [modelValue, modelModifiers] = defineModel({ type: [String, Number] });
+const inputRef = ref(null);
+const {
+  size: formItemSize,
+  id,
+  name,
+  highlight,
+  disabled,
+  ariaAttrs,
+  emitFormBlur,
+  emitFormInput,
+  emitFormChange,
+  emitFormFocus
+} = useFormItem(props, { deferInputValidation: true });
+const { size: buttonGroupSize, orientation } = useButtonGroup(props);
+const { isLeading, leadingIconName, isTrailing, trailingIconName } = useComponentIcons(props);
+const { generateStyle } = useTheme();
+const style = computed(() => generateStyle("input", {
   ...props,
-  // @ts-expect-error ignore type
   type: props.type,
-  size: size.value,
+  size: buttonGroupSize.value || formItemSize.value,
+  highlight: highlight.value,
   groupOrientation: orientation.value,
   leading: isLeading.value || !!slots.leading,
-  trailing: isTrailing.value || !!slots.trailing,
-}))
-
+  trailing: isTrailing.value || !!slots.trailing
+}));
 function autoFocus() {
   if (props.autofocus)
-    inputRef.value?.focus()
+    inputRef.value?.focus();
 }
-
-function updateInput(value: string) {
+function updateInput(value) {
   if (modelModifiers.trim)
-    value = value.trim()
-
-  if (modelModifiers.number || props.type === 'number')
-    value = looseToNumber(value)
-
-  modelValue.value = value
+    value = value.trim();
+  if (modelModifiers.number || props.type === "number")
+    value = looseToNumber(value);
+  modelValue.value = value;
+  emitFormInput();
 }
-
-function onInput(event: Event) {
+function onInput(event) {
   if (!modelModifiers.lazy)
-    updateInput((event.target as HTMLInputElement).value)
+    updateInput(event.target.value);
 }
-
-function onChange(event: Event) {
-  const value = (event.target as HTMLInputElement).value
-
+function onChange(event) {
+  const value = event.target.value;
   if (modelModifiers.lazy)
-    updateInput(value)
-
+    updateInput(value);
   if (modelModifiers.trim)
-    (event.target as HTMLInputElement).value = value.trim()
-
-  emit('change', event)
+    event.target.value = value.trim();
+  emit("change", event);
+  emitFormChange();
 }
-
-function onBlur(event: FocusEvent) {
-  emit('blur', event)
+function onBlur(event) {
+  emit("blur", event);
+  emitFormBlur();
 }
-
 defineExpose({
-  inputRef,
-})
-
+  inputRef
+});
 onMounted(() => {
   setTimeout(() => {
-    autoFocus()
-  }, props.autofocusDelay)
-})
+    autoFocus();
+  }, props.autofocusDelay);
+});
 </script>
 
 <template>
   <Primitive
     :as="as"
+    :aria-disabled="disabled ? true : void 0"
     :class="style.base({ class: [props.class, props.ui?.base] })"
-    :aria-disabled="props.disabled ? true : undefined"
+    :data-part="$attrs['data-part'] ?? 'base'"
   >
-    <span v-if="isLeading || slots.leading" :class="style.leading({ class: props.ui?.leading })">
+    <span v-if="isLeading || slots.leading" :class="style.leading({ class: props.ui?.leading })" data-part="leading">
       <slot name="leading">
         <span
           v-if="isLeading && leadingIconName"
           :class="style.leadingIcon({ class: [leadingIconName, props.ui?.leadingIcon] })"
+          data-part="leading-icon"
         ></span>
       </slot>
     </span>
 
     <input
-      :id="id"
       ref="inputRef"
+      :class="style.input({ class: props.ui?.input })"
+      data-part="input"
       :type="props.type"
       :value="modelValue"
-      :name="props.name"
       :placeholder="props.placeholder"
-      :class="style.input({ class: props.ui?.input })"
-      :disabled="props.disabled"
       :required="props.required"
       :autocomplete="props.autocomplete"
-      v-bind="$attrs"
+      v-bind="{ ...$attrs, ...ariaAttrs, id, name, disabled }"
       @input="onInput"
       @blur="onBlur"
       @change="onChange"
+      @focus="emitFormFocus"
     />
 
     <slot></slot>
 
-    <span v-if="isTrailing || slots.trailing" :class="style.trailing({ class: props.ui?.trailing })">
+    <span v-if="isTrailing || slots.trailing" :class="style.trailing({ class: props.ui?.trailing })" data-part="trailing">
       <slot name="trailing">
         <span
           v-if="isTrailing && trailingIconName"
           :class="style.trailingIcon({ class: [trailingIconName, props.ui?.trailingIcon] })"
+          data-part="trailing-icon"
         ></span>
       </slot>
     </span>

package/dist/runtime/components/Input.vue.d.ts

@@ -0,0 +1,64 @@
+import type { VariantProps } from '@byyuurin/ui-kit';
+import type { PrimitiveProps } from 'reka-ui';
+import type { InputHTMLAttributes } from 'vue';
+import type { UseComponentIconsProps } from '../composables/useComponentIcons.js';
+import type { input } from '../theme/index.js';
+import type { ComponentAttrs } from '../types/index.js';
+export interface InputEmits {
+    'update:modelValue': [payload: string | number];
+    'blur': [event: FocusEvent];
+    'change': [event: Event];
+}
+export interface InputSlots {
+    leading?: (props?: {}) => any;
+    default?: (props?: {}) => any;
+    trailing?: (props?: {}) => any;
+}
+type InputVariants = VariantProps<typeof input>;
+export interface InputProps extends ComponentAttrs<typeof input>, UseComponentIconsProps {
+    /**
+     * The element or component this component should render as.
+     * @default "div"
+     */
+    as?: PrimitiveProps['as'];
+    id?: string;
+    name?: string;
+    type?: InputHTMLAttributes['type'];
+    placeholder?: string;
+    size?: InputVariants['size'];
+    variant?: InputVariants['variant'];
+    loading?: boolean;
+    highlight?: boolean;
+    underline?: boolean;
+    required?: boolean;
+    autocomplete?: InputHTMLAttributes['autocomplete'];
+    autofocus?: boolean;
+    autofocusDelay?: number;
+    disabled?: boolean;
+}
+declare const _default: __VLS_WithSlots<import("vue").DefineComponent<InputProps & {
+    modelValue?: string | number;
+}, {
+    inputRef: import("vue").Ref<HTMLInputElement | null, HTMLInputElement | null>;
+}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    blur: (event: FocusEvent) => any;
+    change: (event: Event) => any;
+    "update:modelValue": (...args: unknown[]) => any;
+}, string, import("vue").PublicProps, Readonly<InputProps & {
+    modelValue?: string | number;
+}> & Readonly<{
+    onBlur?: ((event: FocusEvent) => any) | undefined;
+    onChange?: ((event: Event) => any) | undefined;
+    "onUpdate:modelValue"?: ((...args: unknown[]) => any) | undefined;
+}>, {
+    variant: "outline" | "soft" | "soft-outline" | "ghost" | "none";
+    type: import("vue").InputTypeHTMLAttribute;
+    autocomplete: string;
+    autofocusDelay: number;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>, InputSlots>;
+export default _default;
+type __VLS_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};