/contexture-react

React components for building contexture interfaces

Primary LanguageJavaScriptMIT LicenseMIT

contexture-react

React components for building contexture interfaces https://smartprocure.github.io/contexture-react

CircleCI npm version dependencies Storybook

Installation

To install with npm:

$ npm i contexture-react

Structure & Usage

Contexture-react includes the following:

  1. React components for building contexture interfaces, known simply as search components throughout our documentation

  2. The GreyVest component library

  3. Some pre-made themes for our search components, including a GreyVest theme

  4. Utility functions for building contexture interfaces, theming, and more

  5. Storybook stories for documenting and testing our components

Here is a quick guide to the directory structure:

Folder Description
src/exampleTypes Contains React components for the set of example node types included in contexture-client. Exported as exampleTypes.
src/greyVest Contains the Grey Vest component library, which is exported as greyVest and consists of basic React components. Used by the Grey Vest theme.
src/themes Contains the Grey Vest, Blueberry, Material, and base themes, hopefully with more soon to come. Exported as themes.
src/purgatory Neither search components nor library components -- they just have nowhere else to go.
everything else

Documentation

Documentation lives in our Storybook. Stories of interest include:

Notes on this repository

This project was scaffolded generally following this link: https://medium.com/@efreyreg/create-react-component-libraries-with-storybook-and-styled-jsx-8999f423f06b

Cross Browser Testing

Cross browser testing is done using BrowserStack thanks to their awesome support for open source projects!

BrowserStack