@pinpt/react

Pinpoint React Library

Usage

Installing:

npm i @pinpt/react

After installation, import the base styles. This is similar to a style reset and includes only the minimal styles for basic functionality.

The library is designed to be easily themable with CSS.

import '@pinpt/react/dist/base.css';

Components can be imported as so:

import { Statistic } from '@pinpt/react';

const component = () => <Statistic.Bar claps={21} views={5} />;

Building Your Site:

There are two primary ways to build a site using this library, either using prebuilt components, or custom-building the application yourself. Using prebuilt components is the easiest way to get up and running, and you can read more about them here.

Using the components individually provides for more customization options, but you'll need to be careful to include a few important parts. The most important is the Pinpoint component to wrap your content entries. Without this, analytics and link unfurling will not work as expected. Read more about implementation here.

Read the docs

Check out the docs for detailed implementation guides. You can also play with the Interactive Storybook

Local Dev

If you want to do local dev with the App Template you can use the following:

In this folder, cd into node_modules and then:

cd react && npm link
cd react-dom && npm link

This will link te react and react-dom libraries so they can be used by the other project.

Then, in the app-template folder, run:

npm link react react-dom

This will then link those library into the node_modules for app-template and then allow you to make changes to this project and then test them live in the other. You'll still need to run npm run build with each change to make sure those changes are compiled and then npm run dev in the app-template to pick them up.