JavaScript

Learn more about Sneat's core js and usage of third-party plugins.


Folder structure

Below is the folder structure which contain the JS/ES6 files.

📦
├── 📂 js                                   > Template core JS(ES6) folder
│   ├── 📂 _template-customizer               > Contains template customizer markup & styles
│   ├── 📄 bootstrap.js                       > Extends bootstrap JS from node_modules/
│   ├── 📄 dropdown-hover.js                  > Add onHover event for bootstrap dropdowns
│   ├── 📄 helpers.js                         > Contains reusable helper functions
│   ├── 📄 mega-dropdown.js                   > Mega menu JS
│   ├── 📄 menu.js                            > Core menu JS (vertical & horizontal)
│   └── 📄 template-customizer.js             > Customizer Plugin JS
│
├── 📂 assets                               > Templates assets
│   └── 📂 js                                 > Contains main, config, pages, apps and third-party plugins JS
│       ├── 📄 main.js                        > Initialize the template core components, plugins and contain common JS.
│       ├── 📄 config.js                      > Contains JS global variables and TemplateCustomizer settings
│       └── ...
│
├── 📂 libs                                 > Third-party libraries(plugins)
│   ├── 📂 datatables                         > DataTables plugins JS extends from node_modules
│   │   └── 📄 jquery.dataTables.js
│   └── ...
│
├── 📄 build-config.js                      > Template build config file
├── 📄 gulpfile.js                          > Gulpfile
└── ...
  • js/ Folder contains template core JS (ES6) files. Sneat uses Webpack to transpile those files and generate js in assets/vendor/js/ folder. Read more. It is not recommend to make any changes in this folder.
    • bootstrap.js File extend core bootstrap js from node_modules. You can also import required only plugins of bootstrap.
    • helpers.js File contains reusable helper functions. Read more
    • menu.js Core menu JS file, contain vertical & horizontal menu (navigation) code.
    • template-customizer.js Template Customizer Plugin JS file. Read more
  • assets/js Folder contains template static JavaScript files of each pages, apps and third-party plugins usage. If you modify any JavaScript files from this folder, make sure you keep an eye on those you edited changes as it will be constantly updated and you need to merge those changes manually.
    • main.js This the main file which initialize the template core components, plugins and contain common JS.
    • config.js Contains JS global variables and TemplateCustomizer settings which are used in this templates. Read more
  • libs/ Folder also contains third-party libraries (plugins) JavaScript files which is extended from node_modules/. You can easily add/remover plugins as per your choice. For more details refer Third Party Plugin Guide.

Customizing JS

Sneat provide almost all possible options to customize it easily using config.js file. Apart from that it also provides useful helper methods to customize it easily.

You can also modify any pages, apps or third-party plugin JavaScript files from assets/js folder. Just make sure you keep an eye on those you edited changes as it will be constantly updated and you need to merge those changes manually.

Where should I write my custom JavaScrip?

To avoid file loss, overrides of your custom JavaScript or any other conflicts during the upgrade process, create your custom javascript file assets/js/scripts.js. Just don't forget to include it in your HTML file.


Methods

Helpers

Useful JavaScript helpers methods to customize Sneat easily. For example, To use helpers methods, Open browser developer tool and in console tab run Helpers.isRtl()

Method Description
isLightStyle() Returns true if the current style is light, else returns false.
isDarkStyle() Returns true if the current style is dark, else returns false.
isRtl() Returns true if the current layout is in RTL direction, else returns false.
isCollapsed() Returns true if the current layout is collapsed, else returns false.
isFixed() Returns true if the current layout is fixed, else returns false.
isNavbarFixed() Returns true if the Navbar is fixed, else returns false.
isFooterFixed() Returns true if the Footer is fixed, else returns false.
setCollapsed() Set to true to collapsed vertical menu, false to expand it. For example, setCollapsed(true)
toggleCollapsed() Set to true to collapsed vertical menu, false to expand it.
isSmallScreen() Returns true if the window width is less than 1200px, else returns false.
isMobileDevice() Returns true if the current devices is mobile, else returns false.

Customizer

Useful customizer JavaScript helper methods to customize Sneat easily. For example, To use customizer helper methods, Open browser developer tool and in console tab run templateCustomizer.setRtl(true)

Method Description
setRtl() Set to true to enable RTL direction (mode), false to disable it.
setStyle() Set the current style light/dark. Accepts the following values:
  • 'light'
  • 'dark'
setTheme() Set the current theme. Accepts the following values:
  • 'theme-default'
  • 'theme-semi-dark'
  • 'theme-bordered'
setLayoutType() Set the current layout type static/fixed. Accepts the following values:
  • 'static'
  • 'fixed'
setLayoutNavbarFixed() Set to true to make layout navbar fixed, false to make it static.
setLayoutFooterFixed() Set to true to make layout footer fixed, false to make it static.
setLang() Set current language. The value must be in the TemplateCustomizer.LANGUAGES, otherwise an error will be thrown. Read more
update() Update customizer settings panel.
clearLocalStorage() Clear localStorage.
destroy() Destroy TemplateCustomizer instance.

FAQs

Can I remove jQuery?

Yes. Before you remove it, confirm the following important points.

  • Many third-party plugins (For example, Select2, Block UI, jQuery-idletimer, Typeahead etc..) are still using jQuery and they are very useful. Due to that we can't remove it. But if you are not using those libraries you can remove jQuery.
  • The navbar search functionality also depends on jQuery plugin (Typeahead), it will stop working if you remove jQuery.

If you are fine with the above points, then proceed with removing jquery.js from HTML.
Also, remove jQuery plugin usage from main.js. Search for the Removed following code if you do't wish to use jQuery and remove the code.

How can I use Translation (Internationalization)?

Sneat Use i18next as internationalization-framework. For demo purposes in this template, we're just translating the menu (navigation), but you can use translation anyware in this template.

  1. Add/update language option to the navbar dropdown easily.
    To add the Arabic language, refer the following code. Don't forget to set language to data-language attribute. This template use Flag Icons flag library, use any country flag icon from it.
    <li>
      <a class="dropdown-item" href="javascript:void(0);" data-language="ae">
        <i class="fi fi-ae me-1"></i>
        <span class="align-middle">Arebic</span>
      </a>
    </li>
  2. assets/json/locales/ folder contain different languages translation files. It contains Key, Value pairs for each word to translate. You can add more Key, Value pairs or create a new language file.
  3. Also, add that Key to data-i18n attribute to HTML tag. For example, <span data-i18n="Apple">Apple</span>
  4. Search for the Internationalization section in main.js. It contains the following code.
    if (typeof i18next !== 'undefined' && typeof i18nextXHRBackend !== 'undefined') {
          i18next
            .use(i18nextXHRBackend)
            .init({
              lng: 'ae',
              debug: false,
              fallbackLng: 'en',
              backend: {
                loadPath: assetsPath + 'json/locales/.json'
              },
              returnObjects: true
            })
            .then(function (t) {
              localize();
            });
        }
    • lang: use this parameter to set default language For example, 'ae'. If the default translation language file is not available then it will use fallbackLng automatically.
    • loadPath: Set the language JSON file path.
© 2017- ThemeSelection, Hand-crafted & Made with ❤️