1.0.3 • Published 4 months ago
@yukiniro/react-github-corners v1.0.3
React Github Corners
SSR friendly React component for Github Corners that can add a Github Corner to your React project.
Installation
# npm
npm i @yukiniro/react-github-corners -S# yarn
yarn add @yukiniro/react-github-corners# pnpm
pnpm add @yukiniro/react-github-cornersUsage
import React from "react";
import GithubCorners from "@yukiniro/react-github-corners"; // import the component
import "@yukiniro/react-github-corners/dist/style.css"; // import the style
const App = () => {
return <GithubCorners href="https://github.com/Yukiniro/react-github-corners" />;
};Props
| Name | Type | Default | Description |
|---|---|---|---|
| href | string | - | The link of your Github repository |
| size | number | 80 | The size of the corner |
| bgColor | string | #151513 | The background color of the corner |
| color | string | #fff | The color of the octocat |
| position | string | right | The position of the corner |
| zIndex | number | 999999 | The z-index of the corner |
| className | string | - | The class name of the corner |
| style | object | - | The style of the corner |