# memphis-uix

> A UI Component Library for React Web Apps!

Latest version **0.0.2-a** (published 2020-09-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install memphis-uix
pnpm add memphis-uix
yarn add memphis-uix
bun add memphis-uix
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2-a |
| Published | 2020-09-15 |
| First published | 2020-09-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >=10 |
| Dependencies | 3 |
| Unpacked size | 251.9 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 2 |
| Author | ahamedzoha |
| Maintainers | flamingoscooter |
| Keywords | react ui, react multiselect, dropdowns |

## Links

- npm: https://www.npmjs.com/package/memphis-uix
- Repository: https://github.com/ahamedzoha/memphis-ui
- Homepage: https://memphis-ui.netlify.app/
- Issues: https://github.com/ahamedzoha/memphis-ui/issues
- npm.io page: https://npm.io/package/memphis-uix

## Dependencies (3)

- [node-sass](https://npm.io/package/node-sass.md) ^4.14.1
- [react-docgen](https://npm.io/package/react-docgen.md) ^5.3.0
- [styled-components](https://npm.io/package/styled-components.md) ^5.2.0

## Recent versions

- 0.0.2-a (latest) — 2020-09-15
- 0.0.2-b — 2020-09-15
- 0.0.1-a — 2020-09-11
- 0.0.1 — 2020-09-10

## README

![Memphis UI Logo](/src/stories/assets/logo.png)

# Welcome to memphis ui

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

[![NPM](https://img.shields.io/npm/v/memphis-uix.svg)](https://www.npmjs.com/package/memphis-uix) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

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]

<br />

### Installation 1 - via npm

---

```
npm add memphis-uix
```

Or

```
npm install --save memphis-uix@latest
```

<br />

### 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.

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:

```bash
npm install

npm run storybook

npm start
```

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

```bash
npm install

npm start
```

## Usage

**Visit [memphis ui storybook](https://memphis-ui.netlify.app/) to get an in-depth walkthrough on using the components**

Example

```jsx
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>
)
```

_To see all the available props visit the Buttons story page_

#### NPM Homepage [Link](https://www.npmjs.com/package/memphis-uix)

## License

MIT © [ahamedzoha](https://github.com/ahamedzoha)

---
_Source: https://npm.io/package/memphis-uix · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._