Installation

Requirements

react and react-dom 18 or later (peer dependencies)

Install

npm install @osforms/react

pnpm add @osforms/react

yarn add @osforms/react

TypeScript

Types are bundled, so no separate @types package is needed. Import them from @osforms/react:

import type {
  FormSchema,
  FormField,
  FormTheme,
  FieldType,
  ConditionalLogic,
} from '@osforms/react';

Also exported: FieldConfig, FieldOption, FieldValidation, FormMode, WelcomeScreen, ThankYouScreen, OSFormProps, FormState, and FormStateActions.

Next.js (App Router)

Works out of the box. Add 'use client' when using in a Server Component file:

'use client';

import { OSForm } from '@osforms/react';

export default function ContactPage() {
  return <OSForm formId="abc123" mode="conversational" fullScreen />;
}

Next.js (Pages Router)

No special configuration needed, and no 'use client' directive:

import { OSForm } from '@osforms/react';

export default function ContactPage() {
  return <OSForm formId="abc123" />;
}

Vite / CRA

Works without additional configuration.

Bundle size

What	Size
`@osforms/react` (gzipped)	~10 kB
`framer-motion` (gzipped, auto-installed)	~40 kB

Overview

Components

Advanced

Requirements

Install

TypeScript

Next.js (App Router)

Next.js (Pages Router)

Vite / CRA

Bundle size

​Requirements

​Install

​TypeScript

​Next.js (App Router)

​Next.js (Pages Router)

​Vite / CRA

​Bundle size

Requirements

Install

TypeScript

Next.js (App Router)

Next.js (Pages Router)

Vite / CRA

Bundle size