@byyuurin/ui 0.0.11 → 0.1.0

package/dist/runtime/components/FormField.vue

@@ -0,0 +1,108 @@
+<script>
+import theme from "#build/ui/form-field";
+</script>
+
+<script setup>
+import { Label, Primitive } from "reka-ui";
+import { computed, ref, useId, watch } from "vue";
+import { useAppConfig } from "#imports";
+import { injectFormErrors, injectFormInputs, provideFormField, provideFormInputId } from "../composables/useFormField";
+import { cv, merge } from "../utils/style";
+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 },
+  ui: { type: null, required: false },
+  class: { type: [Object, String, Number, Boolean, null, Array], required: false, skipCheck: true }
+});
+const slots = defineSlots();
+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;
+});
+const id = ref(useId());
+const ariaId = id.value;
+const formInputs = injectFormInputs();
+watch(id, () => {
+  if (formInputs && props.name)
+    formInputs.value[props.name] = { id: id.value, pattern: props.errorPattern };
+}, {
+  immediate: true
+});
+provideFormInputId(id);
+provideFormField(computed(() => ({
+  name: props.name,
+  size: props.size,
+  eagerValidation: props.eagerValidation,
+  validateOnInputDelay: props.validateOnInputDelay,
+  errorPattern: props.errorPattern,
+  hint: props.hint,
+  description: props.description,
+  help: props.help,
+  ariaId,
+  error: error.value
+})));
+const appConfig = useAppConfig();
+const ui = computed(() => {
+  const styler = cv(merge(theme, appConfig.ui.formField));
+  return styler(props);
+});
+</script>
+
+<template>
+  <Primitive :as="props.as" :class="ui.root({ class: [props.ui?.root, props.class] })" data-part="root">
+    <div :class="ui.wrapper({ class: props.ui?.wrapper })" data-part="wrapper">
+      <div v-if="props.label || !!slots.label" :class="ui.labelWrapper({ class: props.ui?.labelWrapper })" data-part="label-wrapper">
+        <Label :for="id" :class="ui.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="ui.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="ui.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) && ui.container({ class: props.ui?.container })" data-part="container">
+      <slot :error="error"></slot>
+
+      <div v-if="typeof error === 'string' && error || !!slots.error" :id="`${ariaId}-error`" :class="ui.error({ class: props.ui?.error })" data-part="error">
+        <slot name="error" :error="error">
+          {{ error }}
+        </slot>
+      </div>
+      <div v-else-if="props.help || !!slots.help" :class="ui.help({ class: props.ui?.help })" data-part="help">
+        <slot name="help" :help="props.help">
+          {{ props.help }}
+        </slot>
+      </div>
+    </div>
+  </Primitive>
+</template>

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

