Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/linusborg/vue-ko-fi-button

the Ko-fi Buttton (www.ko-fi.com) implemented as a Vue component (no affiliation)
https://github.com/linusborg/vue-ko-fi-button

Last synced: 11 days ago
JSON representation

the Ko-fi Buttton (www.ko-fi.com) implemented as a Vue component (no affiliation)

Awesome Lists containing this project

README

        

# vue-ko-fi-button

> A Vue component to add the KoFi Button to your Vue apps.

## About

**Disclaimer**: I'm not working for www.ko-fi.com or am in any other way affiliated with them except for using their service.

I created this component because I wanted to implement their [button widget](https://ko-fi.com/Manage/Widgets) into my Vue apps, but found it difficult to do so.

It looks kind of like this (even though this one is the static version for markdown):


Buy Me a Coffee at ko-fi.com

I'm using their CSS with very little tweaks, and of course link to their images. I hope that's cool with them.

## Install

```bash
npm i -D @linusborg/vue-ko-fi-button
# or
yarn add -D @linusborg/vue-ko-fi-button
```

## ES5/ES6

* The package's main export is a .vue File containing ES5 code (IE-compatible).
* If you want to use the ES6-version directly, import from `'@linusborg/vue-ko-fi-button/es6/KoFiButton.vue'`

### In the browser

The package also comes with a UMD build if you really need to include it with a `` element.

```html
<script src="https://unpkg.com/@linusborg/vue-ko-fi-button/umd/VueKoFiButton.umd.min.js">
```

The component will be avaliable as `window.VueKoFiButton`.

## Usage

```html

import KoFiButton from '@linusborg/vue-ko-fi-button'
export default {
name: 'YourComponent',
components: {
KoFiButton
}
}
```

## Development

<!-- markdownlint-disable MD033 -->
<details>
<summary>Boring details about this project's dev setup</summary>

### Setup

```bash
yarn install
```

### Compiles and hot-reloads for demo/development

```bash
yarn serve
```

### Compiles and minifies for production

```bash
yarn build
```

### Lints and fixes files

```bash
yarn lint
```

### Run unit tests

```bash
yarn test:unit
```

### Release a new version

```bash

yarn relase
```

### Customize configuration

See [Configuration Reference](https://cli.vuejs.org/config/).

</details>