Bracket Plus Documentation v1.4

Thank you so much for purchasing our theme. If you have any questions that are beyond the scope of this help file, please feel free to email us at themepixels@gmail.com or send us a help request here. Thanks so much!

Introduction

Bracket Plus, a premium dashboard and app template using flat and minimal design. It is fully responsive built with Bootstrap 4 using SASS preprocessor, HTML5, CSS3 and jQuery plugins. It includes a huge collection of reusable UI components using a very reusable style classes that increases the speed of page time load. It can be used for most type of dashboard and app templates nowadays like analytics, admin or messenger app for your desktpo or mobile applications. Amazing flexibility and reusability. See the demo.

Getting Started

This part of the doc will help you to quick start your project and will give you a basic idea about how bracket plus work. For you to get start open the "themes" folder in templates/ of your download package.

What's In The Box

Once you have download the package you will see the following folder structure inside templates/ folder.

The Tool

Once you have download the package you will see files that you might not familiar along with the folders listed above.

Note: If you are still unsure of what's the use of this files, you may want to proceed to the next topic:

• NodeJS
• Bower
• Grunt

NodeJS

Before installing bower and grunt first you must have NodeJs installed, NodeJS will have npm (node packaged modules).

Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine. Node.js uses an event-driven, non-blocking I/O model that makes it lightweight and efficient. Node.js' package ecosystem, npm, is the largest ecosystem of open source libraries in the world.

Installing in Mac

Simply download the Macintosh Installer direct from the nodejs.org web site.

If you want to download the package with bash:

curl "https://nodejs.org/dist/latest/node-${VERSION:-$(wget -qO- https://nodejs.org/dist/latest/ | sed -nE 's|.*>node-(.*)\.pkg.*|\1|p')}.pkg" > "$HOME/Downloads/node-latest.pkg" && sudo installer -store -pkg "$HOME/Downloads/node-latest.pkg" -target "/"

Using Homebrew:

brew install node

Installing in Windows

Simply download the Windows Installer direct from the nodejs.org web site.

Gulp JS

Before installing gulp first you must have NodeJs installed, NodeJS will have npm (node packaged modules).

Gulp is a toolkit for automating painful or time-consuming tasks in your development workflow, so you can stop messing around and build something.

Installing the CLI

If you have previously installed a version of gulp globally, please run npm rm --global gulp to make sure your old version doesn't collide with gulp-cli.

$ npm install -g gulp-cli

Verify that gulp is successfully installed, and version of installed gulp will appear.

$ gulp --version

SASS

Before running grunt first you must check if you have sass installed in your machine. You can verify that sass is already installed by running the command.

$ sass --version

If version appear, it means sass already installed in your machine and proceed to the next topic, otherwise follow the instructions below on installing sass.

Installing SASS

Windows

Before you start using Sass you will need to install Ruby. The fastest way to get Ruby on your Windows computer is to use Ruby Installer. It's a single-click installer that will get everything set up for you super fast.

Mac

If you prefer the command line over an application then getting Sass set up is a fairly quick process. Sass has a Ruby dependency but if you're using a Mac, congratulations, Ruby comes pre-installed.

Install SASS

Ruby uses Gems to manage its various packages of code like Sass. In your open terminal or cmd window:

$ gem install sass

You should now have Sass installed, but it never hurts to double-check.

$ sass --version

Running Bracket Plus

You're moments away to see the bracket plus dashboard template up and running in your local machine. First, go to the root folder where the package.json located. In your download package it should be in the root folder. Please run the following command below.

Note: Running bracket plus to you local machine is not a requirements for you to see the template. You can directly browse to the template folder and choose any html file you want to open by opening it directly to the browser.

$ npm install

This will download all dependencies defined in package.json file. Once it finished running the command, it will generate a folder name node_modules/ where you see downloaded files.Next, run another command below

$ gulp npm-lib

This will extract all dependencies defined in package.json file. Once it finished running the command, it will generate a folder name lib/ where you see extracted files.

Running in Browser

Now you're good to go in running the template and preview it in browser by running the command below.

$ gulp serve

The template is now up and running in your browser. Feel free to visit each page and familiarize the flow of it.

Stylesheet

We use SASS in creating styles in this template logically grouping into sections. Below are the structure of sass files and folders

Bootstrap

All of the files organized into a name of element are override styles of Bootstrap core framework styles. It is overriden for performance and design quality improvement purposes.

