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

React portals + Github corners + Styled component = 💘
https://github.com/zzarcon/react-gh-corner

gh gh-corner gh-pages github github-corner github-pages portal react react-dom react-portal

Last synced: about 2 months ago
JSON representation

React portals + Github corners + Styled component = 💘

• Host: GitHub
• URL: https://github.com/zzarcon/react-gh-corner
• Owner: zzarcon
• License: mit
• Created: 2018-06-06T22:22:16.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-07T04:08:42.000Z (over 1 year ago)
• Last Synced: 2024-07-05T03:36:46.377Z (3 months ago)
• Topics: gh, gh-corner, gh-pages, github, github-corner, github-pages, portal, react, react-dom, react-portal
• Language: TypeScript
• Homepage: https://zzarcon.github.io/react-gh-corner/
• Size: 4.13 MB
• Stars: 38
• Watchers: 3
• Forks: 3
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# react-gh-corner [![Build Status](https://travis-ci.org/zzarcon/react-gh-corner.svg?branch=master)](https://travis-ci.org/zzarcon/react-gh-corner)

> React portals + Github corners + Styled component = 💘



  

  





# Demo 🍿

[https://zzarcon.github.io/react-gh-corner](https://zzarcon.github.io/react-gh-corner)

# Install 🚀

```

$ yarn add react-gh-corner

```

# Usage ⛏

**Basic** 

```tsx

import GHCorner from 'react-gh-corner';

```

**Custom**

```tsx

import GHCorner from 'react-gh-corner';

```

# Api 📚

```ts

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

interface Props {

  href: string;

  position?: CornerPosition;

  bgColor?: string;

  size?: number;

  ariaLabel?: string;

  openInNewTab?: boolean;

}

```

See [example/](https://github.com/zzarcon/react-gh-corner/tree/master/example) for full example.

# Author

[@zzarcon](https://twitter.com/zzarcon)