SurveyJS Form Library

SurveyJS Form Library is a free and open-source JavaScript form library for rendering dynamic, JSON-based forms and surveys in React, Angular, Vue, and plain JavaScript applications. It collects responses in the browser and lets you send submitted data to any backend or database.

Use it to build complex multi-step forms, pop-up surveys, quizzes, scored surveys, calculator forms, and other data-entry tools. Form content and structure, validation, conditional logic, navigation, and appearance are defined through a SurveyJS JSON form definition.

You can create form definitions manually, generate them with AI, or build them visually with SurveyJS Creator, an embeddable drag-and-drop form builder.

https://github.com/surveyjs/survey-library/assets/102306951/844563b2-c7c3-400c-962f-bcdbe7274d55

How It Works

SurveyJS Form Library renders forms from JSON definitions directly in your web application. It runs in the browser and does not require a SurveyJS backend, so you retain control over form definitions, submitted responses, and data storage.

Your application can:

1. Create or load a SurveyJS JSON form definition.
2. Render it with SurveyJS Form Library.
3. Collect responses in the browser.
4. Send submitted data to your backend.
5. Store it in the database or service of your choice.

Installation

Choose the package for your framework:

React Form Library

npm install survey-react-ui

Get Started with Form Library for React

Angular Form Library

npm install survey-angular-ui

Get Started with Form Library for Angular

Vue.js Form Library

npm install survey-vue3-ui

Get Started with Form Library for Vue.js

Plain JavaScript Form Library

npm install survey-js-ui

Get Started with Form Library for Plain JavaScript

Package Architecture

SurveyJS Form Library separates form logic from rendering. The framework-independent survey-core package provides the form model, validation, conditional logic, calculations, navigation, localization, and other core behavior. Framework-specific packages such as survey-react-ui, survey-angular-ui, and survey-vue3-ui render that model in React, Angular, and Vue 3 applications. Installing a rendering package brings survey-core with it.

Key Features

Dynamic Forms and Surveys

• Multi-step forms, quizzes, scored surveys, calculator forms, and survey pop-ups
• Conditional visibility, branching, calculated values, and expression-based logic
• Input validation, partial submissions, auto-save, and lazy loading
• Dynamic panels, repeating question groups, carry-forward responses, and text piping
• Multiple navigation modes for long and complex forms

Multi-Framework Support

• Dedicated Form Library rendering packages for React, Angular, Vue 3, and plain JavaScript
• TypeScript support
• Client-side rendering with no required SurveyJS backend

Data and Backend Integration

• Connect to any server, API, or database
• Store form definitions and submitted responses in your own infrastructure
• Load choices from web services
• Integrate with third-party libraries, payment systems, and custom backend workflows
• Backend integration examples for PHP, ASP.NET Core, and Node.js

Form Controls

• 20+ built-in question and input types
• Custom question types and input components
• Electronic signature and image capture
• Reusable composite questions and third-party widgets

Localization and Accessibility

• Community-supported localization for 50+ languages
• Multi-language forms and automatic locale selection
• Right-to-left language support
• Accessible input controls and keyboard navigation

This is the beginning of the README. Read the rest at the original. Read the full README ↗