Getting Started

Introduction

The form system provides a structured and scalable way to manage forms using validation, default values, and field configurations.

Installing the Library

Install @codeleap/form using Bun:

bun add @codeleap/form

Initial example

Import form from the library and use it:

src/form.ts

import { fields, form } from '@codeleap/form'
import { t } from '@lingui/core/macro'

export const example = form('example', {
  input: fields.text({
    placeholder: 'Placeholder',
  }),
})

Declare the Global Type

This is used to show the additional options that can be declared per field and passed to the input.

index.d.ts

import { TextInputProps } from 'react-native'

declare module '@codeleap/form' {
  export interface ExtraFieldOptions extends TextInputFields {
    placeholder?: string
    label?: string
    secure?: boolean
  }
}