Skip to content

Commit

Permalink
Add the showToolbox property to the docs (fix #5845)
Browse files Browse the repository at this point in the history
  • Loading branch information
RomanTsukanov committed Sep 3, 2024
1 parent e1b1fb8 commit a2a4031
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions packages/survey-creator-core/src/creator-base.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1231,6 +1231,8 @@ export class SurveyCreatorModel extends Base
* Provides access to the [Toolbox API](https://surveyjs.io/survey-creator/documentation/api-reference/questiontoolbox).
*
* [Toolbox Customization](https://surveyjs.io/survey-creator/documentation/toolbox-customization (linkStyle))
* @see showToolbox
* @see toolboxLocation
*/
public toolbox: QuestionToolbox;
public get toolboxCategories(): Array<any> {
Expand Down Expand Up @@ -1287,6 +1289,15 @@ export class SurveyCreatorModel extends Base
public get showToolbox() {
return this.showToolboxValue && this.allowShowToolbox;
}
/**
* Specifies whether to show the Toolbox.
*
* Default value: `true`
*
* [Toolbox Customization](https://surveyjs.io/survey-creator/documentation/toolbox-customization (linkStyle))
* @see toolbox
* @see toolboxLocation
*/
public set showToolbox(val: boolean) {
if (<any>val !== true && <any>val !== false) {
SurveyHelper.warnText("showToolbox is a boolean property now.");
Expand Down Expand Up @@ -3789,6 +3800,10 @@ export class SurveyCreatorModel extends Base
* - `"left"` (default) - Displays the Toolbox on the left side of the design surface.
* - `"right"` - Displays the Toolbox on the right side of the design surface.
* - `"sidebar"` - Displays the Toolbox as an overlay on top of the Property Grid. Use the [`sidebarLocation`](https://surveyjs.io/survey-creator/documentation/api-reference/survey-creator#sidebarLocation) property to specify the Property Grid position.
*
* [Toolbox Customization](https://surveyjs.io/survey-creator/documentation/toolbox-customization (linkStyle))
* @see showToolbox
* @see toolbox
*/
@property({
defaultValue: "left", onSet: (newValue, target: SurveyCreatorModel) => {
Expand Down

0 comments on commit a2a4031

Please sign in to comment.