egoist / vue-electron-link

Open link in default browser from your Electron app.

vue-electron-link

The hyperlink that opens link in default browser or file explorer or moves it to trash, for your Electron app.

Install

yarn add vue-electron-link

Note: use this in Electron renderer process only.

Usage

<template>
  <div id="app">
    <electron-link
      class="link"
      href="https://google.com">
      open link in default browser
    </electron-link>

    <br>
    <electron-link
      href="./example/main.js"
      :is-file="true">
      open item in folder
    </electron-link>

    <br>
    <electron-link
      href="./example/foo.txt"
      :move-to-trash="handleRemoved">
      move to trash
    </electron-link>
  </div>
</template>

<script>
import ElectronLink from 'vue-electron-link'

export default {
  components: {
    ElectronLink
  },

  methods: {
    handleRemoved(success) {
      alert(`removed: ${success}`)
    }
  }
}
</script>

To run the example locally:

git clone https://github.com/egoist/vue-electron-link.git
cd vue-electron-link
yarn
yarn build
yarn example

Props

href

Type: string
Required: true

isFile

Type: boolean

Open the value of href in file explorer instead of browser.

moveToTrash

Type: boolean function

Move the value of href to trash instead of opening in browser.

If you supply a function as the value of this prop, it will be called with the return value of shell.moveItemToTrash.

Contributing

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request :D

Author

vue-electron-link © EGOIST, Released under the MIT License.
Authored and maintained by EGOIST with help from contributors (list).

egoist.moe · GitHub @EGOIST · Twitter @_egoistlily

vue-electron-link's Issues

External browser not loading

I can't get the provided example (under "To run the example locally") to open my default browser. The electron app loads and the file and trash links work, but not the browser link.

Using macOS 10.13.1