Getting Started

Learn how to install and get started with react-classmate

Prerequisites

Make sure React (>16.8) is installed

Install

npm i react-classmate
# or
yarn add react-classmate
# or
pnpm add react-classmate

Import with ES

import rc from "react-classmate"

Import with CommonJS

const rc = require("react-classmate").default

The default for CJS is currently needed because the package is designed as ES module. Named CJS export version is coming soon.

Next steps

Create a component
Extend elements
Learn about variants

Having Problems, Issues, etc?

If you are having problems or any other feedback, please file an issue on GitHub

Everything is documented in Typescript?

For now. It should be easy to remove the types and use the library in plain JavaScript. Later on, I might provide a JavaScript version of the documentation.