Documentation

WELCOME

Welcome to the our documentation! We allow you to make beautiful, modern, and fast websites/applications regardless of your design experience.

A forward-thinking library of web components.

  • Works with all frameworks 🧩
  • Works with CDNs 🚛
  • Fully customizable with CSS 🎨
  • Includes a dark theme 🌛
  • Built with accessibility in mind ♿️
  • Open source 😸
Designed in India by Saurabh & Neha.

Quick Start

Get started by including production-ready CSS and JavaScript via CDN links without the need for any build steps.

  1. Create a new index.html file in your project root. Include the <meta name="viewport"> tag as well for proper responsive behavior in mobile devices.
  2. <!doctype html>
    <html lang="en">
        <head>
            <meta charset="utf-8">
            <meta name="viewport" content="width=device-width, initial-scale=1">
            <tilte>UI-Component library demo </tilte>
        </head>
        <body>
            <h1>Hello world!</h1>
        </body>
    </html>
  3. Include CSS and JS links . &Place the <link> tag in the <head></head> for our CSS, and the <script></script> tag for our JavaScript bundle before the closing </body>
  4. <!doctype html>
    <html lang="en">
        <head>
        <meta charset="utf-8">
        <meta name="viewport" content="width=device-width, initial-scale=1">
        <title>UI-Component library demo </title>
        <link href="https://ui-component-library-123.netlify.app/style/style/uiComponentLibrary.min.css" rel="stylesheet" >
    </head>
    <body>
        <h1>Hello  world!    </h1>
        <script src="https://ui-component-library-123.netlify.app/js/js/uiComponentLibrary.min.js" >  </script>
    </body>
    </html>
  5. Hello world! Open the page in your browser to see your rendered page. Now you can start building by creating your own layout, adding dozens of components, and utilizing our official examples.

How to install ?

To use all features, Just Add CDN link of CSS and JS in head tag of index.html file. After adding CDN links Just search for your UI like navbar, button, form etc in WebHelpUI components and Copy the HTML code given then add the code in your HTML file where you want to add this UI.

CDN Link

<link rel="stylesheet" href="https://ui-component-library-123.netlify.app/style/style/uiComponentLibrary.min.css">
<script src="https://ui-component-library-123.netlify.app/js/js/uiComponentLibrary.min.js"></script>

Examples: Add button in your website

  1. Add CDN Link of css and JavaScript(JS optional) in head tag
  2. <head>
        <meta charset="UTF-8">
        <meta http-equiv="X-UA-Compatible" content="IE=edge">
        <meta name="viewport" content="width=device-width, initial-scale=1.0">
        <link rel="stylesheet" href="https://ui-component-library-123.netlify.app/style/style/uiComponentLibrary.min.css ">
        <script src="https://ui-component-library-123.netlify.app/js/js/uiComponentLibrary.min.js" ></script>
        <title>Button-Preview</title>
    </head>
  3. Copy the HTML code of Button of your choice from UI components
  4. <button id="btn-primary">Primary</button>
    <button id="btn-secondary">Secondary</button>

Browsers and devices

It is supported in all Browsers and all devices.

Supported Browsers

  • Chrome
  • FireFox
  • Safari
  • Microsoft Edge
  • Opera
  • Brave
  • Both Android Browsers & Desktop Browsers

Responsiveness

A great way to create a responsive design, is to use a responsive style sheet, like uiComponentLibrary.use.css. It make it easy to develop sites that look nice at any size!

All UI which you will use from these UI components is fully responsive and changes according to the screen size.

Example:

Let's Take an Exapmle of Navbar in Desktop and Mobile

Desktop
Mobile & Tablets

Devices

We have devided all the devices into two categories based on their screen width.

  • Mobile Devices ( width < 780px )
  • Tablets ( 780px < width < 980px )
  • Desktop Devices ( width > 980px )

Progress Bar

A progress bar can be used to show a user how far along he/she is in a process.

Basic Progress Bar

A default progress bar in Ui-Component-Library looks like this:

70% Complete

To create a default progress bar, add a .progress class to a <div> element:

<div class="progress">
    <div class="progress-bar" role="progressbar" aria-valuenow="70"
    aria-valuemin="0" aria-valuemax="100" style="width:70%">
        <span class="sr-only">70% Complete</span>
    </div>
</div>

Progress Bar With Label

A progress bar with a label looks like this:

70%

Remove the .sr-only class from the progress bar to show a visible percentage:

<div class="progress">
    <div class="progress-bar" role="progressbar" aria-valuenow="70"
    aria-valuemin="0" aria-valuemax="100" style="width:70%">
        70%
    </div>
</div>

Colored Progress Bars

Contextual classes are used to provide "meaning through colors".

The contextual classes that can be used with progress bars are:

  • .progress-bar-success
  • .progress-bar-info
  • .progress-bar-warning
  • .progress-bar-danger
