https://github.com/mr-addict/wc-fork-me-on-github
A web component that displays a "Fork me on GitHub" ribbon
https://github.com/mr-addict/wc-fork-me-on-github
lit web-component
Last synced: 2 months ago
JSON representation
A web component that displays a "Fork me on GitHub" ribbon
- Host: GitHub
- URL: https://github.com/mr-addict/wc-fork-me-on-github
- Owner: MR-Addict
- Created: 2025-06-16T10:38:02.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-06-16T15:13:28.000Z (11 months ago)
- Last Synced: 2025-06-16T16:27:22.945Z (11 months ago)
- Topics: lit, web-component
- Language: TypeScript
- Homepage: https://mr-addict.github.io/wc-fork-me-on-github/
- Size: 78.1 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# WC Fork me on Github 
A web component that displays a "Fork me on Github" ribbon.
## Installation
You can install the component via npm:
```sh
npm install wc-fork-me-on-github
```
And then import it in your JavaScript:
```js
import "wc-fork-me-on-github";
```
Or if you prefer to use it as a script tag, you can include it directly from a CDN:
```html
```
## Usage
Now, you can use the `` element in your HTML:
```html
```
## Attributes
- **`repository`**: The Github repository in the format `owner/repo`. This is required to display the ribbon correctly.
- **`position`**: The position of the ribbon. Options are `right-top(default)`, `right-bottom`, `left-top`, and `left-bottom`.
- **`ribbon`**: The text to display on the ribbon. Defaults to "Fork me on Github".
- **`color`**: The color of the ribbon. Defaults to `#a00`. Any valid CSS color value can be used here.
- **`darkColor`**: If not set, it will default to the same value as `color`.