Skip to content

Commit dd9ea82

Browse files
committed
add information about usage
1 parent 8da14df commit dd9ea82

File tree

1 file changed

+25
-3
lines changed

1 file changed

+25
-3
lines changed

README.md

+25-3
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,34 @@ import vueTabevents from 'vue-tabevents';
2828
Vue.use(vueTabevents);
2929
```
3030

31-
<!-- ## Example Usage
31+
## Usage
3232

33-
```html
33+
To an emit event to other tabs
3434

35+
```
36+
this.$tabEvent.emit('eventName');
37+
38+
const data = {
39+
name: 'Ali'
40+
phone: 123
41+
}
42+
43+
this.$tabEvent.emit('eventName', data);
44+
```
45+
46+
To listen for events emitted by other types
47+
48+
```
49+
this.$tabEvent.on('eventName', callback);
50+
51+
this.$tabEvent.on('eventName', (data) => console.log(data));
52+
```
3553

36-
``` -->
54+
To stop listening to an event
55+
56+
```
57+
this.$tabEvent.off('eventName');
58+
```
3759

3860
## Authors
3961

0 commit comments

Comments
 (0)