neumorphism-react

Neumorphism React

Neumorphism React is a React neumorphism components library designed to provide ready to use components following the neumorphism UI/UX trend.

Documentation

You will find the full documentation and examples of the component library here

! Notice that the documentation is in building state so, some things may be missing !

The library is available on npm

Library installation

Dependencies

Neumorphism React requires the installation of the @emotion/core and @emotion/styled packages:

npm install --save @emotion/core @emotion/styled

or

yarn add @emotion/core @emotion/styled

Package installation

To install the Neumorphism React package, run the following command:

npm install --save neumorphism-react

or

yarn add neumorphism-react

Contributing

The project repository is available here

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

Tech stack

• React
• styleguidist for component visualization and documentation
• emotion for component styling
• jest for testing
• eslint for code linting
• rollup for bundling

Setup and launch the project

• Clone the project:

git clone https://github.com/ZanchiTheo/neumorphism-react.git

• Install dependencies:

yarn install

• Launch the styleguidist server:

yarn start

• Access the project at localhost:6060

License

MIT