docs: update descriptions

qlik-oss · Apr 25, 2023 · 9ab7b43 · 9ab7b43
1 parent 1d7a751
commit 9ab7b43
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 28 deletions.
diff --git a/apis/nucleus/src/components/listbox/default-properties.js b/apis/nucleus/src/components/listbox/default-properties.js
@@ -73,64 +73,64 @@ const listdef = {
    */
   checkboxes: false,
   /**
-   * enables search.
+   * Enables search.
    * @type {boolean=}
    * @default
    */
   searchEnabled: true,
   /**
-   * show title.
+   * Show title.
    * @type {boolean=}
    * @default
    */
   showTitle: true,
   /**
-   * start search with wildcard search.
+   * Pre-fill search input field with wildcard characters.
    * @type {boolean=}
    * @default
    */
   wildCardSearch: false,
   /**
-   * layout settings.
+   * Layout settings.
    * @type {object=}
    */
   layoutOptions: {
     /**
-     * dense mode.
+     * Dense mode.
      * @type {boolean=}
      * @default
      */
     dense: false,
     /**
-     * layout mode.
+     * Layout mode.
      * @type {('singleColumn' | 'grid')=}
      * @default
      */
     dataLayout: 'singleColumn',
     /**
-     * layout order.
+     * Layout order.
      * Only used when dataLayout is 'grid'
      * @type {('row' | 'column')=}
      * @default
      */
     layoutOrder: 'row',
     /**
-     * max visible columns.
+     * Max visible columns.
      * Only used when dataLayout is 'grid'
      * and layoutOrder is 'row'
      * @type {object=}
      */
     maxVisibleColumns: {
       /**
-       * auto max visible columns. (as many as it can fit)
+       * Automatically fit as many columns as possible.
        * Only used when dataLayout is 'grid'
        * and layoutOrder is 'row'
        * @type {boolean=}
        * @default
        */
       auto: true,
       /**
-       * fixed number of max visible columns.
+       * Fixed number of max visible columns.
        * Only used when dataLayout is 'grid'
        * layoutOrder is 'row'
        * and auto is false
@@ -140,22 +140,22 @@ const listdef = {
       maxColumns: 3,
     },
     /**
-     * max visible rows.
+     * Max visible rows.
      * Only used when dataLayout is 'grid'
      * and layoutOrder is 'column'
      * @type {object=}
      */
     maxVisibleRows: {
       /**
-       * auto max visible rows. (as many as it can fit)
+       * Automatically fits as many rows as possible.
        * Only used when dataLayout is 'grid'
        * and layoutOrder is 'column'
        * @type {boolean=}
        * @default
        */
       auto: true,
       /**
-       * fixed number of max visible rows.
+       * Fixed number of max visible rows.
        * Only used when dataLayout is 'grid'
        * layoutOrder is 'column'
        * and auto is false
@@ -166,7 +166,7 @@ const listdef = {
     },
   },
   /**
-   * listbox title
+   * Listbox title
    * @type {string=}
    * @default
    */

diff --git a/apis/stardust/api-spec/spec.json b/apis/stardust/api-spec/spec.json
@@ -1762,35 +1762,35 @@
           "type": "boolean"
         },
         "searchEnabled": {
-          "description": "enables search.",
+          "description": "Enables search.",
           "optional": true,
           "defaultValue": true,
           "type": "boolean"
         },
         "showTitle": {
-          "description": "show title.",
+          "description": "Show title.",
           "optional": true,
           "defaultValue": true,
           "type": "boolean"
         },
         "wildCardSearch": {
-          "description": "start search with wildcard search.",
+          "description": "Pre-fill search input field with wildcard characters.",
           "optional": true,
           "defaultValue": false,
           "type": "boolean"
         },
         "layoutOptions": {
-          "description": "layout settings.",
+          "description": "Layout settings.",
           "optional": true,
           "entries": {
             "dense": {
-              "description": "dense mode.",
+              "description": "Dense mode.",
               "optional": true,
               "defaultValue": false,
               "type": "boolean"
             },
             "dataLayout": {
-              "description": "layout mode.",
+              "description": "Layout mode.",
               "optional": true,
               "defaultValue": "singleColumn",
               "kind": "union",
@@ -1806,7 +1806,7 @@
               ]
             },
             "layoutOrder": {
-              "description": "layout order.\nOnly used when dataLayout is 'grid'",
+              "description": "Layout order.\nOnly used when dataLayout is 'grid'",
               "optional": true,
               "defaultValue": "row",
               "kind": "union",
@@ -1822,17 +1822,17 @@
               ]
             },
             "maxVisibleColumns": {
-              "description": "max visible columns.\nOnly used when dataLayout is 'grid'\nand layoutOrder is 'row'",
+              "description": "Max visible columns.\nOnly used when dataLayout is 'grid'\nand layoutOrder is 'row'",
               "optional": true,
               "entries": {
                 "auto": {
-                  "description": "auto max visible columns. (as many as it can fit)\nOnly used when dataLayout is 'grid'\nand layoutOrder is 'row'",
+                  "description": "Automatically fit as many columns as possible.\nOnly used when dataLayout is 'grid'\nand layoutOrder is 'row'",
                   "optional": true,
                   "defaultValue": true,
                   "type": "boolean"
                 },
                 "maxColumns": {
-                  "description": "fixed number of max visible columns.\nOnly used when dataLayout is 'grid'\nlayoutOrder is 'row'\nand auto is false",
+                  "description": "Fixed number of max visible columns.\nOnly used when dataLayout is 'grid'\nlayoutOrder is 'row'\nand auto is false",
                   "optional": true,
                   "defaultValue": 3,
                   "type": "number"
@@ -1841,17 +1841,17 @@
               "kind": "object"
             },
             "maxVisibleRows": {
-              "description": "max visible rows.\nOnly used when dataLayout is 'grid'\nand layoutOrder is 'column'",
+              "description": "Max visible rows.\nOnly used when dataLayout is 'grid'\nand layoutOrder is 'column'",
               "optional": true,
               "entries": {
                 "auto": {
-                  "description": "auto max visible rows. (as many as it can fit)\nOnly used when dataLayout is 'grid'\nand layoutOrder is 'column'",
+                  "description": "Automatically fits as many rows as possible.\nOnly used when dataLayout is 'grid'\nand layoutOrder is 'column'",
                   "optional": true,
                   "defaultValue": true,
                   "type": "boolean"
                 },
                 "maxRows": {
-                  "description": "fixed number of max visible rows.\nOnly used when dataLayout is 'grid'\nlayoutOrder is 'column'\nand auto is false",
+                  "description": "Fixed number of max visible rows.\nOnly used when dataLayout is 'grid'\nlayoutOrder is 'column'\nand auto is false",
                   "optional": true,
                   "defaultValue": 3,
                   "type": "number"
@@ -1863,7 +1863,7 @@
           "kind": "object"
         },
         "title": {
-          "description": "listbox title",
+          "description": "Listbox title",
           "optional": true,
           "defaultValue": "",
           "type": "string"