To learn more about Bootstrap, visit their site at https://v4-alpha.getbootstrap.com/

Plugins

All files organized into a name of plugin are override styles from some of the plugins used in this template and can be found in lib/ folder. It is also overriden for performance and design quality improvement purposes.

Utilities

Utilities classes are very reusable classes with a single purpose to reduce the frequency of highly repetitive declarations.

Note: Below are some of the classes that we think are more reusable. If you did not find any classes on the list be sure to check the scss files under scss/utilities/ folder if there are any existing classes you need before you can create a new style.

Background Color

Borders

Height

Width

Margins

Padding

Position

Typography

If you have any questions that are beyond the scope of this class reference, please feel free to email us at themepixels@gmail.com. Thanks so much!

HTML Structure

Header Panel

Below is the html structure of the header of Bracket plus admin template that includes navicon menu for mobile and non-mobile display. Some of the class found in header are explained below.

<div class="br-header">
  <div class="br-header-left">
    <div class="navicon-left hidden-md-down"><a id="btnLeftMenu" href=""><i class="icon ion-navicon-round"></i></a></div>
    <div class="navicon-left hidden-lg-up"><a id="btnLeftMenuMobile" href=""><i class="icon ion-navicon-round"></i></a></div>
    <div class="input-group hidden-xs-down wd-170 transition">
      <input id="searchbox" type="text" class="form-control" placeholder="Search">
      <span class="input-group-btn">
        <button class="btn btn-secondary" type="button"><i class="fa fa-search"></i></button>
      </span>
    </div><!-- input-group -->
  </div><!-- br-header-left -->
  <div class="br-header-right">
    <nav>...</nav>
    <div class="navicon-right">
      <a id="btnRightMenu" href="" class="pos-relative">
        <i class="icon ion-ios-chatboxes-outline"></i>
        <!-- start: if statement -->
        <span class="square-8 bg-danger pos-absolute t-10 r--5 rounded-circle"></span>
        <!-- end: if statement -->
      </a>
    </div><!-- navicon-right -->
  </div><!-- br-header-right -->
</div><!-- br-header -->

Left Sidebar

Below is the html structure of the left sidebar of Bracket plus admin template that includes menu and icon menu. Some of the class found in left sidebar are explained below.

<!-- ########## START: LEFT PANEL ########## -->
<div class="br-logo"><a href=""><span>[</span>bracket <i>plus</i><span>]</span></a></div>
<div class="br-sideleft overflow-y-auto">
  <label class="sidebar-label pd-x-10 mg-t-20 op-3">Navigation</label>
  <ul class="br-sideleft-menu">
    <li class="br-menu-item">
      <a href="index.html" class="br-menu-link">
        <i class="menu-item-icon icon ion-ios-home-outline tx-24"></i>
        <span class="menu-item-label">Dashboard</span>
      </a><!-- br-menu-link -->
    </li><!-- br-menu-item -->
    <li class="br-menu-item">
      <a href="#" class="br-menu-link with-sub">
        <i class="menu-item-icon icon ion-ios-photos-outline tx-20"></i>
        <span class="menu-item-label">Cards &amp; Widgets</span>
      </a><!-- br-menu-link -->
      <ul class="br-menu-sub">
        <li class="sub-item"><a href="card-dashboard.html" class="sub-link">Dashboard</a></li>
        <li class="sub-item"><a href="card-social.html" class="sub-link">Blog &amp; Social Media</a></li>
        <li class="sub-item"><a href="card-listing.html" class="sub-link">Shop &amp; Listing</a></li>
      </ul>
    </li>
    ...
  </ul><!-- br-sideleft-menu -->

  ...

</div><!-- br-sideleft -->
<!-- ########## END: LEFT PANEL ########## -->

Right Sidebar

Below is the html structure of the right sidebar of Bracket plus admin template that includes a list of users and files, dates and some settings. Some of the class found in right sidebar are explained below.

<div class="br-sideright">
  <ul class="nav nav-tabs sidebar-tabs" role="tablist">...</ul>
  <div class="tab-content">
    <div class="tab-pane">...</div>
    ...
  </div><!-- tab-content -->
</div><!-- br-sideright -->

Main Panel

Below is the html structure of the main panel of Bracket plus admin template that wraps the contents of the page.

