Skip to content

Commit d156b05

Browse files
author
ahmed.alatawi
committed
fix: updated README to include details for the APIs
1 parent cce5183 commit d156b05

File tree

1 file changed

+52
-1
lines changed

1 file changed

+52
-1
lines changed

README.md

Lines changed: 52 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,8 +79,59 @@ settings = {
7979
}
8080
```
8181

82+
### :page_facing_up: NgxSmartDatatable API
83+
84+
| Attributes | Description |
85+
| --- | --- |
86+
| `[settings]` | The settings applied to the `table`, which include the `columns` and `data` properties (required) |
87+
| `(sortedOrder)` | A `sort` event fired when data order is changed (`asc` or `desc`). Note: `ordering` property must be set to `true` in `settings` |
88+
| `(selectedRows)` | A `select` event fired when a row is selected. Note: `select` property must be set to `true` in `settings` |
89+
| `(deselectedRows)` | A `deselect` event fired when a row is deselected |
90+
| `(reorderedRow)` | A `row-reorder` event fired when rows are reordered. Note: `rowReorder` property must be set to `true` in `settings` |
91+
| `(reorderedColumn)` | A `column-reorder` event fired when columns are reordered. Note: `colReorder` property must be set to `true` in `settings` |
92+
| `(selectedKeyCells)` | A `key` event fired when a keyboard key is detected and pressed. Note: `keys` property must be set to `true` in `settings` |
93+
| `(changedPage)` | A `page` event fired when table's paging is updated |
94+
| `(autoFilledCells)` | An `autoFill` event triggered when an fill action is completed. Note: `autoFill` property must be set to `true` in `settings` |
95+
| `(displayedResponsive)` | A `responsive-display` event fired when the display of table is updated. Note: `responsive` property must be set to `true` in `settings` |
96+
| `(loadedTable)` | An event fired when the table is fully loaded |
97+
| `(loadedjQuery)` | An event fired when an instance of jQuery is loaded |
98+
99+
100+
### Note: :bulb:
101+
102+
`(emittedEvent)`: This is used to fire an event(s), which is not mentioned in the above table. The list of all available events can be found [here](https://datatables.net/reference/event/). The name(s) of the event(s) would need to be added to `eventNames` array in the `settings` object.
103+
104+
Example of adding `responsive-resize` and `column-reorder` events:
105+
```html
106+
<ngx-smart-datatable
107+
...
108+
109+
(emittedEvent)="onEmitEvent($event)">
110+
</ngx-smart-datatable>
111+
```
112+
```typescript
113+
settings = {
114+
...
115+
116+
eventNames: ['responsive-resize', 'column-reorder']
117+
}
118+
...
119+
120+
onEmitEvent(event: any): void {
121+
console.log('onEmitEvent: ', event);
122+
123+
if (event.e.type === 'responsive-resize') {
124+
// do something
125+
}
126+
127+
if (event.e.type === 'column-reorder') {
128+
// do something
129+
}
130+
}
131+
```
132+
82133
### Reference :dart:
83-
* [DataTables.net](https://datatables.net/)
134+
[DataTables.net](https://datatables.net/)
84135

85136

86137
### Author :books:

0 commit comments

Comments
 (0)