README.md

A lightweight, accessible and responsive react component library for your next project.

SwiftlyUI (In development)

A lightweight, accessible and responsive react component library for your next project.

Installation

npm:

npm install swiftlyui

yarn:

yarn add swiftlyui

Getting started with SwiftlyUI

index.css Needs to be imported in your project for swiftlyUI's styles to be applied to each of the components. index.css needs to be imported once in the project, it is recommended that swiftlyui/index.css is imported at the base of your project.

import React from 'react';
import { Button } from 'swiftlyui'
import 'swiftlyui/index.css'

function App(){
  return (
    <Button 
      className="swiftlyButton" 
      buttonColor="#fff" 
      contentColor="#123" 
      onClick={() => console.log('clicked')}
    >
      Click me!
    </Button>)
}

Documentation

Docs Hosting

Online Hosting

Running documents locally

We use storybook for local docs!

yarn storybook

Roadmap

Future plans for the library are to fill Swiftly-UI with more accessible components that help developers build out their projects more quickly

License

This project is licensed under the terms of the MIT License