Forge React

The official React implementation of the Forge design system created by @zigurous.

Installation

CDN

Available from any of the following:

• Install with CloudFront https://cdn.zigurous.com/[email protected]/dist/index.min.js
• Install with jsDelivr https://cdn.jsdelivr.net/gh/zigurous/[email protected]/dist/index.min.js
• Install with Statically https://cdn.statically.io/gh/zigurous/forge-react/1.0.0/dist/index.min.js

Add the script in your HTML file:

<script src="https://cdn.zigurous.com/[email protected]/dist/index.min.js">

GitHub Packages

Generate a personal access token in your GitHub account with the read:packages scope. GitHub requires an auth token to download packages even if they are public.

Add an .npmrc file in the same directory as your package.json with the lines below. Replace ${NPM_TOKEN} with the token you generated in the previous step.

registry=https://registry.npmjs.org/
@zigurous:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken=${NPM_TOKEN}

Install the package using your preferred package manager:

• Install with npm npm install @zigurous/forge-react
• Install with yarn yarn add @zigurous/forge-react
• Install with pnpm pnpm add @zigurous/forge-react

Usage

import { Button } from '@zigurous/forge-react'
import React from 'react'

export default function Component() {
  return (
    <div>
      <Button>Example</Button>
    </div>
  )
}