[{"_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://v3.nuxtjs.org/docs/directory-structure/composables","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":"<script setup>\nconst { result, search } = useAlgoliaSearch('test_index') // pass your index name as param\n\nonMounted(async () => {\n  await search({ query: 'Samsung' });\n})\n</script>\n","language":"vue"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"text","value":"<script setup>\nconst { result, search } = useAlgoliaSearch('test_index') // pass your index name as param\n\nonMounted(async () => {\n  await search({ query: 'Samsung' });\n})\n</script>\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":"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":"<script setup>\nconst { result, search } = useAlgoliaFacetedSearch('test_index')\n\nonMounted(async () => {\n  const facet = { \n    name: 'category',\n    query: 'phone'\n   }\n  await search({ facet })\n})\n</script>\n","language":"vue"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"text","value":"<script setup>\nconst { result, search } = useAlgoliaFacetedSearch('test_index')\n\nonMounted(async () => {\n  const facet = { \n    name: 'category',\n    query: 'phone'\n   }\n  await search({ facet })\n})\n</script>\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":"<script setup>\nconst { result, get } = useAlgoliaRecommend()\n\nonMounted(async () => {\n  await get({ queries: [{ indexName: 'test_index', model: 'related-products', objectID: 'dca44dd5-aea6-4553-a3af-fcbda981a2ef' }] });\n})\n</script>\n","language":"vue"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"text","value":"<script setup>\nconst { result, get } = useAlgoliaRecommend()\n\nonMounted(async () => {\n  await get({ queries: [{ indexName: 'test_index', model: 'related-products', objectID: 'dca44dd5-aea6-4553-a3af-fcbda981a2ef' }] });\n})\n</script>\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 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":"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":"<script setup>\nconst algolia = useAlgoliaRef()\n</script>\n","language":"vue"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"text","value":"<script setup>\nconst algolia = useAlgoliaRef()\n</script>\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":"<script setup>\nconst algoliaIndex = useAlgoliaInitIndex('test')\n\nconsole.log(algoliaIndex.appId)\n</script>\n","language":"vue"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"text","value":"<script setup>\nconst algoliaIndex = useAlgoliaInitIndex('test')\n\nconsole.log(algoliaIndex.appId)\n</script>\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://v3.nuxtjs.org/docs/directory-structure/composables","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":"<script setup>\nconst { result, search } = useAlgoliaSearch('test_index') // pass your index name as param\n\nonMounted(async () => {\n  await search({ query: 'Samsung' });\n})\n</script>\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-df6d14"},"children":[{"type":"text","value":"<"}]},{"type":"element","tag":"span","props":{"class":"ct-211cf8"},"children":[{"type":"text","value":"script"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-d4f8b2"},"children":[{"type":"text","value":"setup"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":">"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-30a487"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":" { "}]},{"type":"element","tag":"span","props":{"class":"ct-f5b83e"},"children":[{"type":"text","value":"result"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":", "}]},{"type":"element","tag":"span","props":{"class":"ct-f5b83e"},"children":[{"type":"text","value":"search"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":" } "}]},{"type":"element","tag":"span","props":{"class":"ct-b98c14"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-bbfe83"},"children":[{"type":"text","value":"useAlgoliaSearch"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":"("}]},{"type":"element","tag":"span","props":{"class":"ct-6d3686"},"children":[{"type":"text","value":"'test_index'"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":") "}]},{"type":"element","tag":"span","props":{"class":"ct-bfacb2"},"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-bbfe83"},"children":[{"type":"text","value":"onMounted"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":"("}]},{"type":"element","tag":"span","props":{"class":"ct-30a487"},"children":[{"type":"text","value":"async"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":" () "}]},{"type":"element","tag":"span","props":{"class":"ct-30a487"},"children":[{"type":"text","value":"=>"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":" {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":"  "}]},{"type":"element","tag":"span","props":{"class":"ct-30a487"},"children":[{"type":"text","value":"await"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-bbfe83"},"children":[{"type":"text","value":"search"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":"({ "}]},{"type":"element","tag":"span","props":{"class":"ct-211cf8"},"children":[{"type":"text","value":"query"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-6d3686"},"children":[{"type":"text","value":"'Samsung'"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":" });"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":"})"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":"</"}]},{"type":"element","tag":"span","props":{"class":"ct-211cf8"},"children":[{"type":"text","value":"script"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"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":"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":"<script setup>\nconst { result, search } = useAlgoliaFacetedSearch('test_index')\n\nonMounted(async () => {\n  const facet = { \n    name: 'category',\n    query: 'phone'\n   }\n  await search({ facet })\n})\n</script>\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-df6d14"},"children":[{"type":"text","value":"<"}]},{"type":"element","tag":"span","props":{"class":"ct-211cf8"},"children":[{"type":"text","value":"script"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-d4f8b2"},"children":[{"type":"text","value":"setup"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":">"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-30a487"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":" { "}]},{"type":"element","tag":"span","props":{"class":"ct-f5b83e"},"children":[{"type":"text","value":"result"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":", "}]},{"type":"element","tag":"span","props":{"class":"ct-f5b83e"},"children":[{"type":"text","value":"search"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":" } "}]},{"type":"element","tag":"span","props":{"class":"ct-b98c14"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-bbfe83"},"children":[{"type":"text","value":"useAlgoliaFacetedSearch"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":"("}]},{"type":"element","tag":"span","props":{"class":"ct-6d3686"},"children":[{"type":"text","value":"'test_index'"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"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-bbfe83"},"children":[{"type":"text","value":"onMounted"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":"("}]},{"type":"element","tag":"span","props":{"class":"ct-30a487"},"children":[{"type":"text","value":"async"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":" () "}]},{"type":"element","tag":"span","props":{"class":"ct-30a487"},"children":[{"type":"text","value":"=>"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":" {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":"  "}]},{"type":"element","tag":"span","props":{"class":"ct-30a487"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-f5b83e"},"children":[{"type":"text","value":"facet"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-b98c14"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":" { "}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":"    "}]},{"type":"element","tag":"span","props":{"class":"ct-211cf8"},"children":[{"type":"text","value":"name"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-6d3686"},"children":[{"type":"text","value":"'category'"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":"    "}]},{"type":"element","tag":"span","props":{"class":"ct-211cf8"},"children":[{"type":"text","value":"query"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-6d3686"},"children":[{"type":"text","value":"'phone'"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":"   }"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":"  "}]},{"type":"element","tag":"span","props":{"class":"ct-30a487"},"children":[{"type":"text","value":"await"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-bbfe83"},"children":[{"type":"text","value":"search"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":"({ "}]},{"type":"element","tag":"span","props":{"class":"ct-211cf8"},"children":[{"type":"text","value":"facet"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":" })"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":"})"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":"</"}]},{"type":"element","tag":"span","props":{"class":"ct-211cf8"},"children":[{"type":"text","value":"script"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"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":"<script setup>\nconst { result, get } = useAlgoliaRecommend()\n\nonMounted(async () => {\n  await get({ queries: [{ indexName: 'test_index', model: 'related-products', objectID: 'dca44dd5-aea6-4553-a3af-fcbda981a2ef' }] });\n})\n</script>\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-df6d14"},"children":[{"type":"text","value":"<"}]},{"type":"element","tag":"span","props":{"class":"ct-211cf8"},"children":[{"type":"text","value":"script"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-d4f8b2"},"children":[{"type":"text","value":"setup"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":">"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-30a487"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":" { "}]},{"type":"element","tag":"span","props":{"class":"ct-f5b83e"},"children":[{"type":"text","value":"result"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":", "}]},{"type":"element","tag":"span","props":{"class":"ct-f5b83e"},"children":[{"type":"text","value":"get"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":" } "}]},{"type":"element","tag":"span","props":{"class":"ct-b98c14"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-bbfe83"},"children":[{"type":"text","value":"useAlgoliaRecommend"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"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-bbfe83"},"children":[{"type":"text","value":"onMounted"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":"("}]},{"type":"element","tag":"span","props":{"class":"ct-30a487"},"children":[{"type":"text","value":"async"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":" () "}]},{"type":"element","tag":"span","props":{"class":"ct-30a487"},"children":[{"type":"text","value":"=>"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":" {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":"  "}]},{"type":"element","tag":"span","props":{"class":"ct-30a487"},"children":[{"type":"text","value":"await"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-bbfe83"},"children":[{"type":"text","value":"get"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":"({ "}]},{"type":"element","tag":"span","props":{"class":"ct-211cf8"},"children":[{"type":"text","value":"queries"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":": [{ "}]},{"type":"element","tag":"span","props":{"class":"ct-211cf8"},"children":[{"type":"text","value":"indexName"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-6d3686"},"children":[{"type":"text","value":"'test_index'"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":", "}]},{"type":"element","tag":"span","props":{"class":"ct-211cf8"},"children":[{"type":"text","value":"model"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-6d3686"},"children":[{"type":"text","value":"'related-products'"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":", "}]},{"type":"element","tag":"span","props":{"class":"ct-211cf8"},"children":[{"type":"text","value":"objectID"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-6d3686"},"children":[{"type":"text","value":"'dca44dd5-aea6-4553-a3af-fcbda981a2ef'"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":" }] });"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":"})"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":"</"}]},{"type":"element","tag":"span","props":{"class":"ct-211cf8"},"children":[{"type":"text","value":"script"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"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 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":"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":"<script setup>\nconst algolia = useAlgoliaRef()\n</script>\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-df6d14"},"children":[{"type":"text","value":"<"}]},{"type":"element","tag":"span","props":{"class":"ct-211cf8"},"children":[{"type":"text","value":"script"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-d4f8b2"},"children":[{"type":"text","value":"setup"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":">"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-30a487"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-f5b83e"},"children":[{"type":"text","value":"algolia"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-b98c14"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-bbfe83"},"children":[{"type":"text","value":"useAlgoliaRef"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":"()"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":"</"}]},{"type":"element","tag":"span","props":{"class":"ct-211cf8"},"children":[{"type":"text","value":"script"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"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":"<script setup>\nconst algoliaIndex = useAlgoliaInitIndex('test')\n\nconsole.log(algoliaIndex.appId)\n</script>\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-df6d14"},"children":[{"type":"text","value":"<"}]},{"type":"element","tag":"span","props":{"class":"ct-211cf8"},"children":[{"type":"text","value":"script"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-d4f8b2"},"children":[{"type":"text","value":"setup"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":">"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-30a487"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-f5b83e"},"children":[{"type":"text","value":"algoliaIndex"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-b98c14"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-bbfe83"},"children":[{"type":"text","value":"useAlgoliaInitIndex"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":"("}]},{"type":"element","tag":"span","props":{"class":"ct-6d3686"},"children":[{"type":"text","value":"'test'"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"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-f5b83e"},"children":[{"type":"text","value":"console"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":"."}]},{"type":"element","tag":"span","props":{"class":"ct-bbfe83"},"children":[{"type":"text","value":"log"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":"("}]},{"type":"element","tag":"span","props":{"class":"ct-f5b83e"},"children":[{"type":"text","value":"algoliaIndex"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":"."}]},{"type":"element","tag":"span","props":{"class":"ct-211cf8"},"children":[{"type":"text","value":"appId"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":")"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"children":[{"type":"text","value":"</"}]},{"type":"element","tag":"span","props":{"class":"ct-211cf8"},"children":[{"type":"text","value":"script"}]},{"type":"element","tag":"span","props":{"class":"ct-df6d14"},"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-bfacb2{color:#7F848E}.ct-6d3686{color:#98C379}.ct-bbfe83{color:#61AFEF}.ct-b98c14{color:#56B6C2}.ct-f5b83e{color:#E5C07B}.ct-30a487{color:#C678DD}.ct-d4f8b2{color:#D19A66}.ct-211cf8{color:#E06C75}.ct-df6d14{color:#ABB2BF}"}]}],"toc":{"title":"","searchDepth":2,"depth":2,"links":[{"id":"usealgoliasearch","depth":2,"text":"useAlgoliaSearch"},{"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/nuxtjs/algolia-module","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"@nuxtjs/algolia-module"}]}]},{"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":"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":"p","props":{},"children":[{"type":"text","value":"This key is fully typed and links you to the "},{"type":"element","tag":"a","props":{"href":"https://docsearch.algolia.com/docs/api","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"DocSearch API reference"}]},{"type":"text","value":" for each key."}]},{"type":"element","tag":"code","props":{"code":"// nuxt.config.ts\n{\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":"javascript"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"text","value":"// nuxt.config.ts\n{\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":"p","props":{},"children":[{"type":"text","value":"You can find a list of every supported parameters by looking at the type definition ("},{"type":"element","tag":"a","props":{"href":"https://github.com/nuxt-community/algolia-module/tree/main/src/types.ts","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"DocSearchOptions"}]},{"type":"text","value":")."}]},{"type":"element","tag":"h2","props":{"id":"usage"},"children":[{"type":"text","value":"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":"<template>\n  <AlgoliaDocSearch :options=\"options\" />\n</template>\n","language":"vue"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"text","value":"<template>\n  <AlgoliaDocSearch :options=\"options\" />\n</template>\n"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"options"}]},{"type":"text","value":" key is optional."}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"The component will try to resolve the configuration by itself via "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"useRuntimeConfig"}]},{"type":"text","value":"."}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"If you want to overwrite the config from your "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"nuxt.config"}]},{"type":"text","value":", you can pass the object via the prop."}]},{"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/nuxtjs/algolia-module","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"@nuxtjs/algolia-module"}]}]},{"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-b39e34"},"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-b39e34"},"children":[{"type":"text","value":"npm install @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":"p","props":{},"children":[{"type":"text","value":"This key is fully typed and links you to the "},{"type":"element","tag":"a","props":{"href":"https://docsearch.algolia.com/docs/api","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"DocSearch API reference"}]},{"type":"text","value":" for each key."}]},{"type":"element","tag":"code","props":{"code":"// nuxt.config.ts\n{\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":"javascript"},"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-b3c6d3"},"children":[{"type":"text","value":"// nuxt.config.ts"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-b39e34"},"children":[{"type":"text","value":"{"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-b39e34"},"children":[{"type":"text","value":"  algolia: {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-b39e34"},"children":[{"type":"text","value":"    apiKey: "}]},{"type":"element","tag":"span","props":{"class":"ct-51ac23"},"children":[{"type":"text","value":"'apiKey'"}]},{"type":"element","tag":"span","props":{"class":"ct-b39e34"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-b39e34"},"children":[{"type":"text","value":"    applicationId: "}]},{"type":"element","tag":"span","props":{"class":"ct-51ac23"},"children":[{"type":"text","value":"'applicationId'"}]},{"type":"element","tag":"span","props":{"class":"ct-b39e34"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-b39e34"},"children":[{"type":"text","value":"    "}]},{"type":"element","tag":"span","props":{"class":"ct-b3c6d3"},"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-b39e34"},"children":[{"type":"text","value":"    docSearch: {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-b39e34"},"children":[{"type":"text","value":"      indexName: "}]},{"type":"element","tag":"span","props":{"class":"ct-51ac23"},"children":[{"type":"text","value":"'indexName'"}]},{"type":"element","tag":"span","props":{"class":"ct-b39e34"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-b39e34"},"children":[{"type":"text","value":"    }"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-b39e34"},"children":[{"type":"text","value":"  }  "}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-b39e34"},"children":[{"type":"text","value":"}"}]}]}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"You can find a list of every supported parameters by looking at the type definition ("},{"type":"element","tag":"a","props":{"href":"https://github.com/nuxt-community/algolia-module/tree/main/src/types.ts","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"DocSearchOptions"}]},{"type":"text","value":")."}]},{"type":"element","tag":"h2","props":{"id":"usage"},"children":[{"type":"text","value":"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":"<template>\n  <AlgoliaDocSearch :options=\"options\" />\n</template>\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-b39e34"},"children":[{"type":"text","value":"<"}]},{"type":"element","tag":"span","props":{"class":"ct-cb6e74"},"children":[{"type":"text","value":"template"}]},{"type":"element","tag":"span","props":{"class":"ct-b39e34"},"children":[{"type":"text","value":">"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-b39e34"},"children":[{"type":"text","value":"  <"}]},{"type":"element","tag":"span","props":{"class":"ct-b0eeec"},"children":[{"type":"text","value":"AlgoliaDocSearch"}]},{"type":"element","tag":"span","props":{"class":"ct-b39e34"},"children":[{"type":"text","value":" :"}]},{"type":"element","tag":"span","props":{"class":"ct-b0eeec"},"children":[{"type":"text","value":"options"}]},{"type":"element","tag":"span","props":{"class":"ct-b39e34"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-b39e34"},"children":[{"type":"text","value":"\""}]},{"type":"element","tag":"span","props":{"class":"ct-cb6e74"},"children":[{"type":"text","value":"options"}]},{"type":"element","tag":"span","props":{"class":"ct-b39e34"},"children":[{"type":"text","value":"\""}]},{"type":"element","tag":"span","props":{"class":"ct-b39e34"},"children":[{"type":"text","value":" />"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-b39e34"},"children":[{"type":"text","value":"</"}]},{"type":"element","tag":"span","props":{"class":"ct-cb6e74"},"children":[{"type":"text","value":"template"}]},{"type":"element","tag":"span","props":{"class":"ct-b39e34"},"children":[{"type":"text","value":">"}]}]}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"options"}]},{"type":"text","value":" key is optional."}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"The component will try to resolve the configuration by itself via "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"useRuntimeConfig"}]},{"type":"text","value":"."}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"If you want to overwrite the config from your "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"nuxt.config"}]},{"type":"text","value":", you can pass the object via the prop."}]},{"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-b0eeec{color:#D19A66}.ct-cb6e74{color:#E06C75}.ct-51ac23{color:#98C379}.ct-b3c6d3{color:#7F848E}.ct-b39e34{color:#ABB2BF}"}]}],"toc":{"title":"","searchDepth":2,"depth":2,"links":[{"id":"installation","depth":2,"text":"Installation"},{"id":"configuration","depth":2,"text":"Configuration"},{"id":"usage","depth":2,"text":"Usage"},{"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"}]