Skip to content
On this page

UiField

The UiField component is used to capture text input from the user. It uses v-model, similar to a regular field. It has support for errors and validation.

Typings

typescript
interface ComponentProps {
  type: FieldType;
  title: string;
  description?: string;
  variant?: FieldVariants[ComponentProps['type']];
  placeholder?: string;
  disabled?: boolean;
  autocomplete?: string;
  readonly?: boolean;
  clearable?: boolean;
  rules?: string[];
  validation?: FieldValidation;
  settings?: FieldSettings;
  mask?: string[];
  name: string;
  required?: boolean;
  stacked?: boolean;
  errors?: string;
  modelValue?: string;
}

Basic Implementation

vue
<template>
  <div class="flex gap-4 items-center flex-wrap">
    <FieldComponent
      v-model="model"
      type="TEXT"
      title="Input Field"
      name="field"
      class="w-full"
    />
  </div>
</template>

<script setup lang="ts">
import { Field } from '@components/form';
import { ref } from 'vue';

const model = ref();
</script>

Text

Text Masked

Long Text

Rich Text

Birth Certificate

CPF

RG

Date

Hour

Phone

Text Async

Select

Select Gender

Select Marital Status

Checkbox

Radio

Radio Inline

Radio Card

Radio Card Small

Radio Card Stacked

Number

Clinux UI - Released under the MIT License.