Skip to content

Latest commit

 

History

History
227 lines (142 loc) · 5.18 KB

README.md

File metadata and controls

227 lines (142 loc) · 5.18 KB

cleanUI - Component Library

Project Link: cleanUI

What is cleanUI?

clean UI is a lightweight and customizable Component Library.

This library will make it simple for devs to use and style different CSS components!

It helps you build your projects sooner

How to install cleanUI?

To use the library just copy and paste the given code in the part of the HTML. So that you can style your components by just adding class names to your HTML elements.

<link rel="stylesheet" href="https://clean-ui.netlify.app/Components/global.css" />

Features

  1. Open Source

  2. Responsive

  3. Clean code

  4. Ready to use

Following are all the components that clean UI consist of:

  1. Typography

  2. Avatars

  3. Alerts

  4. Button

  5. Badge

  6. Cards

  7. Input

  8. Image

  9. Lists

  10. Navigation

  11. Modal

  12. Toast

  13. Rating

Typography

Typography describes the creative design of the text on your web pages.

cleanUI has following types of typography styles:

  • Heading
  • Paragraph text
  • Text align
  • Extra Style
    • gray text
    • highlight
    • strikethrough
    • bold text
    • regular text
    • light text
    • small text
    • text with primary color
    • text with secondary color
    • text with tertiary color

Avatars

Avatar can be used to show user's profile picture on profile information page, on navigation bar & in blogs.

cleanUI has following types of Avatars:

  • Avatars w/ Different Sizes
  • Square Avatars
  • Text Avatar

Alerts

Alerts are used to attract user's attention for important information without interrupting the user's flow.

cleanUI has following types of Alerts:

  • Solid Alerts
  • Hollow Alerts
  • Alert w/ Button
  • Alert w/ Icons

Each alert have 5 types of alerts, they are as follows:

  • Primary Alert
  • Secondary Alert
  • Success Alert
  • Warning Alert
  • Danger Alert

Buttons

Buttons can be used to make your web page interactive to your user. You can use them to take user action.

cleanUI has following types of Buttons:

  • Solid Buttons

We have 4 types of Solid Buttons - Primary Button - Secondary Button - Success Button - Error Button

  • Outline Buttons

We have 4 types of Outline Buttons - Primary Button - Secondary Button - Success Button - Error Button

  • Button w/ Icon
  • Floating Button
  • Toggle Button

Badge

Badge can be used to show either status of the user (online, offline or DnD) or you can use it to show notification count.

cleanUI has following types of Badges:

  • Badge on Icons
  • Badge on Avatars

Cards

Cards can be proved very useful. You can use them to display content on an e-commerce app, or on a video library app. You can also use them to show user feedback in the form of text-only card on your site.

cleanUI has following types of Cards:

  • Text Only Card
  • Vertical Item Card
  • Horizontal Card
  • Text Overlay Card
  • Card with Badge
  • Card with dismiss
  • Shadow Card

Inputs

The input tag specifies an input field where the user can enter data. The input element can be displayed in several ways, depending on the type attribute like text, radio, checkbox etc. You can also disabled them by using appropriate classes.

cleanUI has following types of Inputs:

  • Form Input
  • Error Form Input
  • Radio Button
  • Checkbox

Images

The Image component allows you to place an image on your page.

cleanUI has following types of Images:

  • Responsive Images
  • Circular Image

Lists

Lists are used in various places such as navigation bar, article page etc.

cleanUI has following types of Images:

  1. Ordered Lists

We have 6 types of Ordered lists and they are as follows:

  • Numbered List I
  • Numbered List II
  • Lower Alphabet List
  • Upper Alphabet List
  • Lower Roman List
  • Upper Roman List
  1. Unordered Lists

We have 4 types of Ordered lists and they are as follows:

  • Default List
  • Default List w/ Hollow Circle Bullets
  • Default List w/ Square Bullets
  • Default List w/ No Bullets
  1. Inline Lists

  2. Reversed List

Navigation

Navigation bar is used to navigate through the web apps or websites.

Modal

Modals are pop-ups that are used to show important information to the user. They are positioned over everything else in the document and remove scroll from the page.

Toast

This component can be used for toast or snackbar component. Toast is mostly used to show feedback message.

cleanUI has following types of Images:

  • Toast w/ buttons
  • Success Toast
  • Failure Toast

Ratings

Rating components can be used as read-only badge or in reviews section to take review from user.