@@ -0,0 +1,63 @@
+import type { VariantProps } from '@byyuurin/ui-kit';
+import type { PrimitiveProps } from 'reka-ui';
+import theme from '#build/ui/form-field';
+import type { ComponentBaseProps, ComponentUIProps } from '../types';
+import type { StaticSlot } from '../types/utils';
+type ThemeVariants = VariantProps<typeof theme>;
+export interface FormFieldProps extends ComponentBaseProps {
+    /**
+     * The element or component this component should render as.
+     * @default "div"
+     */
+    as?: PrimitiveProps['as'];
+    /** The name of the FormField. 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?: ThemeVariants['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;
+    ui?: ComponentUIProps<typeof theme>;
+}
+export interface FormFieldSlots {
+    label: StaticSlot<{
+        label?: string;
+    }>;
+    hint: StaticSlot<{
+        hint?: string;
+    }>;
+    description: StaticSlot<{
+        description?: string;
+    }>;
+    help: StaticSlot<{
+        help?: string;
+    }>;
+    error: StaticSlot<{
+        error?: boolean | string;
+    }>;
+    default: StaticSlot<{
+        error?: boolean | string;
+    }>;
+}
+declare const __VLS_export: __VLS_WithSlots<import("vue").DefineComponent<FormFieldProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<FormFieldProps> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>, FormFieldSlots>;
+declare const _default: typeof __VLS_export;
+export default _default;
+type __VLS_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/runtime/components/Icon.vue

@@ -0,0 +1,20 @@
+<script>
+
+</script>
+
+<script setup>
+import { reactivePick } from "@vueuse/core";
+import { useForwardProps } from "reka-ui";
+const props = defineProps({
+  name: { type: [String, Object], required: true },
+  mode: { type: String, required: false },
+  size: { type: [String, Number], required: false },
+  customize: { type: Function, required: false }
+});
+const iconProps = useForwardProps(reactivePick(props, "name", "mode", "size", "customize"));
+</script>
+
+<template>
+  <Icon v-if="typeof props.name === 'string'" v-bind="iconProps" />
+  <component :is="props.name" v-else />
+</template>

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

@@ -0,0 +1,9 @@
+export interface IconProps {
+    name: string | object;
+    mode?: 'svg' | 'css';
+    size?: string | number;
+    customize?: (content: string, name?: string, prefix?: string, provider?: string) => string;
+}
+declare const __VLS_export: import("vue").DefineComponent<IconProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<IconProps> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/runtime/components/Input.vue

@@ -1,152 +1,157 @@
 <script>
-
+import theme from "#build/ui/input";
 </script>
 
 <script setup>
+import { useVModel } from "@vueuse/core";
 import { Primitive } from "reka-ui";
 import { computed, onMounted, ref } from "vue";
-import { useButtonGroup } from "../composables/useButtonGroup";
+import { useAppConfig } from "#imports";
 import { useComponentIcons } from "../composables/useComponentIcons";
-import { useFormItem } from "../composables/useFormItem";
-import { useTheme } from "../composables/useTheme";
+import { useFieldGroup } from "../composables/useFieldGroup";
+import { useFormField } from "../composables/useFormField";
 import { looseToNumber } from "../utils";
-defineOptions({
-  inheritAttrs: false
-});
+import { cv, merge } from "../utils/style";
+import Avatar from "./Avatar.vue";
+import Icon from "./Icon.vue";
+defineOptions({ 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 },
+  color: { type: null, required: false },
   size: { type: null, required: false },
-  variant: { type: null, required: false, default: "outline" },
+  variant: { type: null, required: false },
   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 },
+  defaultValue: { type: null, required: false },
+  modelValue: { type: null, required: false },
+  modelModifiers: { type: Object, required: false },
   ui: { type: null, required: false },
-  icon: { type: String, required: false },
+  class: { type: [Object, String, Number, Boolean, null, Array], required: false, skipCheck: true },
+  icon: { type: [String, Object], required: false },
+  avatar: { type: Object, required: false },
   leading: { type: Boolean, required: false },
-  leadingIcon: { type: String, required: false },
+  leadingIcon: { type: [String, Object], required: false },
   trailing: { type: Boolean, required: false },
-  trailingIcon: { type: String, required: false },
-  loadingIcon: { type: String, required: false }
+  trailingIcon: { type: [String, Object], required: false },
+  loadingIcon: { type: [String, Object], 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 modelValue = useVModel(props, "modelValue", emit, { defaultValue: props.defaultValue });
+const { id, name, size: formFieldSize, color, highlight, disabled, ariaAttrs, emitFormBlur, emitFormInput, emitFormChange, emitFormFocus } = useFormField(props, { deferInputValidation: true });
+const { size: fieldGroupSize, orientation } = useFieldGroup(props);
 const { isLeading, leadingIconName, isTrailing, trailingIconName } = useComponentIcons(props);
-const { generateStyle } = useTheme();
-const style = computed(() => generateStyle("input", {
-  ...props,
-  type: props.type,
-  size: buttonGroupSize.value || formItemSize.value,
-  highlight: highlight.value,
-  groupOrientation: orientation.value,
-  leading: isLeading.value || !!slots.leading,
-  trailing: isTrailing.value || !!slots.trailing
-}));
-function autoFocus() {
-  if (props.autofocus)
-    inputRef.value?.focus();
-}
+const appConfig = useAppConfig();
+const ui = computed(() => {
+  const styler = cv(merge(theme, appConfig.ui.input));
+  return styler({
+    ...props,
+    type: props.type,
+    color: color.value,
+    size: fieldGroupSize.value || formFieldSize.value,
+    highlight: highlight.value,
+    fieldGroup: orientation.value,
+    leading: isLeading.value || !!props.avatar || !!slots.leading,
+    trailing: isTrailing.value || !!slots.trailing
+  });
+});
+const inputRef = ref(null);
 function updateInput(value) {
-  if (modelModifiers.trim)
-    value = value.trim();
-  if (modelModifiers.number || props.type === "number")
+  if (props.modelModifiers?.trim)
+    value = value?.trim() ?? null;
+  if (props.modelModifiers?.number)
     value = looseToNumber(value);
+  if (props.modelModifiers?.nullable)
+    value ||= null;
+  if (props.modelModifiers?.optional)
+    value ||= void 0;
   modelValue.value = value;
   emitFormInput();
 }
 function onInput(event) {
-  if (!modelModifiers.lazy)
+  if (!props.modelModifiers?.lazy)
     updateInput(event.target.value);
 }
 function onChange(event) {
   const value = event.target.value;
-  if (modelModifiers.lazy)
+  if (props.modelModifiers?.lazy)
     updateInput(value);
-  if (modelModifiers.trim)
+  if (props.modelModifiers?.trim)
     event.target.value = value.trim();
-  emit("change", event);
   emitFormChange();
+  emit("change", event);
 }
 function onBlur(event) {
-  emit("blur", event);
   emitFormBlur();
+  emit("blur", event);
+}
+function autoFocus() {
+  if (props.autofocus)
+    inputRef.value?.focus();
 }
+onMounted(() => {
+  setTimeout(() => autoFocus(), props.autofocusDelay);
+});
 defineExpose({
   inputRef
 });
-onMounted(() => {
-  setTimeout(() => {
-    autoFocus();
-  }, props.autofocusDelay);
-});
 </script>
 
 <template>
-  <Primitive
-    :as="as"
-    :aria-disabled="disabled ? true : void 0"
-    :class="style.base({ class: [props.class, props.ui?.base] })"
-    :data-part="$attrs['data-part'] ?? 'base'"
-  >
-    <span v-if="isLeading || slots.leading" :class="style.leading({ class: props.ui?.leading })" data-part="leading">
-      <slot name="leading">
-        <span
+  <Primitive :as="as" :class="ui.root({ class: [props.ui?.root, props.class] })" data-part="root">
+    <span v-if="isLeading || !!props.avatar || !!slots.leading" :class="ui.leading({ class: props.ui?.leading })" data-part="leading">
+      <slot name="leading" :ui="ui">
+        <Icon
           v-if="isLeading && leadingIconName"
-          :class="style.leadingIcon({ class: [leadingIconName, props.ui?.leadingIcon] })"
+          :name="leadingIconName"
+          :class="ui.leadingIcon({ class: props.ui?.leadingIcon })"
           data-part="leading-icon"
-        ></span>
+        />
+        <Avatar
+          v-else-if="props.avatar"
+          :size="props.ui?.leadingAvatarSize || ui.leadingAvatarSize()"
+          v-bind="props.avatar"
+          :class="ui.leadingAvatar({ class: props.ui?.leadingAvatar })"
+          data-part="leading-avatar"
+        />
       </slot>
     </span>
 
     <input
       ref="inputRef"
-      :class="style.input({ class: props.ui?.input })"
-      data-part="input"
       :type="props.type"
       :value="modelValue"
       :placeholder="props.placeholder"
       :required="props.required"
       :autocomplete="props.autocomplete"
-      v-bind="{ ...$attrs, ...ariaAttrs, id, name, disabled }"
+      v-bind="{ id, name, disabled, ...$attrs, ...ariaAttrs }"
+      :class="ui.base({ class: props.ui?.base })"
+      data-part="base"
       @input="onInput"
       @blur="onBlur"
       @change="onChange"
       @focus="emitFormFocus"
     />
 
-    <slot></slot>
+    <slot :ui="ui"></slot>
 
-    <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] })"
+    <span v-if="isTrailing || slots.trailing" :class="ui.trailing({ class: props.ui?.trailing })" data-part="trailing">
+      <slot name="trailing" :ui="ui">
+        <Icon
+          v-if="trailingIconName"
+          :name="trailingIconName"
+          :class="ui.trailingIcon({ class: props.ui?.trailingIcon })"
           data-part="trailing-icon"
-        ></span>
+        />
       </slot>
     </span>
   </Primitive>

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

@@ -1,21 +1,14 @@
 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 {
+import theme from '#build/ui/input';
+import type { UseComponentIconsProps } from '../composables/useComponentIcons';
+import type { ComponentBaseProps, ComponentStyler, ComponentUIProps } from '../types';
+import type { ModelModifiers } from '../types/input';
+import type { AcceptableValue, MaybeNull, StaticSlot } from '../types/utils';
+export type InputValue = AcceptableValue;
+type ThemeVariants = VariantProps<typeof theme>;
+export interface InputProps<T extends InputValue = InputValue> extends ComponentBaseProps, UseComponentIconsProps {
     /**
      * The element or component this component should render as.
      * @default "div"
@@ -24,41 +17,60 @@ export interface InputProps extends ComponentAttrs<typeof input>, UseComponentIc
     id?: string;
     name?: string;
     type?: InputHTMLAttributes['type'];
+    /** The placeholder text when the input is empty. */
     placeholder?: string;
-    size?: InputVariants['size'];
-    variant?: InputVariants['variant'];
+    /** @default "primary" */
+    color?: ThemeVariants['color'];
+    /** @default "md" */
+    size?: ThemeVariants['size'];
+    /** @default "outline" */
+    variant?: ThemeVariants['variant'];
     loading?: boolean;
+    /** Highlight the ring color like a focus state. */
     highlight?: boolean;
-    underline?: boolean;
     required?: boolean;
     autocomplete?: InputHTMLAttributes['autocomplete'];
     autofocus?: boolean;
     autofocusDelay?: number;
     disabled?: boolean;
+    defaultValue?: T;
+    modelValue?: T;
+    modelModifiers?: ModelModifiers;
+    ui?: ComponentUIProps<typeof theme>;
 }
