---
title: Custom Navigation Buttons
product: Form Library
description: Learn how to easily add a new navigation button to a form by using the addNavigationItem() method. View a free demo for JavaScript with a ready-to-use code snippet to learn more. Customize your forms and improve user experience with SurveyJS.
framework: React
source: https://surveyjs.io/form-library/examples/add-custom-navigation-button/reactjs
index: https://surveyjs.io/form-library/examples/overview.md
---

# Custom Navigation Buttons (React)

A survey displays a set of navigation buttons for respondents to start and end the survey, switch between survey pages, or preview answers. This example demonstrates how to add a custom navigation button that performs any required action.

## Configure a Custom Navigation Button

To add a custom button to your survey, call the [`addNavigationItem`](/form-library/documentation/api-reference/survey-data-model#addNavigationItem) method on a [`SurveyModel`](/form-library/documentation/api-reference/survey-data-model) instance. This method accepts an [`IAction`](/form-library/documentation/api-reference/iaction) object whose properties configure the button. Assign a unique string value to the [`id`](/form-library/documentation/api-reference/iaction#id) property and a button caption to the [`title`](/form-library/documentation/api-reference/iaction#title) property. Use the [`action`](/form-library/documentation/api-reference/iaction#action) property to specify the function this button should execute. This demo adds a custom "Clear Page" button that clears question values on the current page.

## Position a Custom Navigation Button

Navigation buttons are ordered according to their [`visibleIndex`](/form-library/documentation/api-reference/iaction#visibleIndex) values. The following table lists the `visibleIndex` values of built-in buttons:

| Navigation Button | `visibleIndex` |
| ----------------- | -------------- |
| Start | 10 |
| Previous Page | 20 |
| Next Page | 30 |
| Preview | 40 |
| Complete | 50 |

To insert a custom button before, after, or between two other buttons, assign a corresponding `visibleIndex` value to this button. If you do not specify `visibleIndex`, your button will be added to the end.

You can also position a button using CSS. Navigation controls are `<button>` elements wrapped in `<div>` elements. Create a CSS class that positions the `<div>` the way you need and assign the class name to the [`css`](/form-library/documentation/api-reference/iaction#css) property of the `IAction` object when you add the button. In this demo, the "Clear Page" button is aligned to the left using the `.nav-button-div` CSS class.

## Customize Button Appearance Using CSS

To style a custom button, define one or more CSS classes for the inner `<button>` element. The button also contains a nested `<span>` element for its label text. Assign one or more space-separated class names to the [`innerCss`](/form-library/documentation/api-reference/iaction#innerCss) property of the `IAction` object.

This demo shows how to override background and font colors for a custom button in normal and hover states.

## Localize the Button Text

Localization allows you to translate a custom button's caption to different languages. To localize the button text, you need to get objects with translations for each target locale and add a custom property to them. This property should contain a button caption for a specific locale. To apply the translations, assign the custom property's name to the `locTitleName` property of the `IAction` object. Make sure not to specify the `title` property in this case. Refer to the commented-out lines in the code listing for an example.

## 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";
// Uncomment the following line if you want to localize the custom button text 
//import { getLocaleStrings } from "survey-core";
//import "survey-core/survey.i18n";

function SurveyComponent() {
    const survey = new Model(json);
    survey.onComplete.add((sender, options) => {
        console.log(JSON.stringify(sender.data, null, 3));
    });
    // Uncomment the following lines if you want to localize the custom button text 
    // const enTranslations = getLocaleStrings("en");
    // const frTranslations = getLocaleStrings("fr");
    // enTranslations.clearPage = "Clear Page";
    // frTranslations.clearPage = "Effacer la page";
    
    survey.addNavigationItem({
        id: "sv-nav-clear-page",
        // To set the button text, use the `title` property  if you don't use localization:
        title: "Clear Page",
        // ... or the `locTitleName` property if you do use localization:
        // locTitleName: "clearPage",
        action: () => {
            survey.currentPage.questions.forEach((question) => {
                question.value = undefined;
            });
        },
        css: "nav-button-div",
        innerCss: "nav-button"
    });
    return (<Survey model={survey} />);
}

export default SurveyComponent;
```

### `src/index.css`

```css
.nav-button-div {
    margin-left: auto; 
    margin-right: 0;
}

.nav-button {
    background-color: #ff9814;
}

.nav-button:hover {
    background-color: #f28a05;
}

.nav-button span,
.nav-button:hover span {
  color: #ffffff;
}
```

### `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 = {
  "title": "Patient Assessment Form",
  "pages": [
   {
    "name": "Patient information",
    "elements": [
     {
      "type": "panel",
      "name": "patient-information",
      "elements": [
       {
        "type": "text",
        "name": "first-name",
        "title": "First name"
       },
       {
        "type": "text",
        "name": "last-name",
        "startWithNewLine": false,
        "title": "Last name"
       },
       {
        "type": "text",
        "name": "ssn",
        "title": "Social Security number",
        "requiredErrorText": "You SSN must be a 9-digit number.",
        "validators": [
         {
          "type": "regex",
          "text": "Your SSN must be a 9-digit number",
          "regex": "^(?!0{3})(?!6{3})[0-8]\\d{2}-?(?!0{2})\\d{2}-?(?!0{4})\\d{4}$"
         }
        ],
        "maxLength": 9
       },
       {
        "type": "text",
        "name": "birthdate",
        "startWithNewLine": false,
        "title": "Date of birth",
        "inputType": "date",
        "maxValueExpression": "today()"
       },
       {
        "type": "text",
        "name": "concerns",
        "title": "List any concerns you want to talk about during your visit"
       }
      ]
     }
    ],
    "title": "Patient information"
   },
   {
    "name": "Health history",
    "elements": [
     {
      "type": "panel",
      "name": "health-history",
      "elements": [
       {
        "type": "boolean",
        "name": "diabetes",
        "startWithNewLine": false,
        "title": "Do you have diabetes?"
       },
       {
        "type": "boolean",
        "name": "high-blood-pressure",
        "startWithNewLine": false,
        "title": "High blood pressure?"
       },
       {
        "type": "boolean",
        "name": "high-cholesterol",
        "startWithNewLine": false,
        "title": "High cholesterol?"
       },
       {
        "type": "comment",
        "name": "other-health-conditions",
        "title": "Do you have other health conditions?",
        "maxLength": 300
       }
      ]
     }
    ],
    "title": "Health history"
   },
   {
    "name": "Social history",
    "elements": [
     {
      "type": "panel",
      "name": "social-history",
      "elements": [
       {
        "type": "panel",
        "name": "smoking",
        "elements": [
         {
          "type": "radiogroup",
          "name": "cigarettes",
          "title": "Do you smoke cigarettes?",
          "choices": [
           {
            "value": "never",
            "text": "Never"
           },
           {
            "value": "yes",
            "text": "Yes"
           },
           {
            "value": "quit",
            "text": "Quit"
           }
          ]
         },
         {
          "type": "text",
          "name": "packs-a-day",
          "visibleIf": "{cigarettes} = 'yes'",
          "title": "How many packs a day?",
          "inputType": "number",
          "min": 0
         },
         {
          "type": "panel",
          "name": "smoking-history",
          "elements": [
           {
            "type": "text",
            "name": "date-quit",
            "title": "Date quit",
            "titleLocation": "left",
            "inputType": "date",
            "maxValueExpression": "today()"
           },
           {
            "type": "text",
            "name": "years-smoked",
            "title": "Years smoked",
            "titleLocation": "left",
            "inputType": "number",
            "min": 0
           }
          ],
          "visibleIf": "{cigarettes} = 'quit'"
         },
         {
          "type": "boolean",
          "name": "vape",
          "title": "Do you vape (e-cigarettes)?"
         }
        ]
       },
       {
        "type": "panel",
        "name": "alcohol-use-history",
        "elements": [
         {
          "type": "boolean",
          "name": "alcohol",
          "title": "Do you drink alcohol?"
         },
         {
          "type": "text",
          "name": "drinks-per-week",
          "visibleIf": "{alcohol} = true",
          "title": "How many drinks per week?"
         }
        ],
        "startWithNewLine": false
       },
       {
        "type": "panel",
        "name": "drug-use-history",
        "elements": [
         {
          "type": "checkbox",
          "name": "recreational-drugs",
          "title": "Do you use recreational drugs?",
          "choices": [
           {
            "value": "rarely",
            "text": "Rarely"
           },
           {
            "value": "marijuana",
            "text": "Marijuana"
           },
           {
            "value": "cocaine",
            "text": "Cocaine"
           },
           {
            "value": "opioids",
            "text": "Opioids"
           }
          ],
          "showOtherItem": true,
          "showNoneItem": true,
          "otherPlaceholder": "Please specify... ",
          "noneText": "Never",
          "otherText": "Other",
          "colCount": 3
         },
         {
          "type": "text",
          "name": "drug-use-times-per-month",
          "visibleIf": "{recreational-drugs} anyof ['rarely', 'marijuana', 'cocaine', 'opioids', 'other']",
          "title": "How many times per month",
          "description": "If you take different types of drugs, please specify the frequency of use for each in a 'drug - # times/month' format."
         }
        ]
       },
       {
        "type": "panel",
        "name": "personal-info",
        "elements": [
         {
          "type": "dropdown",
          "name": "education",
          "title": "What is your highest level of education completed?",
          "choices": [
           {
            "value": "high-school",
            "text": "High School"
           },
           {
            "value": "trade-school",
            "text": "Trade School"
           },
           {
            "value": "college",
            "text": "College"
           },
           {
            "value": "post-graduate",
            "text": "Post-graduate degree(s)"
           }
          ]
         },
         {
          "type": "dropdown",
          "name": "marital-status",
          "title": "What is your marital status?",
          "choices": [
           {
            "value": "married",
            "text": "Married"
           },
           {
            "value": "partnership",
            "text": "Partnership"
           },
           {
            "value": "divorced",
            "text": "Divorced"
           },
           {
            "value": "separated",
            "text": "Separated"
           },
           {
            "value": "single",
            "text": "Single"
           },
           {
            "value": "widow",
            "text": "Widow(er)"
           }
          ]
         },
         {
          "type": "panel",
          "name": "sexual-life",
          "elements": [
           {
            "type": "boolean",
            "name": "sexually-active",
            "title": "Are you sexually active?"
           },
           {
            "type": "text",
            "name": "sexual-partners-number",
            "title": "How many sexual partners do you have?",
            "inputType": "number",
            "min": 0
           },
           {
            "type": "radiogroup",
            "name": "sexual-partners-gender",
            "titleLocation": "hidden",
            "choices": [
             {
              "value": "men",
              "text": "Men"
             },
             {
              "value": "women",
              "text": "Women"
             },
             {
              "value": "both",
              "text": "Both"
             }
            ],
            "colCount": 3
           },
           {
            "type": "radiogroup",
            "name": "contraception",
            "title": "Do you use contraception?",
            "showCommentArea": true,
            "commentText": "If yes, what method?",
            "choices": [
             {
              "value": "yes",
              "text": "Yes"
             },
             {
              "value": "no",
              "text": "No"
             }
            ]
           }
          ]
         }
        ]
       },
       {
        "type": "panel",
        "name": "employment-exercises-children",
        "elements": [
         {
          "type": "radiogroup",
          "name": "employment",
          "title": "Are you employed?",
          "showCommentArea": true,
          "commentText": "Type of work",
          "choices": [
           {
            "value": "yes",
            "text": "Yes"
           },
           {
            "value": "no",
            "text": "No"
           },
           {
            "value": "retired",
            "text": "Retired"
           }
          ],
          "colCount": 3
         },
         {
          "type": "panel",
          "name": "physical-activity",
          "elements": [
           {
            "type": "radiogroup",
            "name": "do-exercise",
            "title": "Do you exercise?",
            "choices": [
             {
              "value": "yes",
              "text": "Yes"
             },
             {
              "value": "no",
              "text": "No"
             }
            ],
            "colCount": 2
           },
           {
            "type": "multipletext",
            "name": "activities",
            "visibleIf": "{do-exercise} = 'yes'",
            "titleLocation": "hidden",
            "items": [
             {
              "name": "activity-type",
              "title": "Type of activity"
             },
             {
              "name": "activity-frequency",
              "title": "How often"
             },
             {
              "name": "activity-duration",
              "title": "How long per activity"
             }
            ]
           }
          ]
         },
         {
          "type": "panel",
          "name": "children",
          "elements": [
           {
            "type": "boolean",
            "name": "have-children",
            "title": "Do you have children?"
           },
           {
            "type": "multipletext",
            "name": "children-ages",
            "visibleIf": "{have-children} = true",
            "titleLocation": "hidden",
            "items": [
             {
              "name": "children-number",
              "title": "# of children"
             },
             {
              "name": "ages",
              "title": "Their ages"
             }
            ]
           }
          ]
         }
        ],
        "startWithNewLine": false
       }
      ]
     }
    ],
    "title": "Social history"
   },
   {
    "name": "Surgical history / recent hospitalizations",
    "elements": [
     {
      "type": "comment",
      "name": "surgery-description",
      "title": "Date and type of surgery / procedure"
     }
    ],
    "title": "Surgical history / recent hospitalizations"
   },
   {
    "name": "Family history",
    "elements": [
     {
      "type": "matrixdynamic",
      "name": "family-history",
      "titleLocation": "hidden",
      "columns": [
       {
        "name": "relation",
        "title": "Relation"
       },
       {
        "name": "health-conditions",
        "title": "Health conditions"
       },
       {
        "name": "cancer-history",
        "title": "Family history of cancer"
       }
      ],
      "cellType": "text"
     }
    ],
    "title": "Family history"
   },
   {
    "name": "Preventive care",
    "elements": [
     {
      "type": "panel",
      "name": "preventive-care",
      "elements": [
       {
        "type": "panel",
        "name": "recent-shots-panel",
        "elements": [
         {
          "type": "matrixdropdown",
          "name": "recent-shots",
          "title": "Recent shots from a doctor or pharmacist",
          "columns": [
           {
            "name": "date",
            "title": "Date"
           },
           {
            "name": "place",
            "title": "Place"
           }
          ],
          "cellType": "text",
          "rows": [
           {
            "value": "flu",
            "text": "Flu"
           },
           {
            "value": "shingles",
            "text": "Shingles"
           },
           {
            "value": "pneumonia",
            "text": "Pneumonia"
           },
           {
            "value": "tetanus",
            "text": "Tetanus"
           },
           {
            "value": "other",
            "text": "Other"
           }
          ]
         }
        ]
       },
       {
        "type": "panel",
        "name": "recent-tests-panel",
        "elements": [
         {
          "type": "matrixdropdown",
          "name": "recent-tests",
          "title": "Recent tests or procedures",
          "columns": [
           {
            "name": "date",
            "title": "Date"
           },
           {
            "name": "place",
            "title": "Place"
           }
          ],
          "cellType": "text",
          "rows": [
           {
            "value": "colonoscopy",
            "text": "Colonoscopy"
           },
           {
            "value": "cologuard",
            "text": "Cologuard"
           },
           {
            "value": "mammogram",
            "text": "Mammogram"
           },
           {
            "value": "pap",
            "text": "PAP"
           },
           {
            "value": "other",
            "text": "Other"
           }
          ]
         }
        ],
        "startWithNewLine": false
       },
       {
        "type": "panel",
        "name": "specialists-panel",
        "elements": [
         {
          "type": "matrixdynamic",
          "name": "specialists",
          "title": "Specialists",
          "columns": [
           {
            "name": "provider",
            "title": "Provider's first and last name"
           },
           {
            "name": "speciality",
            "title": "Speciality"
           },
           {
            "name": "city",
            "title": "Town/City"
           }
          ],
          "cellType": "text",
          "rowCount": 1
         }
        ]
       },
       {
        "type": "panel",
        "name": "medications-and-allergies",
        "elements": [
         {
          "type": "multipletext",
          "name": "medications",
          "title": "Medications",
          "items": [
           {
            "name": "medication-name",
            "title": "Name"
           },
           {
            "name": "medication-dose",
            "title": "Dose"
           },
           {
            "name": "medication-times-per-day",
            "title": "Times per day"
           }
          ]
         },
         {
          "type": "multipletext",
          "name": "allergies",
          "startWithNewLine": false,
          "title": "Allergies",
          "items": [
           {
            "name": "allergy-type",
            "title": "Type"
           },
           {
            "name": "allergy-reaction",
            "title": "Reaction"
           }
          ]
         }
        ]
       }
      ]
     }
    ],
    "title": "Preventive care"
   },
   {
    "name": "Symptoms",
    "elements": [
     {
      "type": "tagbox",
      "name": "symptoms",
      "title": "Please select any symptoms you have now or have had in the past month.",
      "choices": [
       "Fever",
       "Chills",
       "Feeling poorly",
       "Feeling tired",
       "Weight gain",
       "Weight loss",
       "Chest pain",
       "Heart pounding",
       "Fast pulse",
       "Slow pulse",
       "Leg pain with exercise",
       "Leg swelling",
       "Joint pain",
       "Neck pain",
       "Joint swelling",
       "Joint stiffness",
       "Muscle aches",
       "Back pain",
       "Sores",
       "Rash",
       "Itching",
       "Change in a mole",
       "Unusual growth/spot"
      ]
     },
     {
      "type": "signaturepad",
      "name": "signature",
      "title": "Signature:",
      "titleLocation": "left"
     },
     {
      "type": "text",
      "name": "current-date",
      "startWithNewLine": false,
      "title": "Today's date:",
      "titleLocation": "left",
      "defaultValueExpression": "today()",
      "inputType": "date"
     }
    ],
    "title": "Symptoms"
   }
  ]
 };
```

### `src/theme.js`

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

### `package.json`

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

## Other Frameworks

- [Angular](https://surveyjs.io/form-library/examples/add-custom-navigation-button/angular.md)
- [Vue 3](https://surveyjs.io/form-library/examples/add-custom-navigation-button/vue3js.md)
- [jQuery](https://surveyjs.io/form-library/examples/add-custom-navigation-button/jquery.md)
- [Vanilla JS](https://surveyjs.io/form-library/examples/add-custom-navigation-button/vanillajs.md)