From 293fc1e3a734b5110c240049288b4038185025bb Mon Sep 17 00:00:00 2001
From: Steve <info@konfer.be>
Date: Wed, 27 Mar 2024 21:32:56 +0100
Subject: [PATCH] chore: finalize doc without details

---
 docs/.vitepress/config.js        | 14 --------
 docs/api.md                      |  5 ---
 docs/guide.md                    |  4 +--
 docs/guide/examples/callbacks.md | 15 ++++++++
 docs/guide/examples/data.md      |  4 +++
 docs/guide/examples/input.md     |  2 ++
 docs/guide/examples/options.md   | 61 ++++++++++++++++++++++++++++++--
 docs/guide/getting-started.md    |  1 -
 docs/index.md                    |  6 ++--
 9 files changed, 84 insertions(+), 28 deletions(-)
 delete mode 100644 docs/api.md

diff --git a/docs/.vitepress/config.js b/docs/.vitepress/config.js
index 048aaad..1b97452 100644
--- a/docs/.vitepress/config.js
+++ b/docs/.vitepress/config.js
@@ -10,7 +10,6 @@ export default defineConfig({
     nav: [
       { text: 'Home', link: '/' },
       { text: 'Guide', link: '/guide' },
-      { text: 'API', link: '/api' },
       { text: 'Demo', link: '/demo' },
     ],
 
@@ -45,19 +44,6 @@ export default defineConfig({
           ]
         },
       ],
-      '/api': {
-        text: 'kompletr',
-        collapsed: false,
-        items: [
-          { text: 'kompletr', link: '/api/signature' },
-          { text: 'input', link: '/api/input' },
-          { text: 'data', link: '/api/data' },
-          { text: 'options', link: '/api/options' },
-          { text: 'onKeyup', link: '/api/onkeyup' },
-          { text: 'onSelect', link: '/api/onselect' },
-          { text: 'onError', link: '/api/onerror' },
-        ]
-      },
     },
 
     socialLinks: [
diff --git a/docs/api.md b/docs/api.md
deleted file mode 100644
index a27ac3a..0000000
--- a/docs/api.md
+++ /dev/null
@@ -1,5 +0,0 @@
----
-outline: deep
----
-
-# API documentation
\ No newline at end of file
diff --git a/docs/guide.md b/docs/guide.md
index 38ed842..1268573 100644
--- a/docs/guide.md
+++ b/docs/guide.md
@@ -2,6 +2,4 @@
 
 Here is the Kømpletr guide. You'll find some examples of integration regarding main use cases.
 
-All the examples are using the way of the simplicity, and use only the options required for the demonstration.
-
-For technical details, see [API](./api.md) section.
\ No newline at end of file
+All the examples are using the way of the simplicity, and use only the options required for the demonstration.
\ No newline at end of file
diff --git a/docs/guide/examples/callbacks.md b/docs/guide/examples/callbacks.md
index b434b7f..f49a349 100644
--- a/docs/guide/examples/callbacks.md
+++ b/docs/guide/examples/callbacks.md
@@ -1,7 +1,14 @@
 # Callbacks
 
+Three callbacks are exposed to give you more flexibility:
+
 ## onKeyup
 
+Fired after *onkeyup* event, with parameters:
+
+- *value*: current input value
+- *done*: callback function to call with refreshed data in parameter
+
 ```html
 <script>
   const input = document.getElementById('auto-complete');
@@ -22,6 +29,10 @@
 
 ## onSelect
 
+Fired when a suggestion is selected by a click or a keypress on Enter:
+
+- *selected*: current input value
+  
 ```html
 <script>
   const input = document.getElementById('auto-complete');
@@ -37,6 +48,10 @@
 
 ## onError
 
+Fired when an error is catched, with the error given in parameter:
+
+- *error*: current error
+  
 ```html
 <script>
   const input = document.getElementById('auto-complete');
diff --git a/docs/guide/examples/data.md b/docs/guide/examples/data.md
index 6a06289..8ae2ef2 100644
--- a/docs/guide/examples/data.md
+++ b/docs/guide/examples/data.md
@@ -1,5 +1,9 @@
 # Data
 
+The *data* parameter is required as **Object[]** or **String[]**.
+
+It can be empty at initialization if you take the ownership on the querying by using the *onKeyup* callback to manage the data.
+
 ## Querying on initialization
 
 ```html
diff --git a/docs/guide/examples/input.md b/docs/guide/examples/input.md
index 18c6ae1..4bc5fe3 100644
--- a/docs/guide/examples/input.md
+++ b/docs/guide/examples/input.md
@@ -1,5 +1,7 @@
 # Input
 
+The *input* parameter is required as **HTMLInputElement** or **selector**.
+
 ## Giving a selector
 
 ```html
diff --git a/docs/guide/examples/options.md b/docs/guide/examples/options.md
index 5d15cdb..f03a932 100644
--- a/docs/guide/examples/options.md
+++ b/docs/guide/examples/options.md
@@ -1,6 +1,12 @@
+
+
 # Options
 
-## animations
+The *options* parameter is required as **Object** with following properties:
+
+## animationType and animationDuration
+
+Boths optionals.
 
 ```html
 <script>
@@ -20,6 +26,8 @@
 
 ## cache
 
+Optional.
+
 ```html
 <script>
   kompletr({
@@ -37,11 +45,20 @@
 
 ## fieldsToDisplay
 
+Required if *data* contains object values, to indicate which properties should be displayed into suggested item.
+
 ```html
 <script>
   kompletr({
     input: 'auto-complete',
-    data: ['orange', 'apple', 'kiwi'],
+    data: [
+      {
+        name: 'Belgium',
+        population: 10000000,
+        code: 'BE',
+        beer: true
+      }
+    ],
     options: {
       fieldsToDisplay: [
         'name',
@@ -58,6 +75,17 @@
     
 ## filterOn
 
+Optional.
+
+Can be used to determine the search method when you delegate the filtering to Kompletr (in other terms, when you pass data without refresh it on your own by using *onKeyup* callback).
+
+Accepted values:
+
+- *prefix*: the search is done from the begining of the term
+- *expression*: the search is done into the whole word
+
+Default: *prefix*
+
 ```html
 <script>
   kompletr({
@@ -75,6 +103,12 @@
 
 ## maxResults
 
+Optional.
+
+Number of results to display.
+
+Default: 5
+
 ```html
 <script>
   kompletr({
@@ -92,6 +126,12 @@
 
 ## propToMapAsValue
 
+Optional.
+
+Number of results to display.
+
+Default: 10
+
 ```html
 <script>
   kompletr({
@@ -109,6 +149,12 @@
 
 ## startQueryingFromChar
 
+Optional.
+
+Number of chars before to fire research.
+
+Default: 2
+
 ```html
 <script>
   kompletr({
@@ -126,6 +172,17 @@
 
 ## theme
 
+Optional.
+
+Theme style.
+
+Accepted values:
+
+- *light*
+- *dark*
+
+Default: *light*
+
 ```html
 <script>
   kompletr({
diff --git a/docs/guide/getting-started.md b/docs/guide/getting-started.md
index f5822c7..0ba4974 100644
--- a/docs/guide/getting-started.md
+++ b/docs/guide/getting-started.md
@@ -98,4 +98,3 @@ import styles from './kompletr.min.css';
   });
 </script>
 ```
-:link: See [API section](./api.md) for more informations about available options.
diff --git a/docs/index.md b/docs/index.md
index 23ccabd..7554f36 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -8,11 +8,11 @@ hero:
   tagline: 10kb of vanilla lightweight to add highly featured autocompletion on your pages.
   actions:
     - theme: brand
+      text: Demo
+      link: /demo
+    - theme: alt
       text: Getting started
       link: /guide
-    - theme: alt
-      text: API Documentation
-      link: /api
 
 features:
   - icon: ✨