actioncable-vue

ActionCableVue is an easy-to-use Action Cable integration for VueJS.

#### 🚀 Installation

``bash
npm install actioncable-vue --save
`

`javascript
// Vue 3.x
import { createApp } from "vue";
import App from "./App.vue";
import ActionCableVue from "actioncable-vue";

const actionCableVueOptions = {
debug: true,
debugLevel: "error",
connectionUrl: "ws://localhost:5000/api/cable", // If you don"t provide a connectionUrl, ActionCable will use the default behavior
connectImmediately: true,
unsubscribeOnUnmount: true,
};

createApp(App)
.use(store)
.use(router)
.use(ActionCableVue, actionCableVueOptions)
.mount("#app");
`

`javascript
// Vue 2.x
import Vue from "vue";
import ActionCableVue from "actioncable-vue";
import App from "./App.vue";

Vue.use(ActionCableVue, {
debug: true,
debugLevel: "error",
connectionUrl: "ws://localhost:5000/api/cable", // or function which returns a string with your JWT appended to your server URL as a query parameter
connectImmediately: true,
});

new Vue({
router,
store,
render: (h) => h(App),
}).$mount("#app");
`

| Parameters | Type | Default | Required | Description |
| -------------------- | --------------- | ----------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| debug | Boolean | false | Optional | Enable logging for debug |
| debugLevel | String | error | Optional | Debug level required for logging. Either info, error, or all |
| connectionUrl | String/Function | null | Optional | ActionCable websocket server url. Omit it for the default behavior |
| connectImmediately | Boolean | true | Optional | ActionCable connects to your server immediately. If false, ActionCable connects on the first subscription. |
| unsubscribeOnUnmount | Boolean | true | Optional | Unsubscribe from channels when component is unmounted. |
| store | Object | null | Optional | Vuex store |

#### Table of content

- Component Level Usage
- Subscriptions
- Unsubscriptions
- Manually connect to the server
- Disconnecting from the server
- Performing an action on your Action Cable server
- Usage with Vuex
- Usage with Nuxt.JS

#### Wall of Appreciation

- Many thanks to @x88BitRain for adding Vue 3 compatibility

#### 🌈 Component Level Usage

If you want to listen to channel events from your Vue component:

1. If you're using Vue 3 setup script define a channels object in the setup function.
2. If you're using Vue 3 defineComponent define a channels property.
3. You need to either add a channels object in the Vue component (Vue 2 only)
4. If you're using vue-class-component define a channels property. (Vue 2 only)

Each defined object in channels will start to receive events provided you subscribe correctly.

##### 1. Vue 3 setup script

`typescript

`

##### 2. Vue 3 defineComponent

`typescript
import { onMounted } from "vue";

export default defineComponent({
channels: {
ChatChannel: {
connected() {
console.log("connected");
},
rejected() {
console.log("rejected");
},
received(data) {},
disconnected() {},
},
},
setup() {
onMounted(() => {
this.$cable.subscribe({
channel: "ChatChannel",
});
});
},
});
`

##### 3. Vue 2.x.

`javascript
new Vue({
data() {
return {
message: "Hello world",
};
},
channels: {
ChatChannel: {
connected() {},
rejected() {},
received(data) {},
disconnected() {},
},
},
methods: {
sendMessage: function () {
this.$cable.perform({
channel: "ChatChannel",
action: "send_message",
data: {
content: this.message,
},
});
},
},
mounted() {
this.$cable.subscribe({
channel: "ChatChannel",
room: "public",
});
},
});
`

##### 4. Vue 2.x vue-class-component

`typescript
@Component
export default class ChatComponent extends Vue {
@Prop({ required: true }) private id!: string;

get channels() {
return {
ChatChannel: {
connected() {
console.log("connected");
},
rejected() {},
received(data) {},
disconnected() {},
},
};
}

sendMessage() {
this.$cable.perform({
channel: "ChatChannel",
action: "send_message",
data: {
content: this.message,
},
});
}

async mounted() {
this.$cable.subscribe({
channel: "ChatChannel",
room: "public",
});
}
}
`

#### 👂🏾 Subscriptions

###### 1. Subscribing to a channel

Define a channels object in your component matching the action cable server channel name you passed for the subscription.

`typescript

`

$3

> ActionCableVue automatically uses your ActionCable server channel name if you do not pass in a specific channel name to use in your channels. It will also override clashing channel names.

###### 2. Subscribing to the same channel but different rooms

`typescript

`

###### 3. Subscribing to a channel with a computed name

`typescript
// Conversations.vue


`

`typescript
// Chat.vue


`

#### 🔇 Unsubscriptions

> For Vue 2.x and when using Vue 3.x defineComponent, when your component is destroyed ActionCableVue automatically unsubscribes from any channel that component was subscribed to.

###### 1. Unsubscribing from a channel (Vue 3.x setup script)

`typescript

`

###### 2. Unsubscribing from a channel Vue 2.x

`javascript
new Vue({
methods: {
unsubscribe() {
this.$cable.unsubscribe("ChatChannel");
},
},
});
`

#### 🔌 Manually connect to the server

ActionCableVue automatically connects to your Action Cable server if connectImmediately is not set to false during setup. If you do set connectImmediately to false you can manually trigger a connection to your ActionCable server with this.$cable.connection.connect.

`typescript

`

#### ✂️ Disconnecting from the server

`typescript

`

#### 💎 Performing an action on your Action Cable server

Requires that you have a method defined in your Rails Action Cable channel whose name matches the action property passed in.

`typescript

`

#### 🐬 Usage with Vuex (Vue 2.x)

ActionCableVue has support for Vuex. All you have to do is setup your store correctly and pass it in during the ActionCableVue plugin setup.

`javascript
// store.js

import Vue from "vue";
import Vuex from "vuex";

Vue.use(Vuex);

export default new Vuex.Store({
state: {},
mutations: {
sendMessage(state, content) {
this.$cable.perform({
action: "send_message",
data: {
content,
},
});
},
},
actions: {
sendMessage({ commit }, content) {
commit("sendMessage", content);
},
},
});
`

`javascript
import store from "./store";
import Vue from "vue";
import ActionCableVue from "actioncable-vue";

Vue.use(ActionCableVue, {
debug: true,
debugLevel: "all",
connectionUrl: process.env.WEBSOCKET_HOST,
connectImmediately: true,
store,
});
`

#### 💪 Usage with Nuxt

ActionCableVue works just fine with Nuxt 2 or 3. All you need to do is set it up as a client side plugin.

##### Nuxt 3

`javascript
// /plugins/actioncablevue.client.js
import ActionCableVue from "actioncable-vue";

export default defineNuxtPlugin(({ vueApp }) => {
const config = useRuntimeConfig();

vueApp.use(ActionCableVue, {
debug: true,
debugLevel: "all",
connectionUrl: config.public.WEBSOCKET_HOST,
connectImmediately: true,
});
});


// /pages/chat.vue

`

##### Nuxt 2

`javascript
// /plugins/actioncable-vue.js

import Vue from "vue";
import ActionCableVue from "actioncable-vue";

if (process.client) {
Vue.use(ActionCableVue, {
debug: true,
debugLevel: "all",
connectionUrl: process.env.WEBSOCKET_HOST,
connectImmediately: true,
});
}

// nuxt.config.js
plugins: [{ src: "@/plugins/actioncable-vue", ssr: false }];
``