- 🔍 a NPM module for catalog style faceted filtering. Processes data for sidebar checkbox filters on product catalog / listing pages.
- Node.js
npm install underscore big-integervar Facetor = require('facetor')
var catalogFacetor = new Facetor();
// ...- Browser
<head>
<script src="javascript.js"></script>
<script>
var catalogFacetor = new Facetor();
// ...
</script>
</head>- AMD is also supported.
- build index using an array containing facetable attributes, and an array of items which has those attributes. Attributes in array format are supported (EX: multiple tags or multiple color, etc)
// build index
catalogFacetor.build({
facets: ["title", "category"],
items: [
{
title: "rural",
category: "stroller"
},
{
title: "urban",
category: "stroller"
},
{
title: "rural",
category: "stroller"
},
{
title: "urban",
category: "locks"
},
{
title: "urban",
category: "locks"
},
{
title: ["urban", "misc"],
category: ["stroller"]
}
]
});- You can export / import
indexinto a.jsonformat. If you are importing,STEP 1is optional.
var index = catalogFacetor.export();
catalogFacetor.import(index);- Passing in these options
var results = catalogFacetor.results({
facets: ["title.rural", "title.misc"],
operators: ["AND", "OR"],
attributes: ["count", "status", "path"]
});- Results in
{
"index": {
"title": {
"rural": {
"_bitmap": "5",
"_status": 1,
"_count": 3,
"_path": "title.rural"
},
"urban": {
"_bitmap": "58",
"_status": 0,
"_count": 6,
"_path": "title.urban"
},
"misc": {
"_bitmap": "32",
"_status": 1,
"_count": 3,
"_path": "title.misc"
},
"_status": 0.5,
"_count": 6,
"_path": "title"
},
"category": {
"stroller": {
"_bitmap": "39",
"_status": 0,
"_count": 4,
"_path": "category.stroller"
},
"locks": {
"_bitmap": "24",
"_status": 0,
"_count": 5,
"_path": "category.locks"
},
"_status": 0,
"_count": 6,
"_path": "category"
}
},
"items": [
{
"title": "rural",
"category": "stroller"
},
{
"title": "rural",
"category": "stroller"
},
{
"title": [
"urban",
"misc"
],
"category": [
"stroller"
]
}
]
}