vue-electron-link

KO | EN

gitlite — search

#javascript #python #hacktoberfest #go #deep-learning #docker #nodejs #java #vue #pytorch #security #ios #openai #open-source

vue-electron-link

(★ 12)

Open link in default browser from your Electron app.

vue-electron-link Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# vue-electron-link

[![NPM version](https://img.shields.io/npm/v/vue-electron-link.svg?style=flat)](https://npmjs.com/package/vue-electron-link) [![NPM downloads](https://img.shields.io/npm/dm/vue-electron-link.svg?style=flat)](https://npmjs.com/package/vue-electron-link) [![CircleCI](https://circleci.com/gh/egoist/vue-electron-link/tree/master.svg?style=shield)](https://circleci.com/gh/egoist/vue-electron-link/tree/master)  [![donate](https://img.shields.io/badge/$-donate-ff69b4.svg?maxAge=2592000&style=flat)](https://github.com/egoist/donate) [![chat](https://img.shields.io/badge/chat-on%20discord-7289DA.svg?style=flat)](https://chat.egoist.moe)

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

## Install

```bash
yarn add vue-electron-link
```

**Note: use this in Electron renderer process only.**

## Usage

```vue
<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>

export default {
  components: {
    ElectronLink
  },

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

To run the example locally:

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

## Props

### href

Type: `string`<br>
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](https://electron.atom.io/docs/api/shell/#shellmoveitemtotrashfullpath).

## 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](https://github.com/egoist), Released under the [MIT](./LICENSE) License.<br>
Authored and maintained by EGOIST with help from contributors ([list](https://github.com/egoist/vue-electron-link/contributors)).

> [egoist.moe](https://egoist.moe) · GitHub [@EGOIST](https://github.com/egoist) · Twitter [@_egoistlily](https://twitter.com/_egoistlily)

vue-electron-link

vue-electron-link Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

vue-electron-link

vue-electron-link Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README