Code Documentation

Fork Me React.js component

test Maintainability codecov Version Downloads npm bundle size Gitpod ready-to-code

A simple fork me component for React.js projects!

We are happy to announce that we have launched a new course to help you understand the turborepo-template better Craft Next Gen UI Libraries for React 18 and Next.js 14

Features

✅ Fully Treeshakable (import from @mayank1513/fork-me/client/component)

✅ Full TypeScript Support

✅ Unleash the full power of React18 Server components

✅ Works with all build systems/tools/frameworks for React18

✅ Doccumented with Typedoc (Docs)

Install

$ pnpm add @mayank1513/fork-me

or

$ npm install @mayank1513/fork-me

or

$ yarn add @mayank1513/fork-me

Add on your page

<ForkMe gitHubUrl="https://github.com/mayank1513/turborepo-template" />
// and
<StarMe gitHubUrl="https://github.com/mayank1513/turborepo-template" />

You need to import styles for ForkMe component

import "@mayank1513/fork-me/server/index.css";

Optional parameters

    text?: string; // replace the Fork me on GitHub text
width?: string | number; // if you need to adjust the width of the ribbon (length)
height?: string | number; // to adjust height of the ribbon
bgColor?: string; // background color
textColor?: string; // text color

🤩 Don't forger to star this repo!

Want hands-on course for getting started with Turborepo? Check out React and Next.js with TypeScript and The Game of Chess with Next.js, React and TypeScrypt

Repo Stats

License

Licensed as MIT open source.


with 💖 by Mayank Kumar Chaudhari