[{"_path":"/getting-started/usage","_draft":false,"_partial":false,"_empty":false,"title":"Usage","description":"","excerpt":{"type":"root","children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"This module exposes composables that are "},{"type":"element","tag":"a","props":{"href":"https://nuxt.com/docs/guide/directory-structure/composables#composables-directory","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"auto-imported"}]},{"type":"text","value":" by Nuxt 3."}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"For more details check out the official documentation of initializing algolia client "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/api-client/getting-started/instantiate-client-index/javascript/?client=javascript","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"here"}]}]},{"type":"element","tag":"h2","props":{"id":"usealgoliasearch"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"useAlgoliaSearch"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Use this composable to search the index by certain query and optional request options"}]},{"type":"element","tag":"code","props":{"code":"\n","language":"vue"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"text","value":"\n"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"This composable works also for SSR applications and requests like this:"}]},{"type":"element","tag":"code","props":{"code":"\n","language":"vue"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"text","value":"\n"}]}]}]},{"type":"element","tag":"ul","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"result"}]},{"type":"text","value":" will contain a value of a search method. It is reactive computed property that will be populated when a search method will fulfill. This result will have a form described "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/api-reference/api-methods/search/#response","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"here"}]}]},{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"search"}]},{"type":"text","value":" method is used to fetch the results by the index and populates "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"result"}]},{"type":"text","value":" reactive property. This method requires a parameter "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"query"}]},{"type":"text","value":" and accepts an optional parameter of "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"requestOptions"}]},{"type":"text","value":" that you can check out "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/api-reference/api-methods/search/#method-param-requestoptions","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"here"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"For more details check out the official documentation of this method "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/api-client/methods/search/","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"here"}]}]},{"type":"element","tag":"h2","props":{"id":"useasyncalgoliasearch"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"useAsyncAlgoliaSearch"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Async wrapper around "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"useAlgoliaSearch"}]},{"type":"text","value":" composable that decreases the number of steps needed to use Algolia with "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"useAsyncData"}]},{"type":"text","value":" while maintaining the same functionality. The response will have a form described "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/api-reference/api-methods/search/#response","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"here"}]},{"type":"text","value":" and will be wrapped around "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"useAsyncData"}]},{"type":"text","value":" so you will have access to "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"data"}]},{"type":"text","value":", "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"error"}]},{"type":"text","value":", and other properties."}]},{"type":"element","tag":"code","props":{"code":"\n\n\n {{ data.value.hits }}
\n\n","language":"vue"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"text","value":"\n\n\n {{ data.value.hits }}
\n\n"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"This composable accepts an object as a param with following properties:"}]},{"type":"element","tag":"ul","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"indexName"}]},{"type":"text","value":" - the name of you index in Algolia dashboard. For more details about initializing index check out the official documentation "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/api-client/getting-started/instantiate-client-index/javascript/?client=javascript#initialize-an-index","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"here"}]},{"type":"text","value":". If you passed a global index in your module configuration, this property can be skipped."}]},{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"query"}]},{"type":"text","value":" - a keyword, sentence, or text that you want to search the index with."}]},{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"key"}]},{"type":"text","value":" - if you need multiple asyncAlgoliaSearch calls in a single page, add a unique key to get passed to the useAsyncData underneath, so new calls won't overwrite old data."}]},{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"requestOptions"}]},{"type":"text","value":" optional object with options for the request like filters. You can check more about is "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/api-reference/api-methods/search/#method-param-requestoptions","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"here"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"If you want to fetch search results filtered by some facet values you can do so like following:"}]},{"type":"element","tag":"code","props":{"code":"const { result, search } = useAlgoliaSearch(\"INDEX_NAME\");\n\nawait search({ query: input_string, requestOptions: {facetFilters: [\"tags:happy\"]} });\n","language":"ts"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"text","value":"const { result, search } = useAlgoliaSearch(\"INDEX_NAME\");\n\nawait search({ query: input_string, requestOptions: {facetFilters: [\"tags:happy\"]} });\n"}]}]}]},{"type":"element","tag":"h2","props":{"id":"usealgoliafacetedsearch"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"useAlgoliaFacetedSearch"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Use this composable to search using facet values like "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"category"}]},{"type":"text","value":", "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"phone"}]},{"type":"text","value":"."}]},{"type":"element","tag":"alert","props":{"type":"info"},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"In order for this to work, you have to add facet attributes in your dashboard or via code. Read more about it "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"here"}]}]}]},{"type":"element","tag":"code","props":{"code":"\n","language":"vue"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"text","value":"\n"}]}]}]},{"type":"element","tag":"ul","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"result"}]},{"type":"text","value":" will contain a value of a search method. It is reactive computed property that will be populated when a search method will fulfill. This result will have a form described "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/api-reference/api-methods/search-for-facet-values/#response","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"here"}]}]},{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"search"}]},{"type":"text","value":" method is used to fetch the results by the certain facet value pairs like name and query, and populates "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"result"}]},{"type":"text","value":" reactive property. This method requries a parameter for "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"facet"}]},{"type":"text","value":" and accepts an optional parameter of "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"requestOptions"}]},{"type":"text","value":" that you can check out "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/api-reference/api-methods/search/#method-param-requestoptions","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"here"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"For more details about using this search method check out the official documentation "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/api-reference/api-methods/search-for-facet-values/","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"here"}]}]},{"type":"element","tag":"h2","props":{"id":"usealgoliarecommend"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"useAlgoliaRecommend"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Use this composable to get the recommendations matching certain criteria optional request options."}]},{"type":"element","tag":"alert","props":{"type":"info"},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"In order to make this composable work, make sure to setup a "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"recommend"}]},{"type":"text","value":" property to "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"true"}]},{"type":"text","value":" in algolia configuration in "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"nuxt.config.ts"}]},{"type":"text","value":"."}]}]},{"type":"element","tag":"code","props":{"code":"\n","language":"vue"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"text","value":"\n"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"This composable returns the following:"}]},{"type":"element","tag":"ul","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"result"}]},{"type":"text","value":" will contain a value of a get method. It is reactive computed property that will be populated when a get method will fulfill. This result will have a form described "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/api-reference/api-methods/get-recommendations/#response","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"here"}]}]},{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"get"}]},{"type":"text","value":" method is used to get the recommendations based on the criteria described "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/api-reference/api-methods/get-recommendations/#parameters","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"here"}]},{"type":"text","value":" and an optional parameter of "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"requestOptions"}]},{"type":"text","value":" that you can check out "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/api-reference/api-methods/search/#method-param-requestoptions","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"here"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"This composable also accepts an optional key parameter:"}]},{"type":"element","tag":"ul","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"key"}]},{"type":"text","value":" - if you need multiple useAlgoliaRecommend calls, add a unique key to get passed to the userState('recommend-result') underneath, so new calls won't overwrite old data."}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"For more details check out the official documentation of this method "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/api-reference/api-methods/get-recommendations/","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"here"}]}]},{"type":"element","tag":"h2","props":{"id":"usealgoliaref"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"useAlgoliaRef"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"By calling this composable you have access to "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"algoliasearch"}]},{"type":"text","value":" instance anywhere in your app"}]},{"type":"element","tag":"code","props":{"code":"\n","language":"vue"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"text","value":"\n"}]}]}]},{"type":"element","tag":"h2","props":{"id":"usealgoliainitindex"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"useAlgoliaInitIndex"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Use this composable to initialize index you would like to search through. It accepts an index name as a parameter"}]},{"type":"element","tag":"code","props":{"code":"\n","language":"vue"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"text","value":"\n"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"For more details about initializing index check out the official documentation "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/api-client/getting-started/instantiate-client-index/javascript/?client=javascript#initialize-an-index","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"here"}]}]}]},"body":{"type":"root","children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"This module exposes composables that are "},{"type":"element","tag":"a","props":{"href":"https://nuxt.com/docs/guide/directory-structure/composables#composables-directory","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"auto-imported"}]},{"type":"text","value":" by Nuxt 3."}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"For more details check out the official documentation of initializing algolia client "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/api-client/getting-started/instantiate-client-index/javascript/?client=javascript","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"here"}]}]},{"type":"element","tag":"h2","props":{"id":"usealgoliasearch"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"useAlgoliaSearch"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Use this composable to search the index by certain query and optional request options"}]},{"type":"element","tag":"code","props":{"code":"\n","language":"vue"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":"<"}]},{"type":"element","tag":"span","props":{"class":"ct-28054e"},"children":[{"type":"text","value":"script"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-3ce7e3"},"children":[{"type":"text","value":"setup"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":">"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-527146"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" { "}]},{"type":"element","tag":"span","props":{"class":"ct-f81f11"},"children":[{"type":"text","value":"result"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":", "}]},{"type":"element","tag":"span","props":{"class":"ct-f81f11"},"children":[{"type":"text","value":"search"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" } "}]},{"type":"element","tag":"span","props":{"class":"ct-ff5e68"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-4296d8"},"children":[{"type":"text","value":"useAlgoliaSearch"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":"("}]},{"type":"element","tag":"span","props":{"class":"ct-b42748"},"children":[{"type":"text","value":"'test_index'"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":") "}]},{"type":"element","tag":"span","props":{"class":"ct-1a75bd"},"children":[{"type":"text","value":"// pass your index name as param"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-4296d8"},"children":[{"type":"text","value":"onMounted"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":"("}]},{"type":"element","tag":"span","props":{"class":"ct-527146"},"children":[{"type":"text","value":"async"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" () "}]},{"type":"element","tag":"span","props":{"class":"ct-527146"},"children":[{"type":"text","value":"=>"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-527146"},"children":[{"type":"text","value":"await"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-4296d8"},"children":[{"type":"text","value":"search"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":"({ "}]},{"type":"element","tag":"span","props":{"class":"ct-28054e"},"children":[{"type":"text","value":"query"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-b42748"},"children":[{"type":"text","value":"'Samsung'"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" });"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":"})"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":""}]}]}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"This composable works also for SSR applications and requests like this:"}]},{"type":"element","tag":"code","props":{"code":"\n","language":"vue"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":"<"}]},{"type":"element","tag":"span","props":{"class":"ct-28054e"},"children":[{"type":"text","value":"script"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-3ce7e3"},"children":[{"type":"text","value":"setup"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-3ce7e3"},"children":[{"type":"text","value":"lang"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-b42748"},"children":[{"type":"text","value":"\"ts\""}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":">"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-527146"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" { "}]},{"type":"element","tag":"span","props":{"class":"ct-f81f11"},"children":[{"type":"text","value":"result"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":", "}]},{"type":"element","tag":"span","props":{"class":"ct-f81f11"},"children":[{"type":"text","value":"search"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" } "}]},{"type":"element","tag":"span","props":{"class":"ct-ff5e68"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-4296d8"},"children":[{"type":"text","value":"useAlgoliaSearch"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":"("}]},{"type":"element","tag":"span","props":{"class":"ct-b42748"},"children":[{"type":"text","value":"'test_index'"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":") "}]},{"type":"element","tag":"span","props":{"class":"ct-1a75bd"},"children":[{"type":"text","value":"// pass your index name as param"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-527146"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" { "}]},{"type":"element","tag":"span","props":{"class":"ct-f81f11"},"children":[{"type":"text","value":"data"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" } "}]},{"type":"element","tag":"span","props":{"class":"ct-ff5e68"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-527146"},"children":[{"type":"text","value":"await"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-4296d8"},"children":[{"type":"text","value":"useAsyncData"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":"("}]},{"type":"element","tag":"span","props":{"class":"ct-b42748"},"children":[{"type":"text","value":"'ssr-search-results'"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":", () "}]},{"type":"element","tag":"span","props":{"class":"ct-527146"},"children":[{"type":"text","value":"=>"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-4296d8"},"children":[{"type":"text","value":"search"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":"({ "}]},{"type":"element","tag":"span","props":{"class":"ct-28054e"},"children":[{"type":"text","value":"query"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-b42748"},"children":[{"type":"text","value":"'Samsung'"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" }))"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":""}]}]}]}]}]},{"type":"element","tag":"ul","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"result"}]},{"type":"text","value":" will contain a value of a search method. It is reactive computed property that will be populated when a search method will fulfill. This result will have a form described "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/api-reference/api-methods/search/#response","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"here"}]}]},{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"search"}]},{"type":"text","value":" method is used to fetch the results by the index and populates "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"result"}]},{"type":"text","value":" reactive property. This method requires a parameter "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"query"}]},{"type":"text","value":" and accepts an optional parameter of "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"requestOptions"}]},{"type":"text","value":" that you can check out "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/api-reference/api-methods/search/#method-param-requestoptions","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"here"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"For more details check out the official documentation of this method "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/api-client/methods/search/","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"here"}]}]},{"type":"element","tag":"h2","props":{"id":"useasyncalgoliasearch"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"useAsyncAlgoliaSearch"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Async wrapper around "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"useAlgoliaSearch"}]},{"type":"text","value":" composable that decreases the number of steps needed to use Algolia with "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"useAsyncData"}]},{"type":"text","value":" while maintaining the same functionality. The response will have a form described "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/api-reference/api-methods/search/#response","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"here"}]},{"type":"text","value":" and will be wrapped around "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"useAsyncData"}]},{"type":"text","value":" so you will have access to "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"data"}]},{"type":"text","value":", "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"error"}]},{"type":"text","value":", and other properties."}]},{"type":"element","tag":"code","props":{"code":"\n\n\n {{ data.value.hits }}
\n\n","language":"vue"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":"<"}]},{"type":"element","tag":"span","props":{"class":"ct-28054e"},"children":[{"type":"text","value":"script"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-3ce7e3"},"children":[{"type":"text","value":"setup"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-3ce7e3"},"children":[{"type":"text","value":"lang"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-b42748"},"children":[{"type":"text","value":"\"ts\""}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":">"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-527146"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" { "}]},{"type":"element","tag":"span","props":{"class":"ct-f81f11"},"children":[{"type":"text","value":"data"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":", "}]},{"type":"element","tag":"span","props":{"class":"ct-f81f11"},"children":[{"type":"text","value":"error"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" } "}]},{"type":"element","tag":"span","props":{"class":"ct-ff5e68"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-527146"},"children":[{"type":"text","value":"await"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-4296d8"},"children":[{"type":"text","value":"useAsyncAlgoliaSearch"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":"({ "}]},{"type":"element","tag":"span","props":{"class":"ct-28054e"},"children":[{"type":"text","value":"indexName"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-b42748"},"children":[{"type":"text","value":"'test_index'"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":", "}]},{"type":"element","tag":"span","props":{"class":"ct-28054e"},"children":[{"type":"text","value":"query"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-b42748"},"children":[{"type":"text","value":"'Samsung'"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" })"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":""}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":"<"}]},{"type":"element","tag":"span","props":{"class":"ct-28054e"},"children":[{"type":"text","value":"template"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":">"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" <"}]},{"type":"element","tag":"span","props":{"class":"ct-3ce7e3"},"children":[{"type":"text","value":"div"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":">{{ "}]},{"type":"element","tag":"span","props":{"class":"ct-3ce7e3"},"children":[{"type":"text","value":"data"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":"."}]},{"type":"element","tag":"span","props":{"class":"ct-3ce7e3"},"children":[{"type":"text","value":"value"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":"."}]},{"type":"element","tag":"span","props":{"class":"ct-3ce7e3"},"children":[{"type":"text","value":"hits"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" }}"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":""}]}]}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"This composable accepts an object as a param with following properties:"}]},{"type":"element","tag":"ul","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"indexName"}]},{"type":"text","value":" - the name of you index in Algolia dashboard. For more details about initializing index check out the official documentation "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/api-client/getting-started/instantiate-client-index/javascript/?client=javascript#initialize-an-index","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"here"}]},{"type":"text","value":". If you passed a global index in your module configuration, this property can be skipped."}]},{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"query"}]},{"type":"text","value":" - a keyword, sentence, or text that you want to search the index with."}]},{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"key"}]},{"type":"text","value":" - if you need multiple asyncAlgoliaSearch calls in a single page, add a unique key to get passed to the useAsyncData underneath, so new calls won't overwrite old data."}]},{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"requestOptions"}]},{"type":"text","value":" optional object with options for the request like filters. You can check more about is "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/api-reference/api-methods/search/#method-param-requestoptions","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"here"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"If you want to fetch search results filtered by some facet values you can do so like following:"}]},{"type":"element","tag":"code","props":{"code":"const { result, search } = useAlgoliaSearch(\"INDEX_NAME\");\n\nawait search({ query: input_string, requestOptions: {facetFilters: [\"tags:happy\"]} });\n","language":"ts"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-527146"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" { "}]},{"type":"element","tag":"span","props":{"class":"ct-f81f11"},"children":[{"type":"text","value":"result"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":", "}]},{"type":"element","tag":"span","props":{"class":"ct-f81f11"},"children":[{"type":"text","value":"search"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" } "}]},{"type":"element","tag":"span","props":{"class":"ct-ff5e68"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-4296d8"},"children":[{"type":"text","value":"useAlgoliaSearch"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":"("}]},{"type":"element","tag":"span","props":{"class":"ct-b42748"},"children":[{"type":"text","value":"\"INDEX_NAME\""}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":");"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-527146"},"children":[{"type":"text","value":"await"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-4296d8"},"children":[{"type":"text","value":"search"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":"({ "}]},{"type":"element","tag":"span","props":{"class":"ct-28054e"},"children":[{"type":"text","value":"query"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-28054e"},"children":[{"type":"text","value":"input_string"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":", "}]},{"type":"element","tag":"span","props":{"class":"ct-28054e"},"children":[{"type":"text","value":"requestOptions"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":": {"}]},{"type":"element","tag":"span","props":{"class":"ct-28054e"},"children":[{"type":"text","value":"facetFilters"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":": ["}]},{"type":"element","tag":"span","props":{"class":"ct-b42748"},"children":[{"type":"text","value":"\"tags:happy\""}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":"]} });"}]}]}]}]}]},{"type":"element","tag":"h2","props":{"id":"usealgoliafacetedsearch"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"useAlgoliaFacetedSearch"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Use this composable to search using facet values like "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"category"}]},{"type":"text","value":", "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"phone"}]},{"type":"text","value":"."}]},{"type":"element","tag":"alert","props":{"type":"info"},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"In order for this to work, you have to add facet attributes in your dashboard or via code. Read more about it "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"here"}]}]}]},{"type":"element","tag":"code","props":{"code":"\n","language":"vue"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":"<"}]},{"type":"element","tag":"span","props":{"class":"ct-28054e"},"children":[{"type":"text","value":"script"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-3ce7e3"},"children":[{"type":"text","value":"setup"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":">"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-527146"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" { "}]},{"type":"element","tag":"span","props":{"class":"ct-f81f11"},"children":[{"type":"text","value":"result"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":", "}]},{"type":"element","tag":"span","props":{"class":"ct-f81f11"},"children":[{"type":"text","value":"search"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" } "}]},{"type":"element","tag":"span","props":{"class":"ct-ff5e68"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-4296d8"},"children":[{"type":"text","value":"useAlgoliaFacetedSearch"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":"("}]},{"type":"element","tag":"span","props":{"class":"ct-b42748"},"children":[{"type":"text","value":"'test_index'"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":")"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-4296d8"},"children":[{"type":"text","value":"onMounted"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":"("}]},{"type":"element","tag":"span","props":{"class":"ct-527146"},"children":[{"type":"text","value":"async"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" () "}]},{"type":"element","tag":"span","props":{"class":"ct-527146"},"children":[{"type":"text","value":"=>"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-527146"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-f81f11"},"children":[{"type":"text","value":"facet"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-ff5e68"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" { "}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-28054e"},"children":[{"type":"text","value":"name"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-b42748"},"children":[{"type":"text","value":"'category'"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-28054e"},"children":[{"type":"text","value":"query"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-b42748"},"children":[{"type":"text","value":"'phone'"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" }"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-527146"},"children":[{"type":"text","value":"await"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-4296d8"},"children":[{"type":"text","value":"search"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":"({ "}]},{"type":"element","tag":"span","props":{"class":"ct-28054e"},"children":[{"type":"text","value":"facet"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" })"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":"})"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":""}]}]}]}]}]},{"type":"element","tag":"ul","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"result"}]},{"type":"text","value":" will contain a value of a search method. It is reactive computed property that will be populated when a search method will fulfill. This result will have a form described "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/api-reference/api-methods/search-for-facet-values/#response","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"here"}]}]},{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"search"}]},{"type":"text","value":" method is used to fetch the results by the certain facet value pairs like name and query, and populates "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"result"}]},{"type":"text","value":" reactive property. This method requries a parameter for "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"facet"}]},{"type":"text","value":" and accepts an optional parameter of "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"requestOptions"}]},{"type":"text","value":" that you can check out "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/api-reference/api-methods/search/#method-param-requestoptions","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"here"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"For more details about using this search method check out the official documentation "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/api-reference/api-methods/search-for-facet-values/","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"here"}]}]},{"type":"element","tag":"h2","props":{"id":"usealgoliarecommend"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"useAlgoliaRecommend"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Use this composable to get the recommendations matching certain criteria optional request options."}]},{"type":"element","tag":"alert","props":{"type":"info"},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"In order to make this composable work, make sure to setup a "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"recommend"}]},{"type":"text","value":" property to "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"true"}]},{"type":"text","value":" in algolia configuration in "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"nuxt.config.ts"}]},{"type":"text","value":"."}]}]},{"type":"element","tag":"code","props":{"code":"\n","language":"vue"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":"<"}]},{"type":"element","tag":"span","props":{"class":"ct-28054e"},"children":[{"type":"text","value":"script"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-3ce7e3"},"children":[{"type":"text","value":"setup"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":">"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-527146"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" { "}]},{"type":"element","tag":"span","props":{"class":"ct-f81f11"},"children":[{"type":"text","value":"result"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":", "}]},{"type":"element","tag":"span","props":{"class":"ct-f81f11"},"children":[{"type":"text","value":"get"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" } "}]},{"type":"element","tag":"span","props":{"class":"ct-ff5e68"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-4296d8"},"children":[{"type":"text","value":"useAlgoliaRecommend"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":"()"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-4296d8"},"children":[{"type":"text","value":"onMounted"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":"("}]},{"type":"element","tag":"span","props":{"class":"ct-527146"},"children":[{"type":"text","value":"async"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" () "}]},{"type":"element","tag":"span","props":{"class":"ct-527146"},"children":[{"type":"text","value":"=>"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-527146"},"children":[{"type":"text","value":"await"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-4296d8"},"children":[{"type":"text","value":"get"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":"({ "}]},{"type":"element","tag":"span","props":{"class":"ct-28054e"},"children":[{"type":"text","value":"queries"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":": [{ "}]},{"type":"element","tag":"span","props":{"class":"ct-28054e"},"children":[{"type":"text","value":"indexName"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-b42748"},"children":[{"type":"text","value":"'test_index'"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":", "}]},{"type":"element","tag":"span","props":{"class":"ct-28054e"},"children":[{"type":"text","value":"model"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-b42748"},"children":[{"type":"text","value":"'related-products'"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":", "}]},{"type":"element","tag":"span","props":{"class":"ct-28054e"},"children":[{"type":"text","value":"objectID"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-b42748"},"children":[{"type":"text","value":"'dca44dd5-aea6-4553-a3af-fcbda981a2ef'"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" }] });"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":"})"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":""}]}]}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"This composable returns the following:"}]},{"type":"element","tag":"ul","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"result"}]},{"type":"text","value":" will contain a value of a get method. It is reactive computed property that will be populated when a get method will fulfill. This result will have a form described "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/api-reference/api-methods/get-recommendations/#response","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"here"}]}]},{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"get"}]},{"type":"text","value":" method is used to get the recommendations based on the criteria described "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/api-reference/api-methods/get-recommendations/#parameters","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"here"}]},{"type":"text","value":" and an optional parameter of "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"requestOptions"}]},{"type":"text","value":" that you can check out "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/api-reference/api-methods/search/#method-param-requestoptions","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"here"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"This composable also accepts an optional key parameter:"}]},{"type":"element","tag":"ul","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"key"}]},{"type":"text","value":" - if you need multiple useAlgoliaRecommend calls, add a unique key to get passed to the userState('recommend-result') underneath, so new calls won't overwrite old data."}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"For more details check out the official documentation of this method "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/api-reference/api-methods/get-recommendations/","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"here"}]}]},{"type":"element","tag":"h2","props":{"id":"usealgoliaref"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"useAlgoliaRef"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"By calling this composable you have access to "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"algoliasearch"}]},{"type":"text","value":" instance anywhere in your app"}]},{"type":"element","tag":"code","props":{"code":"\n","language":"vue"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":"<"}]},{"type":"element","tag":"span","props":{"class":"ct-28054e"},"children":[{"type":"text","value":"script"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-3ce7e3"},"children":[{"type":"text","value":"setup"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":">"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-527146"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-f81f11"},"children":[{"type":"text","value":"algolia"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-ff5e68"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-4296d8"},"children":[{"type":"text","value":"useAlgoliaRef"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":"()"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":""}]}]}]}]}]},{"type":"element","tag":"h2","props":{"id":"usealgoliainitindex"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"useAlgoliaInitIndex"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Use this composable to initialize index you would like to search through. It accepts an index name as a parameter"}]},{"type":"element","tag":"code","props":{"code":"\n","language":"vue"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":"<"}]},{"type":"element","tag":"span","props":{"class":"ct-28054e"},"children":[{"type":"text","value":"script"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-3ce7e3"},"children":[{"type":"text","value":"setup"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":">"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-527146"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-f81f11"},"children":[{"type":"text","value":"algoliaIndex"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-ff5e68"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-4296d8"},"children":[{"type":"text","value":"useAlgoliaInitIndex"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":"("}]},{"type":"element","tag":"span","props":{"class":"ct-b42748"},"children":[{"type":"text","value":"'test'"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":")"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-f81f11"},"children":[{"type":"text","value":"console"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":"."}]},{"type":"element","tag":"span","props":{"class":"ct-4296d8"},"children":[{"type":"text","value":"log"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":"("}]},{"type":"element","tag":"span","props":{"class":"ct-f81f11"},"children":[{"type":"text","value":"algoliaIndex"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":"."}]},{"type":"element","tag":"span","props":{"class":"ct-28054e"},"children":[{"type":"text","value":"appId"}]},{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":")"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-aaeecd"},"children":[{"type":"text","value":""}]}]}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"For more details about initializing index check out the official documentation "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/api-client/getting-started/instantiate-client-index/javascript/?client=javascript#initialize-an-index","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"here"}]}]},{"type":"element","tag":"style","children":[{"type":"text","value":".ct-1a75bd{color:#7F848E}.ct-b42748{color:#98C379}.ct-4296d8{color:#61AFEF}.ct-ff5e68{color:#56B6C2}.ct-f81f11{color:#E5C07B}.ct-527146{color:#C678DD}.ct-3ce7e3{color:#D19A66}.ct-28054e{color:#E06C75}.ct-aaeecd{color:#ABB2BF}"}]}],"toc":{"title":"","searchDepth":2,"depth":2,"links":[{"id":"usealgoliasearch","depth":2,"text":"useAlgoliaSearch"},{"id":"useasyncalgoliasearch","depth":2,"text":"useAsyncAlgoliaSearch"},{"id":"usealgoliafacetedsearch","depth":2,"text":"useAlgoliaFacetedSearch"},{"id":"usealgoliarecommend","depth":2,"text":"useAlgoliaRecommend"},{"id":"usealgoliaref","depth":2,"text":"useAlgoliaRef"},{"id":"usealgoliainitindex","depth":2,"text":"useAlgoliaInitIndex"}]}},"_type":"markdown","_id":"content:1.getting-started:3.usage.md","_source":"content","_file":"1.getting-started/3.usage.md","_extension":"md"},{"_path":"/advanced/docsearch","_draft":false,"_partial":false,"_empty":false,"title":"DocSearch","description":"","excerpt":{"type":"root","children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"DocSearch provides an easy way for Open Source documentations to have an instant search on their websites!"}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"You probably have seen it in a lot of websites with the "},{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"Cmd+K"}]},{"type":"text","value":" shortcut!"}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Websites like "},{"type":"element","tag":"a","props":{"href":"https://nuxtjs.org","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"nuxtjs.org"}]},{"type":"text","value":", "},{"type":"element","tag":"a","props":{"href":"https://vuejs.org","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"vuejs.org"}]},{"type":"text","value":" uses it to provide an instant search to users without any backend!"}]},{"type":"element","tag":"h2","props":{"id":"installation"},"children":[{"type":"text","value":"Installation"}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"As DocSearch is an additional feature for "},{"type":"element","tag":"a","props":{"href":"https://github.com/nuxt-modules/algolia","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"@nuxt-modules/algolia"}]}]},{"type":"text","value":", it needs two additional dependencies:"}]},{"type":"element","tag":"code-group","props":{},"children":[{"type":"element","tag":"code","props":{"code":"yarn add @docsearch/js @docsearch/css\n","filename":"Yarn","language":"bash"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"text","value":"yarn add @docsearch/js @docsearch/css\n"}]}]}]},{"type":"element","tag":"code","props":{"code":"npm install @docsearch/js @docsearch/css\n","filename":"NPM","language":"bash"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"text","value":"npm install @docsearch/js @docsearch/css\n"}]}]}]},{"type":"element","tag":"code","props":{"code":"pnpm add @docsearch/js @docsearch/css\n","filename":"PNPM","language":"bash"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"text","value":"pnpm add @docsearch/js @docsearch/css\n"}]}]}]}]},{"type":"element","tag":"h2","props":{"id":"configuration"},"children":[{"type":"text","value":"Configuration"}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"You can easily configure DocSearch usage via the "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"docSearch"}]},{"type":"text","value":" key in the module configuration."}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"By default, it is set to "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"false"}]},{"type":"text","value":", which disables it and does not ship anything to your Nuxt app bundle."}]},{"type":"element","tag":"code","props":{"code":"// nuxt.config.ts\nexport default defineNuxtConfig({\n algolia: {\n apiKey: 'apiKey',\n applicationId: 'applicationId',\n // DocSearch key is used to configure DocSearch extension.\n docSearch: {\n indexName: 'indexName',\n }\n } \n})\n","language":"ts"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"text","value":"// nuxt.config.ts\nexport default defineNuxtConfig({\n algolia: {\n apiKey: 'apiKey',\n applicationId: 'applicationId',\n // DocSearch key is used to configure DocSearch extension.\n docSearch: {\n indexName: 'indexName',\n }\n } \n})\n"}]}]}]},{"type":"element","tag":"h3","props":{"id":"supported-options"},"children":[{"type":"text","value":"Supported options"}]},{"type":"element","tag":"h4","props":{"id":"indexname"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"indexName"}]}]},{"type":"element","tag":"blockquote","props":{},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"type: string"}]},{"type":"text","value":" | "},{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"required"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Your Algolia index name."}]},{"type":"element","tag":"h4","props":{"id":"placeholder"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"placeholder"}]}]},{"type":"element","tag":"blockquote","props":{},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"type: string"}]},{"type":"text","value":" | `default: \"Search docs\" | "},{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"optional"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"The placeholder of the input of the DocSearch pop-up modal."}]},{"type":"element","tag":"h4","props":{"id":"searchparameters"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"searchParameters"}]}]},{"type":"element","tag":"blockquote","props":{},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"type: SearchParameters"}]},{"type":"text","value":" | "},{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"optional"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"The "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/api-reference/search-api-parameters/","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"Algolia Search Parameters"}]},{"type":"text","value":"."}]},{"type":"element","tag":"h4","props":{"id":"disableuserpersonalization"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"disableUserPersonalization"}]}]},{"type":"element","tag":"blockquote","props":{},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"type: boolean"}]},{"type":"text","value":" | "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"default: false"}]},{"type":"text","value":" | "},{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"optional"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Disable saving recent searches and favorites to the local storage."}]},{"type":"element","tag":"h4","props":{"id":"initialquery"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"initialQuery"}]}]},{"type":"element","tag":"blockquote","props":{},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"type: string"}]},{"type":"text","value":" | "},{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"optional"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"The search input initial query."}]},{"type":"element","tag":"h4","props":{"id":"translations"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"translations"}]}]},{"type":"element","tag":"blockquote","props":{},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"type: Partial"}]},{"type":"text","value":" | "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"default: docSearchTranslations"}]},{"type":"text","value":" | "},{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"optional"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Allow translations of any raw text and aria-labels present in the DocSearch button or modal components."}]},{"type":"element","tag":"details","props":{},"children":[{"type":"element","tag":"summary","props":{},"children":[{"type":"text","value":"docSearchTranslations"}]},{"type":"element","tag":"div","props":{},"children":[{"type":"element","tag":"code","props":{"code":"const translations: DocSearchTranslations = {\n button: {\n buttonText: 'Search',\n buttonAriaLabel: 'Search',\n },\n modal: {\n searchBox: {\n resetButtonTitle: 'Clear the query',\n resetButtonAriaLabel: 'Clear the query',\n cancelButtonText: 'Cancel',\n cancelButtonAriaLabel: 'Cancel',\n },\n startScreen: {\n recentSearchesTitle: 'Recent',\n noRecentSearchesText: 'No recent searches',\n saveRecentSearchButtonTitle: 'Save this search',\n removeRecentSearchButtonTitle: 'Remove this search from history',\n favoriteSearchesTitle: 'Favorite',\n removeFavoriteSearchButtonTitle: 'Remove this search from favorites',\n },\n errorScreen: {\n titleText: 'Unable to fetch results',\n helpText: 'You might want to check your network connection.',\n },\n footer: {\n selectText: 'to select',\n selectKeyAriaLabel: 'Enter key',\n navigateText: 'to navigate',\n navigateUpKeyAriaLabel: 'Arrow up',\n navigateDownKeyAriaLabel: 'Arrow down',\n closeText: 'to close',\n closeKeyAriaLabel: 'Escape key',\n searchByText: 'Search by',\n },\n noResultsScreen: {\n noResultsText: 'No results for',\n suggestedQueryText: 'Try searching for',\n reportMissingResultsText: 'Believe this query should return results?',\n reportMissingResultsLinkText: 'Let us know.',\n },\n },\n};\n","language":"ts"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"text","value":"const translations: DocSearchTranslations = {\n button: {\n buttonText: 'Search',\n buttonAriaLabel: 'Search',\n },\n modal: {\n searchBox: {\n resetButtonTitle: 'Clear the query',\n resetButtonAriaLabel: 'Clear the query',\n cancelButtonText: 'Cancel',\n cancelButtonAriaLabel: 'Cancel',\n },\n startScreen: {\n recentSearchesTitle: 'Recent',\n noRecentSearchesText: 'No recent searches',\n saveRecentSearchButtonTitle: 'Save this search',\n removeRecentSearchButtonTitle: 'Remove this search from history',\n favoriteSearchesTitle: 'Favorite',\n removeFavoriteSearchButtonTitle: 'Remove this search from favorites',\n },\n errorScreen: {\n titleText: 'Unable to fetch results',\n helpText: 'You might want to check your network connection.',\n },\n footer: {\n selectText: 'to select',\n selectKeyAriaLabel: 'Enter key',\n navigateText: 'to navigate',\n navigateUpKeyAriaLabel: 'Arrow up',\n navigateDownKeyAriaLabel: 'Arrow down',\n closeText: 'to close',\n closeKeyAriaLabel: 'Escape key',\n searchByText: 'Search by',\n },\n noResultsScreen: {\n noResultsText: 'No results for',\n suggestedQueryText: 'Try searching for',\n reportMissingResultsText: 'Believe this query should return results?',\n reportMissingResultsLinkText: 'Let us know.',\n },\n },\n};\n"}]}]}]}]}]},{"type":"element","tag":"h4","props":{"id":"facetfilters"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"facetFilters"}]}]},{"type":"element","tag":"blockquote","props":{},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"type: string"}]},{"type":"text","value":" | "},{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"optional"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"The facetFilters to use in your search parameters. This is local shorthand and provided by "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"@nuxtjs/algolia"}]},{"type":"text","value":"."}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"This will be overwritten if you add "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"facetFilters"}]},{"type":"text","value":" into your "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"searchOptions"}]},{"type":"text","value":" object."}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"See "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/api-reference/api-parameters/facetFilters/","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"algolia facetFilters"}]}]},{"type":"element","tag":"h4","props":{"id":"langattribute"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"langAttribute"}]}]},{"type":"element","tag":"blockquote","props":{},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"type: string"}]},{"type":"text","value":" | "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"default: 'language'"}]},{"type":"text","value":" | "},{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"optional"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"The language to prefix all your facetFilters with. This will be overwritten if you add "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"facetFilters"}]},{"type":"text","value":" into your "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"searchOptions"}]},{"type":"text","value":" object. This is local shorthand and provided by "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"@nuxtjs/algolia"}]},{"type":"text","value":"."}]},{"type":"element","tag":"h4","props":{"id":"lang"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"lang"}]}]},{"type":"element","tag":"blockquote","props":{},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"type: string"}]},{"type":"text","value":" | "},{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"optional"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Default language to be used on the Algolia DocSearch client."}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"If defined, "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"@nuxtjs/algolia"}]},{"type":"text","value":" will add an additional filter to the "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/api-reference/api-parameters/facetFilters/","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"facetFilters"}]},{"type":"text","value":" array like this:"}]},{"type":"element","tag":"code","props":{"code":"const facetFilters = [\n `${options.langAttribute}:${options.lang}`,\n ...options.facetFilters\n]\n","language":"ts"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"text","value":"const facetFilters = [\n `${options.langAttribute}:${options.lang}`,\n ...options.facetFilters\n]\n"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"For example, with the following configuration:"}]},{"type":"element","tag":"code","props":{"code":"// nuxt.config.ts\nexport default defineNuxtConfig({\n algolia: {\n docSearch: {\n // ... other options\n lang: 'en',\n facetFilters: ['category:Book']\n }\n } \n})\n","language":"ts"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"text","value":"// nuxt.config.ts\nexport default defineNuxtConfig({\n algolia: {\n docSearch: {\n // ... other options\n lang: 'en',\n facetFilters: ['category:Book']\n }\n } \n})\n"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"The "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"facetFilters"}]},{"type":"text","value":" sent by "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"@nuxtjs/algolia"}]},{"type":"text","value":" will look like this:"}]},{"type":"element","tag":"code","props":{"code":"['language:en', 'category:Book'] \n","language":"js"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"text","value":"['language:en', 'category:Book'] \n"}]}]}]},{"type":"element","tag":"h2","props":{"id":"component-usage"},"children":[{"type":"text","value":"Component Usage"}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"You can easily add the component anywhere in your app like this:"}]},{"type":"element","tag":"code","props":{"code":"\n \n\n","language":"vue"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"text","value":"\n \n\n"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"The component will use the configuration values declared in "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"nuxt.config.ts"}]},{"type":"text","value":"."}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"You can pass the configuration directly to the component as well if it's more convenient for you, like this:"}]},{"type":"element","tag":"code","props":{"code":"\n \n\n","language":"vue"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"text","value":"\n \n\n"}]}]}]},{"type":"element","tag":"alert","props":{"type":"info"},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"If a specific option is set in both "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"nuxt.config.ts"}]},{"type":"text","value":" and as a component prop, the latter takes precedence."}]}]},{"type":"element","tag":"h3","props":{"id":"additional-component-props"},"children":[{"type":"text","value":"Additional Component Props"}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"These options are only available as component props."}]},{"type":"element","tag":"h4","props":{"id":"transformitems"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"transformItems"}]}]},{"type":"element","tag":"blockquote","props":{},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"type: function"}]},{"type":"text","value":" | "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"default: items => items"}]},{"type":"text","value":" | "},{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"optional"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Receives the items from the search response, and is called before displaying them. Should return a new array with the same shape as the original array. Useful for mapping over the items to transform, and remove or reorder them."}]},{"type":"element","tag":"code","props":{"code":"\n {\n return items.map((item) => ({\n ...item,\n content: item.content.toUpperCase(),\n }));\n }\"\n />\n\n","language":"vue"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"text","value":"\n {\n return items.map((item) => ({\n ...item,\n content: item.content.toUpperCase(),\n }));\n }\"\n />\n\n"}]}]}]},{"type":"element","tag":"h4","props":{"id":"hitcomponent"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"hitComponent"}]}]},{"type":"element","tag":"blockquote","props":{},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"type: ({ hit, children }) => JSX.Element"}]},{"type":"text","value":" | "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"default: Hit"}]},{"type":"text","value":" | "},{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"optional"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"The component to display each item."}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"See the "},{"type":"element","tag":"a","props":{"href":"https://github.com/algolia/docsearch/blob/main/packages/docsearch-react/src/Hit.tsx","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"default implementation"}]},{"type":"text","value":"."}]},{"type":"element","tag":"h4","props":{"id":"transformsearchclient"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"transformSearchClient"}]}]},{"type":"element","tag":"blockquote","props":{},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"type: function"}]},{"type":"text","value":" | "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"default: searchClient => searchClient"}]},{"type":"text","value":" | "},{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"optional"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Useful for transforming the "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/api-client/getting-started/what-is-the-api-client/javascript/?client=javascript","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"Algolia Search Client"}]},{"type":"text","value":", for example to debounce search queries:"}]},{"type":"element","tag":"code","props":{"code":"\n \n\n\n\n","language":"vue"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"text","value":"\n \n\n\n\n"}]}]}]},{"type":"element","tag":"h4","props":{"id":"navigator"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"navigator"}]}]},{"type":"element","tag":"blockquote","props":{},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"type: Navigator"}]},{"type":"text","value":" | "},{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"optional"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"An implementation of "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/ui-libraries/autocomplete/introduction/what-is-autocomplete/","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"Algolia Autocomplete"}]},{"type":"text","value":"’s Navigator API to redirect the user when opening a link."}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Learn more on the "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/ui-libraries/autocomplete/core-concepts/keyboard-navigation/","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"Navigator API"}]},{"type":"text","value":" documentation."}]},{"type":"element","tag":"h4","props":{"id":"getmissingresultsurl"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"getMissingResultsUrl"}]}]},{"type":"element","tag":"blockquote","props":{},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"type: ({ query: string }) => string"}]},{"type":"text","value":" | "},{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"optional"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Function to return the URL of your documentation repository."}]},{"type":"element","tag":"code","props":{"code":"\n \n\n\n\n","language":"vue"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"text","value":"\n \n\n\n\n"}]}]}]},{"type":"element","tag":"h2","props":{"id":"theming"},"children":[{"type":"text","value":"Theming"}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"If you want to theme the component, you can use these files as a reference for available variables/classes:"}]},{"type":"element","tag":"ul","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"a","props":{"href":"https://github.com/algolia/docsearch/blob/next/packages/docsearch-css/src/_variables.css","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"_variables.css"}]}]},{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"a","props":{"href":"https://github.com/algolia/docsearch/blob/next/packages/docsearch-css/src/button.css","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"button.css"}]}]},{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"a","props":{"href":"https://github.com/algolia/docsearch/blob/next/packages/docsearch-css/src/modal.css","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"modal.css"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"The components gets shipped with "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"@docsearch/css"}]},{"type":"text","value":" which is the default theme from "},{"type":"element","tag":"a","props":{"href":"https://algolia.com","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"Algolia"}]},{"type":"text","value":"."}]}]},"body":{"type":"root","children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"DocSearch provides an easy way for Open Source documentations to have an instant search on their websites!"}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"You probably have seen it in a lot of websites with the "},{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"Cmd+K"}]},{"type":"text","value":" shortcut!"}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Websites like "},{"type":"element","tag":"a","props":{"href":"https://nuxtjs.org","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"nuxtjs.org"}]},{"type":"text","value":", "},{"type":"element","tag":"a","props":{"href":"https://vuejs.org","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"vuejs.org"}]},{"type":"text","value":" uses it to provide an instant search to users without any backend!"}]},{"type":"element","tag":"h2","props":{"id":"installation"},"children":[{"type":"text","value":"Installation"}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"As DocSearch is an additional feature for "},{"type":"element","tag":"a","props":{"href":"https://github.com/nuxt-modules/algolia","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"@nuxt-modules/algolia"}]}]},{"type":"text","value":", it needs two additional dependencies:"}]},{"type":"element","tag":"code-group","props":{},"children":[{"type":"element","tag":"code","props":{"code":"yarn add @docsearch/js @docsearch/css\n","filename":"Yarn","language":"bash"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"yarn add @docsearch/js @docsearch/css"}]}]}]}]}]},{"type":"element","tag":"code","props":{"code":"npm install @docsearch/js @docsearch/css\n","filename":"NPM","language":"bash"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"npm install @docsearch/js @docsearch/css"}]}]}]}]}]},{"type":"element","tag":"code","props":{"code":"pnpm add @docsearch/js @docsearch/css\n","filename":"PNPM","language":"bash"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"pnpm add @docsearch/js @docsearch/css"}]}]}]}]}]}]},{"type":"element","tag":"h2","props":{"id":"configuration"},"children":[{"type":"text","value":"Configuration"}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"You can easily configure DocSearch usage via the "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"docSearch"}]},{"type":"text","value":" key in the module configuration."}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"By default, it is set to "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"false"}]},{"type":"text","value":", which disables it and does not ship anything to your Nuxt app bundle."}]},{"type":"element","tag":"code","props":{"code":"// nuxt.config.ts\nexport default defineNuxtConfig({\n algolia: {\n apiKey: 'apiKey',\n applicationId: 'applicationId',\n // DocSearch key is used to configure DocSearch extension.\n docSearch: {\n indexName: 'indexName',\n }\n } \n})\n","language":"ts"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-c239ba"},"children":[{"type":"text","value":"// nuxt.config.ts"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-26e336"},"children":[{"type":"text","value":"export"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-26e336"},"children":[{"type":"text","value":"default"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a1dff3"},"children":[{"type":"text","value":"defineNuxtConfig"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"({"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"algolia"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":": {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"apiKey"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-6e72d0"},"children":[{"type":"text","value":"'apiKey'"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"applicationId"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-6e72d0"},"children":[{"type":"text","value":"'applicationId'"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-c239ba"},"children":[{"type":"text","value":"// DocSearch key is used to configure DocSearch extension."}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"docSearch"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":": {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"indexName"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-6e72d0"},"children":[{"type":"text","value":"'indexName'"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" }"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" } "}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"})"}]}]}]}]}]},{"type":"element","tag":"h3","props":{"id":"supported-options"},"children":[{"type":"text","value":"Supported options"}]},{"type":"element","tag":"h4","props":{"id":"indexname"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"indexName"}]}]},{"type":"element","tag":"blockquote","props":{},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"type: string"}]},{"type":"text","value":" | "},{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"required"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Your Algolia index name."}]},{"type":"element","tag":"h4","props":{"id":"placeholder"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"placeholder"}]}]},{"type":"element","tag":"blockquote","props":{},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"type: string"}]},{"type":"text","value":" | `default: \"Search docs\" | "},{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"optional"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"The placeholder of the input of the DocSearch pop-up modal."}]},{"type":"element","tag":"h4","props":{"id":"searchparameters"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"searchParameters"}]}]},{"type":"element","tag":"blockquote","props":{},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"type: SearchParameters"}]},{"type":"text","value":" | "},{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"optional"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"The "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/api-reference/search-api-parameters/","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"Algolia Search Parameters"}]},{"type":"text","value":"."}]},{"type":"element","tag":"h4","props":{"id":"disableuserpersonalization"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"disableUserPersonalization"}]}]},{"type":"element","tag":"blockquote","props":{},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"type: boolean"}]},{"type":"text","value":" | "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"default: false"}]},{"type":"text","value":" | "},{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"optional"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Disable saving recent searches and favorites to the local storage."}]},{"type":"element","tag":"h4","props":{"id":"initialquery"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"initialQuery"}]}]},{"type":"element","tag":"blockquote","props":{},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"type: string"}]},{"type":"text","value":" | "},{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"optional"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"The search input initial query."}]},{"type":"element","tag":"h4","props":{"id":"translations"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"translations"}]}]},{"type":"element","tag":"blockquote","props":{},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"type: Partial"}]},{"type":"text","value":" | "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"default: docSearchTranslations"}]},{"type":"text","value":" | "},{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"optional"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Allow translations of any raw text and aria-labels present in the DocSearch button or modal components."}]},{"type":"element","tag":"details","props":{},"children":[{"type":"element","tag":"summary","props":{},"children":[{"type":"text","value":"docSearchTranslations"}]},{"type":"element","tag":"div","props":{},"children":[{"type":"element","tag":"code","props":{"code":"const translations: DocSearchTranslations = {\n button: {\n buttonText: 'Search',\n buttonAriaLabel: 'Search',\n },\n modal: {\n searchBox: {\n resetButtonTitle: 'Clear the query',\n resetButtonAriaLabel: 'Clear the query',\n cancelButtonText: 'Cancel',\n cancelButtonAriaLabel: 'Cancel',\n },\n startScreen: {\n recentSearchesTitle: 'Recent',\n noRecentSearchesText: 'No recent searches',\n saveRecentSearchButtonTitle: 'Save this search',\n removeRecentSearchButtonTitle: 'Remove this search from history',\n favoriteSearchesTitle: 'Favorite',\n removeFavoriteSearchButtonTitle: 'Remove this search from favorites',\n },\n errorScreen: {\n titleText: 'Unable to fetch results',\n helpText: 'You might want to check your network connection.',\n },\n footer: {\n selectText: 'to select',\n selectKeyAriaLabel: 'Enter key',\n navigateText: 'to navigate',\n navigateUpKeyAriaLabel: 'Arrow up',\n navigateDownKeyAriaLabel: 'Arrow down',\n closeText: 'to close',\n closeKeyAriaLabel: 'Escape key',\n searchByText: 'Search by',\n },\n noResultsScreen: {\n noResultsText: 'No results for',\n suggestedQueryText: 'Try searching for',\n reportMissingResultsText: 'Believe this query should return results?',\n reportMissingResultsLinkText: 'Let us know.',\n },\n },\n};\n","language":"ts"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-26e336"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-0ef1a9"},"children":[{"type":"text","value":"translations"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-0ef1a9"},"children":[{"type":"text","value":"DocSearchTranslations"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-3ed0c6"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"button"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":": {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"buttonText"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-6e72d0"},"children":[{"type":"text","value":"'Search'"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"buttonAriaLabel"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-6e72d0"},"children":[{"type":"text","value":"'Search'"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" },"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"modal"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":": {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"searchBox"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":": {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"resetButtonTitle"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-6e72d0"},"children":[{"type":"text","value":"'Clear the query'"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"resetButtonAriaLabel"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-6e72d0"},"children":[{"type":"text","value":"'Clear the query'"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"cancelButtonText"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-6e72d0"},"children":[{"type":"text","value":"'Cancel'"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"cancelButtonAriaLabel"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-6e72d0"},"children":[{"type":"text","value":"'Cancel'"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" },"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"startScreen"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":": {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"recentSearchesTitle"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-6e72d0"},"children":[{"type":"text","value":"'Recent'"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"noRecentSearchesText"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-6e72d0"},"children":[{"type":"text","value":"'No recent searches'"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"saveRecentSearchButtonTitle"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-6e72d0"},"children":[{"type":"text","value":"'Save this search'"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"removeRecentSearchButtonTitle"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-6e72d0"},"children":[{"type":"text","value":"'Remove this search from history'"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"favoriteSearchesTitle"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-6e72d0"},"children":[{"type":"text","value":"'Favorite'"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"removeFavoriteSearchButtonTitle"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-6e72d0"},"children":[{"type":"text","value":"'Remove this search from favorites'"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" },"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"errorScreen"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":": {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"titleText"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-6e72d0"},"children":[{"type":"text","value":"'Unable to fetch results'"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"helpText"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-6e72d0"},"children":[{"type":"text","value":"'You might want to check your network connection.'"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" },"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"footer"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":": {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"selectText"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-6e72d0"},"children":[{"type":"text","value":"'to select'"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"selectKeyAriaLabel"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-6e72d0"},"children":[{"type":"text","value":"'Enter key'"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"navigateText"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-6e72d0"},"children":[{"type":"text","value":"'to navigate'"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"navigateUpKeyAriaLabel"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-6e72d0"},"children":[{"type":"text","value":"'Arrow up'"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"navigateDownKeyAriaLabel"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-6e72d0"},"children":[{"type":"text","value":"'Arrow down'"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"closeText"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-6e72d0"},"children":[{"type":"text","value":"'to close'"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"closeKeyAriaLabel"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-6e72d0"},"children":[{"type":"text","value":"'Escape key'"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"searchByText"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-6e72d0"},"children":[{"type":"text","value":"'Search by'"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" },"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"noResultsScreen"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":": {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"noResultsText"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-6e72d0"},"children":[{"type":"text","value":"'No results for'"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"suggestedQueryText"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-6e72d0"},"children":[{"type":"text","value":"'Try searching for'"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"reportMissingResultsText"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-6e72d0"},"children":[{"type":"text","value":"'Believe this query should return results?'"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"reportMissingResultsLinkText"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-6e72d0"},"children":[{"type":"text","value":"'Let us know.'"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" },"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" },"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"};"}]}]}]}]}]}]}]},{"type":"element","tag":"h4","props":{"id":"facetfilters"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"facetFilters"}]}]},{"type":"element","tag":"blockquote","props":{},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"type: string"}]},{"type":"text","value":" | "},{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"optional"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"The facetFilters to use in your search parameters. This is local shorthand and provided by "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"@nuxtjs/algolia"}]},{"type":"text","value":"."}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"This will be overwritten if you add "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"facetFilters"}]},{"type":"text","value":" into your "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"searchOptions"}]},{"type":"text","value":" object."}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"See "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/api-reference/api-parameters/facetFilters/","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"algolia facetFilters"}]}]},{"type":"element","tag":"h4","props":{"id":"langattribute"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"langAttribute"}]}]},{"type":"element","tag":"blockquote","props":{},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"type: string"}]},{"type":"text","value":" | "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"default: 'language'"}]},{"type":"text","value":" | "},{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"optional"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"The language to prefix all your facetFilters with. This will be overwritten if you add "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"facetFilters"}]},{"type":"text","value":" into your "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"searchOptions"}]},{"type":"text","value":" object. This is local shorthand and provided by "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"@nuxtjs/algolia"}]},{"type":"text","value":"."}]},{"type":"element","tag":"h4","props":{"id":"lang"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"lang"}]}]},{"type":"element","tag":"blockquote","props":{},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"type: string"}]},{"type":"text","value":" | "},{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"optional"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Default language to be used on the Algolia DocSearch client."}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"If defined, "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"@nuxtjs/algolia"}]},{"type":"text","value":" will add an additional filter to the "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/api-reference/api-parameters/facetFilters/","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"facetFilters"}]},{"type":"text","value":" array like this:"}]},{"type":"element","tag":"code","props":{"code":"const facetFilters = [\n `${options.langAttribute}:${options.lang}`,\n ...options.facetFilters\n]\n","language":"ts"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-26e336"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-0ef1a9"},"children":[{"type":"text","value":"facetFilters"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-3ed0c6"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" ["}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-6e72d0"},"children":[{"type":"text","value":"`"}]},{"type":"element","tag":"span","props":{"class":"ct-26e336"},"children":[{"type":"text","value":"${"}]},{"type":"element","tag":"span","props":{"class":"ct-0ef1a9"},"children":[{"type":"text","value":"options"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"."}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"langAttribute"}]},{"type":"element","tag":"span","props":{"class":"ct-26e336"},"children":[{"type":"text","value":"}"}]},{"type":"element","tag":"span","props":{"class":"ct-6e72d0"},"children":[{"type":"text","value":":"}]},{"type":"element","tag":"span","props":{"class":"ct-26e336"},"children":[{"type":"text","value":"${"}]},{"type":"element","tag":"span","props":{"class":"ct-0ef1a9"},"children":[{"type":"text","value":"options"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"."}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"lang"}]},{"type":"element","tag":"span","props":{"class":"ct-26e336"},"children":[{"type":"text","value":"}"}]},{"type":"element","tag":"span","props":{"class":"ct-6e72d0"},"children":[{"type":"text","value":"`"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" ..."}]},{"type":"element","tag":"span","props":{"class":"ct-0ef1a9"},"children":[{"type":"text","value":"options"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"."}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"facetFilters"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"]"}]}]}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"For example, with the following configuration:"}]},{"type":"element","tag":"code","props":{"code":"// nuxt.config.ts\nexport default defineNuxtConfig({\n algolia: {\n docSearch: {\n // ... other options\n lang: 'en',\n facetFilters: ['category:Book']\n }\n } \n})\n","language":"ts"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-c239ba"},"children":[{"type":"text","value":"// nuxt.config.ts"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-26e336"},"children":[{"type":"text","value":"export"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-26e336"},"children":[{"type":"text","value":"default"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a1dff3"},"children":[{"type":"text","value":"defineNuxtConfig"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"({"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"algolia"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":": {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"docSearch"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":": {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-c239ba"},"children":[{"type":"text","value":"// ... other options"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"lang"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-6e72d0"},"children":[{"type":"text","value":"'en'"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"facetFilters"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":": ["}]},{"type":"element","tag":"span","props":{"class":"ct-6e72d0"},"children":[{"type":"text","value":"'category:Book'"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"]"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" }"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" } "}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"})"}]}]}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"The "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"facetFilters"}]},{"type":"text","value":" sent by "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"@nuxtjs/algolia"}]},{"type":"text","value":" will look like this:"}]},{"type":"element","tag":"code","props":{"code":"['language:en', 'category:Book'] \n","language":"js"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"["}]},{"type":"element","tag":"span","props":{"class":"ct-6e72d0"},"children":[{"type":"text","value":"'language:en'"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":", "}]},{"type":"element","tag":"span","props":{"class":"ct-6e72d0"},"children":[{"type":"text","value":"'category:Book'"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"] "}]}]}]}]}]},{"type":"element","tag":"h2","props":{"id":"component-usage"},"children":[{"type":"text","value":"Component Usage"}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"You can easily add the component anywhere in your app like this:"}]},{"type":"element","tag":"code","props":{"code":"\n \n\n","language":"vue"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"<"}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"template"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":">"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" <"}]},{"type":"element","tag":"span","props":{"class":"ct-566cfa"},"children":[{"type":"text","value":"AlgoliaDocSearch"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" />"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":""}]}]}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"The component will use the configuration values declared in "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"nuxt.config.ts"}]},{"type":"text","value":"."}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"You can pass the configuration directly to the component as well if it's more convenient for you, like this:"}]},{"type":"element","tag":"code","props":{"code":"\n \n\n","language":"vue"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"<"}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"template"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":">"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" <"}]},{"type":"element","tag":"span","props":{"class":"ct-566cfa"},"children":[{"type":"text","value":"AlgoliaDocSearch"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-566cfa"},"children":[{"type":"text","value":"applicationId"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-6e72d0"},"children":[{"type":"text","value":"\"appId\""}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-566cfa"},"children":[{"type":"text","value":"apiKey"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-6e72d0"},"children":[{"type":"text","value":"\"key\""}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-566cfa"},"children":[{"type":"text","value":"indexName"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-6e72d0"},"children":[{"type":"text","value":"\"indexName\""}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-566cfa"},"children":[{"type":"text","value":"placeholder"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-6e72d0"},"children":[{"type":"text","value":"\"Search\""}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" :"}]},{"type":"element","tag":"span","props":{"class":"ct-566cfa"},"children":[{"type":"text","value":"searchParameters"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"\""}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"{}"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"\""}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" :"}]},{"type":"element","tag":"span","props":{"class":"ct-566cfa"},"children":[{"type":"text","value":"disableUserPersonalization"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"\""}]},{"type":"element","tag":"span","props":{"class":"ct-566cfa"},"children":[{"type":"text","value":"false"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"\""}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-566cfa"},"children":[{"type":"text","value":"initialQuery"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-6e72d0"},"children":[{"type":"text","value":"\"\""}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" :"}]},{"type":"element","tag":"span","props":{"class":"ct-566cfa"},"children":[{"type":"text","value":"translations"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"\""}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"{}"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"\""}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" />"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":""}]}]}]}]}]},{"type":"element","tag":"alert","props":{"type":"info"},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"If a specific option is set in both "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"nuxt.config.ts"}]},{"type":"text","value":" and as a component prop, the latter takes precedence."}]}]},{"type":"element","tag":"h3","props":{"id":"additional-component-props"},"children":[{"type":"text","value":"Additional Component Props"}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"These options are only available as component props."}]},{"type":"element","tag":"h4","props":{"id":"transformitems"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"transformItems"}]}]},{"type":"element","tag":"blockquote","props":{},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"type: function"}]},{"type":"text","value":" | "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"default: items => items"}]},{"type":"text","value":" | "},{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"optional"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Receives the items from the search response, and is called before displaying them. Should return a new array with the same shape as the original array. Useful for mapping over the items to transform, and remove or reorder them."}]},{"type":"element","tag":"code","props":{"code":"\n {\n return items.map((item) => ({\n ...item,\n content: item.content.toUpperCase(),\n }));\n }\"\n />\n\n","language":"vue"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"<"}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"template"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":">"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" <"}]},{"type":"element","tag":"span","props":{"class":"ct-566cfa"},"children":[{"type":"text","value":"AlgoliaDocSearch"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" :"}]},{"type":"element","tag":"span","props":{"class":"ct-566cfa"},"children":[{"type":"text","value":"transform-items"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"\""}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"("}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"items"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":") "}]},{"type":"element","tag":"span","props":{"class":"ct-26e336"},"children":[{"type":"text","value":"=>"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-26e336"},"children":[{"type":"text","value":"return"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-0ef1a9"},"children":[{"type":"text","value":"items"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"."}]},{"type":"element","tag":"span","props":{"class":"ct-a1dff3"},"children":[{"type":"text","value":"map"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"(("}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"item"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":") "}]},{"type":"element","tag":"span","props":{"class":"ct-26e336"},"children":[{"type":"text","value":"=>"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" ({"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" ..."}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"item"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"content"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-0ef1a9"},"children":[{"type":"text","value":"item"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"."}]},{"type":"element","tag":"span","props":{"class":"ct-0ef1a9"},"children":[{"type":"text","value":"content"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"."}]},{"type":"element","tag":"span","props":{"class":"ct-a1dff3"},"children":[{"type":"text","value":"toUpperCase"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"(),"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" }));"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" }"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"\""}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" />"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":""}]}]}]}]}]},{"type":"element","tag":"h4","props":{"id":"hitcomponent"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"hitComponent"}]}]},{"type":"element","tag":"blockquote","props":{},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"type: ({ hit, children }) => JSX.Element"}]},{"type":"text","value":" | "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"default: Hit"}]},{"type":"text","value":" | "},{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"optional"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"The component to display each item."}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"See the "},{"type":"element","tag":"a","props":{"href":"https://github.com/algolia/docsearch/blob/main/packages/docsearch-react/src/Hit.tsx","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"default implementation"}]},{"type":"text","value":"."}]},{"type":"element","tag":"h4","props":{"id":"transformsearchclient"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"transformSearchClient"}]}]},{"type":"element","tag":"blockquote","props":{},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"type: function"}]},{"type":"text","value":" | "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"default: searchClient => searchClient"}]},{"type":"text","value":" | "},{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"optional"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Useful for transforming the "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/api-client/getting-started/what-is-the-api-client/javascript/?client=javascript","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"Algolia Search Client"}]},{"type":"text","value":", for example to debounce search queries:"}]},{"type":"element","tag":"code","props":{"code":"\n \n\n\n\n","language":"vue"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"<"}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"template"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":">"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" <"}]},{"type":"element","tag":"span","props":{"class":"ct-566cfa"},"children":[{"type":"text","value":"AlgoliaDocSearch"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" :"}]},{"type":"element","tag":"span","props":{"class":"ct-566cfa"},"children":[{"type":"text","value":"transform-search-client"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"\""}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"transformSearchClient"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"\""}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" />"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":""}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"<"}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"script"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-566cfa"},"children":[{"type":"text","value":"setup"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-566cfa"},"children":[{"type":"text","value":"lang"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-6e72d0"},"children":[{"type":"text","value":"\"ts\""}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":">"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-26e336"},"children":[{"type":"text","value":"import"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-26e336"},"children":[{"type":"text","value":"type"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" { "}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"SearchClient"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" } "}]},{"type":"element","tag":"span","props":{"class":"ct-26e336"},"children":[{"type":"text","value":"from"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-6e72d0"},"children":[{"type":"text","value":"'algoliasearch'"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-26e336"},"children":[{"type":"text","value":"import"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-26e336"},"children":[{"type":"text","value":"type"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" { "}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"DocSearchProps"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" } "}]},{"type":"element","tag":"span","props":{"class":"ct-26e336"},"children":[{"type":"text","value":"from"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-6e72d0"},"children":[{"type":"text","value":"'docsearch'"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-26e336"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a1dff3"},"children":[{"type":"text","value":"transformSearchClient"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-0ef1a9"},"children":[{"type":"text","value":"DocSearchProps"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"["}]},{"type":"element","tag":"span","props":{"class":"ct-6e72d0"},"children":[{"type":"text","value":"'transformSearchClient'"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"] "}]},{"type":"element","tag":"span","props":{"class":"ct-3ed0c6"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" ("}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"searchClient"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":") "}]},{"type":"element","tag":"span","props":{"class":"ct-26e336"},"children":[{"type":"text","value":"=>"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-26e336"},"children":[{"type":"text","value":"return"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" ..."}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"searchClient"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"search"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-a1dff3"},"children":[{"type":"text","value":"debounce"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"("}]},{"type":"element","tag":"span","props":{"class":"ct-0ef1a9"},"children":[{"type":"text","value":"searchClient"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"."}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"search"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":", "}]},{"type":"element","tag":"span","props":{"class":"ct-566cfa"},"children":[{"type":"text","value":"5000"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":")"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" } "}]},{"type":"element","tag":"span","props":{"class":"ct-26e336"},"children":[{"type":"text","value":"as"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-0ef1a9"},"children":[{"type":"text","value":"SearchClient"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"}"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-26e336"},"children":[{"type":"text","value":"function"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a1dff3"},"children":[{"type":"text","value":"debounce"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" ("}]},{"type":"element","tag":"span","props":{"class":"ct-a1dff3"},"children":[{"type":"text","value":"func"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":": (..."}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"args"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-0ef1a9"},"children":[{"type":"text","value":"unknown"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"[]) "}]},{"type":"element","tag":"span","props":{"class":"ct-26e336"},"children":[{"type":"text","value":"=>"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-0ef1a9"},"children":[{"type":"text","value":"unknown"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":", "}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"wait"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-3ed0c6"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-566cfa"},"children":[{"type":"text","value":"100"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":") {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-26e336"},"children":[{"type":"text","value":"let"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"lastTimeout"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-3ed0c6"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-566cfa"},"children":[{"type":"text","value":"null"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-26e336"},"children":[{"type":"text","value":"return"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-26e336"},"children":[{"type":"text","value":"function"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" (..."}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"args"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":") {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-26e336"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-0ef1a9"},"children":[{"type":"text","value":"that"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-3ed0c6"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-0ef1a9"},"children":[{"type":"text","value":"this"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-26e336"},"children":[{"type":"text","value":"return"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-26e336"},"children":[{"type":"text","value":"new"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-0ef1a9"},"children":[{"type":"text","value":"Promise"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"(("}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"resolve"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":", "}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"reject"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":") "}]},{"type":"element","tag":"span","props":{"class":"ct-26e336"},"children":[{"type":"text","value":"=>"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-26e336"},"children":[{"type":"text","value":"if"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" ("}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"lastTimeout"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":") {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-3ed0c6"},"children":[{"type":"text","value":"clearTimeout"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"("}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"lastTimeout"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":")"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" }"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"lastTimeout"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-3ed0c6"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-3ed0c6"},"children":[{"type":"text","value":"setTimeout"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"(() "}]},{"type":"element","tag":"span","props":{"class":"ct-26e336"},"children":[{"type":"text","value":"=>"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"lastTimeout"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-3ed0c6"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-566cfa"},"children":[{"type":"text","value":"null"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-0ef1a9"},"children":[{"type":"text","value":"Promise"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"."}]},{"type":"element","tag":"span","props":{"class":"ct-a1dff3"},"children":[{"type":"text","value":"resolve"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"("}]},{"type":"element","tag":"span","props":{"class":"ct-0ef1a9"},"children":[{"type":"text","value":"func"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"."}]},{"type":"element","tag":"span","props":{"class":"ct-a1dff3"},"children":[{"type":"text","value":"apply"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"("}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"that"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":", "}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"args"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"))."}]},{"type":"element","tag":"span","props":{"class":"ct-a1dff3"},"children":[{"type":"text","value":"then"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"("}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"resolve"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":")."}]},{"type":"element","tag":"span","props":{"class":"ct-a1dff3"},"children":[{"type":"text","value":"catch"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"("}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"reject"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":")"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" }, "}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"wait"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":")"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" })"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" }"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"}"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":""}]}]}]}]}]},{"type":"element","tag":"h4","props":{"id":"navigator"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"navigator"}]}]},{"type":"element","tag":"blockquote","props":{},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"type: Navigator"}]},{"type":"text","value":" | "},{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"optional"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"An implementation of "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/ui-libraries/autocomplete/introduction/what-is-autocomplete/","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"Algolia Autocomplete"}]},{"type":"text","value":"’s Navigator API to redirect the user when opening a link."}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Learn more on the "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/ui-libraries/autocomplete/core-concepts/keyboard-navigation/","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"Navigator API"}]},{"type":"text","value":" documentation."}]},{"type":"element","tag":"h4","props":{"id":"getmissingresultsurl"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"getMissingResultsUrl"}]}]},{"type":"element","tag":"blockquote","props":{},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"type: ({ query: string }) => string"}]},{"type":"text","value":" | "},{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"optional"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Function to return the URL of your documentation repository."}]},{"type":"element","tag":"code","props":{"code":"\n \n\n\n\n","language":"vue"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"<"}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"template"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":">"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" <"}]},{"type":"element","tag":"span","props":{"class":"ct-566cfa"},"children":[{"type":"text","value":"AlgoliaDocSearch"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" :"}]},{"type":"element","tag":"span","props":{"class":"ct-566cfa"},"children":[{"type":"text","value":"get-missing-results-url"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"\""}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"getMissingResultsUrl"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"\""}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" />"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":""}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"<"}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"script"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-566cfa"},"children":[{"type":"text","value":"setup"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-566cfa"},"children":[{"type":"text","value":"lang"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-6e72d0"},"children":[{"type":"text","value":"\"ts\""}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":">"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-26e336"},"children":[{"type":"text","value":"import"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-26e336"},"children":[{"type":"text","value":"type"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" { "}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"DocSearchProps"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" } "}]},{"type":"element","tag":"span","props":{"class":"ct-26e336"},"children":[{"type":"text","value":"from"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-6e72d0"},"children":[{"type":"text","value":"'docsearch'"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-26e336"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a1dff3"},"children":[{"type":"text","value":"getMissingResultsUrl"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-0ef1a9"},"children":[{"type":"text","value":"DocSearchProps"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"["}]},{"type":"element","tag":"span","props":{"class":"ct-6e72d0"},"children":[{"type":"text","value":"'getMissingResultsUrl'"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"] "}]},{"type":"element","tag":"span","props":{"class":"ct-3ed0c6"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" ({ "}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"query"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" }) "}]},{"type":"element","tag":"span","props":{"class":"ct-26e336"},"children":[{"type":"text","value":"=>"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-26e336"},"children":[{"type":"text","value":"return"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-6e72d0"},"children":[{"type":"text","value":"`https://github.com/algolia/docsearch/issues/new?title="}]},{"type":"element","tag":"span","props":{"class":"ct-26e336"},"children":[{"type":"text","value":"${"}]},{"type":"element","tag":"span","props":{"class":"ct-a00e8c"},"children":[{"type":"text","value":"query"}]},{"type":"element","tag":"span","props":{"class":"ct-26e336"},"children":[{"type":"text","value":"}"}]},{"type":"element","tag":"span","props":{"class":"ct-6e72d0"},"children":[{"type":"text","value":"`"}]},{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":";"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":"}"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-6cab9e"},"children":[{"type":"text","value":""}]}]}]}]}]},{"type":"element","tag":"h2","props":{"id":"theming"},"children":[{"type":"text","value":"Theming"}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"If you want to theme the component, you can use these files as a reference for available variables/classes:"}]},{"type":"element","tag":"ul","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"a","props":{"href":"https://github.com/algolia/docsearch/blob/next/packages/docsearch-css/src/_variables.css","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"_variables.css"}]}]},{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"a","props":{"href":"https://github.com/algolia/docsearch/blob/next/packages/docsearch-css/src/button.css","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"button.css"}]}]},{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"a","props":{"href":"https://github.com/algolia/docsearch/blob/next/packages/docsearch-css/src/modal.css","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"modal.css"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"The components gets shipped with "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"@docsearch/css"}]},{"type":"text","value":" which is the default theme from "},{"type":"element","tag":"a","props":{"href":"https://algolia.com","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"Algolia"}]},{"type":"text","value":"."}]},{"type":"element","tag":"style","children":[{"type":"text","value":".ct-566cfa{color:#D19A66}.ct-3ed0c6{color:#56B6C2}.ct-0ef1a9{color:#E5C07B}.ct-6e72d0{color:#98C379}.ct-a00e8c{color:#E06C75}.ct-a1dff3{color:#61AFEF}.ct-26e336{color:#C678DD}.ct-c239ba{color:#7F848E}.ct-6cab9e{color:#ABB2BF}"}]}],"toc":{"title":"","searchDepth":2,"depth":2,"links":[{"id":"installation","depth":2,"text":"Installation"},{"id":"configuration","depth":2,"text":"Configuration","children":[{"id":"supported-options","depth":3,"text":"Supported options"}]},{"id":"component-usage","depth":2,"text":"Component Usage","children":[{"id":"additional-component-props","depth":3,"text":"Additional Component Props"}]},{"id":"theming","depth":2,"text":"Theming"}]}},"_type":"markdown","_id":"content:2.advanced:3.docsearch.md","_source":"content","_file":"2.advanced/3.docsearch.md","_extension":"md"}]