Welcome to memphis ui

An opinionated React JSX component library to do the heavy liftings for you

All the components here have been designed from scratch with minimal dependency with other libraries. Notable libraries used in this project are:

• Material Icons

Installation

There are two installations available.

1. Package only installation from NPM (to be used in your projects) ==> See [Installation 1]
2. Entire library including storybook (for development purposes only) ==> See [Installation 2]

Installation 1 - via npm

npm add memphis-uix
Copy

Or

npm install --save memphis-uix@latest
Copy

Installation 2 - Entire project

This project is initiated using the create-react-library starter boilerplate. This was for easy library publishing to NPM. Afterwards, storybook was installed on top in order to visualize and test the components.

In order to clone the project, please visit memphis ui Github Repo. Clone the project in your local machine and follow the following steps:

1. Checkout develop branch if you're in master. (It usually has the latest commits).
2. cd into root directory if you haven't.
3. Run these commands:

npm install

npm run storybook

npm start
Copy

4. On a new terminal, cd into the example folder and also do the following:

npm install

npm start
Copy

Usage

Example

import React from 'react'
import { Card, Button } from 'memphis-uix'

const App = () => (
  <Button variant='primary'>
    How's it going!{' '}
    <span role='img' aria-label='smily'>
      😄
    </span>
  </Button>
)
Copy

To see all the available props visit the Buttons story page

NPM Homepage Link

Presets for popular toolsEasy setup for TypeScript, SCSS and more.Build configurationHow to customize webpack and BabelStylingHow to load and configure CSS librariesDataProviders and mocking for data libraries

Storybook documentationConfigure, customize, and extendIn-depth guidesBest practices from leading teamsGitHub projectView the source and add issuesDiscord chatChat with maintainers and the community