• Stars
    star
    298
  • Rank 139,663 (Top 3 %)
  • Language
    JavaScript
  • License
    ISC License
  • Created over 8 years ago
  • Updated about 5 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

The vue plugin that attaches electron APIs to the Vue object, making them accessible to all components.

vue-electron

The vue plugin that wraps electron APIs to the Vue object.

js-standard-style

Need a full boilerplate for creating electron apps built with vue? Make sure to check out electron-vue.

https://github.com/SimulatedGREG/electron-vue

Installing

Install using NPM

npm install vue-electron --save

Include using webpack or browserify

main.js

import Vue from 'vue'
import VueElectron from 'vue-electron'

Vue.use(VueElectron)

Using the plugin

This plugin will attach electron APIs to the Vue object itself, so accessing all APIs is dead simple. All official documentation from electron can be used and accessed from this.$electron.

So instead of...

const electron = require('electron')

export default {
  methods: {
    getName () {
      return electron.remote.app.getName()
    }
  }
}

Now you can...

export default {
  methods: {
    getName () {
      return this.$electron.remote.app.getName()
    }
  }
}

Now you might be thinking, "Is it really that annoying to simply require electron to access it?" Probably not, but it can get cumbersome to have to include it in every component file that needs it. In the end, attaching electron directly to Vue just makes sense.

More Repositories

1

electron-vue

An Electron & Vue.js quick start boilerplate with vue-cli scaffolding, common Vue plugins, electron-packager/electron-builder, unit/e2e testing, vue-devtools, and webpack.
JavaScript
15,470
star
2

nginx-cheatsheet

A quick reference to common server configurations from serving static files to using in congruency with Node.js applications.
324
star
3

asar-explorer

Now you can snoop through all the electron apps
JavaScript
74
star
4

Kappa.js

A simple jQuery Plugin that can easily find text Twitch emotes and replace them with their respective emoticons.
JavaScript
16
star
5

vue-horizon

The vue plugin that wraps @horizon/client APIs to the Vue object and more.
JavaScript
10
star
6

electron-cheatsheet

[in-progress] Easily search through Electron APIs.
JavaScript
4
star
7

electron-touchbar-shortcuts

A simple electron app built specifically for a TouchBar focused "shortcuts" application.
JavaScript
4
star
8

signal

Personal app for stage musicians & sound technicians to communicate during performances.
JavaScript
3
star
9

twitch-chat-overlay

simple twitch chat overlay for streamers
HTML
3
star
10

simple-static-website

HTML
2
star
11

Crystal

CSS
2
star
12

rbac

A Role-Based Access Control system that doesn't assume anything (well mostly)
JavaScript
2
star
13

wander

experimental file system explorer made with electron
JavaScript
1
star
14

quick-do

JavaScript
1
star
15

GregTools

Vue
1
star
16

Frequency

JavaScript
1
star
17

twitter-countdown

Twitter Bot to tweet out the time left for a specified date.
JavaScript
1
star
18

HipClip

A minimal clipboard history app.
JavaScript
1
star
19

faux

Create fake data APIs defined with declarative models using Faker.js
JavaScript
1
star