Add a description

surveyjs · Dec 26, 2024 · 4567ec5 · 4567ec5
1 parent 7d062c9
commit 4567ec5
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 10 deletions.
diff --git a/packages/survey-creator-core/src/creator-base.ts b/packages/survey-creator-core/src/creator-base.ts
@@ -202,8 +202,15 @@ export class SurveyCreatorModel extends Base
     });
   }
   /**
+   * Specifies how users navigate categories in the Property Grid.
    * 
+   * Accepted values:
+   * 
+   * - `"accordion"` (default)        
+   * The Property Grid displays a stacked list of categories that users can expand or collapse to reveal nested properties.
    * 
+   * - `"buttons"`      
+   * The Property Grid displays the properties of a currently selected category. Users can switch between categories using buttons on the right side of the Property Grid. 
    */
   get propertyGridNavigationMode(): "buttons" | "accordion" {
     return this.showOneCategoryInPropertyGrid ? "buttons" : "accordion";
@@ -259,7 +266,7 @@ export class SurveyCreatorModel extends Base
   /**
    * Specifies a default device for survey preview in the Preview tab.
    *
-   * Possible values:
+   * Accepted values:
    * 
    * - `"desktop"` (default)
    * - `"iPhoneSE"`
@@ -275,7 +282,7 @@ export class SurveyCreatorModel extends Base
   /**
    * Specifies the orientation of the selected device in the Preview tab.
    *
-   * Possible values:
+   * Accepted values:
    * 
    * - `"landscape"` (default)
    * - `"portrait"`
@@ -1198,7 +1205,7 @@ export class SurveyCreatorModel extends Base
   /**
    * Gets or sets the currently displayed tab.
    * 
-   * Possible values:
+   * Accepted values:
    * 
    * - [`"designer"`](#showDesignerTab)
    * - [`"test"`](#showPreviewTab)
@@ -2328,7 +2335,7 @@ export class SurveyCreatorModel extends Base
   /**
    * Indicates the state of Survey Creator.
    * 
-   * Possible values:
+   * Accepted values:
    * 
    * - `""` - Survey Creator doesn't have unsaved changes.
    * - `"modified"` - Survey Creator has unsaved changes.
@@ -3904,7 +3911,7 @@ export class SurveyCreatorModel extends Base
   /**
    * Specifies the Toolbox location.
    * 
-   * Possible values:
+   * Accepted values:
    * 
    * - `"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.
@@ -3924,7 +3931,7 @@ export class SurveyCreatorModel extends Base
   /**
    * Specifies the position of the sidebar that displays the Property Grid. Applies only when [`showSidebar`](https://surveyjs.io/survey-creator/documentation/api-reference/survey-creator#showSidebar) is `true`.
    * 
-   * Possible values:
+   * Accepted values:
    * 
    * - `"right"` (default) - Displays the sidebar on the right side of the design surface.
    * - `"left"` - Displays the sidebar on the left side of the design surface.
@@ -3935,7 +3942,7 @@ export class SurveyCreatorModel extends Base
   /**
    * Specifies the visibility of the buttons that expand and collapse survey elements on the design surface.
    * 
-   * Possible values:
+   * Accepted values:
    * 
    * - `"onhover"` (default) - Displays an expand/collapse button when a survey element is hovered over or selected.
    * - `"always"` - Displays the expand/collapse buttons permanently.

diff --git a/packages/survey-creator-core/src/creator-options.ts b/packages/survey-creator-core/src/creator-options.ts
@@ -233,7 +233,7 @@ export interface ICreatorOptions {
   /**
    * Specifies a default device for survey preview in the Preview tab.
    *
-   * Possible values:
+   * Accepted values:
    * 
    * - `"desktop"` (default)
    * - `"iPhoneSE"`
@@ -249,7 +249,7 @@ export interface ICreatorOptions {
   /**
    * Specifies the orientation of the selected device in the Preview tab.
    * 
-   * Possible values:
+   * Accepted values:
    * - `"landscape"` (default)
    * - `"portrait"`
    */
@@ -291,7 +291,7 @@ export interface ICreatorOptions {
   /**
    * Specifies the visibility of the buttons that expand and collapse survey elements on the design surface.
    * 
-   * Possible values:
+   * Accepted values:
    * 
    * - `"onhover"` (default) - Displays an expand/collapse button when a survey element is hovered over or selected.
    * - `"always"` - Displays the expand/collapse buttons permanently.
@@ -328,8 +328,15 @@ export interface ICreatorOptions {
    */
   collapseQuestions?: boolean;
   /**
+   * Specifies how users navigate categories in the Property Grid.
+   * 
+   * Accepted values:
    * 
+   * - `"accordion"` (default)        
+   * The Property Grid displays a stacked list of categories that users can expand or collapse to reveal nested properties.
    * 
+   * - `"buttons"`      
+   * The Property Grid displays the properties of a currently selected category. Users can switch between categories using buttons on the right side of the Property Grid. 
    */
   propertyGridNavigationMode?: "buttons" | "accordion";
 }