https://github.com/mshenfield/react-github-corners

A fresher "Fork me on Github" callout ported to React
https://github.com/mshenfield/react-github-corners

github-corner react

Last synced: about 13 hours ago
JSON representation

A fresher "Fork me on Github" callout ported to React

• Host: GitHub
• URL: https://github.com/mshenfield/react-github-corners
• Owner: mshenfield
• License: mit
• Created: 2017-04-25T14:59:22.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-01-24T18:31:04.000Z (almost 2 years ago)
• Last Synced: 2024-04-14T06:39:36.873Z (7 months ago)
• Topics: github-corner, react
• Language: JavaScript
• Size: 258 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# React Github Corners

A small React wrapper around [@tholman](https://github.com/tholman)'s [github-corners](https://github.com/tholman/github-corners). See [the example site](http://tholman.com/github-corners/) to see the corner live with the smal animations.

## Installation

Add `react-github-corners` to your project from npm using your favorite package management tool

## Usage

If you have [Webpack](https://webpack.js.org/) configured to [load CSS](https://webpack.github.io/docs/stylesheets.html) and [transpile JSX](https://github.com/babel/babel-loader), this can simply be imported and used. This also plays nice with [create-react-app](https://github.com/facebookincubator/create-react-app).

```js

import GithubCorner from 'react-github-corners'

import 'react-github-corners/dist/GithubCorner.css'

const App = (props) => ()

```

You can override the color using the `color` and `backgroundColor` props:

```js

const App = (props) => ()

```

Class names try to follow [BEM](http://getbem.com/introduction/) principles, so you can dig around the source code to find the class names and take direct control of the components using plain CSS. You can also override the SVG style by passing an `svgStyle` attribute to your component:

```js

const App = (props) => ( Naturally, these aren't built by GitHub, or endorsed by them.

Ditto for this.

Copyright (c) 2016 Tim Holman