Exciting news!Announcing our $4.6M Series Seed. Learn more
Socket
LoveBlogFAQ
Install
Log in

quarkify

Package Overview
Dependencies
11
Maintainers
1
Versions
76
Issues
File Explorer

Advanced tools

quarkify

An awesome lightweight React UI Component library

    3.2.2latest

Version published
Maintainers
1
Yearly downloads
15,954
increased by124.96%

Weekly downloads

Readme

Source

Logo

Quarkify

An awesome lightweight React UI Component library
Explore the docs »

View Demo · Report Bug · Request Feature

Build Status codecov contributions welcome MIT License

Table of Contents

About The Project

There are many great UI libraries for react available but almost all of them are highly customizable and full of boilerplate code, so we decided to create our own lightweight React Component library and you should give it a try.

Here's why:

  • Your time will be spent doing actual work instead of creating simple components.
  • You will not worry about consistency across your components.
  • Each component is implemented with accessibility in mind. :smile:

You may also suggest changes by forking this repo and creating a pull request or opening an issue with the tag.

Built With

Getting Started

To get a local copy up and running follow these simple example steps.

Installation

  • To add quarkify library to your project
  1. Simply run one of the commands below in your project directory.
npm install [email protected] --save

or

yarn add quarkify
  • To install storybook locally
  1. Clone the repo
git clone https://github.com/Trendyol/quarkify.git
  1. Install NPM packages
npm install

Or alternatively Yarn

yarn install
  1. Run tests
npm run test yarn run test
  1. Run storybook
npm start yarn start

Usage

To preview the live demo and see usages of the components please refer to our demo

Examples

We have several examples on our document. Here is the first one to get you started:

import Button from "quarkify/components/button" function App() { return ( <div className="App"> <Button variant={"primary"} >Hello World</Button> </div> ); }

This will render Button component with primary variant:

Button Component

As you can see, to import components into your project, you need to specify the path as

"quarkify/components/{component-name}"

Furthermore, to use Modal component:

import Button from "quarkify/components/button" import Modal from "quarkify/components/modal"; let show = false; function handleChange() { show = !show } function closeModal() { show = false } function App() { return ( <div className="App"> <Button onClick={handleChange}>Toggle Me</Button> <Modal show={show} animation={"slideInUp"}> <Modal.Header onClose={closeModal} leftIcon={"back-button"} leftIconOnClick={closeModal} > Some Title </Modal.Header> <Modal.Content> <p>Some content</p> </Modal.Content> <Modal.Actions> <Button onClick={closeModal} fluid> Ok </Button> </Modal.Actions> </Modal> </div> ); }

When button is toggled, it will render the modal as it is seen below:

Modal Component

For more examples, please refer to the documentation

Contributing

Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Please don't forget to check our commit message styles as we want to have consistency across our commit logs.

License

Distributed under the MIT License. See LICENSE for more information.

Acknowledgements

FAQs

What is quarkify?

An awesome lightweight React UI Component library

Is quarkify popular?

The npm package quarkify receives a total of 207 weekly downloads. As such, quarkify popularity was classified as not popular.

Is quarkify well maintained?

We found that quarkify demonstrated a healthy version release cadence and project activity. It has 1 open source maintainer collaborating on the project.

Last updated on 17 Feb 2022
Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc