SearchstaxFacetsWidget for Vue
The SearchstaxFacetsWidget
component displays the facet filters.
Props
facetingType
– Faceting mode: ‘and’, ‘or’, ‘showUnavailable’, ‘tabs’itemsPerPageDesktop
– Facets to show per group on desktopitemsPerPageMobile
– Facets to show per group on mobilespecificFacets
– Array of facet names to display
Slots
#desktopFacets
Custom template for desktop facets.
Slot props:
facetsTemplateDataDesktop
– Facets data objectisNotDeactivated
– Check if facet group is activetoggleFacetGroup
– Toggle facet group active stateisChecked
– Check if facet value is selectedselectFacet
– Handler for facet selectshowMoreLessDesktop
– Show more/less facets handlerfacetContainers
– Object of facet DOM containers
#mobileFacets
Custom template for mobile facets.
Slot props:
facetsTemplateDataMobile
– Facets data objectselectedFacetsCheckboxes
– Selected facet values- Other handlers (same as #desktopFacets)
Usage
1 2 3 4 5 | <SearchstaxFacetsWidget :facetingType="'or'" :itemsPerPageDesktop="3" :itemsPerPageMobile="99" ></SearchstaxFacetsWidget> |
The **SearchstaxFacetsWidget**
component displays the facet filters.
Props
facetingType
– Faceting mode: ‘and’, ‘or’, ‘showUnavailable’, ‘tabs’itemsPerPageDesktop
– Facets to show per group on desktopitemsPerPageMobile
– Facets to show per group on mobilespecificFacets
– Array of facet names to display
Slots
#desktopFacets
Custom template for desktop facets.
Slot props:
facetsTemplateDataDesktop
– Facets data objectisNotDeactivated
– Check if facet group is activetoggleFacetGroup
– Toggle facet group active stateisChecked
– Check if facet value is selectedselectFacet
– Handler for facet selectshowMoreLessDesktop
– Show more/less facets handlerfacetContainers
– Object of facet DOM containers
#mobileFacets
Custom template for mobile facets.
Slot props:
facetsTemplateDataMobile
– Facets data objectselectedFacetsCheckboxes
– Selected facet values- Other handlers (same as #desktopFacets)
Usage
1 2 3 4 5 | <SearchstaxFacetsWidget :facetingType="'or'" :itemsPerPageDesktop="3" :itemsPerPageMobile="99" ></SearchstaxFacetsWidget> |
Example
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 | <SearchstaxFacetsWidget :facetingType="'or'" :itemsPerPageDesktop="3" :itemsPerPageMobile="99" > <template #desktopFacets="{ facetsTemplateDataDesktop, isNotDeactivated, toggleFacetGroup, isChecked, selectFacet, showMoreLessDesktop, facetContainers }" > <div v-if="facetsTemplateDataDesktop?.hasResultsOrExternalPromotions" class="searchstax-facets-container-desktop" > <div v-for="facet in facetsTemplateDataDesktop.facets" :key="facet" class="searchstax-facet-container" :class="{ 'active': isNotDeactivated(facet.name) }" > <div> <div class="searchstax-facet-title-container" @click="toggleFacetGroup(facet.name)" > <div class="searchstax-facet-title"> {{ facet.label }} </div> <div class="searchstax-facet-title-arrow active"></div> </div> <div class="searchstax-facet-values-container"> <div v-for="(facetValue, key) in facet.values" :key="facetValue.value + facetValue.parentName" class="searchstax-facet-value-container" :class="{ 'searchstax-facet-value-disabled': facetValue.disabled }" :ref="el => { facetContainers[key + facet.name] = el }" > <div class="searchstax-facet-input"> <input type="checkbox" class="searchstax-facet-input-checkbox" :checked="isChecked(facetValue)" :disabled="facetValue.disabled" @click="selectFacet(key + facet.name, $event, facetValue, true)" /> </div> <div class="searchstax-facet-value-label" @click="selectFacet(key + facet.name, $event, facetValue, false)" >{{ facetValue.value }}</div> <div class="searchstax-facet-value-count" @click="selectFacet(key + facet.name, $event, facetValue, false)" >({{ facetValue.count }})</div> </div> <div class="searchstax-facet-show-more-container" v-if="facet.hasMoreFacets" > <div class="searchstax-facet-show-more-container" @click="showMoreLessDesktop($event, facet)" > <div v-if="facet.showingAllFacets" class="searchstax-facet-show-less-button searchstax-facet-show-button" >less</div> <div v-else class="searchstax-facet-show-more-button searchstax-facet-show-button" >more</div> </div> </div> </div> </div> </div> </div> </template> <template #mobileFacets="{ facetsTemplateDataMobile, selectedFacetsCheckboxes, isNotDeactivated, toggleFacetGroup, isChecked, selectFacet, showMoreLessDesktop, facetContainers, openOverlay, unselectFacet, unselectAll, closeOverlay }" > <div class="searchstax-facets-container-mobile" v-if="facetsTemplateDataMobile?.hasResultsOrExternalPromotions" > <div class="searchstax-facets-pills-container"> <div class="searchstax-facets-pill searchstax-facets-pill-filter-by" @click="openOverlay" > <div class="searchstax-facets-pill-label">Filter By</div> </div> <div class="searchstax-facets-pills-selected"> <div class="searchstax-facets-pill searchstax-facets-pill-facets" v-for="facet in selectedFacetsCheckboxes" :key="facet.value" @click="unselectFacet(facet)" > <div class="searchstax-facets-pill-label">{{ facet.value }} ({{ facet.count }})</div> <div class="searchstax-facets-pill-icon-close"></div> </div> </div> <div class="searchstax-facets-pill searchstax-clear-filters searchstax-facets-pill-clear-all" v-if="selectedFacetsCheckboxes.length" @click="unselectAll" > <div class="searchstax-facets-pill-label">Clear Filters</div> </div> </div> <div class="searchstax-facets-mobile-overlay" :class="{ 'searchstax-show': facetsTemplateDataMobile?.overlayOpened }" > <div class="searchstax-facets-mobile-overlay-header"> <div class="searchstax-facets-mobile-overlay-header-title">Filter By</div> <div class="searchstax-search-close" @click="closeOverlay" ></div> </div> <div class="searchstax-facets-container-mobile"> <div v-for="facet in facetsTemplateDataMobile?.facets" :key="facet" class="searchstax-facet-container" :class="{ 'active': isNotDeactivated(facet.name) }" > <div> <div class="searchstax-facet-title-container" @click="toggleFacetGroup(facet.name)" > <div class="searchstax-facet-title"> {{ facet.label }} </div> <div class="searchstax-facet-title-arrow active"></div> </div> <div class="searchstax-facet-values-container"> <div v-for="(facetValue, key) in facet.values" :key="facetValue.value + facetValue.parentName" class="searchstax-facet-value-container" :class="{ 'searchstax-facet-value-disabled': facetValue.disabled }" :ref="el => { facetContainers[key + facet.name] = el }" > <div class="searchstax-facet-input"> <input type="checkbox" class="searchstax-facet-input-checkbox" :checked="isChecked(facetValue)" :disabled="facetValue.disabled" @click="selectFacet(key + facet.name, $event, facetValue, true)" /> </div> <div class="searchstax-facet-value-label" @click="selectFacet(key + facet.name, $event, facetValue, false)" >{{ facetValue.value }}</div> <div class="searchstax-facet-value-count" @click="selectFacet(key + facet.name, $event, facetValue, false)" >({{ facetValue.count }})</div> </div> <div class="searchstax-facet-show-more-container" v-if="facet.hasMoreFacets" > <div class="searchstax-facet-show-more-container" @click="showMoreLessDesktop($event, facet)" > <div v-if="facet.showingAllFacets" class="searchstax-facet-show-less-button searchstax-facet-show-button" >less</div> <div v-else class="searchstax-facet-show-more-button searchstax-facet-show-button" >more</div> </div> </div> </div> </div> </div> </div> <button class="searchstax-facets-mobile-overlay-done" @click="closeOverlay" >Done</button> </div> </div> </template> </SearchstaxFacetsWidget> |
Questions?
Do not hesitate to contact the SearchStax Support Desk.