1(window.webpackJsonp=window.webpackJsonp||[]).push([[33],{100:function(e,t,r){"use strict";r.d(t,"a",(function(){return u})),r.d(t,"b",(function(){return d}));var n=r(0),a=r.n(n);function o(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function c(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t<arguments.length;t++){var r=null!=arguments[t]?arguments[t]:{};t%2?c(Object(r),!0).forEach((function(t){o(e,t,r[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(r)):c(Object(r)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(r,t))}))}return e}function l(e,t){if(null==e)return{};var r,n,a=function(e,t){if(null==e)return{};var r,n,a={},o=Object.keys(e);for(n=0;n<o.length;n++)r=o[n],t.indexOf(r)>=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n<o.length;n++)r=o[n],t.indexOf(r)>=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var s=a.a.createContext({}),p=function(e){var t=a.a.useContext(s),r=t;return e&&(r="function"==typeof e?e(t):i({},t,{},e)),r},u=function(e){var t=p(e.components);return a.a.createElement(s.Provider,{value:t},e.children)},b={inlineCode:"code",wrapper:function(e){var t=e.children;return a.a.createElement(a.a.Fragment,{},t)}},m=Object(n.forwardRef)((function(e,t){var r=e.components,n=e.mdxType,o=e.originalType,c=e.parentName,s=l(e,["components","mdxType","originalType","parentName"]),u=p(r),m=n,d=u["".concat(c,".").concat(m)]||u[m]||b[m]||o;return r?a.a.createElement(d,i({ref:t},s,{components:r})):a.a.createElement(d,i({ref:t},s))}));function d(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=r.length,c=new Array(o);c[0]=m;var i={};for(var l in t)hasOwnProperty.call(t,l)&&(i[l]=t[l]);i.originalType=e,i.mdxType="string"==typeof e?e:n,c[1]=i;for(var s=2;s<o;s++)c[s]=r[s];return a.a.createElement.apply(null,c)}return a.a.createElement.apply(null,r)}m.displayName="MDXCreateElement"},93:function(e,t,r){"use strict";r.r(t),r.d(t,"frontMatter",(function(){return c})),r.d(t,"metadata",(function(){return i})),r.d(t,"rightToc",(function(){return l})),r.d(t,"default",(function(){return p}));var n=r(2),a=r(6),o=(r(0),r(100)),c={id:"getting-started",title:"Getting Started"},i={unversionedId:"getting-started",id:"getting-started",isDocsHomePage:!1,title:"Getting Started",description:"This page is an overview of the Autocomplete documentation and related resources.",source:"@site/docs/getting-started.md",permalink:"/docs/getting-started",editUrl:"https://github.com/francoischalifour/autocomplete.js/edit/next/packages/website/docs/getting-started.md",sidebar:"docs",next:{title:"State",permalink:"/docs/state"}},l=[{value:"Features",id:"features",children:[]},{value:"Installation",id:"installation",children:[]}],s={rightToc:l};function p(e){var t=e.components,r=Object(a.a)(e,["components"]);return Object(o.b)("wrapper",Object(n.a)({},s,r,{components:t,mdxType:"MDXLayout"}),Object(o.b)("p",null,"This page is an overview of the Autocomplete documentation and related resources."),Object(o.b)("p",null,"Autocomplete is a JavaScript library for ",Object(o.b)("strong",{parentName:"p"},"building autocomplete search experiences"),"."),Object(o.b)("h2",{id:"features"},"Features"),Object(o.b)("ul",null,Object(o.b)("li",{parentName:"ul"},"Displays suggestions as you type"),Object(o.b)("li",{parentName:"ul"},"Provides autocompletion"),Object(o.b)("li",{parentName:"ul"},"Supports custom templates for UI flexibility"),Object(o.b)("li",{parentName:"ul"},"Works well with RTL languages"),Object(o.b)("li",{parentName:"ul"},"Triggers custom hooks to plug your logic"),Object(o.b)("li",{parentName:"ul"},"Plugs easily to Algolia's realtime search engine")),Object(o.b)("h2",{id:"installation"},"Installation"),Object(o.b)("p",null,"Autocomplete is available on the ",Object(o.b)("a",Object(n.a)({parentName:"p"},{href:"https://www.npmjs.com/"}),"npm")," registry."),Object(o.b)("pre",null,Object(o.b)("code",Object(n.a)({parentName:"pre"},{className:"language-sh"}),"yarn add @francoischalifour/autocomplete-core@alpha\n# or\nnpm install @francoischalifour/autocomplete-core@alpha\n")),Object(o.b)("p",null,"If you do not wish to use a package manager, you can use standalone endpoints:"),Object(o.b)("pre",null,Object(o.b)("code",Object(n.a)({parentName:"pre"},{className:"language-html"}),'\x3c!-- jsDelivr --\x3e\n<script src="https://cdn.jsdelivr.net/npm/@francoischalifour/autocomplete-core@alpha"><\/script>\n\n\x3c!-- unpkg --\x3e\n<script src="https://unpkg.com/@francoischalifour/autocomplete-core@alpha"><\/script>\n')))}p.isMDXComponent=!0}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.