Skip to content

Latest commit

 

History

History
33 lines (29 loc) · 1.13 KB

README.md

File metadata and controls

33 lines (29 loc) · 1.13 KB

KBD Iso

A class-based generator for differing Isotope filtering options

Install

npm i kbd-iso

Usage

Iso = require 'kbd-iso'
sort = new Iso
	container: 'iso'
	items: 'iso__item'
	filters: 'iso__filter'
	gutter: 16
	filterType: 'simple'

sort.init()

Options

  • container: String, ID of Isotope Container
  • items: String, Classname of Isotope items
  • filters: String, Classname of Isotope filters
  • gutter: Int, Width of desired gutter
  • lazy: Boolean, Lazyload Images?
  • filterType: String; 'simple', 'dropdownFilters', 'sidebarFilters'
  • sidebarButton: String, Classname of Sidebar Trigger
  • sidebar: String, Classname of Sidebar for filters
  • menus: String, Classname of dropdown menus
  • notify: Boolean, Optional for appending "No results found" to Isotope instance when nothing is returned
  • clearFiltersButton: String, Classname for optional button to clear all current filters
  • sort: Object, Pass in sorting options for order, sortBy and sortAscending
  • setHeightToWidth: Boolean, If you need to run this function from the KBD Utility it is built in.