v 1.9.6

Add a Survey to a React Application

This step-by-step tutorial will help you get started with the SurveyJS Library in a React application. To add a survey to your React application, follow the steps below:

As a result, you will create a survey displayed below:

You can find the full code in the following GitHub repository: Get Started with SurveyJS - React.

Install the survey-react npm Package

The SurveyJS Library for React is distributed as a survey-react npm package. Run the following command to install it:

npm install survey-react --save

Configure Styles

SurveyJS is shipped with several style sheets that implement different themes. Import one of the style sheets in the React component in which your survey will be.

To apply the imported theme, call the applyTheme(themeName) method. Its argument accepts different values depending on the chosen theme:

  • Modern theme
    "modern"

  • Default theme (in various color schemes)
    "default", "orange", "darkblue", "darkrose", "stone", "winter", "winterstone"

  • Bootstrap theme (if your application uses Bootstrap)
    "bootstrap"

For instance, the following code applies the Modern theme:

// Modern theme
import 'survey-react/modern.min.css';
// Default theme
// import 'survey-react/survey.min.css';
import { StylesManager } from 'survey-react';

StylesManager.applyTheme("modern");

Create a Model

A model describes the layout and contents of your survey. The simplest survey model contains one or several questions without layout modifications.

Models are specified by model definitions (JSON objects). For example, the following model definition declares two textual questions, each with a title and a name. Titles are displayed on screen. Names are used to identify the questions in code.

const surveyJson = {
  elements: [{
    name: "FirstName",
    title: "Enter your first name:",
    type: "text"
  }, {
    name: "LastName",
    title: "Enter your last name:",
    type: "text"
  }]
};

To instantiate a model, pass the model definition to the Model constructor as shown in the code below. The model instance will be later used to render the survey.

import { ..., Model } from 'survey-react';
// ...
function App() {
  const survey = new Model(surveyJson);

  return ... ;
}
View full code
import 'survey-react/modern.min.css';
// import 'survey-react/survey.min.css';
import { StylesManager, Model } from 'survey-react';

StylesManager.applyTheme("modern");

const surveyJson = {
  elements: [{
    name: "FirstName",
    title: "Enter your first name:",
    type: "text"
  }, {
    name: "LastName",
    title: "Enter your last name:",
    type: "text"
  }]
};

function App() {
  const survey = new Model(surveyJson);

  return ...;
}

export default App;

Render the Survey

To render a survey, import the Survey component, add it to the template, and pass the model instance you created in the previous step to the component's model attribute:

import { ..., Survey } from 'survey-react';
// ...
const surveyJson = { ... };

function App() {
  const survey = new Model(surveyJson);

  return <Survey model={survey} />;
}

If you replicate the code correctly, you should see the following survey:

Get Started with SurveyJS - Primitive Survey

View full code
import 'survey-react/modern.min.css';
// import 'survey-react/survey.min.css';
import { Survey, StylesManager, Model } from 'survey-react';

StylesManager.applyTheme("modern");

const surveyJson = {
  elements: [{
    name: "FirstName",
    title: "Enter your first name:",
    type: "text"
  }, {
    name: "LastName",
    title: "Enter your last name:",
    type: "text"
  }]
};

function App() {
  const survey = new Model(surveyJson);

  return <Survey model={survey} />;
}

export default App;

Handle Survey Completion

After a respondent completes a survey, the results are available within the onComplete event handler. In real-world applications, you should send the results to a server where they will be stored in a database and processed. In this tutorial, the results are simply output in an alert dialog:

import { useCallback } from 'react';
// ...
function App() {
  const survey = new Model(surveyJson);
  const alertResults = useCallback((sender) => {
    const results = JSON.stringify(sender.data);
    alert(results);
  }, []);

  survey.onComplete.add(alertResults);

  return <Survey model={survey} />;
}

Get Started with SurveyJS - Survey Results

As you can see, survey results are saved in a JSON object. Its properties correspond to the name property values of your questions in the model definition.

View full code
import { useCallback } from 'react';

import 'survey-react/modern.min.css';
// import 'survey-react/survey.min.css';
import { Survey, StylesManager, Model } from 'survey-react';

StylesManager.applyTheme("modern");

const surveyJson = {
  elements: [{
    name: "FirstName",
    title: "Enter your first name:",
    type: "text"
  }, {
    name: "LastName",
    title: "Enter your last name:",
    type: "text"
  }]
};

function App() {
  const survey = new Model(surveyJson);
  const alertResults = useCallback((sender) => {
    const results = JSON.stringify(sender.data);
    alert(results);
  }, []);

  survey.onComplete.add(alertResults);

  return <Survey model={survey} />;
}

export default App;

Conclusion

You have learnt how to add a survey to your React application. For further information, refer to help topics within the Design a Survey section.