:warning: Development has moved to the contexture monorepo: This package lives in https://github.com/smartprocure/contexture/tree/master/packages/react
contexture-react
React components for building contexture interfaces https://smartprocure.github.io/contexture-react
Installation
To install with npm:
$ npm i contexture-reactStructure & Usage
Contexture-react includes the following:
-
React components for building contexture interfaces, known simply as search components throughout our documentation
-
The GreyVest component library
-
Some pre-made themes for our search components, including a GreyVest theme
-
Utility functions for building contexture interfaces, theming, and more
-
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:
- Theming documentation
- A Live Demo using IMDB data
- Changelog
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!