40% Complete (success)
50% Complete (info)
60% Complete (warning)
70% Complete (danger)

The following example shows how to create progress bars with the different contextual classes:

<div class="progress">
    <div class="progress-bar progress-bar-success" role="progressbar" aria-valuenow="40"
    aria-valuemin="0" aria-valuemax="100" style="width:40%">
        40% Complete (success)
    </div>
</div>

<div class="progress">
    <div class="progress-bar progress-bar-info" role="progressbar" aria-valuenow="50"
    aria-valuemin="0" aria-valuemax="100" style="width:50%">
        50% Complete (info)
    </div>
</div>

<div class="progress">
    <div class="progress-bar progress-bar-warning" role="progressbar" aria-valuenow="60"
    aria-valuemin="0" aria-valuemax="100" style="width:60%">
        60% Complete (warning)
    </div>
</div>

<div class="progress">
    <div class="progress-bar progress-bar-danger" role="progressbar" aria-valuenow="70"
    aria-valuemin="0" aria-valuemax="100" style="width:70%">
        70% Complete (danger)
    </div>
</div>

Striped Progress Bars

Progress bars can also be striped:

40% Complete (success)
50% Complete (info)
60% Complete (warning)
70% Complete (danger)

Add class .progress-bar-striped to add stripes to the progress bars:

<div class="progress">
    <div class="progress-bar progress-bar-success progress-bar-striped" role="progressbar"
    aria-valuenow="40" aria-valuemin="0" aria-valuemax="100" style="width:40%">
        40% Complete (success)
    </div>
</div>

<div class="progress">
    <div class="progress-bar progress-bar-info progress-bar-striped" role="progressbar"
    aria-valuenow="50" aria-valuemin="0" aria-valuemax="100" style="width:50%">
        50% Complete (info)
    </div>
</div>

<div class="progress">
    <div class="progress-bar progress-bar-warning progress-bar-striped" role="progressbar"
    aria-valuenow="60" aria-valuemin="0" aria-valuemax="100" style="width:60%">
        60% Complete (warning)
    </div>
</div>

<div class="progress">
    <div class="progress-bar progress-bar-danger progress-bar-striped" role="progressbar"
    aria-valuenow="70" aria-valuemin="0" aria-valuemax="100" style="width:70%">
        70% Complete (danger)
    </div>
</div>

Animated Progress Bar

40%

Add class .active to animate the progress bar:

<div class="progress">
    <div class="progress-bar progress-bar-striped active" role="progressbar"
    aria-valuenow="40" aria-valuemin="0" aria-valuemax="100" style="width:40%">
        40%
    </div>
</div>

Stacked Progress Bars

Progress bars can also be stacked:

Free Space
Warning
Danger

Create a stacked progress bar by placing multiple bars into the same <div class="progress"> :

<div class="progress">
    <div class="progress-bar progress-bar-success" role="progressbar" style="width:40%">
        Free Space
    </div>
    <div class="progress-bar progress-bar-warning" role="progressbar" style="width:10%">
        Warning
    </div>
    <div class="progress-bar progress-bar-danger" role="progressbar" style="width:20%">
        Danger
    </div>
</div>

Alerts

UI-component library provides an easy way to create predefined alert messages:


Success! This alert box could indicate a successful or positive action.
Info! This alert box could indicate a neutral informative change or action.
Warning! This alert box could indicate a warning that might need attention.
Danger! This alert box could indicate a dangerous or potentially negative action.

Alerts are created with the .alert class, followed by one of the four contextual classes .alert-success, .alert-info, .alert-warning or .alert-danger:

<div class="alert alert-success">
    <strong>Success!</strong> Indicates a successful or positive action.
</div>

<div class="alert alert-info">
    <strong>Info!</strong> Indicates a neutral informative change or action.
</div>

<div class="alert alert-warning">
    <strong>Warning!</strong> Indicates a warning that might need attention.
</div>

<div class="alert alert-danger">
    <strong>Danger!</strong> Indicates a dangerous or potentially negative action.
</div>

Avatars

Avatars gives good User Experience on the website, it can be used to show user/admin profile or logo in the Navbar.

UI-Component-Library provides different types of Avatars based on the size and design, you can pick any of them according to your requirement.

  1. Circular Avatars
  2. Squre Avatars

Circular Avatars

Circular Avatar can be used to show user profile or company logo. You can change the image also.

You can use this design by adding a class name "crl-avatar-box" and use any size by adding class names ".avatar-lg", "avatar-mdl1","avatar-mdl2","avatar-sml1","avatar-sml2".

You can also give custon size and style by using these class names using !important keyword

avatar
avatar
avatar
avatar
avatar
<div class="crl-avatar-box avatar-lg">
    <img src="/image/avatar-icon.jpg" alt="avatar">
