README.md

SurveyJS Vue Form Library (Vue 3)

A free and open-source MIT-licensed JavaScript form builder library that allows you to design dynamic, data-driven, multi-language survey forms and run them in your Vue applications.

NOTE: This package contains a version of SurveyJS Form Library for Vue 3. If you are looking for a Vue 2 version, refer to the survey-vue-ui npm package.

Features

• Dynamic forms, surveys, polls, and quizzes for your JavaScript application
• Integration with React, Angular, Vue, jQuery, and Knockout
• 20+ built-in question types and support for custom question types
• Built-in themes and CSS customization
• Answer validation
• TypeScript support
• Community-supported UI localization to 50+ languages
• Integration with any backend framework (examples for PHP, NodeJS, and ASP.NET included)
• Compatibility with any server + database combination
• Third-party component integration

Get Started

To get started with SurveyJS Vue Form Library, refer to the following tutorial: Add a Survey to a Vue 3 Application.

Resources

• Website
• Documentation
• Live Examples
• What's New

Build SurveyJS Vue Form Library from Sources

1. Clone the repo

   git clone https://github.com/surveyjs/survey-library.git
   cd survey-library

2. Install dependencies common for all SurveyJS libraries
   Make sure that you have Node.js v16 or later and a compatible npm version installed.

   npm install -g karma-cli
   npm install

3. Build the platform-independent part and plugins

   npm run build_core
   npm run build-plugins
   

4. Install SurveyJS Vue Form Library dependencies and build this library

   cd packages/survey-vue3-ui 
   npm i
   npm run build
   

   You can find the built scripts and style sheets in folders under the build directory.

5. Run a test application

   npm run dev
   

   This command runs a local HTTP server at http://localhost:5173/.

6. Run unit tests

   npm run test
   

   The unit tests use Karma.

Licensing

SurveyJS Form Library is distributed under the MIT license.