vue-github-buttons

WebJar for vue-github-buttons

License	Apache-2.0
Categories	Github Development Tools Version Controls
GroupId	org.webjars.npm
ArtifactId	vue-github-buttons
Last Version	3.1.0
Release Date	Oct 20, 2020
Type	jar
Description	vue-github-buttons WebJar for vue-github-buttons
Project URL	https://www.webjars.org
Source Code Management	https://github.com/gluons/vue-github-buttons

Download vue-github-buttons

Filename	Size
vue-github-buttons-3.1.0.pom
vue-github-buttons-3.1.0.jar	171 KB
vue-github-buttons-3.1.0-sources.jar	22 bytes
vue-github-buttons-3.1.0-javadoc.jar	22 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.webjars.npm/vue-github-buttons/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>vue-github-buttons</artifactId>
    <version>3.1.0</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.npm/vue-github-buttons/
implementation 'org.webjars.npm:vue-github-buttons:3.1.0'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.webjars.npm/vue-github-buttons/
implementation ("org.webjars.npm:vue-github-buttons:3.1.0")

Apache Buildr

'org.webjars.npm:vue-github-buttons:jar:3.1.0'

Apache Ivy

<dependency org="org.webjars.npm" name="vue-github-buttons" rev="3.1.0">
  <artifact name="vue-github-buttons" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.webjars.npm', module='vue-github-buttons', version='3.1.0')
)

Scala SBT

libraryDependencies += "org.webjars.npm" % "vue-github-buttons" % "3.1.0"

Leiningen

[org.webjars.npm/vue-github-buttons "3.1.0"]

Dependencies

compile (3)

Group / Artifact	Type	Version
org.webjars.npm : format-thousands	jar	[1.1.1,2)
org.webjars.npm : node-fetch	jar	[2.3.0,3)
org.webjars.npm : tslib	jar	[1.9.3,2)

Project Modules

There are no modules declared in this project.

Vue GitHub Buttons

GitHub buttons component for Vue.

• Vue GitHub Buttons
  • Installation
  • Demo
  • Usage
  • Using with Nuxt
    • Module options
      • css
      • useCache
  • Using with VuePress
  • API
    • Plugin Options
      • useCache
    • Components
      • gh-btns-watch
      • gh-btns-star
      • gh-btns-fork
      • gh-btns-follow

Installation

Via NPM:

npm install vue-github-buttons

Via Yarn:

yarn add vue-github-buttons

Demo

Go to https://gluons.github.io/vue-github-buttons

Usage

import Vue from 'vue';
import VueGitHubButtons from 'vue-github-buttons';
import App from './App.vue';

// Stylesheet
import 'vue-github-buttons/dist/vue-github-buttons.css';

Vue.use(VueGitHubButtons);
// Or if your don't want to use cache
Vue.use(VueGitHubButtons, { useCache: false });

new Vue({
	el: '#app',
	render: h => h(App)
});

<template>
	<div id="app">
		<gh-btns-watch slug="vuejs/vue" show-count></gh-btns-watch>
		<gh-btns-star slug="vuejs/vue" show-count></gh-btns-star>
		<gh-btns-fork slug="vuejs/vue" show-count></gh-btns-fork>
		<gh-btns-follow user="yyx990803" show-count></gh-btns-follow>
	</div>
</template>

<script>
// JavaScript ...
</script>

<style>
/* Style ... */
</style>

Using with Nuxt

Add vue-github-buttons/nuxt to modules in nuxt.config.js.

module.exports = {
	modules: [
		'vue-github-buttons/nuxt',
		// Or with options
		['vue-github-buttons/nuxt', {
			css: false, // Don't include CSS
			useCache: false // Don't use cache
		}]
	]
};

Module options

css

Type: Boolean
Default: true

Include Vue GitHub Buttons's CSS.

useCache

Type: Boolean
Default: true

Enable caching. (See below)

Using with VuePress

Require VuePress v1.x

Add Vue GitHub Buttons to your plugins in .vuepress/config.js.

module.exports = {
	plugins: [
		require('vue-github-buttons/plugins/vuepress'),

		/* Or using plugin with options */

		[
			require('vue-github-buttons/plugins/vuepress'),
			{
				useCache: false
			}
		]
	]
}

Plugin options are the same as Vue plugin options.

API

Plugin Options

useCache

Type: Boolean
Default: true

Enable count number caching. (Use session storage)

GitHub API has limited requests. So, caching may be useful when user refresh the webpage.

Vue.use(VueGitHubButtons, { useCache: false }); // Disable cache

Components

gh-btns-watch

👁️ A watch button.

• slug - GitHub slug (username/repo).
• show-count - Enable displaying the count number.

gh-btns-star

⭐ A star button.

• slug - GitHub slug (username/repo).
• show-count - Enable displaying the count number.

gh-btns-fork

🍴 A fork button.

• slug - GitHub slug (username/repo).
• show-count - Enable displaying the count number.

gh-btns-follow

👤 A follow button.

• user - GitHub username.
• show-count - Enable displaying the count number.

Versions

Version
3.1.0 Oct 20, 2020