</div>

<div class="crl-avatar-box avatar-mdl1">
    <img src="/image/avatar-icon.jpg" alt="avatar">
</div>

<div class="crl-avatar-box avatar-mdl2">
    <img src="/image/avatar-icon.jpg" alt="avatar">
</div>

<div class="crl-avatar-box avatar-sml1">
    <img src="/image/avatar-icon.jpg" alt="avatar">
</div>

<div class="crl-avatar-box avatar-sml2">
    <img src="/image/avatar-icon.jpg" alt="avatar">
</div>
                

Squre Avatars

Squre avatar can be used to show user profile or company logo. You can change the image also.

You can use this design by adding a class name "squre-avatar-box" and use any size by adding class names ".avatar-lg", "avatar-mdl1","avatar-mdl2","avatar-sml1","avatar-sml2".

You can also give custon size and style by using these class names using !important keyword

avatar
avatar
avatar
avatar
avatar
<div class="squre-avatar-box avatar-lg">
    <img src="/image/avatar_square.png" alt="avatar">
</div>

<div class="squre-avatar-box avatar-mdl1">
    <img src="/image/avatar_square.png" alt="avatar">
</div>

<div class="squre-avatar-box avatar-mdl2">
    <img src="/image/avatar_square.png" alt="avatar">
</div>

<div class="squre-avatar-box avatar-sml1">
    <img src="/image/avatar_square.png" alt="avatar">
</div>

<div class="squre-avatar-box avatar-sml2">
    <img src="/image/avatar_square.png" alt="avatar">
</div>
                

Badge

Badge are used to show notification or status.

UI-Component-Library provides different types of Badge based on the design, you can pick any of them according to your requirement. These alerts are :

  1. Profile Badge
  2. Heading Badge
  3. Link Badge
  4. Button Badge
  5. Positioned Badge

Profile Badge

It will show the status of Profile.

logo
logo
logo
logo
logo
<div class="badge-profile badge-profile-1">
    <img src="/image/avatar-icon.jpg" alt="logo">
</div>

<div class="badge-profile badge-profile-2">
    <img src="/image/avatar-icon.jpg" alt="logo">
</div>

<div class="badge-profile badge-profile-3">
    <img src="/image/avatar-icon.jpg" alt="logo">
</div>

<div class="badge-profile badge-profile-4">
    <img src="/image/avatar-icon.jpg" alt="logo">
</div>

<div class="badge-profile badge-profile-5">
    <img src="/image/avatar-icon.jpg" alt="logo">
</div>

Heading Badge

It will show the status of Heading on your website.

Example Heading

Example Heading

Example Heading

Example Heading

Example Heading
<div class="badge-heading badge-heading-1">
    <h1>Example Heading</h1>
</div>

<div class="badge-heading badge-heading-2">
    <h2>Example Heading</h2>
</div>

<div class="badge-heading badge-heading-3">
    <h3>Example Heading</h3>
</div>

<div class="badge-heading badge-heading-4">
    <h4>Example Heading</h4>
</div>

<div class="badge-heading badge-heading-5">
    <h5>Example Heading</h5>
</div>

It will show the status of Link on your website.

<div class="badge-link badge-link-1">
    <a href="#">This is a new link</a>
</div>
<div class="badge-link badge-link-2">
    <a href="#">This is a new link</a>
</div>
<div class="badge-link badge-link-3">
    <a href="#">This is a new link</a>
</div>
<div class="badge-link badge-link-4">
    <a href="#">This is a new link</a>
</div>
<div class="badge-link badge-link-5">
    <a href="#">This is a new link</a>
</div>

Button Badge

It will show the status of button on your website.

<button class="badge-button badge-button-1">
    Notification <span class="button-badge-text">6</span>
</button>

Positioned Badge

It will show the status of Profile or Inbox on your website.

<button class="btn btn-info badge-positioned-1">
    Inbox <span class="positioned-badge-text">99+</span>
</button>

<button class="btn btn-info badge-positioned-2">
    Profile <span class="positioned-badge-text"></span>
</button>

SnackBar

This component can be used for toast or snackbar component. Snackbar is to used show message that need user action

You can use snackbar to show notifications and error,sucess and warn messages.


UI-Component UI-Component-Library provides different types of snackbars based on the situation, you can pick any of them according to your requirement.

<!-- Success SnackBar  -->
<button class="success-warn-btn">Success</button>
<div class="success-snackbar-warning">
    Completed Successfully
</div>

<!-- Error SnackBar  -->
<button class="error-warn-btn">Error</button>
<div class="error-snackbar-warning">
    Error 404
</div>

<!-- Warning SnackBar  -->
<button class="warning-warn-btn">Warning</button>
<div class="warning-snackbar-warning">
    Warning! Accessing Wrong File
</div>