Skip to content

zzarcon/react-gh-corner

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

27 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

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