surveyjs/survey-library

Documentation · Setup Guides for My Stack · Form Library Demos · Theme Adapters · Store Survey Results · Report Bug

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. Define the form as a SurveyJS JSON object.
2. Render it with SurveyJS Form Library.
3. Collect responses in the browser.
4. Send the submitted data to your backend.
5. Store it in the database or service of your choice.

Installation

Choose the package for your framework:

React

npm install survey-react-ui

Get Started with Form Library for React

Angular

npm install survey-angular-ui

Get Started with Form Library for Angular

Vue.js

npm install survey-vue3-ui

Get Started with Form Library for Vue.js

Plain JavaScript

npm install survey-js-ui

Get Started with Form Library for Plain JavaScript

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

• Native integrations 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 form components and custom 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

Appearance and Customization

• Shared design token system based on CSS variables
• Built-in themes with support for custom branding
• Theme Adapters for Bootstrap, Material UI, and shadcn/ui
• Custom question rendering and reusable UI components
• Configurable layouts, navigation controls, validation messages, and form behavior

Resources

• Website
• Documentation
• Full-Featured Demo
• Release Notes
• Roadmap
• What's New

SurveyJS Product Family

• Form Library - A free and open-source MIT-licensed JavaScript library that renders dynamic JSON-based forms in your web application, and collects responses.
• Survey Creator - A self-hosted drag-and-drop form builder that automatically generates JSON definition (schemas) of your forms in real time. Try out a free full-featured demo to evaluate its capabilities.
• Dashboard - Simplifies survey data visualization and analysis with interactive and customizable charts and tables.
• PDF Generator - An open-source JavaScript library that renders SurveyJS surveys and forms as PDF files in a browser. With PDF Generator you can save an unlimited number of custom-built forms to PDF (both editable and read-only).

Build from Source

1. Build the platform-independent part

2. Build one of the UI packages

   • Angular Form Library
   • React Form Library
   • Vue Form Library
   • HTML/CSS/JS Form Library

Licensing

SurveyJS Form Library is distributed under the MIT license.