Skip to content

davikiyo/simple-ui-components

Repository files navigation

Simple UI Components Library

npm latest package CircleCI codecov

React components library 🚀 for webpages.

Installation

npm:

npm install @davikiyo/simple-ui-components

yarn:

yarn add @davikiyo/simple-ui-components

Components

The available components are as follows:

  • Alert
  • AppBar
  • Card
  • Drawer
  • Grid
  • Icons
    • Icon
    • IconSprite
  • Lists
    • List
    • ListItem
  • Modal
  • Pagination
  • Tab
  • Table
  • UI
    • Button
    • Checkbox
    • IconButton
    • MenuButton
    • Switch
    • Textbox

Icons

Icon component depends on IconSprite to display the icons. Add IconSprite at the top level of your app. (Only once)

// index.jsx or App.jsx
import React from 'react'
import ReactDOM from 'react-dom/client'
import { IconSprite } from '@davikiyo/simple-ui-components'
import App from './App'
import './index.css'

ReactDOM.createRoot(document.getElementById('root')).render(
  <React.StrictMode>
    <IconSprite />
    <App />
  </React.StrictMode>
)

Demo

Available components can be checked by running Storybook.

Prerequisites

You're going to need:

  • Node.js >= 16.0.0.
  • Yarn — npm might not work.

Setting up

  1. Fork this repository on GitHub.
  2. Clone your forked repository with git clone https://github.com/YOURNAME/simple-ui-components.git
  3. Install dependencies with yarn install.
  4. Run Storybook with yarn dev — you should be able to see Storybook running at http://localhost:6006.