Skip to content

Commit 9f81742

Browse files
committed
release: 4.5.0
1 parent b1516c7 commit 9f81742

File tree

3 files changed

+14
-4
lines changed

3 files changed

+14
-4
lines changed

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Aside from the `backends` option, you can define the backend to connect to entir
5959
* `VUE_APP_BACKEND_HOST` contains the hostname (e.g. `kuzzle.mydomain.com`),
6060
* `VUE_APP_BACKEND_PORT` contains the port (e.g. `443`),
6161
* `VUE_APP_BACKEND_SSL` can be set to `true` if the connection supports the SSL layer (do not set this variable if SSL is not supported).
62-
* `VUE_APP_BACKEND_PROTO` can be set to either `http` or `websocket`. If left blank, Websocket protocol is used by default.
62+
* `VUE_APP_BACKEND_PROTO` can be set to either `http` or `websocket`. If left blank, Websocket protocol is used by default.
6363

6464
For example, you can build your up to connect the Websocket to `wss://kuzzle.mydomain.com:443` like the following
6565

@@ -113,3 +113,13 @@ And from anywhere in your app where the `Vue` class is available, as
113113
```javascript
114114
Vue.prototype.$kuzzle;
115115
```
116+
117+
### Composition API (Vue 2.7 & 3)
118+
119+
In components with composition API you can use the composable to access the Kuzzle SDK instance
120+
121+
```javascript
122+
import { useKuzzle } from 'vue-plugin-kuzzle';
123+
124+
const $kuzzle = useKuzzle();
125+
```

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "vue-plugin-kuzzle",
3-
"version": "4.4.0",
3+
"version": "4.5.0",
44
"description": "A Vuejs plugin shipping the Kuzzle SDK in your components",
55
"main": "./dist/index.js",
66
"module": "./dist/index.js",

0 commit comments

Comments
 (0)