Quick start

Requirements

• React 16+

Installation

npm

npm i @circleco/headless-ui-kit

yarn

yarn add @circleco/headless-ui-kit

pnpm

pnpm i @circleco/headless-ui-kit

Usage

After installing the package, you need to set up two things:

• add our CSS file to your app.

import '@circleco/headless-ui-kit/style.css'

• add CircleProvider before using our components.

  import {
    CircleProvider
  } from "@circleco/headless-ui-kit/components/Provider";


  const getTokenFunction = () => {
    return "<MEMEBER_TOKEN>" // you must return the member api here.
  };

  return (
    <CircleProvider getTokenFunction={getTokenFunction}>
      <Component />
    </CircleProvider>
  );

Documentation

We use Storybook as our source of truth. All pieces of code you see there are perfect examples of how to use our components.

https://circleco.github.io/headless-js-uikit