Skip to content

Commit

Permalink
Merge pull request #18 from angeliski/docs/events-tabulator-emit
Browse files Browse the repository at this point in the history
Docs/events tabulator emit
  • Loading branch information
angeliski authored Aug 21, 2019
2 parents f4a4290 + fb8dfcd commit cd8de3f
Show file tree
Hide file tree
Showing 2 changed files with 61 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ docs/.vuepress/dist

/tests/e2e/videos/
/tests/e2e/screenshots/
vue-tabulator-v*.tgz
vue-tabulator*.tgz
# local env files
.env.local
.env.*.local
Expand Down
60 changes: 60 additions & 0 deletions docs/guide/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,66 @@ The update strategy is responsible for how data is updated in the Tabulator inst
::: warning Use update in editable tables
To avoid [problems](https://github.com/angeliski/vue-tabulator/issues/13) prefer use `UPDATE` strategy on editable tables
:::
## Events

All events in Tabulator follow CamelCase convention, but the events in vue-tabulator will follow the kebab-case:

`rowClick -> row-click`

:::tip
You can use the options object next to the vue event system to configure your instance.
The vue-tabulator will call both methods: first emit the event then run the callback in the options object.
:::

### Row Callbacks
- (Available in Release 1.2.0)

You can see all events available [here](http://tabulator.info/docs/4.4/callbacks#row).

The events will be emitted in the root component:

```html{5}
<VueTabulator
v-model="data"
:options="options"
:integration="{ updateStrategy: 'REPLACE' }"
@row-click="myMethod"
/>
```

### Cell Callbacks
- (Available in Release 1.2.0)

You can see all events available [here](http://tabulator.info/docs/4.4/callbacks#cell).

The events will be emitted in the root component:

```html{5}
<VueTabulator
v-model="data"
:options="options"
:integration="{ updateStrategy: 'REPLACE' }"
@cell-click="myMethod"
/>
```

The Callbacks Tabulator will be soon available in the vue-way:
- Table Callbacks (Soon)
- Column Callbacks (Soon)
- Data Callbacks (Soon)
- Ajax Callbacks (Soon)
- Filter Callbacks (Soon)
- Sorting Callbacks (Soon)
- Layout Callbacks (Soon)
- Pagination Callbacks (Soon)
- Group Callbacks (Soon)
- Selection Callbacks (Soon)
- Row Movement Callbacks (Soon)
- Validation Callbacks (Soon)
- History Callbacks (Soon)
- Clipboard Callbacks (Soon)
- Download Callbacks (Soon)
- Data Tree Callbacks (Soon)


## Advanced Interaction
Expand Down

0 comments on commit cd8de3f

Please sign in to comment.