algoliasearch.zendesk-hc 3.0.0-beta.8 → 3.0.0

package/README.md

@@ -1,40 +1,23 @@
-# Algolia for Zendesk Guide
+# JavaScript library: `algoliasearchZendeskHC`
 
-[![npm](https://img.shields.io/npm/v/algoliasearch.zendesk-hc.png)](https://www.npmjs.com/package/algoliasearch.zendesk-hc) [![GitHub license](https://img.shields.io/badge/license-mit-green)](../LICENSE)
+[![npm](https://img.shields.io/npm/v/algoliasearch.zendesk-hc.png)](https://www.npmjs.com/package/algoliasearch.zendesk-hc)
+[![GitHub license](https://img.shields.io/github/license/algolia/algoliasearch-zendesk.png)](../LICENSE)
 
-This JavaScript library replaces the default search of your Zendesk Guide help center by Algolia.
-
-[Algolia](https://www.algolia.com) is a hosted full-text, numerical, and faceted search engine capable of delivering realtime results from the first keystroke.
+This JavaScript library allows you to replace the default search of your Zendesk Help Center by Algolia. [Algolia](https://www.algolia.com) is a hosted full-text, numerical, and faceted search engine capable of delivering realtime results from the first keystroke.
 
 ## Documentation
 
-Read our documentation on [algolia.com](https://www.algolia.com/doc/integration/zendesk/getting-started/quick-start/).
-
-## Development
-
-The `package.json` holds multiple scripts:
+<!--
+  docs/documentation.md is generated from the content of the ## Documentation section of app/README.md
+  To change its content, modify app/README.md, go to the app/ folder and run `npm install && npm run build:docs`
+-->
 
-- `clean`: Removes `dist/` and `node_modules/`
-- `build`: Compiles the JS & CSS files to `dist/algoliasearch.zendesk-hc.{css,js}`
-- `dev`: Launches `parcel`, and watches the files to rebuild them if needed
-- `lint`: Lints the JS files
-- `format`: Runs prettier
+Documentation is available at https://www.algolia.com/doc/integration/zendesk/get-started.
 
 ## Contributing
 
 We're considering any contribution and PR, please go ahead!
 
-## Release
-
-Bump the version in `package.json`. We follow semantic versioning.
-
-```bash
-npm install
-npm run clean
-NODE_ENV=production npm run build
-npm publish
-```
-
 ## License
 
 This project is under the [MIT License](../LICENSE).

package/dist/algoliasearch.zendesk-hc.css

@@ -0,0 +1,503 @@
+/*!
+* Algolia Search for Zendesk's Help Center v3.0.0
+* https://github.com/algolia/algoliasearch-zendesk
+* Copyright 2026 Algolia (https://alg.li/support); Licensed MIT
+*/
+@charset "UTF-8";
+/* Search by, for autocomplete (IS has a dedicated widget) */
+.aa-powered-by-link {
+  display: inline-block;
+  width: 64px;
+  text-indent: 101%;
+  overflow: hidden;
+  white-space: nowrap;
+  background-image: url(data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjI5MSAwIDI4MSA2NCI+PHBhdGggZmlsbD0iIzAwM0RGRiIgZD0iTTUzNC40IDkuMUg1MjhhLjguOCAwIDAgMS0uNy0uN1YxLjhjMC0uNC4yLS43LjYtLjhsNi41LTFjLjQgMCAuOC4yLjkuNnY3LjhjMCAuNC0uNC43LS44Ljd6TTQyOCAzNS4yVi44YzAtLjUtLjMtLjgtLjctLjhoLS4ybC02LjQgMWMtLjQgMC0uNy40LS43Ljh2MzVjMCAxLjYgMCAxMS44IDEyLjMgMTIuMi41IDAgLjgtLjQuOC0uOFY0M2MwLS40LS4zLS43LS42LS44LTQuNS0uNS00LjUtNi00LjUtN3ptMTA2LjUtMjEuOEg1MjhjLS40IDAtLjcuNC0uNy44djM0YzAgLjQuMy44LjcuOGg2LjVjLjQgMCAuOC0uNC44LS44di0zNGMwLS41LS40LS44LS44LS44em0tMTcuNyAyMS44Vi44YzAtLjUtLjMtLjgtLjgtLjhsLTYuNSAxYy0uNCAwLS43LjQtLjcuOHYzNWMwIDEuNiAwIDExLjggMTIuMyAxMi4yLjQgMCAuOC0uNC44LS44VjQzYzAtLjQtLjMtLjctLjctLjgtNC40LS41LTQuNC02LTQuNC03em0tMjIuMi0yMC42YTE2LjUgMTYuNSAwIDAgMSA4LjYgOS4zYy44IDIuMiAxLjMgNC44IDEuMyA3LjVhMTkuNCAxOS40IDAgMCAxLTQuNiAxMi42IDE0LjggMTQuOCAwIDAgMS01LjIgMy42Yy0yIC45LTUuMiAxLjQtNi44IDEuNGEyMSAyMSAwIDAgMS02LjctMS40IDE1LjQgMTUuNCAwIDAgMS04LjYtOS4zIDIxLjMgMjEuMyAwIDAgMSAwLTE0LjQgMTUuMiAxNS4yIDAgMCAxIDguNi05LjNjMi0uOCA0LjMtMS4yIDYuNy0xLjJzNC42LjQgNi43IDEuMnptLTYuNyAyNy42YzIuNyAwIDQuNy0xIDYuMi0zczIuMi00LjMgMi4yLTcuOC0uNy02LjMtMi4yLTguMy0zLjUtMy02LjItMy00LjcgMS02LjEgM2MtMS41IDItMi4yIDQuOC0yLjIgOC4zcy43IDUuOCAyLjIgNy44IDMuNSAzIDYuMiAzem0tODguOC0yOC44Yy02LjIgMC0xMS43IDMuMy0xNC44IDguMmExOC42IDE4LjYgMCAwIDAgNC44IDI1LjJjMS44IDEuMiA0IDEuOCA2LjIgMS43cy4xIDAgLjEgMGguOWM0LjItLjcgOC00IDkuMS04LjF2Ny40YzAgLjQuMy43LjguN2g2LjRhLjcuNyAwIDAgMCAuNy0uN1YxNC4yYzAtLjUtLjMtLjgtLjctLjhoLTEzLjV6bTYuMyAyNi41YTkuOCA5LjggMCAwIDEtNS43IDJoLS41YTEwIDEwIDAgMCAxLTkuMi0xNGMxLjQtMy43IDUtNi4zIDktNi4zaDYuNHYxOC4zem0xNTIuMy0yNi41aDEzLjVjLjUgMCAuOC4zLjguN3YzMy43YzAgLjQtLjMuNy0uOC43aC02LjRhLjcuNyAwIDAgMS0uOC0uN3YtNy40Yy0xLjIgNC00LjggNy40LTkgOGgtLjFhNC4yIDQuMiAwIDAgMS0uNS4xaC0uOWExMC4zIDEwLjMgMCAwIDEtNy0yLjZjLTQtMy4zLTYuNS04LjQtNi41LTE0LjIgMC0zLjcgMS03LjIgMy0xMCAzLTUgOC41LTguMyAxNC43LTguM3ptLjYgMjguNGMyLjItLjEgNC4yLS42IDUuNy0yVjIxLjdoLTYuM2E5LjggOS44IDAgMCAwLTkgNi40IDEwLjIgMTAuMiAwIDAgMCA5LjEgMTMuOWguNXpNNDUyLjggMTMuNGMtNi4yIDAtMTEuNyAzLjMtMTQuOCA4LjJhMTguNSAxOC41IDAgMCAwIDMuNiAyNC4zIDEwLjQgMTAuNCAwIDAgMCAxMyAuNmMyLjItMS41IDMuOC0zLjcgNC41LTYuMXY3LjhjMCAyLjgtLjggNS0yLjIgNi4zLTEuNSAxLjUtNCAyLjItNy41IDIuMmwtNi0uM2MtLjMgMC0uNy4yLS44LjVsLTEuNiA1LjVjLS4xLjQuMS44LjUgMWguMWMyLjguNCA1LjUuNiA3IC42IDYuMyAwIDExLTEuNCAxNC00LjEgMi43LTIuNSA0LjItNi4zIDQuNS0xMS40VjE0LjJjMC0uNS0uNC0uOC0uOC0uOGgtMTMuNXptNi4zIDguMnYxOC4zYTkuNiA5LjYgMCAwIDEtNS42IDJoLTFhMTAuMyAxMC4zIDAgMCAxLTguOC0xNGMxLjQtMy43IDUtNi4zIDktNi4zaDYuNHpNMjkxIDMxLjVBMzIgMzIgMCAwIDEgMzIyLjggMGgzMC44Yy42IDAgMS4yLjUgMS4yIDEuMnY2MS41YzAgMS4xLTEuMyAxLjctMi4yIDFsLTE5LjItMTdhMTggMTggMCAwIDEtMTEgMy40IDE4LjEgMTguMSAwIDEgMSAxOC4yLTE0LjhjLS4xLjQtLjUuNy0uOS42LS4xIDAtLjMgMC0uNC0uMmwtMy44LTMuNGMtLjQtLjMtLjYtLjgtLjctMS40YTEyIDEyIDAgMSAwLTIuNCA4LjNjLjQtLjQgMS0uNSAxLjYtLjJsMTQuNyAxMy4xdi00NkgzMjNhMjYgMjYgMCAxIDAgMTAgNDkuN2MuOC0uNCAxLjYtLjIgMi4zLjNsMyAyLjdjLjMuMi4zLjcgMCAxbC0uMi4yYTMyIDMyIDAgMCAxLTQ3LjItMjguNnoiLz48L3N2Zz4=);
+  background-repeat: no-repeat;
+  background-size: contain;
+  vertical-align: middle;
+}
+
+.clearfix {
+  clear: both;
+}
+
+/***************************/
+/* @algolia/autocomplete-js */
+/***************************/
+.aa-Form {
+  position: relative;
+}
+.aa-Form:before {
+  content: "🔍";
+  font-family: "entypo";
+  font-size: 1.25em;
+  line-height: 1;
+  position: absolute;
+  text-align: center;
+  top: 50%;
+  left: 0;
+  width: 2.2em;
+  transform: translateY(-50%);
+  z-index: 1;
+}
+
+.aa-InputWrapperPrefix {
+  display: none;
+}
+
+.aa-Input {
+  box-sizing: border-box;
+  width: 100%;
+  height: 100%;
+  margin: 0;
+  outline: none;
+  padding: 10px;
+  padding-left: 32px;
+  padding-right: 28px;
+}
+
+.aa-InputWrapperSuffix {
+  position: absolute;
+  top: 50%;
+  right: 4px;
+  transform: translateY(-50%);
+}
+
+.aa-ClearButton {
+  background: transparent;
+  border: none;
+  padding: 0;
+  cursor: pointer;
+  color: inherit;
+}
+
+.aa-Panel {
+  position: absolute;
+  z-index: 10000;
+  margin-top: 9px;
+  border: 1px solid #d9d9d9;
+  border-radius: 3px;
+  background-color: #fff;
+  box-shadow: 0 1px 0 0 #ccc, 0 2px 3px 0 #e6e6e6;
+  font-size: 14px;
+  padding: 20px 16px 16px 16px;
+  text-align: left;
+}
+
+.aa-List {
+  list-style: none;
+  padding: 0;
+  margin: 0;
+}
+
+.aa-Item {
+  cursor: pointer;
+  padding-top: 5px;
+}
+
+.aa-powered-by {
+  position: absolute;
+  right: 16px;
+  top: 8px;
+  text-align: right;
+  font-size: 0.8em;
+  color: #999;
+}
+
+/** category **/
+.aa-article-hit--category {
+  height: 18px;
+  font-size: 18px;
+  border-bottom: 1px solid #e6e6e6;
+  height: 18px;
+  margin-bottom: 16px;
+  color: #aaa !important;
+}
+
+.aa-article-hit--category--content {
+  background-color: #fff;
+  padding-right: 16px;
+  display: inline-block;
+  max-width: 100%;
+  white-space: nowrap;
+  overflow-x: hidden;
+  text-overflow: ellipsis;
+}
+
+.aa-article-hit .aa-article-hit--category {
+  display: none;
+}
+
+.aa-article-hit.aa-article-hit__category-first .aa-article-hit--category {
+  display: block;
+}
+
+.aa-article-hit__xs .aa-article-hit--category,
+.aa-article-hit__sm .aa-article-hit--category {
+  margin-bottom: 8px;
+}
+
+/** line **/
+.aa-article-hit--line {
+  width: 100%;
+  margin-bottom: 8px;
+  float: left;
+  line-height: 1.35em;
+}
+
+.aa-article-hit__section-first .aa-article-hit--line {
+  margin-top: 12px;
+}
+
+.aa-article-hit__xs .aa-article-hit--line,
+.aa-article-hit__sm .aa-article-hit--line {
+  margin: 0;
+}
+
+/** section **/
+.aa-article-hit--section {
+  display: none;
+  width: 20%;
+  text-align: right;
+  float: left;
+  padding-right: 16px;
+  padding-top: 4px;
+  font-size: 1.1em;
+  letter-spacing: 0.2px;
+  word-wrap: break-word;
+}
+
+.aa-article-hit__section-first .aa-article-hit--section {
+  display: block;
+}
+
+.aa-article-hit__xs .aa-article-hit--section,
+.aa-article-hit__sm .aa-article-hit--section {
+  width: 100%;
+  text-align: left;
+  margin-top: 8px;
+}
+
+.aa-article-hit__sm .aa-article-hit--section {
+  font-size: 1.2em;
+}
+
+/** content **/
+.aa-article-hit--content {
+  width: 80%;
+  float: right;
+  border-left: 1px solid #ddd;
+  padding: 4px 10% 4px 8px;
+}
+
+.aa-Item:hover .aa-article-hit--content,
+.aa-Item[aria-selected=true] .aa-article-hit--content {
+  background-color: #f8f8f8;
+}
+
+.aa-article-hit__category-first.aa-article-hit__section-first .aa-article-hit--content {
+  border-top: none;
+}
+
+.aa-article-hit__xs .aa-article-hit--content,
+.aa-article-hit__sm .aa-article-hit--content {
+  width: 100%;
+}
+
+.aa-article-hit__xs .aa-article-hit--content {
+  padding: 0 8px;
+  border-left: none;
+}
+
+.aa-article-hit__sm .aa-article-hit--content {
+  padding: 4px 8px;
+  margin: 4px 0;
+  border: none;
+}
+
+/** title **/
+.aa-article-hit--title {
+  font-size: 1.1em;
+  font-weight: bold;
+}
+.aa-article-hit--title mark {
+  position: relative;
+  z-index: 1;
+  background: none;
+  color: inherit;
+}
+.aa-article-hit--title mark::before {
+  content: "";
+  position: absolute;
+  top: 0;
+  left: 0;
+  width: 100%;
+  height: 100%;
+  opacity: 0.1;
+  z-index: -1;
+}
+
+.aa-article-hit__xs .aa-article-hit--title,
+.aa-article-hit__sm .aa-article-hit--title {
+  font-size: 1em;
+  line-height: 1.25em;
+  display: block;
+}
+
+.aa-article-hit__xs .aa-article-hit--title {
+  font-weight: normal;
+  padding: 8px 0;
+  border-top: solid 1px #eee;
+}
+
+.aa-article-hit__xs.aa-article-hit__section-first .aa-article-hit--title {
+  border: none;
+}
+
+/** body **/
+.aa-article-hit--body {
+  font-size: 13px;
+  color: #797979;
+  margin-top: 4px;
+  line-height: 1.25em;
+}
+.aa-article-hit--body mark {
+  background: none;
+  color: #666;
+  font-weight: bold;
+}
+
+.aa-article-hit__xs .aa-article-hit--body {
+  display: none;
+}
+
+.aa-article-hit__sm .aa-article-hit--body {
+  font-size: 0.9em;
+  line-height: 1.25em;
+}
+
+/***************************/
+/*! instantsearch.js 1.1.0 | © Algolia Inc. and other contributors; Licensed MIT | github.com/algolia/instantsearch.js */
+/***************************/
+.ais-with-style.ais-SearchBox {
+  margin-left: 30%;
+  position: relative;
+}
+.ais-with-style.ais-SearchBox .ais-SearchBox-form {
+  position: relative;
+}
+.ais-with-style.ais-SearchBox .ais-SearchBox-form:before {
+  content: "🔍";
+  font-family: "entypo";
+  font-size: 1.25em;
+  line-height: 0;
+  position: absolute;
+  text-align: center;
+  top: 18px;
+  width: 2.2em;
+  z-index: 1;
+}
+.ais-with-style.ais-SearchBox .ais-SearchBox-input {
+  box-sizing: border-box;
+  width: 100%;
+  outline: none;
+  padding: 10px;
+  padding-left: 32px;
+}
+
+#algolia-powered-by-container {
+  margin-left: 30%;
+  font-size: 0.8em;
+  text-align: right;
+  margin-top: 3px;
+  height: 0;
+}
+
+#algolia-hits {
+  float: left;
+  width: 70%;
+}
+#algolia-hits .ais-Hits-list {
+  list-style: none;
+  padding: 0;
+  margin: 0;
+}
+#algolia-hits .search-result {
+  border-top: 1px solid #efefef;
+  margin-top: 10px;
+  padding: 7px 0 10px;
+  position: relative;
+}
+#algolia-hits .search-result:first-child {
+  margin-top: 0;
+}
+#algolia-hits .search-result-meta {
+  padding: 0 10px;
+  float: right;
+  font-size: 0.8em;
+}
+#algolia-hits .search-result-path {
+  font-size: 0.9em;
+  font-style: italic;
+  color: #999;
+}
+#algolia-hits .search-result-body {
+  margin-top: 5px;
+  opacity: 0.7;
+}
+#algolia-hits .search-result-body mark {
+  background: none;
+  color: inherit;
+  font-weight: bold;
+}
+#algolia-hits .search-result-link-wrapper {
+  margin-right: 75px;
+}
+#algolia-hits .search-result-link {
+  display: inline-block;
+  cursor: pointer;
+}
+#algolia-hits .search-result-link mark {
+  position: relative;
+  z-index: 1;
+  background: none;
+  color: inherit;
+}
+#algolia-hits .search-result-link mark::before {
+  content: "";
+  position: absolute;
+  top: 0;
+  left: 0;
+  width: 100%;
+  height: 100%;
+  opacity: 0.1;
+  z-index: -1;
+}
+
+#algolia-stats {
+  margin-left: 30%;
+  margin-top: 15px;
+  text-transform: uppercase;
+}
+
+#algolia-facets {
+  float: left;
+  width: 25%;
+  margin-right: 5%;
+  min-height: 1px;
+}
+#algolia-facets .algolia-facet-block {
+  border: 1px solid #efefef;
+}
+#algolia-facets .ais-Panel-header {
+  text-align: left;
+  text-transform: uppercase;
+  font-weight: 300;
+  font-size: 1em;
+  border-bottom: 1px solid #efefef;
+  padding: 10px;
+}
+#algolia-facets .ais-Panel-body {
+  padding: 10px;
+}
+#algolia-facets .ais-HierarchicalMenu-list--lvl0 {
+  margin-left: 10px;
+}
+#algolia-facets .ais-HierarchicalMenu-list--lvl1 {
+  margin-left: 10px;
+}
+#algolia-facets .ais-HierarchicalMenu-link {
+  display: block;
+  width: 80%;
+  white-space: nowrap;
+  overflow: hidden;
+  text-overflow: ellipsis;
+  cursor: pointer;
+}
+#algolia-facets .ais-HierarchicalMenu-item {
+  line-height: 2em;
+}
+#algolia-facets .ais-HierarchicalMenu-item--selected > div > .ais-HierarchicalMenu-link {
+  font-weight: bold;
+}
+#algolia-facets .ais-HierarchicalMenu-item--selected > div > .ais-HierarchicalMenu-link:hover {
+  text-decoration: line-through;
+  border: none;
+}
+#algolia-facets .ais-HierarchicalMenu-count {
+  display: none;
+}
+#algolia-facets #algolia-labels {
+  margin-top: 20px;
+}
+#algolia-facets #algolia-labels .ais-RefinementList-list {
+  margin-top: 5px;
+  margin-left: -4px;
+  margin-right: -4px;
+}
+#algolia-facets #algolia-labels .ais-RefinementList-item {
+  display: inline-block;
+  max-width: 100%;
+}
+#algolia-facets #algolia-labels .ais-RefinementList-item .ais-RefinementList-label {
+  display: inline-block;
+  padding: 4px 8px;
+  margin: 4px;
+  max-width: 100%;
+  overflow: hidden;
+  text-overflow: ellipsis;
+  background: #efefef;
+  cursor: pointer;
+}
+#algolia-facets #algolia-labels .ais-RefinementList-item .ais-RefinementList-label:hover,
+#algolia-facets #algolia-labels .ais-RefinementList-item--selected .ais-RefinementList-label {
+  text-decoration: none;
+  background: #158EC2;
+  color: white;
+  -webkit-transition: all 0.3s ease;
+  transition: all 0.3s ease;
+}
+#algolia-facets #algolia-labels .ais-RefinementList-item--selected .ais-RefinementList-label:hover {
+  text-decoration: line-through;
+}
+#algolia-facets #algolia-labels .ais-RefinementList-count,
+#algolia-facets #algolia-labels .ais-RefinementList-checkbox {
+  display: none;
+}
+
+.ais-Hits--empty {
+  text-align: center;
+  font-size: 1.8em;
+  margin-top: 100px;
+  font-style: italic;
+}
+
+#algolia-pagination {
+  text-align: center;
+  margin-top: 80px;
+}
+#algolia-pagination .ais-Pagination-list {
+  display: inline-block;
+  list-style: none;
+  padding: 0;
+}
+#algolia-pagination .ais-Pagination-item {
+  display: inline-block;
+  padding: 3px;
+}
+#algolia-pagination .ais-Pagination-item--disabled {
+  visibility: hidden;
+}
+#algolia-pagination .ais-Pagination-item--selected {
+  font-weight: bold;
+  background: #efefef;
+}
+
+/** Responsiveness **/
+#algolia-facets-open {
+  display: none;
+}
+
+#algolia-facets-close {
+  display: none;
+}