Skip to content

Add a Github corner to your project page, This GitHub corner for Vue 3.0+ component.

License

Notifications You must be signed in to change notification settings

uivjs/vue-github-corners

Repository files navigation

@uivjs/vue-github-corners

Build & Deploy Downloads npm version npm unpkg

Add a Github corner to your project page, This GitHub corner for Vue 3.0+ component.

Install

npm i @uivjs/vue-github-corners

Usage

<template>
  <div>
    <github-corners fixed target="__blank" href="https://github.com/uivjs/vue-github-corners" />
  </div>
</template>

<script>
import { defineComponent } from 'vue';
import GithubCorners from '@uivjs/vue-github-corners';

export default defineComponent({
  components: {
    GithubCorners
  }
});
</script>

API

  • href The link to your project page.
  • size Default: 80, The width and height of the corner.
  • color Default: #fff, The Github logo color of the corner.
  • bgColor Default: #151513, The background color of the corner.
  • position: PropType<'right' | 'left'> Default: right, The position of corner.
  • fixed Default false, It is positioned relative to the initial containing block established.
  • zIndex Sets the z-order of a positioned element and its descendants or flex items.
  • bottom Is it displayed at the bottom?

Related

  • react-github-corners Add a Github corner to your project page, This GitHub corner for react component.

License

Licensed under the MIT License.