Skip to content

Commit

Permalink
Update dataTable doc and api-gen
Browse files Browse the repository at this point in the history
  • Loading branch information
mertsincan committed Dec 5, 2021
1 parent aeef959 commit 35d6cf0
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 2 deletions.
6 changes: 6 additions & 0 deletions api-generator/components/datatable.js
Original file line number Diff line number Diff line change
Expand Up @@ -323,6 +323,12 @@ const DataTableProps = [
default: "null",
description: 'Height of the scroll viewport in fixed units or the "flex" keyword for a dynamic size.'
},
{
name: "virtualScrollerOptions",
type: "object",
default: "null",
description: 'Whether to use the virtualScroller feature. The properties of VirtualScroller component can be used like an object in it. Note: Currently only vertical orientation mode is supported.'
},
{
name: "frozenValue",
type: "array",
Expand Down
20 changes: 18 additions & 2 deletions src/views/datatable/DataTableDoc.vue
Original file line number Diff line number Diff line change
Expand Up @@ -452,6 +452,15 @@ export default {
<td>field: Column field <br />
filterModel: {value,matchMode} Filter metadata <br />
filterCallback: Callback function</td>
</tr>
<tr>
<td>loading</td>
<td>data: Row data <br />
column: Column node <br />
field: Column field <br />
index: Row index <br />
frozenRow: Is row frozen <br />
loadingOptions: Loading options.</td>
</tr>
</tbody>
</table>
Expand Down Expand Up @@ -1126,7 +1135,7 @@ export default {
</p>

<p>Individual cell editing is configured by setting the <i>editMode</i> to <b>cell</b>, defining editors with the <b>editor</b> template along with the <i>@cell-edit-complete</i> event. The content of the
editor defines how the editing is implemented. The editor template receives a clone of the row data and using <i>@cell-edit-complete</i> event the new value can be updated to the model or cancelled.
editor defines how the editing is implemented. The editor template receives a clone of the row data and using <i>@cell-edit-complete</i> event the new value can be updated to the model or cancelled.
This also provides flexibility to apply conditional logic such as implementing validations.</p>

<pre v-code><code><template v-pre>
Expand Down Expand Up @@ -1226,7 +1235,7 @@ export default {

</code></pre>

<p>Row Editing is specified by setting <i>cellEdit</i> as <b>row</b>, defining <i>editingRows</i> with the v-model directive to hold the reference of the editing rows,
<p>Row Editing is specified by setting <i>cellEdit</i> as <b>row</b>, defining <i>editingRows</i> with the v-model directive to hold the reference of the editing rows,
adding a row editor column to provide the editing controls and implementing <i>@row-edit-save</i> to update the original row data. Note that
since <i>editingRows</i> is two-way binding enabled, you may use it to initially display one or more rows in editing more or programmatically toggle row editing.</p>
<pre v-code><code><template v-pre>
Expand Down Expand Up @@ -2132,6 +2141,13 @@ export default {
<td>null</td>
<td>Height of the scroll viewport in fixed pixels or the "flex" keyword for a dynamic size.</td>
</tr>
<tr>
<td>virtualScrollerOptions</td>
<td>object</td>
<td>null</td>
<td>Whether to use the virtualScroller feature. The properties of <router-link to="/virtualscroller">VirtualScroller</router-link> component can be used like an object in it.
<br /><b>Note:</b> Currently only vertical orientation mode is supported.</td>
</tr>
<tr>
<td>frozenValue</td>
<td>array</td>
Expand Down

0 comments on commit 35d6cf0

Please sign in to comment.