Back to home

Documentation

Table of contents

Introduction

Skydash Admin is a responsive HTML template that is based on the CSS framework Bootstrap 4 and it is built with Sass. Sass compiler makes it easier to code and customize. If you are unfamiliar with Bootstrap or Sass, visit their website and read through the documentation. All of Bootstrap components have been modified to fit the style of Skydash Admin and provide a consistent look throughout the template.

Before you start working with the template, we suggest you go through the pages that are bundled with the theme. Most of the template example pages contain quick tips on how to create or use a component which can be really helpful when you need to create something on the fly.

Note: We are trying our best to document how to use the template. If you think that something is missing from the documentation, please do not hesitate to tell us about it. If you have any questions or issues regarding this theme please use Envato support form on our profile or email us at support@bootstrapdash.com

Getting started

You can directly use the compiled and ready-to-use the version of the template. But in case you plan to customize the template extensively the template allows you to do so.

Within the download you'll find the following directories and files, logically grouping common assets and providing both compiled and minified variations:

Note: The root folder denoted further in this documentation refers to the 'template' folder inside the downloaded folder

Installation

You need to install package files/Dependencies for this project if you want to customize it. To do this, you must have node and npm installed in your computer.

Installation guide of the node can be found here. As npm comes bundled with a node, a separate installation of npm is not needed.

If you have installed them, just go to the root folder and run the following command in your command prompt or terminal (for the mac users).

This will install the dev dependencies in the local node_modules folder in your root directory.

Then you will need to install Gulp. We use the Gulp task manager for the development processes. Gulp will watch for changes to the SCSS files and automatically compile the files to CSS.

Getting started with Gulp is pretty simple. The Gulp site is a great place to get information on installing Gulp if you need more information. You need to first install Gulp-cli in your machine using the below command.

This installs Gulp-cli globally to your machine. The other thing that Gulp requires, which, is really what does all the work, is the gulpfile.js. In this file, you set up all of your tasks that you will run.

Don't worry. We have this file already created for you!

To run this project in development mode enter the following command below. This will start the file watch by gulp and whenever a file is modified, the SCSS files will be compiled to create the CSS file.

Basic structure

The below snippet shows the basic HTML structure of Skydash Admin. Please note that all the stylesheets and script files in the below snippet should be included to render Skydash Admin styles.

This section contains code of default vertical layout. For other layouts in vertical mode like boxed, icon-menu etc., you can follow the snippet same as below, but you have to just add the appropriate optional class to the body. More details of the classes are given in Options section

Components

Basic UI Elements

Button with the single color
Outlined
Sizes
Bootstrap Dropdown
Action Another action Something else here
Separated link
Action Another action Something else here
Separated link
Action Another action Something else here
Separated link
Action Another action Something else here
Separated link
Action Another action Something else here
Separated link
Dropdown Outlined
Action Another action Something else here
Separated link
Action Another action Something else here
Separated link
Action Another action Something else here
Separated link
Action Another action Something else here
Separated link
Action Another action Something else here
Separated link

Advanced UI Elements

Clipboard, a modern approach to copy text to the clipboard.

Usage

Add the following script files in <body>.

To create a clipboard, add the following code:

Todolist is a minimal jQuery plugin to create checklist.

Usage

Add the following script files in <body>.

To create a filterable list, add the following code:

Dragula ,Drag and drop so simple it hurts.

Usage

To use Dragula in your application, include the following files in <head>.

Add the following script files in <body>.

To create a drag n drop list, add the following code:

The contextMenu Plugin was designed for web applications in need of menus on a possibly large amount of objects. Click Here to see the official documentation.

noUiSlider is a range slider without bloat.

Usage

To use NoUISlider in your application, include the following files in <head>.

Add the following script files in <body>.

To create a slider, add the following code:

Easy, flexible and responsive range slider with skin support. Click Here to see the official documentation.

Colcade is a simple lightweight masonry layout.

Usage

Add the following script files in <body>.

To create a responsive, add the following code:

Media

Light Gallery is a customizable, modular, responsive, Lightbox gallery plugin for jQuery.

Usage

To use LightGallery in your application, include the following files in <head>.

Add the following script files in <body>.

To create Lightbox Gallery, add the following code:

Owl Carousel is a touch enabled jQuery plugin that lets you create a beautiful responsive carousel slider.

Usage

To use Owl Carousel in your application, include the following files in <head>.

Add the following script files in <body>.

To create a carousel, add the following code:

Tables

To create a basic Twitter Bootstrap table, add the following code.

Charts

Chart.js is a simple yet flexible JavaScript charting for designers & developers.

Usage

To use Chart.js in your application, include the following files in <head>.

and the following script files in <body>.

To create a simple chart, add the following code:

Forms

The basic form elements can be added to your application as below:

Icons

Material Design Icons growing icon collection allows designers and developers targeting various platforms to download icons in the format, color and size they need for any project.

Usage

To use Material Design Icons in your application, include the following files in <head>.

To generate an icon, add the following code:

Credits

We have used the following plugins in Skydash admin