docs: add JSDoc for attributes [skip ci] (#1776)

vaadin · Jul 16, 2020 · 20676fd · 20676fd
1 parent d046a8a
commit 20676fd
Show file tree

Hide file tree

Showing 9 changed files with 15 additions and 0 deletions.
diff --git a/src/vaadin-grid-column-group.html b/src/vaadin-grid-column-group.html
@@ -56,6 +56,7 @@
 
             /**
              * Flex grow ratio for the column group as the sum of the ratios of its child columns.
+             * @attr {number} flex-grow
              */
             flexGrow: {
               type: Number,

diff --git a/src/vaadin-grid-column-reordering-mixin.html b/src/vaadin-grid-column-reordering-mixin.html
@@ -19,6 +19,7 @@
       return {
         /**
          * Set to true to allow column reordering.
+         * @attr {boolean} column-reordering-allowed
          * @type {boolean}
          */
         columnReorderingAllowed: {

diff --git a/src/vaadin-grid-column.html b/src/vaadin-grid-column.html
@@ -83,6 +83,7 @@
         /**
          * Aligns the columns cell content horizontally.
          * Supported values: "start", "center" and "end".
+         * @attr {start|center|end} text-align
          * @type {GridColumnTextAlign | null | undefined}
          */
         textAlign: {
@@ -638,6 +639,7 @@
 
           /**
            * Flex grow ratio for the cell widths. When set to 0, cell width is fixed.
+           * @attr {number} flex-grow
            * @type {number}
            */
           flexGrow: {
@@ -685,6 +687,7 @@
            * You can manually trigger the auto sizing behavior again by calling `grid.recalculateColumnWidths()`.
            *
            * The column width may still grow larger when `flexGrow` is not 0.
+           * @attr {boolean} auto-width
            * @type {boolean}
            */
           autoWidth: {

diff --git a/src/vaadin-grid-data-provider-mixin.html b/src/vaadin-grid-data-provider-mixin.html
@@ -105,6 +105,7 @@
 
         /**
          * Number of items fetched at a time from the dataprovider.
+         * @attr {number} page-size
          * @type {number}
          */
         pageSize: {
@@ -166,6 +167,7 @@
 
         /**
          * Path to an item sub-property that identifies the item.
+         * @attr {string} item-id-path
          */
         itemIdPath: {
           type: String,

diff --git a/src/vaadin-grid-drag-and-drop-mixin.html b/src/vaadin-grid-drag-and-drop-mixin.html
@@ -38,12 +38,14 @@
            * - `on-top`: The drop event can happen on top of Grid rows.
            * - `on-top-or-between`: The drop event can happen either on top of or between Grid rows.
            * - `on-grid`: The drop event will not happen on any specific row, it will show the drop target outline around the whole grid.
+           * @attr {between|on-top|on-top-or-between|on-grid} drop-mode
            * @type {GridDropMode | null | undefined}
            */
           dropMode: String,
 
           /**
            * Marks the grid's rows to be available for dragging.
+           * @attr {boolean} rows-draggable
            */
           rowsDraggable: Boolean,
 

diff --git a/src/vaadin-grid-selection-column.html b/src/vaadin-grid-selection-column.html
@@ -64,6 +64,7 @@
 
           /**
            * Flex grow ratio for the cell widths. When set to 0, cell width is fixed.
+           * @attr {number} flex-grow
            * @type {number}
            */
           flexGrow: {
@@ -73,6 +74,7 @@
 
           /**
            * When true, all the items are selected.
+           * @attr {boolean} select-all
            * @type {boolean}
            */
           selectAll: {
@@ -83,6 +85,7 @@
 
           /**
            * When true, the active gets automatically selected.
+           * @attr {boolean} auto-select
            * @type {boolean}
            */
           autoSelect: {

diff --git a/src/vaadin-grid-sort-mixin.html b/src/vaadin-grid-sort-mixin.html
@@ -16,6 +16,7 @@
       return {
         /**
          * When `true`, all `<vaadin-grid-sorter>` are applied for sorting.
+         * @attr {boolean} multi-sort
          * @type {boolean}
          */
         multiSort: {

diff --git a/src/vaadin-grid-tree-column.html b/src/vaadin-grid-tree-column.html
@@ -49,6 +49,7 @@
 
           /**
            * JS Path of the property in the item that indicates whether the item has child items.
+           * @attr {string} item-has-children-path
            */
           itemHasChildrenPath: {
             type: String,

diff --git a/src/vaadin-grid.html b/src/vaadin-grid.html
@@ -407,6 +407,7 @@
            *
            * Effectively, this disables the grid's virtual scrolling so that all the rows are rendered in the DOM at once.
            * If the grid has a large number of items, using the feature is discouraged to avoid performance issues.
+           * @attr {boolean} height-by-rows
            * @type {boolean}
            */
           heightByRows: {