Skip to content

Commit

Permalink
Docs: Describe PageModel.navigationDescription (#7111)
Browse files Browse the repository at this point in the history
  • Loading branch information
RomanTsukanov committed Oct 11, 2023
1 parent 98c5839 commit a4d88b3
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion src/page.ts
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ export class PageModel extends PanelModelBase implements IPage {
return this.survey && (<any>this.survey).showPageTitles;
}
/**
* A caption displayed on a navigation button in the TOC or progress bar. Applies when [`showTOC`](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model#showTOC) is `true` or when [`showProgressBar`](https://surveyjs.io/form-library/documentation/surveymodel#showProgressBar) is `true` and [`progressBarType`](https://surveyjs.io/form-library/documentation/surveymodel#progressBarType) is `"buttons"`.
* A caption displayed on a navigation button in the TOC or progress bar. Applies when [`showTOC`](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model#showTOC) is `true` or when the [progress bar is visible](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model#showProgressBar) and [`progressBarType`](https://surveyjs.io/form-library/documentation/surveymodel#progressBarType) is set to `"buttons"`.
*
* If navigation titles are unspecified, the navigation buttons display page [titles](https://surveyjs.io/form-library/documentation/api-reference/page-model#title) or [names](https://surveyjs.io/form-library/documentation/pagemodel#name).
*/
Expand All @@ -60,6 +60,9 @@ export class PageModel extends PanelModelBase implements IPage {
public get locNavigationTitle(): LocalizableString {
return this.getLocalizableString("navigationTitle");
}
/**
* Explanatory text displayed under a navigation button in the progress bar. Applies when the [progress bar is visible](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model#showProgressBar) and `SurveyModel`'s [`progressBarType`](https://surveyjs.io/form-library/documentation/surveymodel#progressBarType) property is set to `"buttons"`.
*/
public get navigationDescription(): string {
return this.getLocalizableStringText("navigationDescription");
}
Expand Down

0 comments on commit a4d88b3

Please sign in to comment.