@ribbon-studios/fork-me
v1.1.2
Published
A 'Fork Me' React Component built out of spite
Downloads
8
Readme
@ribbon-studios/fork-me
Usage
import { ForkMe } from '@ribbon-studios/fork-me';
export function MyApp() {
return (
<div>
My super cool content.
<ForkMe slug="ribbon-studios/fork-me" />
</div>
);
}
Properties
| Name | Description | Optional? |
| --------------- | ----------------------------------------------------- | --------------------------- |
| slug | The slug of your repository | No |
| side | The side you'd like the octocat to appear! | Yes (defaults to 'right'
) |
| backgroundColor | The ribbon color | Yes (defaults to 'black'
) |
| color | The octocat color | Yes (defaults to 'white'
) |
| newTab | Set this to false to make it open in the current tab. | Yes (defaults to true
) |