Skip to content

Improve docs #69

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Improve docs #69

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0e5f9ef
Removed template from list of props.
Mar 1, 2018
caee5fa
Fixed typo classes props. Removed item from available parts.
Mar 1, 2018
b3c6b38
Document customParams prop.
Mar 1, 2018
74be390
Document customHeaders.
Mar 1, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ Placeholder for input
Custom class name for autocomplete component

#### classes (Object)
Spesific custom class for each part. available: wrapper, input, list, and item
Specific custom class for each part. available: wrapper, input, list

#### id (String)
Custom id name for autocomplete component
Expand All @@ -182,8 +182,11 @@ Number of milliseconds the user should stop typing for before the request is sen
#### process (Function)
Function to process the API result with. Should return an array of entries or an object whose properties can be enumerated.

#### template (Function)
Function to process each result with. Takes the type of an API reply element and should return HTML data.
#### customParams (Object)
Object of key value pairs to be send along with the request as query parameters.

#### customHeaders (Object)
Object of key value pairs with custom headers to be sent along with the request.


## Callback Events
Expand Down