v-github-icon :octocat:



⚠️ Docs are for Vue 3, for Vue 2 docs, check this tree

Features

- GitHub corners made easy!
- Built from scratch usign Vue 3
- For Vue 3.x version – npm i v-github-icon
- For Vue 2.x version – npm i v-github-icon@1 && npm i -D @vue/composition-api

Table of Contents

- v-github-icon :octocat:
- Features
- Table of Contents
- Demo
- Requirements
- Installation
- Build Setup
- Usage
- Nuxt
- HTML
- JS
- HTML
- JS
- API
- Props
- Built with
- Contributing
- Author

Demo


Requirements

- Vue ^3.x

$3

``sh
npm install --save v-github-icon
`

CDN: UNPKG | jsDelivr

$3

`bash


install dependencies

$ npm install

package the library

$ npm run build
`

Usage

Register the component globally:

`js
// main.ts
import { VGithubIcon } from 'v-github-icon';
import { createApp } from 'vue';

const app = createApp({});
app.component('VGithubIcon', VGithubIcon);
`

Or use locally

`javascript
import { VGithubIcon } from 'v-github-icon';
`

$3

For Nuxt 3, create a file in plugins/v-github-icon.ts

`js
import { VGithubIcon } from 'v-github-icon';

export default defineNuxtPlugin((nuxtApp) => {
nuxtApp.vueApp.component('VGithubIcon', VGithubIcon);
`

then import the file in nuxt.config.{j|t}s:

`js
export default {
// ...
plugins: [
// ...
{ src: '~/plugins/v-github-icon', mode: 'client' },
// ...
],
// ...
};
`

Example 1 (refer App.vue)

$3

`html
:position="position"
:url="url"
:bg-color="bgColor"
:fill-color="fillColor"
/>
`

$3

`javascript

`

Example 2 (minimal)

$3

`html

`

$3

`javascript

`

API

$3

| Name | Type | Required? | Description |
| ------------ | ------ | --------- | --------------------------------------------------- |
| url | String | Yes | The URL link to GitHub project repository |
| position | String | No | Position of the icon, 'top-left' or 'top-right' |
| bg-color | String | No | Color of the octocat |
| fill-color | String | No | Color excluding the octocat |

Built with

- TypeScript.
- Vue 2

Contributing

1. Fork it ( https://github.com/vinayakkulkarni/v-github-icon/fork )
2. Create your feature branch (git checkout -b feat/new-feature)
3. Commit your changes (git commit -Sam 'feat: add feature')
4. Push to the branch (git push origin feat/new-feature`)
5. Create a new Pull Request

_Note_:

1. Please contribute using GitHub Flow
2. Commits & PRs will be allowed only if the commit messages & PR titles follow the conventional commit standard, _read more about it here_
3. PS. Ensure your commits are signed. _Read why_

Author

v-github-icon © Vinayak, Released under the MIT License.

Authored and maintained by Vinayak Kulkarni with help from contributors (list).

> vinayakkulkarni.dev · GitHub @vinayakkulkarni · Twitter @\_vinayak_k