---
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: Vue 3
source: https://surveyjs.io/form-library/examples/table-of-contents-with-question-progress/vue3js
index: https://surveyjs.io/form-library/examples/overview.md
---

# Table of Contents with Question Progress Indicators (Vue 3)

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="app" style="position: absolute; top: 0; left: 0; right: 0; bottom: 0; height:100%"></div>
```

### `src/CustomTOCItem.vue`

```html
<template>
  <div v-if="page" class="toc-item-demo">
    <span>{{ title }}</span>
    <span class="toc-item-demo__count">
      {{ answeredQuestionCount }}/{{ questionCount }}
    </span>
  </div>
</template>

<script setup lang="ts">
import { computed, onBeforeUnmount, onMounted, ref } from "vue";
import { useBase } from "survey-vue3-ui";
import type { PageModel, SurveyModel } from "survey-core";

const props = defineProps<{
  page?: PageModel;
  survey?: SurveyModel;
}>();

useBase(() => props.page);

const tick = ref(0);
const onValueChanged = () => {
  tick.value++;
};

onMounted(() => {
  props.survey?.onValueChanged.add(onValueChanged);
});
onBeforeUnmount(() => {
  props.survey?.onValueChanged.remove(onValueChanged);
});

const page = computed(() => props.page);

const title = computed(() => {
  tick.value;
  const currentPage = props.page;
  if (!currentPage) return "";
  return currentPage.navigationTitle || currentPage.title || currentPage.name;
});

const answeredQuestionCount = computed(() => {
  tick.value;
  return props.page?.getProgressInfo().answeredQuestionCount ?? 0;
});

const questionCount = computed(() => {
  tick.value;
  return props.page?.getProgressInfo().questionCount ?? 0;
});
</script>

<style scoped>
.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;
}
</style>
```

### `src/App.vue`

```html
<template>
    <SurveyComponent :model="survey" />
</template>
<script setup lang="ts">
    import { Model } from "survey-core";
    import { SurveyComponent } from "survey-vue3-ui";
    import "survey-core/survey-core.min.css";
    import "./index.css";
    import { json } from "./json";

    const survey = new Model(json);
    survey.onComplete.add((sender, options) => {
        console.log(JSON.stringify(sender.data, null, 3));
    });
</script>
```

### `src/index.css`

```css
/* You can define custom CSS rules here */
```

### `src/json.ts`

```ts
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/main.ts`

```ts
import { createApp } from "vue";
import App from "./App.vue";
import CustomTocItem from "./CustomTOCItem.vue";


const app = createApp(App);
app.component("sv-custom-toc-item", CustomTocItem);

app.mount("#app");
```

### `src/shims-vue.d.ts`

```ts
/* eslint-disable */
declare module "*.vue" {
    import type { DefineComponent } from "vue"
    const component: DefineComponent<{}, {}, any>
    export default component
}
```

### `src/theme.ts`

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

### `.eslintrc.js`

```js
module.exports = {
    root: true,
    env: {
        node: true
    },
    extends: [
        "plugin:vue/vue3-essential",
        "eslint:recommended",
        "@vue/typescript/recommended",
        "@vue/prettier",
        "@vue/prettier/@typescript-eslint"
    ],
    parserOptions: {
        ecmaVersion: 2020
    },
    rules: {
        "no-console": process.env.NODE_ENV === "production" ? "warn" : "off",
        "no-debugger": process.env.NODE_ENV === "production" ? "warn" : "off"
    },
    overrides: [
        {
            files: [
                "**/__tests__/*.{j,t}s?(x)",
                "**/tests/unit/**/*.spec.{j,t}s?(x)"
            ],
            env: {
                jest: true
            }
        }
    ]
};
```

### `babel.config.js`

```js
module.exports = {
  presets: ["@vue/cli-plugin-babel/preset"]
};
```

### `package.json`

```json
{
  "name": "surveyjs-library-vue3",
  "version": "0.1.0",
  "scripts": {
    "serve": "vue-cli-service serve",
    "build": "vue-cli-service build",
    "lint": "vue-cli-service lint"
  },
  "dependencies": {
    "core-js": "^3.6.5",
    "tslib": "2.6.1",
    "vue": "^3.4.1",
    "survey-core": "latest",
    "survey-vue3-ui": "latest",
    "vue-router": "^4.0.0-0",
    "vuex": "^4.0.0-0"
  },
  "devDependencies": {
    "@typescript-eslint/eslint-plugin": "^2.33.0",
    "@typescript-eslint/parser": "^2.33.0",
    "@vue/cli-plugin-babel": "~4.5.0",
    "@vue/cli-plugin-eslint": "~4.5.0",
    "@vue/cli-plugin-pwa": "~4.5.0",
    "@vue/cli-plugin-router": "~4.5.0",
    "@vue/cli-plugin-typescript": "~4.5.0",
    "@vue/cli-plugin-vuex": "~4.5.0",
    "@vue/cli-service": "~4.5.0",
    "@vue/compiler-sfc": "^3.0.0",
    "@vue/eslint-config-prettier": "^6.0.0",
    "@vue/eslint-config-typescript": "^5.0.2",
    "@vue/test-utils": "^2.0.0-0",
    "eslint": "^6.7.2",
    "eslint-plugin-prettier": "^3.1.3",
    "eslint-plugin-vue": "^7.0.0-0",
    "node-sass": "^4.12.0",
    "prettier": "^1.19.1",
    "sass-loader": "^8.0.2",
    "typescript": "~3.9.3"
  }
}
```

### `tsconfig.json`

```json
{
  "compilerOptions": {
    "target": "esnext",
    "module": "esnext",
    "strict": true,
    "jsx": "preserve",
    "importHelpers": true,
    "moduleResolution": "node",
    "skipLibCheck": true,
    "esModuleInterop": true,
    "allowSyntheticDefaultImports": true,
    "sourceMap": true,
    "baseUrl": ".",
    "types": [
      "webpack-env",
      "jest"
    ],
    "paths": {
      "@/*": [
        "src/*"
      ]
    },
    "lib": [
      "esnext",
      "dom",
      "dom.iterable",
      "scripthost"
    ]
  },
  "include": [
    "src/**/*.ts",
    "src/**/*.tsx",
    "src/**/*.vue",
    "tests/**/*.ts",
    "tests/**/*.tsx"
  ],
  "exclude": [
    "node_modules"
  ]
}
```

## Other Frameworks

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