---
title: Table of Contents with Question Progress Indicators
product: Form Library
description: Customize SurveyJS Table of Contents items to show each page title, answered question count, and total question count. View this demo for JavaScript to learn more.
framework: React
source: https://surveyjs.io/form-library/examples/table-of-contents-with-question-progress/reactjs
index: https://surveyjs.io/form-library/examples/overview.md
---

# Table of Contents with Question Progress Indicators (React)

This example demonstrates how to customize Table of Contents items by assigning a custom item template to the [`tocItemComponent`](/form-library/documentation/api-reference/survey-data-model#tocItemComponent) property. The custom template displays each page title along with the number of answered questions and the total number of questions on that page.

To create a custom TOC item template, follow these steps:

1. Create a component that defines the item layout.\
The component receives the [`PageModel`](/form-library/documentation/api-reference/page-model) and [`SurveyModel`](/form-library/documentation/api-reference/survey-data-model) instances through the `page` and `survey` props. Use the page's [`navigationTitle`](/form-library/documentation/api-reference/page-model#navigationTitle), [`title`](/form-library/documentation/api-reference/page-model#title), or [`name`](/form-library/documentation/api-reference/page-model#name) property to display the page label. Call [`getProgressInfo()`](/form-library/documentation/api-reference/page-model#getProgressInfo) to get the `answeredQuestionCount` and `questionCount` values. To keep the counter in sync with answered questions, include the page and its questions in the component state.

2. Register the component under a name.\
In React and other JavaScript applications, register the component in `ReactElementFactory`.\
In Angular, register it in `AngularComponentFactory`.\
In Vue, register it as an application component.

3. Specify the component name in the survey configuration.\
Assign the registered component name to the survey's [`tocItemComponent`](/form-library/documentation/api-reference/survey-data-model#tocItemComponent) property. You can set this property in code or in the survey JSON schema. This demo uses the JSON schema approach shown in the Code tab.

## Files

### `public/index.html`

```html
<div id="surveyElement" style="position: absolute; top: 0; left: 0; right: 0; bottom: 0; min-height: 100%; height:100%"></div>
```

### `src/SurveyComponent.jsx`

```js
import React from "react";
import { Model } from "survey-core";
import { Survey } from "survey-react-ui";
import "survey-core/survey-core.min.css";
import "./index.css";
import { json } from "./json";
import { ReactElementFactory, SurveyElementBase } from "survey-react-ui";


class CustomTOCItem extends SurveyElementBase {
  get page() {
    return this.props.page;
  }
  get survey() {
    return this.props.survey;
  }
  getStateElements() {
    const page = this.page;
    if (!page) return [];
    return [page, ...page.questions];
  }
  render() {
    const page = this.page;
    if (!page) return null;

    const title = page.navigationTitle || page.title || page.name;
    const info = page.getProgressInfo();

    return (
      <div className="toc-item-demo">
        <span>{title}</span>
        <span className="toc-item-demo__count">
          {info.answeredQuestionCount}/{info.questionCount}
        </span>
      </div>
    );
  }
}

ReactElementFactory.Instance.registerElement(
  "sv-custom-toc-item",
  (props) => React.createElement(CustomTOCItem, props)
);



function SurveyComponent() {
    const survey = new Model(json);
    survey.onComplete.add((sender, options) => {
        console.log(JSON.stringify(sender.data, null, 3));
    });
    return (<Survey model={survey} />);
}

export default SurveyComponent;
```

### `src/index.css`

```css
.toc-item-demo {
  display: flex;
  justify-content: space-between;
  align-items: center;
  gap: 8px;
  width: 100%;
}

.toc-item-demo__count {
  flex-shrink: 0;
  opacity: 0.65;
  font-size: 0.85em;
}
```

### `src/index.js`

```js
import React from "react";
import { createRoot } from "react-dom/client";
import SurveyComponent from "./SurveyComponent";

const root = createRoot(document.getElementById("surveyElement"));
root.render(<SurveyComponent />);
```

### `src/json.js`

```js
export const json = {
  "showTOC": true,
  "tocItemComponent": "sv-custom-toc-item",
  "pages": [
    {
      "name": "personal",
      "title": "Profile",
      "elements": [
        {
          "type": "text",
          "name": "firstName",
          "title": "First name"
        },
        {
          "type": "text",
          "name": "lastName",
          "title": "Last name"
        },
        {
          "type": "text",
          "name": "email",
          "title": "Email",
          "inputType": "email"
        }
      ]
    },
    {
      "name": "preferences",
      "title": "Preferences",
      "elements": [
        {
          "type": "checkbox",
          "name": "interests",
          "title": "What are your interests?",
          "choices": ["Sports", "Music", "Travel", "Cooking"]
        },
        {
          "type": "radiogroup",
          "name": "contact",
          "title": "How would you like us to contact you?",
          "choices": ["Email", "Phone", "None"]
        }
      ]
    },
    {
      "name": "feedback",
      "title": "Review",
      "elements": [
        {
          "type": "comment",
          "name": "notes",
          "title": "Additional comments"
        },
        {
          "type": "rating",
          "name": "rating",
          "title": "How would you rate this form?",
          "rateMax": 5
        }
      ]
    }
  ]
}
;
```

### `src/theme.js`

```js
export const themeJson = {};
```

### `package.json`

```json
{
  "dependencies": {
    "react": "latest",
    "react-dom": "latest",
    "babel": "latest",
    
    "survey-core": "latest",
    "survey-react-ui": "latest"
  },
  "devDependencies": {
    "react-scripts": "latest"
  }
}
```

## Other Frameworks

- [Angular](https://surveyjs.io/form-library/examples/table-of-contents-with-question-progress/angular.md)
- [Vue 3](https://surveyjs.io/form-library/examples/table-of-contents-with-question-progress/vue3js.md)
- [Vanilla JS](https://surveyjs.io/form-library/examples/table-of-contents-with-question-progress/vanillajs.md)