<div class="br-mainpanel">
  <div class="br-pageheader">
    <nav class="breadcrumb pd-0 mg-0 tx-12">
      <a class="breadcrumb-item" href="index.html">Bracket</a>
      <a class="breadcrumb-item" href="#">Menu</a>
      <span class="breadcrumb-item active">Sub Menu</span>
    </nav>
  </div><!-- br-pageheader -->
  <div class="br-pagetitle">
    <i class="icon ion-ios-filing-outline"></i>
    <div>
      <h4>Page Title</h4>
      <p class="mg-b-0">Page description.</p>
    </div>
  </div><!-- d-flex -->

  <div class="br-pagebody">
    <!-- this is where your contents will be added -->
  </div><!-- br-pagebody -->

</div><!-- br-mainpanel -->

Elements

The HTML Markup of alerts, buttons, etc. are explained in the live preview of this template. Feel free to use it in your page. Any components that are beyond of this template, may submit a request and suggestion to our email at themepixels@gmail.com

Javascipt

Collapsed (Icon) Menu

The collapsed menu is the left sidebar menu being collapsed and showing only the icons after clicking the navicon menu on left side of the header of the template.

<a id="btnLeftMenu" href=""><i class="icon ion-navicon-round"></i></a>

// This will collapsed sidebar menu on left into a mini icon menu
$('#btnLeftMenu').on('click', function(){
  var menuText = $('.menu-item-label,.menu-item-arrow');

  if($('body').hasClass('collapsed-menu')) {
    $('body').removeClass('collapsed-menu');

    // show current sub menu when reverting back from collapsed menu
    $('.show-sub + .br-menu-sub').slideDown();

    $('.br-sideleft').one('transitionend', function(e) {
      menuText.removeClass('op-lg-0-force');
      menuText.removeClass('d-lg-none');
    });

  } else {
    $('body').addClass('collapsed-menu');

    // hide toggled sub menu
    $('.show-sub + .br-menu-sub').slideUp();

    menuText.addClass('op-lg-0-force');
    $('.br-sideleft').one('transitionend', function(e) {
      menuText.addClass('d-lg-none');
    });
  }
  return false;
});

Expand Menu

The expand menu is the left sidebar menu being expanded from collapsed showing not only just the icon but also its label when the left sidebar is hovered.

// This will expand the icon menu when mouse cursor points anywhere
// inside the sidebar menu on left. This will only trigget to left sidebar
// when it's in collapsed mode (the icon only menu)
$(document).on('mouseover', function(e){
  e.stopPropagation();

  if($('body').hasClass('collapsed-menu') && $('#btnLeftMenu').is(':visible')) {
    var targ = $(e.target).closest('.br-sideleft').length;
    if(targ) {
      $('body').addClass('expand-menu');

      // show current shown sub menu that was hidden from collapsed
      $('.show-sub + .br-menu-sub').slideDown();

      var menuText = $('.menu-item-label,.menu-item-arrow');
      menuText.removeClass('d-lg-none');
      menuText.removeClass('op-lg-0-force');

    } else {
      $('body').removeClass('expand-menu');

      // hide current shown menu
      $('.show-sub + .br-menu-sub').slideUp();

      var menuText = $('.menu-item-label,.menu-item-arrow');
      menuText.addClass('op-lg-0-force');
      menuText.addClass('d-lg-none');
    }
  }
});

Showing of Sub Menu

The sub menu are hidden by default and can only be shown when its parent menu is active or clicked. If the parent menu is active during page load, its sub menu will also displayed.

// This will auto show sub menu using the slideDown()
// when top level menu have a class of .show-sub
$('.show-sub + .br-menu-sub').slideDown();

// This will show sub navigation menu on left sidebar
// only when that top level menu have a sub menu on it.
$('.br-menu-link').on('click', function(){
  var nextElem = $(this).next();
  var thisLink = $(this);

  if(nextElem.hasClass('br-menu-sub')) {

    if(nextElem.is(':visible')) {
      thisLink.removeClass('show-sub');
      nextElem.slideUp();
    } else {
      $('.br-menu-link').each(function(){
        $(this).removeClass('show-sub');
      });

      $('.br-menu-sub').each(function(){
        $(this).slideUp();
      });

      thisLink.addClass('show-sub');
      nextElem.slideDown();
    }
    return false;
  }
});

Show Left Sidebar

The left sidebar is hidden when using smaller screen devices and shows up only when user click on the left navicon of the header. When clicked, the content will be pushed to the right along with the left sidebar that slides from the left to the right.

