Plugins

Adding new plugins

Adding a new plugin to your Sparrow is simple. You Here are two ways you can do that.

Simple approach(without npm)

Place your new plugin in public/vendors folder. Eg: to add the Swiperjs plugin, we will download it from here, unzip it and place the swiper folder in public/vendors folder. You can now simply link the plugin files to your HTML and use them.

Using npm

Suppose we are installing the swiperjsplugin. Here are the steps:

Step 1:

run npm command for install plugin. for swiperjswe can run

 npm i swiper

Step 2:

Go to vendors.json file and give the path directory from node_modules as follow

"swiper": {
	"src": ["swiper-bundle.min.js", "swiper-bundle.min.css"],
	"dest": "swiper"
}

Here, dest refers to public/vendors/, where gulp will copy files from the swiperjs plugin. We actually use the vendors folder to store necessary plugins. And all the plugins folder name will be as we give the dest value

Step 3:

Run the following command:

gulp vendor:move

---

Built-in plugins

Anchor.js

A JavaScript utility for adding deep anchor links to existing page content. AnchorJS is lightweight, accessible, and has no dependencies.
Full Documentation

BigPicture

BigPicture is a pure javascript lightbox. It can display images, iframes, inline content and videos with optional autoplay for YouTube, Vimeo and even self hosted videos.
Implementation in theme - Full Documentation

FontAwesome 5

Get vector icons and social logos on your website with Font Awesome, the web's most popular icon set and toolkit.
Full Documentation

Google Map

Nirvana uses Google map with Snazzy Maps, with different color schemes aimed towards web designers and developers.
Implementation in theme - Full Documentation

Is.js

Micro check plugin. Check types, regexps, presence, time and more...
Full Documentation

Lodash

A modern JavaScript utility library delivering modularity, performance, & extras.
Full Documentation

Plyr

A simple HTML5 media player with custom controls and WebVTT captions.
Full Documentation

Rellax

Rellax is a buttery smooth, super lightweight (1021bytes gzipped), vanilla javascript parallax library.
Implementation in theme - Full Documentation

SmtpJs

Sent email from Javascript
Implementation in theme - Full Documentation

Swiper

Swiper is the most modern free mobile touch slider with hardware accelerated transitions and amazing native behavior. It is intended to be used in mobile websites, mobile web apps, and mobile native/hybrid apps.
Implementation in theme - Full Documentation