react-gh-corner
TypeScript icon, indicating that this package has built-in type declarations

1.1.4 • Public • Published

react-gh-corner Build Status

React portals + Github corners + Styled component = 💘

demo

Demo 🍿

https://zzarcon.github.io/react-gh-corner

Install 🚀

$ yarn add react-gh-corner

Usage

Basic

import GHCorner from 'react-gh-corner';

<GHCorner href="https://github.com/zzarcon/react-gh-corner" />

Custom

import GHCorner from 'react-gh-corner';

<GHCorner
  href="https://github.com/zzarcon/react-gh-corner"
  position="top-right"
  bgColor="hotpink"
  size={250}
  ariaLabel="Check my project"
  openInNewTab={true}
/>

Api 📚

type CornerPosition = 'top-right' | 'top-left';

interface Props {
  href: string;
  position?: CornerPosition;
  bgColor?: string;
  size?: number;
  ariaLabel?: string;
  openInNewTab?: boolean;
}

See example/ for full example.

Author

@zzarcon

Package Sidebar

Install

npm i react-gh-corner

Weekly Downloads

22

Version

1.1.4

License

MIT

Unpacked Size

15.1 kB

Total Files

19

Last publish

Collaborators

  • zzarcon