// This will trigger only when viewed in small devices
// #btnLeftMenuMobile element is hidden in desktop but
// visible in mobile. When clicked the left sidebar menu
// will appear pushing the main content.
$('#btnLeftMenuMobile').on('click', function(){
  $('body').addClass('show-left');
  return false;
});

Show Right Sidebar

The right sidebar is hidden all the time and will only show up when user clicked on the icon located on the right side of the header of the template. The right sidebar consists of 4 tabs that will switch you between their contents.

// This is the right menu icon when it's clicked, the
// right sidebar will appear that contains the four tab menu
$('#btnRightMenu').on('click', function(){
  $('body').addClass('show-right');
  return false;
});

Hiding Sidebar

There is no menu that will let you hide both the left and right sidebar. For you to hide it you only need to click anywhere outside of it. This is applicable for both left sidebar and right sidebar.

// This will hide sidebar when it's clicked outside of it
$(document).on('click', function(e){
  e.stopPropagation();

  // closing left sidebar
  if($('body').hasClass('show-left')) {
    var targ = $(e.target).closest('.br-sideleft').length;
    if(!targ) {
      $('body').removeClass('show-left');
    }
  }

  // closing right sidebar
  if($('body').hasClass('show-right')) {
    var targ = $(e.target).closest('.br-sideright').length;
    if(!targ) {
      $('body').removeClass('show-right');
    }
  }
});

Popover

By default, Bootstrap doesn't auto close popover after appearing in the page resulting other popover overlap each other. By adding the code below it will auto dismiss a popover when clicking anywhere outside of it.

$(document).on('click', function (e) {
  $('[data-toggle="popover"],[data-original-title]').each(function () {
      //the 'is' for buttons that trigger popups
      //the 'has' for icons within a button that triggers a popup
      if (!$(this).is(e.target) && $(this).has(e.target).length === 0 && $('.popover').has(e.target).length === 0) {
          (($(this).popover('hide').data('bs.popover')||{}).inState||{}).click = false  // fix for BS 3.3.6
      }
  });
});

Known Issue

• Not displaying font icons in opening the html files directly in a browser.

  A page loaded from a file:// URI, only files in (or below) the same directory of the filesystem are considered to be "same origin", and so putting the font in a different subtree (../font/) means it will be blocked by security policy restrictions. Most browser disables cross-domain fonts "by default. By fixing this, you need to put the file in a remote or local server. Anyway, that what where we're going.

Changelog

v.14

• New: Chat Page (supports RTL and available in all skins).
• New: Using npm as dependency manager (switching from Bower).
• New: Switch from Gruntfile to Gulp.
• New: Toggle switch button in sidebar right for settings tab using only css.
• New: Toggle switch button for form elements using only css.
• New: Image cropper plugin (Cropper.js).
• Updated: version of Bootstrap to latest (4.1.3).
• Updated: version of FontAwesome to latest using free (5.5.0).
• Updated: latest version of Perfect Scrollbar (new syntax).
• Updated: search bar syntax and style in left header.
• Fixed: some utilities classes for dark.
• Fixed: input group color skin for dark.
• Deprecated: Bower (switch using npm).
• Deprecated: jQuery switchButton dependency.
• Deprecated: Jcrop (replaced with Cropper.js)

v1.3

• Added: Invoice Page
• Added: Dark Skin (with RTL support)
• Updated: Dropdown html structure in header panel.
• Updated: Contact list html structure in right sidebar.
• Updated: Page title and section title html structure in main panel.

v1.3

• Added: Invoice Page
• Added: Dark Skin (with RTL support)
• Updated: Dropdown html structure in header panel.
• Updated: Contact list html structure in right sidebar.
• Updated: Page title and section title html structure in main panel.

v1.1

• Added: New skin (Oreo)
• Added: RTL Support for simple-white skin
• Added: Profile Page.
• Added: Profile Page RTL.
• Added: Compose Message in Mailbox.
• Updated: Adding a separate css files for skins.
• Updated: Restructuring markup of left sidebar menu using <ul>.
• Updated: Replace sidebar skins into template skins.

v1.0

• Initial Release

References

Customer Support

You can request for support via email or themeforest item comments or request help form here

We will assist you any problem you encounter while buidling your dashboard via Bracket plus template

Email: themepixels@gmail.com

We use request help form found here, in comments and email to manage customer support. Soon, as we grow, we will invest and find the best customer support system we can use to serve you better. For the meantime, submit a help request to the link given for any issues and concerns that you have. Don't worry, we will respond to you as quickly as we can. Thank you.