neko mirror
Go to file
2022-08-30 23:02:44 +02:00
.github/workflows github action fix registry-url. 2022-07-18 23:17:37 +02:00
.vscode bump openapi generator version. 2021-02-26 22:54:43 +01:00
dev add dev scripts. 2022-07-16 20:53:37 +02:00
src canvas cursor draw, reset x & y before clear #9. 2022-08-30 23:02:44 +02:00
.babelrc inital commit. 2020-11-05 11:56:26 +01:00
.editorconfig inital commit. 2020-11-05 11:56:26 +01:00
.eslintrc disable multi-word-component-names. 2022-05-14 19:41:34 +02:00
.gitattributes bump openapi generator version. 2021-02-26 22:54:43 +01:00
.gitignore add plugins. 2022-07-17 00:52:29 +02:00
.prettierrc inital commit. 2020-11-05 11:56:26 +01:00
Dockerfile node 16 major upgrade. 2022-05-14 19:25:22 +02:00
LICENSE add LICENSE. 2022-07-18 22:08:36 +02:00
package-lock.json version 1.6.7 2022-08-25 00:22:29 +02:00
package.json version 1.6.7 2022-08-25 00:22:29 +02:00
README.md add README. 2022-07-31 23:38:19 +02:00
tsconfig.json inital commit. 2020-11-05 11:56:26 +01:00
vue.config.js node 16 major upgrade. 2022-05-14 19:25:22 +02:00

neko-client

Connect to demodesk/neko backend with self contained vue component.

For community edition neko with GUI and plug & play deployment visit m1k1o/neko.

Installation

Code is published to public GitHub npm repository.

# npm command
npm i @demodesk/neko
# yarn command
yarn add @demodesk/neko

Registry setup

# npm command
echo @demodesk:registry=https://npm.pkg.github.com >> .npmrc
# yarn command
echo \"@demodesk:registry\" \"https://npm.pkg.github.com\" >> .yarnrc

Example

API consists of accessing Vue reactive state, calling various methods and subscribing to events. Simple usage:

<!-- import vue -->
<script src="https://unpkg.com/vue"></script>

<!-- import neko -->
<script src="./neko.umd.js"></script>
<link rel="stylesheet" href="./neko.css">

<div id="app">
  <neko ref="neko" server="http://127.0.0.1:3000/api" autologin autoplay />
</div>

<script>
new Vue({
  components: { neko },
  mounted() {
    // access state
    // this.$refs.neko.state.session_id
  
    // call methods
    // this.$refs.neko.setUrl('http://127.0.0.1:3000/api')
    // this.$refs.neko.login('username', 'password')
    // this.$refs.neko.logout()
  
    // subscribe to events
    // this.$refs.neko.events.on('room.control.host', (id) => { })
  },
}).$mount('#app')
</script>