Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jessy1092/react-github-fork-ribbon
Pure inline style github fork ribbon on React component.
https://github.com/jessy1092/react-github-fork-ribbon
github-fork-ribbon react
Last synced: 23 days ago
JSON representation
Pure inline style github fork ribbon on React component.
- Host: GitHub
- URL: https://github.com/jessy1092/react-github-fork-ribbon
- Owner: jessy1092
- Created: 2015-01-15T18:42:46.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2022-06-18T16:33:23.000Z (over 2 years ago)
- Last Synced: 2024-04-29T22:13:29.555Z (8 months ago)
- Topics: github-fork-ribbon, react
- Language: JavaScript
- Homepage: http://jessy1092.github.io/react-github-fork-ribbon/
- Size: 1.19 MB
- Stars: 47
- Watchers: 2
- Forks: 11
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
React GitHub Fork Ribbon
=============
[![npm][npm-image]][npm-url] [![Dependency Status][david-dm-image]][david-dm-url]
Pure inline style github fork ribbon on React component. The inline style css is from ["Fork me on GitHub" CSS ribbon](http://simonwhitaker.github.io/github-fork-ribbon-css/).
| | React = 0.12 | React = 0.13 | React >= 0.14 | React >= 0.17 |
| ------- | ------------ | ------------- | ------------- | ------------- |
| Version | <= 0.2 | >= 0.3 < 0.5 | >= 0.5 | >= 0.7 |
## Usage
```sh
npm install react-github-fork-ribbon
```
Ex. React 15.5
```js
import React from 'react';
import ReactDOM from 'react-dom';
import GitHubForkRibbon from 'react-github-fork-ribbon';
const Content = () => (
Fork me on GitHub
);
ReactDOM.render(
,
document.getElementById('content')
);
```
## Attribute
#### href
It would be `` tag's attribute `href`
#### target
It would be `` tag's attribute `target`
#### position
It has four positions.
- `left`
- `right`
- `left-bottom`
- `right-bottom`
### color
It has four color.
- `red`
- `orange`
- `black`
- `green`
#### className
It would be an html tag's attribute `class`.
## Release Notes
see [CHANGELOG.md](https://github.com/jessy1092/react-github-fork-ribbon/blob/master/CHANGELOG.md)
## Contribute
[![devDependency Status][david-dm-dev-image]][david-dm-dev-url]
1. Fork it.
2. Create your feature-branch `git checkout -b your-new-feature-branch`
3. Commit your change `git commit -am 'Add new feature'`
4. Push to the branch `git push origin your-new-feature-branch`
5. Create new Pull Request with `master` branch
## License
The MIT License (MIT)
Copyright (c) 2015-2017 Lee < [email protected] >
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
[react-github-fork-ribbon-url]: https://github.com/jessy1092/react-github-fork-ribbon/releases
[npm-image]: https://img.shields.io/npm/v/react-github-fork-ribbon.svg?style=flat-square
[npm-url]: https://www.npmjs.com/package/react-github-fork-ribbon
[david-dm-image]: https://david-dm.org/jessy1092/react-github-fork-ribbon.svg?style=flat-square
[david-dm-url]: https://david-dm.org/jessy1092/react-github-fork-ribbon
[david-dm-dev-image]: https://david-dm.org/jessy1092/react-github-fork-ribbon/dev-status.svg?style=flat-square
[david-dm-dev-url]: https://david-dm.org/jessy1092/react-github-fork-ribbon#info=devDependencies