-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;
-    };
+export interface InputEmits<T extends InputValue> {
+    'update:modelValue': [value: T];
+    'blur': [event: FocusEvent];
+    'change': [event: Event];
+}
+export interface InputSlots {
+    leading: StaticSlot<{
+        ui: ComponentStyler<typeof theme>;
+    }>;
+    default: StaticSlot<{
+        ui: ComponentStyler<typeof theme>;
+    }>;
+    trailing: StaticSlot<{
+        ui: ComponentStyler<typeof theme>;
+    }>;
+}
+declare const __VLS_export: <T extends InputValue>(__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<InputProps<T> & {
+        onChange?: ((event: Event) => any) | undefined;
+        onBlur?: ((event: FocusEvent) => any) | undefined;
+        "onUpdate:modelValue"?: ((value: T) => any) | undefined;
+    }> & import("vue").PublicProps;
+    expose: (exposed: import("vue").ShallowUnwrapRef<{
+        inputRef: import("vue").Ref<MaybeNull<HTMLInputElement>, MaybeNull<HTMLInputElement>>;
+    }>) => void;
+    attrs: any;
+    slots: InputSlots;
+    emit: ((evt: "change", event: Event) => void) & ((evt: "blur", event: FocusEvent) => void) & ((evt: "update:modelValue", value: T) => void);
+}>) => import("vue").VNode & {
+    __ctx?: Awaited<typeof __VLS_setup>;
 };
+declare const _default: typeof __VLS_export;
+export default _default;
+type __VLS_PrettifyLocal<T> = {
+    [K in keyof T as K]: T[K];
+} & {};