Skip to content

Commit d839e30

Browse files
authored
docs: fix API docs for crud slots [skip ci] (#2260)
1 parent e1410de commit d839e30

2 files changed

Lines changed: 29 additions & 24 deletions

File tree

‎packages/vaadin-crud/src/vaadin-crud.d.ts‎

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -49,26 +49,28 @@ import { CrudDataProvider, CrudEditorPosition, CrudEventMap, CrudI18n } from './
4949
* `toolbar` | To replace the toolbar content. Add an element with the attribute `new-button` for the new item action.
5050
*
5151
* #### Example:
52+
*
5253
* ```html
5354
* <vaadin-crud
5455
* id="crud"
5556
* items='[{"name": "John", "surname": "Lennon", "role": "singer"},
5657
* {"name": "Ringo", "surname": "Starr", "role": "drums"}]'
5758
* >
58-
* <vaadin-grid slot="grid">
59-
* <vaadin-crud-edit-column></vaadin-crud-edit-column>
60-
* <vaadin-grid-column id="column1"></vaadin-grid-column>
61-
* <vaadin-grid-column id="column2"></vaadin-grid-column>
62-
* </vaadin-grid>
63-
*
64-
* <vaadin-form-layout slot="form">
65-
* <vaadin-text-field label="First" path="name"></vaadin-text-field>
66-
* <vaadin-text-field label="Surname" path="surname"></vaadin-text-field>
67-
* </vaadin-form-layout>
59+
* <vaadin-grid slot="grid">
60+
* <vaadin-crud-edit-column></vaadin-crud-edit-column>
61+
* <vaadin-grid-column id="column1"></vaadin-grid-column>
62+
* <vaadin-grid-column id="column2"></vaadin-grid-column>
63+
* </vaadin-grid>
6864
*
69-
* <div slot="footer">Total singers: [[size]]</div>
65+
* <vaadin-form-layout slot="form">
66+
* <vaadin-text-field label="First" path="name"></vaadin-text-field>
67+
* <vaadin-text-field label="Surname" path="surname"></vaadin-text-field>
68+
* </vaadin-form-layout>
7069
*
71-
* <button slot="new">New singer</button>
70+
* <div slot="toolbar">
71+
* Total singers: [[size]]
72+
* <button new-button>New singer</button>
73+
* </div>
7274
* </vaadin-crud>
7375
* ```
7476
* ```js

‎packages/vaadin-crud/src/vaadin-crud.js‎

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -62,26 +62,28 @@ import './vaadin-crud-form.js';
6262
* `toolbar` | To replace the toolbar content. Add an element with the attribute `new-button` for the new item action.
6363
*
6464
* #### Example:
65+
*
6566
* ```html
6667
* <vaadin-crud
6768
* id="crud"
6869
* items='[{"name": "John", "surname": "Lennon", "role": "singer"},
6970
* {"name": "Ringo", "surname": "Starr", "role": "drums"}]'
7071
* >
71-
* <vaadin-grid slot="grid">
72-
* <vaadin-crud-edit-column></vaadin-crud-edit-column>
73-
* <vaadin-grid-column id="column1"></vaadin-grid-column>
74-
* <vaadin-grid-column id="column2"></vaadin-grid-column>
75-
* </vaadin-grid>
76-
*
77-
* <vaadin-form-layout slot="form">
78-
* <vaadin-text-field label="First" path="name"></vaadin-text-field>
79-
* <vaadin-text-field label="Surname" path="surname"></vaadin-text-field>
80-
* </vaadin-form-layout>
72+
* <vaadin-grid slot="grid">
73+
* <vaadin-crud-edit-column></vaadin-crud-edit-column>
74+
* <vaadin-grid-column id="column1"></vaadin-grid-column>
75+
* <vaadin-grid-column id="column2"></vaadin-grid-column>
76+
* </vaadin-grid>
8177
*
82-
* <div slot="footer">Total singers: [[size]]</div>
78+
* <vaadin-form-layout slot="form">
79+
* <vaadin-text-field label="First" path="name"></vaadin-text-field>
80+
* <vaadin-text-field label="Surname" path="surname"></vaadin-text-field>
81+
* </vaadin-form-layout>
8382
*
84-
* <button slot="new">New singer</button>
83+
* <div slot="toolbar">
84+
* Total singers: [[size]]
85+
* <button new-button>New singer</button>
86+
* </div>
8587
* </vaadin-crud>
8688
* ```
8789
* ```js
@@ -102,6 +104,7 @@ import './vaadin-crud-form.js';
102104
* column2.renderer = (root, column, model) => {
103105
* root.textContent = model.item.surname;
104106
* };
107+
* ```
105108
*
106109
* ### Helpers
107110
*

0 commit comments

Comments
 (0)