[{"_path":"/getting-started/configuration","_draft":false,"_partial":false,"_empty":false,"title":"Configuration","description":"","excerpt":{"type":"root","children":[{"type":"element","tag":"h2","props":{"id":"options"},"children":[{"type":"text","value":"Options"}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Defaults:"}]},{"type":"element","tag":"code","props":{"code":"{\n apiKey: '',\n applicationId: '',\n lite: true,\n instantSearch: true,\n crawler: {\n apiKey: '',\n indexName: '',\n meta: ['title', 'description'],\n include: () => true\n },\n recommend: true,\n indexer: {\n storyblok: {\n secret: 'INDEXER_SECRET',\n algoliaAdminApiKey: 'ALGOLIA_ADMIN_KEY',\n indexName: 'ALGOLIA_INDEX_NAME',\n accessToken: 'STORYBLOK_ACCESS_TOKEN'\n }\n }\n}\n","language":"ts"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"text","value":"{\n apiKey: '',\n applicationId: '',\n lite: true,\n instantSearch: true,\n crawler: {\n apiKey: '',\n indexName: '',\n meta: ['title', 'description'],\n include: () => true\n },\n recommend: true,\n indexer: {\n storyblok: {\n secret: 'INDEXER_SECRET',\n algoliaAdminApiKey: 'ALGOLIA_ADMIN_KEY',\n indexName: 'ALGOLIA_INDEX_NAME',\n accessToken: 'STORYBLOK_ACCESS_TOKEN'\n }\n }\n}\n"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"element","tag":"em","props":{},"children":[{"type":"text","value":"For storing sensitive data such as API keys or Application ID variables we recommend using environment variables that can later be loaded to Nuxt runtime config. Check out more "},{"type":"element","tag":"a","props":{"href":"'http://v3.nuxtjs.org/docs/usage/runtime-config/"},"children":[{"type":"text","value":"here"}]},{"type":"text","value":"."}]}]},{"type":"element","tag":"h3","props":{"id":"apikey"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"apiKey"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"This is the public API key to use in your frontend code. This key is only usable for search queries and sending data to the Insights API."}]},{"type":"element","tag":"alert","props":{"type":"info"},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"You can read more about it "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/guides/security/api-keys/","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"here"}]}]}]},{"type":"element","tag":"h3","props":{"id":"applicationid"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"applicationId"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"This is your unique application identifier. It's used to identify you when using Algolia's API."}]},{"type":"element","tag":"alert","props":{"type":"info"},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"You can get it "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/account/api-keys/","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"here"}]}]}]},{"type":"element","tag":"h3","props":{"id":"lite"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"lite"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"By default set to true. Indicates whether to use 'algoliasearch-lite' or normal 'algoliasearch' package. Depending on your needs, if you only need to search you can set this option to true or do not set any option (it is by default true). But if you need more advances functionalities like multi queries, indexing, etc, you can set it to false to load full algoliasearch client."}]},{"type":"element","tag":"alert","props":{"type":"info"},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"You can get it "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/api-client/getting-started/update-the-client/javascript/?client=javascript#search-onlylite-client","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"here"}]}]}]},{"type":"element","tag":"h3","props":{"id":"instantsearch"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"instantSearch"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"By default set to false. Indicates whether to install the official "},{"type":"element","tag":"a","props":{"href":"https://github.com/algolia/vue-instantsearch","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"vue-instantsearch"}]},{"type":"text","value":" plugin. This option can also be an object (see below)."}]},{"type":"element","tag":"alert","props":{"type":"info"},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"More information available in the official "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/vue/","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"Algolia docs"}]},{"type":"text","value":"."}]}]},{"type":"element","tag":"h3","props":{"id":"instantsearchtheme"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"instantSearch.theme"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"By default set to "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"satellite"}]},{"type":"text","value":". Indicates which CSS theme to use for the "},{"type":"element","tag":"a","props":{"href":"https://github.com/algolia/vue-instantsearch","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"vue-instantsearch"}]},{"type":"text","value":" plugin. Valid values are "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"satellite"}]},{"type":"text","value":", "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"reset"}]},{"type":"text","value":" or "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"algolia"}]},{"type":"text","value":"."}]},{"type":"element","tag":"alert","props":{"type":"info"},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"More information available in the official "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/guides/building-search-ui/widgets/customize-an-existing-widget/vue/#style-your-widgets","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"Algolia docs"}]},{"type":"text","value":"."}]}]},{"type":"element","tag":"h3","props":{"id":"crawler"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"crawler"}]}]},{"type":"element","tag":"alert","props":{"type":"info"},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Nuxt 3 SSG is currently under development (see "},{"type":"element","tag":"a","props":{"href":"https://v3.nuxtjs.org/getting-started/introduction#comparison","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"Comparison"}]},{"type":"text","value":")"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Indicates whether you would like the module to automatically index your pages when using Nuxt static site generation. Both the "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"apiKey"}]},{"type":"text","value":" and the "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"indexName"}]},{"type":"text","value":" need to be set for this feature to be enabled."}]},{"type":"element","tag":"h4","props":{"id":"crawlerapikey"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"crawler.apiKey"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"By default this option is not set. This is your private API key to use in your backend code. This key is used to update your Algolia index. "},{"type":"element","tag":"em","props":{},"children":[{"type":"text","value":"DO NOT USE YOUR ADMIN KEY!"}]},{"type":"text","value":" Instead use your admin key to generate another "},{"type":"element","tag":"em","props":{},"children":[{"type":"text","value":"limited"}]},{"type":"text","value":" key with at least the "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"addObject"}]},{"type":"text","value":" and "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"deleteObject"}]},{"type":"text","value":" rights."}]},{"type":"element","tag":"alert","props":{"type":"info"},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"You can read more about it "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/guides/security/api-keys/","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"here"}]}]}]},{"type":"element","tag":"h4","props":{"id":"crawlerindexname"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"crawler.indexName"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"By default this option is not set. This is the name of your Algolia index that will store all your pages' metadata."}]},{"type":"element","tag":"alert","props":{"type":"info"},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"You can check out how to create a new index "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/how-to/importing-from-the-dashboard/#creating-a-new-index","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"here"}]}]}]},{"type":"element","tag":"h4","props":{"id":"crawlermeta"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"crawler.meta"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"By default this option is set to "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"['title', 'description']"}]},{"type":"text","value":". This is the list of metafields that you would like to store when indexing a page. It can either be an array of fields or a function that returns an object of fields. The function should return a string and can be asynchronous."}]},{"type":"element","tag":"code-group","props":{},"children":[{"type":"element","tag":"code","props":{"code":"{\n ...\n meta: ['title', 'description', 'lang']\n}\n","filename":"Array","language":"ts"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"text","value":"{\n ...\n meta: ['title', 'description', 'lang']\n}\n"}]}]}]},{"type":"element","tag":"code","props":{"code":"{\n ...\n meta: async (html: string, route: string) => {\n const result = await somePromise(route)\n\n return {\n ...result,\n foo: 'bar'\n }\n }\n}\n","filename":"Function","language":"ts"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"text","value":"{\n ...\n meta: async (html: string, route: string) => {\n const result = await somePromise(route)\n\n return {\n ...result,\n foo: 'bar'\n }\n }\n}\n"}]}]}]}]},{"type":"element","tag":"h4","props":{"id":"crawlerinclude"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"crawler.include"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"By default this option is not set. This option is used to filter the pages that you would like to index by their route. It can either be an array of strings and/or regular expressions, or a function that should return a boolean. If the option is undefined, then all pages are indexed (default)."}]},{"type":"element","tag":"code-group","props":{},"children":[{"type":"element","tag":"code","props":{"code":"{\n ...\n include: ['/foo', /^(?!\\/?admin).+/]\n}\n","filename":"Array","language":"ts"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"text","value":"{\n ...\n include: ['/foo', /^(?!\\/?admin).+/]\n}\n"}]}]}]},{"type":"element","tag":"code","props":{"code":"{\n ...\n include: (route: string) => {\n return !route.startsWith('admin')\n }\n}\n","filename":"Function","language":"ts"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"text","value":"{\n ...\n include: (route: string) => {\n return !route.startsWith('admin')\n }\n}\n"}]}]}]}]},{"type":"element","tag":"h3","props":{"id":"recommend"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"recommend"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"When set to true it will import the "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"@algolia/recommend"}]},{"type":"text","value":" library used for "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"useAlgoliaRecommend"}]},{"type":"text","value":" composable to get the recommendations based on certain criteria."}]},{"type":"element","tag":"alert","props":{"type":"info"},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"You can read more "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/products/recommendations/","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"here"}]}]}]},{"type":"element","tag":"h3","props":{"id":"indexer"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"indexer"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Configuration for automatic indexing of Algolia index by external Content Management System or another source. For now it supports only Storyblok but will support more in the future."}]},{"type":"element","tag":"h4","props":{"id":"indexerstoryblok"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"indexer.storyblok"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Configuration object for using Storyblok as CMS provider in automatic indexing."}]},{"type":"element","tag":"ul","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"secret"}]},{"type":"text","value":" used to verify if an automatic indexing can be triggered. It is a HTTP query sent via GET request and validated with a private runtime config property. Remember to add it to your webhook configuration."}]},{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"algoliaAdminApiKey"}]},{"type":"text","value":" used to populate Algolia index programatically."}]},{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"indexName"}]},{"type":"text","value":" name of the Algolia index that will be populated after the indexing."}]},{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"accessToken"}]},{"type":"text","value":" to Storyblok space."}]}]}]},"body":{"type":"root","children":[{"type":"element","tag":"h2","props":{"id":"options"},"children":[{"type":"text","value":"Options"}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Defaults:"}]},{"type":"element","tag":"code","props":{"code":"{\n apiKey: '',\n applicationId: '',\n lite: true,\n instantSearch: true,\n crawler: {\n apiKey: '',\n indexName: '',\n meta: ['title', 'description'],\n include: () => true\n },\n recommend: true,\n indexer: {\n storyblok: {\n secret: 'INDEXER_SECRET',\n algoliaAdminApiKey: 'ALGOLIA_ADMIN_KEY',\n indexName: 'ALGOLIA_INDEX_NAME',\n accessToken: 'STORYBLOK_ACCESS_TOKEN'\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-333eeb"},"children":[{"type":"text","value":"{"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":" apiKey: "}]},{"type":"element","tag":"span","props":{"class":"ct-fccdd0"},"children":[{"type":"text","value":"''"}]},{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":" applicationId: "}]},{"type":"element","tag":"span","props":{"class":"ct-fccdd0"},"children":[{"type":"text","value":"''"}]},{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":" lite: "}]},{"type":"element","tag":"span","props":{"class":"ct-76782b"},"children":[{"type":"text","value":"true"}]},{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":" instantSearch: "}]},{"type":"element","tag":"span","props":{"class":"ct-76782b"},"children":[{"type":"text","value":"true"}]},{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":" crawler: {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":" apiKey: "}]},{"type":"element","tag":"span","props":{"class":"ct-fccdd0"},"children":[{"type":"text","value":"''"}]},{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":" indexName: "}]},{"type":"element","tag":"span","props":{"class":"ct-fccdd0"},"children":[{"type":"text","value":"''"}]},{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":" meta: ["}]},{"type":"element","tag":"span","props":{"class":"ct-fccdd0"},"children":[{"type":"text","value":"'title'"}]},{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":", "}]},{"type":"element","tag":"span","props":{"class":"ct-fccdd0"},"children":[{"type":"text","value":"'description'"}]},{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":"],"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":" include: () "}]},{"type":"element","tag":"span","props":{"class":"ct-5d1e39"},"children":[{"type":"text","value":"=>"}]},{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-76782b"},"children":[{"type":"text","value":"true"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":" },"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":" recommend: "}]},{"type":"element","tag":"span","props":{"class":"ct-76782b"},"children":[{"type":"text","value":"true"}]},{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":" indexer: {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":" storyblok: {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":" secret: "}]},{"type":"element","tag":"span","props":{"class":"ct-fccdd0"},"children":[{"type":"text","value":"'INDEXER_SECRET'"}]},{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":" algoliaAdminApiKey: "}]},{"type":"element","tag":"span","props":{"class":"ct-fccdd0"},"children":[{"type":"text","value":"'ALGOLIA_ADMIN_KEY'"}]},{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":" indexName: "}]},{"type":"element","tag":"span","props":{"class":"ct-fccdd0"},"children":[{"type":"text","value":"'ALGOLIA_INDEX_NAME'"}]},{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":" accessToken: "}]},{"type":"element","tag":"span","props":{"class":"ct-fccdd0"},"children":[{"type":"text","value":"'STORYBLOK_ACCESS_TOKEN'"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":" }"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":" }"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":"}"}]}]}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"element","tag":"em","props":{},"children":[{"type":"text","value":"For storing sensitive data such as API keys or Application ID variables we recommend using environment variables that can later be loaded to Nuxt runtime config. Check out more "},{"type":"element","tag":"a","props":{"href":"'http://v3.nuxtjs.org/docs/usage/runtime-config/"},"children":[{"type":"text","value":"here"}]},{"type":"text","value":"."}]}]},{"type":"element","tag":"h3","props":{"id":"apikey"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"apiKey"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"This is the public API key to use in your frontend code. This key is only usable for search queries and sending data to the Insights API."}]},{"type":"element","tag":"alert","props":{"type":"info"},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"You can read more about it "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/guides/security/api-keys/","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"here"}]}]}]},{"type":"element","tag":"h3","props":{"id":"applicationid"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"applicationId"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"This is your unique application identifier. It's used to identify you when using Algolia's API."}]},{"type":"element","tag":"alert","props":{"type":"info"},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"You can get it "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/account/api-keys/","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"here"}]}]}]},{"type":"element","tag":"h3","props":{"id":"lite"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"lite"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"By default set to true. Indicates whether to use 'algoliasearch-lite' or normal 'algoliasearch' package. Depending on your needs, if you only need to search you can set this option to true or do not set any option (it is by default true). But if you need more advances functionalities like multi queries, indexing, etc, you can set it to false to load full algoliasearch client."}]},{"type":"element","tag":"alert","props":{"type":"info"},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"You can get it "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/api-client/getting-started/update-the-client/javascript/?client=javascript#search-onlylite-client","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"here"}]}]}]},{"type":"element","tag":"h3","props":{"id":"instantsearch"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"instantSearch"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"By default set to false. Indicates whether to install the official "},{"type":"element","tag":"a","props":{"href":"https://github.com/algolia/vue-instantsearch","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"vue-instantsearch"}]},{"type":"text","value":" plugin. This option can also be an object (see below)."}]},{"type":"element","tag":"alert","props":{"type":"info"},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"More information available in the official "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/vue/","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"Algolia docs"}]},{"type":"text","value":"."}]}]},{"type":"element","tag":"h3","props":{"id":"instantsearchtheme"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"instantSearch.theme"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"By default set to "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"satellite"}]},{"type":"text","value":". Indicates which CSS theme to use for the "},{"type":"element","tag":"a","props":{"href":"https://github.com/algolia/vue-instantsearch","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"vue-instantsearch"}]},{"type":"text","value":" plugin. Valid values are "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"satellite"}]},{"type":"text","value":", "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"reset"}]},{"type":"text","value":" or "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"algolia"}]},{"type":"text","value":"."}]},{"type":"element","tag":"alert","props":{"type":"info"},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"More information available in the official "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/guides/building-search-ui/widgets/customize-an-existing-widget/vue/#style-your-widgets","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"Algolia docs"}]},{"type":"text","value":"."}]}]},{"type":"element","tag":"h3","props":{"id":"crawler"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"crawler"}]}]},{"type":"element","tag":"alert","props":{"type":"info"},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Nuxt 3 SSG is currently under development (see "},{"type":"element","tag":"a","props":{"href":"https://v3.nuxtjs.org/getting-started/introduction#comparison","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"Comparison"}]},{"type":"text","value":")"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Indicates whether you would like the module to automatically index your pages when using Nuxt static site generation. Both the "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"apiKey"}]},{"type":"text","value":" and the "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"indexName"}]},{"type":"text","value":" need to be set for this feature to be enabled."}]},{"type":"element","tag":"h4","props":{"id":"crawlerapikey"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"crawler.apiKey"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"By default this option is not set. This is your private API key to use in your backend code. This key is used to update your Algolia index. "},{"type":"element","tag":"em","props":{},"children":[{"type":"text","value":"DO NOT USE YOUR ADMIN KEY!"}]},{"type":"text","value":" Instead use your admin key to generate another "},{"type":"element","tag":"em","props":{},"children":[{"type":"text","value":"limited"}]},{"type":"text","value":" key with at least the "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"addObject"}]},{"type":"text","value":" and "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"deleteObject"}]},{"type":"text","value":" rights."}]},{"type":"element","tag":"alert","props":{"type":"info"},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"You can read more about it "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/guides/security/api-keys/","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"here"}]}]}]},{"type":"element","tag":"h4","props":{"id":"crawlerindexname"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"crawler.indexName"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"By default this option is not set. This is the name of your Algolia index that will store all your pages' metadata."}]},{"type":"element","tag":"alert","props":{"type":"info"},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"You can check out how to create a new index "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/how-to/importing-from-the-dashboard/#creating-a-new-index","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"here"}]}]}]},{"type":"element","tag":"h4","props":{"id":"crawlermeta"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"crawler.meta"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"By default this option is set to "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"['title', 'description']"}]},{"type":"text","value":". This is the list of metafields that you would like to store when indexing a page. It can either be an array of fields or a function that returns an object of fields. The function should return a string and can be asynchronous."}]},{"type":"element","tag":"code-group","props":{},"children":[{"type":"element","tag":"code","props":{"code":"{\n ...\n meta: ['title', 'description', 'lang']\n}\n","filename":"Array","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-333eeb"},"children":[{"type":"text","value":"{"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":" ..."}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":" meta: ["}]},{"type":"element","tag":"span","props":{"class":"ct-fccdd0"},"children":[{"type":"text","value":"'title'"}]},{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":", "}]},{"type":"element","tag":"span","props":{"class":"ct-fccdd0"},"children":[{"type":"text","value":"'description'"}]},{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":", "}]},{"type":"element","tag":"span","props":{"class":"ct-fccdd0"},"children":[{"type":"text","value":"'lang'"}]},{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":"]"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":"}"}]}]}]}]}]},{"type":"element","tag":"code","props":{"code":"{\n ...\n meta: async (html: string, route: string) => {\n const result = await somePromise(route)\n\n return {\n ...result,\n foo: 'bar'\n }\n }\n}\n","filename":"Function","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-333eeb"},"children":[{"type":"text","value":"{"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":" ..."}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":" meta: "}]},{"type":"element","tag":"span","props":{"class":"ct-5d1e39"},"children":[{"type":"text","value":"async"}]},{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":" ("}]},{"type":"element","tag":"span","props":{"class":"ct-5e882e"},"children":[{"type":"text","value":"html"}]},{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-fd6a1b"},"children":[{"type":"text","value":"string"}]},{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":", "}]},{"type":"element","tag":"span","props":{"class":"ct-5e882e"},"children":[{"type":"text","value":"route"}]},{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-fd6a1b"},"children":[{"type":"text","value":"string"}]},{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":") "}]},{"type":"element","tag":"span","props":{"class":"ct-5d1e39"},"children":[{"type":"text","value":"=>"}]},{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":" {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-5d1e39"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-fd6a1b"},"children":[{"type":"text","value":"result"}]},{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-028e35"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-5d1e39"},"children":[{"type":"text","value":"await"}]},{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-c7c958"},"children":[{"type":"text","value":"somePromise"}]},{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":"("}]},{"type":"element","tag":"span","props":{"class":"ct-5e882e"},"children":[{"type":"text","value":"route"}]},{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"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-333eeb"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-5d1e39"},"children":[{"type":"text","value":"return"}]},{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":" {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":" ..."}]},{"type":"element","tag":"span","props":{"class":"ct-5e882e"},"children":[{"type":"text","value":"result"}]},{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-5e882e"},"children":[{"type":"text","value":"foo"}]},{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-fccdd0"},"children":[{"type":"text","value":"'bar'"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":" }"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":" }"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":"}"}]}]}]}]}]}]},{"type":"element","tag":"h4","props":{"id":"crawlerinclude"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"crawler.include"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"By default this option is not set. This option is used to filter the pages that you would like to index by their route. It can either be an array of strings and/or regular expressions, or a function that should return a boolean. If the option is undefined, then all pages are indexed (default)."}]},{"type":"element","tag":"code-group","props":{},"children":[{"type":"element","tag":"code","props":{"code":"{\n ...\n include: ['/foo', /^(?!\\/?admin).+/]\n}\n","filename":"Array","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-333eeb"},"children":[{"type":"text","value":"{"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":" ..."}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":" include: ["}]},{"type":"element","tag":"span","props":{"class":"ct-fccdd0"},"children":[{"type":"text","value":"'/foo'"}]},{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":","}]},{"type":"element","tag":"span","props":{"class":"ct-028e35"},"children":[{"type":"text","value":" /"}]},{"type":"element","tag":"span","props":{"class":"ct-5d1e39"},"children":[{"type":"text","value":"^"}]},{"type":"element","tag":"span","props":{"class":"ct-028e35"},"children":[{"type":"text","value":"(?!\\/"}]},{"type":"element","tag":"span","props":{"class":"ct-76782b"},"children":[{"type":"text","value":"?"}]},{"type":"element","tag":"span","props":{"class":"ct-028e35"},"children":[{"type":"text","value":"admin)"}]},{"type":"element","tag":"span","props":{"class":"ct-5e882e"},"children":[{"type":"text","value":"."}]},{"type":"element","tag":"span","props":{"class":"ct-76782b"},"children":[{"type":"text","value":"+"}]},{"type":"element","tag":"span","props":{"class":"ct-028e35"},"children":[{"type":"text","value":"/"}]},{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":"]"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":"}"}]}]}]}]}]},{"type":"element","tag":"code","props":{"code":"{\n ...\n include: (route: string) => {\n return !route.startsWith('admin')\n }\n}\n","filename":"Function","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-333eeb"},"children":[{"type":"text","value":"{"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":" ..."}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":" include: ("}]},{"type":"element","tag":"span","props":{"class":"ct-5e882e"},"children":[{"type":"text","value":"route"}]},{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-fd6a1b"},"children":[{"type":"text","value":"string"}]},{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":") "}]},{"type":"element","tag":"span","props":{"class":"ct-5d1e39"},"children":[{"type":"text","value":"=>"}]},{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":" {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-5d1e39"},"children":[{"type":"text","value":"return"}]},{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-028e35"},"children":[{"type":"text","value":"!"}]},{"type":"element","tag":"span","props":{"class":"ct-fd6a1b"},"children":[{"type":"text","value":"route"}]},{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":"."}]},{"type":"element","tag":"span","props":{"class":"ct-c7c958"},"children":[{"type":"text","value":"startsWith"}]},{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":"("}]},{"type":"element","tag":"span","props":{"class":"ct-fccdd0"},"children":[{"type":"text","value":"'admin'"}]},{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":")"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":" }"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-333eeb"},"children":[{"type":"text","value":"}"}]}]}]}]}]}]},{"type":"element","tag":"h3","props":{"id":"recommend"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"recommend"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"When set to true it will import the "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"@algolia/recommend"}]},{"type":"text","value":" library used for "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"useAlgoliaRecommend"}]},{"type":"text","value":" composable to get the recommendations based on certain criteria."}]},{"type":"element","tag":"alert","props":{"type":"info"},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"You can read more "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/products/recommendations/","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"here"}]}]}]},{"type":"element","tag":"h3","props":{"id":"indexer"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"indexer"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Configuration for automatic indexing of Algolia index by external Content Management System or another source. For now it supports only Storyblok but will support more in the future."}]},{"type":"element","tag":"h4","props":{"id":"indexerstoryblok"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"indexer.storyblok"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Configuration object for using Storyblok as CMS provider in automatic indexing."}]},{"type":"element","tag":"ul","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"secret"}]},{"type":"text","value":" used to verify if an automatic indexing can be triggered. It is a HTTP query sent via GET request and validated with a private runtime config property. Remember to add it to your webhook configuration."}]},{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"algoliaAdminApiKey"}]},{"type":"text","value":" used to populate Algolia index programatically."}]},{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"indexName"}]},{"type":"text","value":" name of the Algolia index that will be populated after the indexing."}]},{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"accessToken"}]},{"type":"text","value":" to Storyblok space."}]}]},{"type":"element","tag":"style","children":[{"type":"text","value":".ct-c7c958{color:#61AFEF}.ct-028e35{color:#56B6C2}.ct-fd6a1b{color:#E5C07B}.ct-5e882e{color:#E06C75}.ct-5d1e39{color:#C678DD}.ct-76782b{color:#D19A66}.ct-fccdd0{color:#98C379}.ct-333eeb{color:#ABB2BF}"}]}],"toc":{"title":"","searchDepth":2,"depth":2,"links":[{"id":"options","depth":2,"text":"Options","children":[{"id":"apikey","depth":3,"text":"apiKey"},{"id":"applicationid","depth":3,"text":"applicationId"},{"id":"lite","depth":3,"text":"lite"},{"id":"instantsearch","depth":3,"text":"instantSearch"},{"id":"instantsearchtheme","depth":3,"text":"instantSearch.theme"},{"id":"crawler","depth":3,"text":"crawler"},{"id":"recommend","depth":3,"text":"recommend"},{"id":"indexer","depth":3,"text":"indexer"}]}]}},"_type":"markdown","_id":"content:1.getting-started:2.configuration.md","_source":"content","_file":"1.getting-started/2.configuration.md","_extension":"md"},{"_path":"/advanced/vue-instantsearch","_draft":false,"_partial":false,"_empty":false,"title":"Vue Instantsearch","description":"","excerpt":{"type":"root","children":[{"type":"element","tag":"h2","props":{"id":"using-with-vue-instantsearch-components"},"children":[{"type":"text","value":"Using with Vue-Instantsearch components"}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"By default, Algolia module only provides the search functionality but you can enable the vue-instantsearch components support to have Vue 3 components ready to serve as search and result components."}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"In order to enable them, first add "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"instantSearch"}]},{"type":"text","value":" configuration option to module configuration:"}]},{"type":"element","tag":"code","props":{"code":"import { defineNuxtConfig } from 'nuxt3'\n\nexport default defineNuxtConfig({\n modules: ['@nuxtjs/algolia'],\n algolia: {\n apiKey: process.env.ALGOLIA_SEARCH_API_KEY,\n applicationId: process.env.ALGOLIA_APPLICATION_ID,\n instantSearch: {\n theme: 'algolia'\n }\n }\n})\n","language":"ts"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"text","value":"import { defineNuxtConfig } from 'nuxt3'\n\nexport default defineNuxtConfig({\n modules: ['@nuxtjs/algolia'],\n algolia: {\n apiKey: process.env.ALGOLIA_SEARCH_API_KEY,\n applicationId: process.env.ALGOLIA_APPLICATION_ID,\n instantSearch: {\n theme: 'algolia'\n }\n }\n})\n"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"element","tag":"em","props":{},"children":[{"type":"text","value":"You can choose a theme from "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"satellite"}]},{"type":"text","value":", "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"reset"}]},{"type":"text","value":", and "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"algolia"}]},{"type":"text","value":". Check out setup docs "},{"type":"element","tag":"a","props":{"href":"/setup#instantSearch"},"children":[{"type":"text","value":"here"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Next, let's create "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"indexName"}]},{"type":"text","value":" variable, call "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"useAlgolia"}]},{"type":"text","value":" composable in page.vue script section to get the reference to Algolia, and import Vue Instantsearch components:"}]},{"type":"element","tag":"code","props":{"code":"\n","language":"ts"},"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":"Finally, let's use it in our page.vue template section with vue-instantsearch components:"}]},{"type":"element","tag":"code","props":{"code":"\n","language":"html"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"text","value":"\n"}]}]}]}]},"body":{"type":"root","children":[{"type":"element","tag":"h2","props":{"id":"using-with-vue-instantsearch-components"},"children":[{"type":"text","value":"Using with Vue-Instantsearch components"}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"By default, Algolia module only provides the search functionality but you can enable the vue-instantsearch components support to have Vue 3 components ready to serve as search and result components."}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"In order to enable them, first add "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"instantSearch"}]},{"type":"text","value":" configuration option to module configuration:"}]},{"type":"element","tag":"code","props":{"code":"import { defineNuxtConfig } from 'nuxt3'\n\nexport default defineNuxtConfig({\n modules: ['@nuxtjs/algolia'],\n algolia: {\n apiKey: process.env.ALGOLIA_SEARCH_API_KEY,\n applicationId: process.env.ALGOLIA_APPLICATION_ID,\n instantSearch: {\n theme: 'algolia'\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-b9e79c"},"children":[{"type":"text","value":"import"}]},{"type":"element","tag":"span","props":{"class":"ct-250980"},"children":[{"type":"text","value":" { "}]},{"type":"element","tag":"span","props":{"class":"ct-55a6f5"},"children":[{"type":"text","value":"defineNuxtConfig"}]},{"type":"element","tag":"span","props":{"class":"ct-250980"},"children":[{"type":"text","value":" } "}]},{"type":"element","tag":"span","props":{"class":"ct-b9e79c"},"children":[{"type":"text","value":"from"}]},{"type":"element","tag":"span","props":{"class":"ct-250980"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-2369fc"},"children":[{"type":"text","value":"'nuxt3'"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-b9e79c"},"children":[{"type":"text","value":"export"}]},{"type":"element","tag":"span","props":{"class":"ct-250980"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-b9e79c"},"children":[{"type":"text","value":"default"}]},{"type":"element","tag":"span","props":{"class":"ct-250980"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-fc9ecd"},"children":[{"type":"text","value":"defineNuxtConfig"}]},{"type":"element","tag":"span","props":{"class":"ct-250980"},"children":[{"type":"text","value":"({"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-250980"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-55a6f5"},"children":[{"type":"text","value":"modules"}]},{"type":"element","tag":"span","props":{"class":"ct-250980"},"children":[{"type":"text","value":": ["}]},{"type":"element","tag":"span","props":{"class":"ct-2369fc"},"children":[{"type":"text","value":"'@nuxtjs/algolia'"}]},{"type":"element","tag":"span","props":{"class":"ct-250980"},"children":[{"type":"text","value":"],"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-250980"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-55a6f5"},"children":[{"type":"text","value":"algolia"}]},{"type":"element","tag":"span","props":{"class":"ct-250980"},"children":[{"type":"text","value":": {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-250980"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-55a6f5"},"children":[{"type":"text","value":"apiKey"}]},{"type":"element","tag":"span","props":{"class":"ct-250980"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-fe7994"},"children":[{"type":"text","value":"process"}]},{"type":"element","tag":"span","props":{"class":"ct-250980"},"children":[{"type":"text","value":"."}]},{"type":"element","tag":"span","props":{"class":"ct-fe7994"},"children":[{"type":"text","value":"env"}]},{"type":"element","tag":"span","props":{"class":"ct-250980"},"children":[{"type":"text","value":"."}]},{"type":"element","tag":"span","props":{"class":"ct-55a6f5"},"children":[{"type":"text","value":"ALGOLIA_SEARCH_API_KEY"}]},{"type":"element","tag":"span","props":{"class":"ct-250980"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-250980"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-55a6f5"},"children":[{"type":"text","value":"applicationId"}]},{"type":"element","tag":"span","props":{"class":"ct-250980"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-fe7994"},"children":[{"type":"text","value":"process"}]},{"type":"element","tag":"span","props":{"class":"ct-250980"},"children":[{"type":"text","value":"."}]},{"type":"element","tag":"span","props":{"class":"ct-fe7994"},"children":[{"type":"text","value":"env"}]},{"type":"element","tag":"span","props":{"class":"ct-250980"},"children":[{"type":"text","value":"."}]},{"type":"element","tag":"span","props":{"class":"ct-55a6f5"},"children":[{"type":"text","value":"ALGOLIA_APPLICATION_ID"}]},{"type":"element","tag":"span","props":{"class":"ct-250980"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-250980"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-55a6f5"},"children":[{"type":"text","value":"instantSearch"}]},{"type":"element","tag":"span","props":{"class":"ct-250980"},"children":[{"type":"text","value":": {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-250980"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-55a6f5"},"children":[{"type":"text","value":"theme"}]},{"type":"element","tag":"span","props":{"class":"ct-250980"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-2369fc"},"children":[{"type":"text","value":"'algolia'"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-250980"},"children":[{"type":"text","value":" }"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-250980"},"children":[{"type":"text","value":" }"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-250980"},"children":[{"type":"text","value":"})"}]}]}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"element","tag":"em","props":{},"children":[{"type":"text","value":"You can choose a theme from "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"satellite"}]},{"type":"text","value":", "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"reset"}]},{"type":"text","value":", and "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"algolia"}]},{"type":"text","value":". Check out setup docs "},{"type":"element","tag":"a","props":{"href":"/setup#instantSearch"},"children":[{"type":"text","value":"here"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Next, let's create "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"indexName"}]},{"type":"text","value":" variable, call "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"useAlgolia"}]},{"type":"text","value":" composable in page.vue script section to get the reference to Algolia, and import Vue Instantsearch components:"}]},{"type":"element","tag":"code","props":{"code":"\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-87b359"},"children":[{"type":"text","value":"<"}]},{"type":"element","tag":"span","props":{"class":"ct-55a6f5"},"children":[{"type":"text","value":"script"}]},{"type":"element","tag":"span","props":{"class":"ct-250980"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-55a6f5"},"children":[{"type":"text","value":"lang"}]},{"type":"element","tag":"span","props":{"class":"ct-87b359"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-2369fc"},"children":[{"type":"text","value":"\"ts\""}]},{"type":"element","tag":"span","props":{"class":"ct-250980"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-55a6f5"},"children":[{"type":"text","value":"setup"}]},{"type":"element","tag":"span","props":{"class":"ct-87b359"},"children":[{"type":"text","value":">"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-b9e79c"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-250980"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-fe7994"},"children":[{"type":"text","value":"indexName"}]},{"type":"element","tag":"span","props":{"class":"ct-250980"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-87b359"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-250980"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-2369fc"},"children":[{"type":"text","value":"'test_index'"}]},{"type":"element","tag":"span","props":{"class":"ct-250980"},"children":[{"type":"text","value":" "}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-b9e79c"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-250980"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-fe7994"},"children":[{"type":"text","value":"algolia"}]},{"type":"element","tag":"span","props":{"class":"ct-250980"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-87b359"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-250980"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-fc9ecd"},"children":[{"type":"text","value":"useAlgoliaRef"}]},{"type":"element","tag":"span","props":{"class":"ct-250980"},"children":[{"type":"text","value":"()"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-b9e79c"},"children":[{"type":"text","value":"import"}]},{"type":"element","tag":"span","props":{"class":"ct-250980"},"children":[{"type":"text","value":" { "}]},{"type":"element","tag":"span","props":{"class":"ct-55a6f5"},"children":[{"type":"text","value":"AisInstantSearch"}]},{"type":"element","tag":"span","props":{"class":"ct-250980"},"children":[{"type":"text","value":", "}]},{"type":"element","tag":"span","props":{"class":"ct-55a6f5"},"children":[{"type":"text","value":"AisSearchBox"}]},{"type":"element","tag":"span","props":{"class":"ct-250980"},"children":[{"type":"text","value":", "}]},{"type":"element","tag":"span","props":{"class":"ct-55a6f5"},"children":[{"type":"text","value":"AisHits"}]},{"type":"element","tag":"span","props":{"class":"ct-250980"},"children":[{"type":"text","value":" } "}]},{"type":"element","tag":"span","props":{"class":"ct-b9e79c"},"children":[{"type":"text","value":"from"}]},{"type":"element","tag":"span","props":{"class":"ct-250980"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-2369fc"},"children":[{"type":"text","value":"'vue-instantsearch/vue3/es'"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-87b359"},"children":[{"type":"text","value":""}]}]}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Finally, let's use it in our page.vue template section with vue-instantsearch components:"}]},{"type":"element","tag":"code","props":{"code":"\n","language":"html"},"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-250980"},"children":[{"type":"text","value":"<"}]},{"type":"element","tag":"span","props":{"class":"ct-55a6f5"},"children":[{"type":"text","value":"template"}]},{"type":"element","tag":"span","props":{"class":"ct-250980"},"children":[{"type":"text","value":">"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-250980"},"children":[{"type":"text","value":" <"}]},{"type":"element","tag":"span","props":{"class":"ct-55a6f5"},"children":[{"type":"text","value":"div"}]},{"type":"element","tag":"span","props":{"class":"ct-250980"},"children":[{"type":"text","value":">"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-250980"},"children":[{"type":"text","value":" <"}]},{"type":"element","tag":"span","props":{"class":"ct-55a6f5"},"children":[{"type":"text","value":"ais-instant-search"}]},{"type":"element","tag":"span","props":{"class":"ct-250980"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-190fb2"},"children":[{"type":"text","value":":index-name"}]},{"type":"element","tag":"span","props":{"class":"ct-250980"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-2369fc"},"children":[{"type":"text","value":"\"indexName\""}]},{"type":"element","tag":"span","props":{"class":"ct-250980"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-190fb2"},"children":[{"type":"text","value":":search-client"}]},{"type":"element","tag":"span","props":{"class":"ct-250980"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-2369fc"},"children":[{"type":"text","value":"\"algolia\""}]},{"type":"element","tag":"span","props":{"class":"ct-250980"},"children":[{"type":"text","value":">"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-250980"},"children":[{"type":"text","value":" <"}]},{"type":"element","tag":"span","props":{"class":"ct-55a6f5"},"children":[{"type":"text","value":"ais-search-box"}]},{"type":"element","tag":"span","props":{"class":"ct-250980"},"children":[{"type":"text","value":" />"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-250980"},"children":[{"type":"text","value":" <"}]},{"type":"element","tag":"span","props":{"class":"ct-55a6f5"},"children":[{"type":"text","value":"ais-hits"}]},{"type":"element","tag":"span","props":{"class":"ct-250980"},"children":[{"type":"text","value":" />"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-250980"},"children":[{"type":"text","value":" "}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-250980"},"children":[{"type":"text","value":" "}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-250980"},"children":[{"type":"text","value":""}]}]}]}]}]},{"type":"element","tag":"style","children":[{"type":"text","value":".ct-190fb2{color:#D19A66}.ct-87b359{color:#56B6C2}.ct-fe7994{color:#E5C07B}.ct-fc9ecd{color:#61AFEF}.ct-2369fc{color:#98C379}.ct-55a6f5{color:#E06C75}.ct-250980{color:#ABB2BF}.ct-b9e79c{color:#C678DD}"}]}],"toc":{"title":"","searchDepth":2,"depth":2,"links":[{"id":"using-with-vue-instantsearch-components","depth":2,"text":"Using with Vue-Instantsearch components"}]}},"_type":"markdown","_id":"content:2.advanced:1.vue-instantsearch.md","_source":"content","_file":"2.advanced/1.vue-instantsearch.md","_extension":"md"}]