Skip to content

immacdonald/phantom

Repository files navigation

Phantom Library

React Components, Hooks, Utilities, and Design Systems

Phantom Library Banner

The Phantom Library for React is a versatile and powerful package designed to streamline your workflow for any sort of web development project by providing a collection of cohesive, modular React components. Each component is built with flexibility in mind, allowing for easy customization using React props and modern CSS styling practices. Whether you're building a complex application or a simple interface, Phantom enables you to maintain consistency and efficiency across your projects by leveraging a well-structured design system.

For documentation and example usage please visit https://immacdonald.github.io/phantom/.

Installation

To setup and use phantom-library in any React project just follow three simple steps:

  1. Install the library:
npm install phantom-library
  1. Then, add a <StyledApp> component in the root of your component hierarchy. The StyledApp maintains the React contexts for responsive functionality as well as theming.
  2. In your index or main file for the website, import the CSS styling from the library with import 'phantom-library/styles' at the very top above any other components or stylesheets.

All done!

Overview

Components

Phantom contains dozens of components from essential building blocks like typography and buttons, to more advanced components like modals and segmented controls.

Responsive Design

Through the use of CSS variables and global React contexts it is simple and easy to develop a consistent design style for your websites. Phantom also includes integration with SASS for easily utilizing design tokens for attributes such as colors and sizes.

About

The React Phantom Component Library

Resources

Stars

Watchers

Forks

Packages

No packages published