autboss.js
v1.0.6
Published
A PHP/jQuery autocomplete plugin for input elements within your app/website
Readme
autBoss.js
An autocomplete plugin that utilizes jQuery to handle input element autocomplete
autBoss.js uses PHP/AJAX to handle sutocomplete functionality within a website/application that uses a database to store and retrieve data. There a a few required options that must be passed in order to successfully use autBoss.js and all of its components. A full list of options and their descriptions can be found below the usage information.
Heads Up!
autBoss.js assumes you are using a PHP framework! To cirumvent this being an issue, autBoss.js has a routing property that will determine whether or not you are within a framework environment or not. Be sure to set this to false if you are NOT using a framework!
Using autBoss.js
Install with npm
- Simply open your command line and enter the following command
npm install autboss.jsInstall with .zip
- Download the
.zipand extract theautboss.min.jsinto your projects JS folder. - Setup your reference tags within the head of your document.
<head>
// jQuery is required!
<script src="https://code.jquery.com/jquery-3.4.1.min.js" type="text/javascript"></script>
<script src="/path/to/autBoss.min.js" type="text/javascript"></script>
... </head>- Make sure you already have a DIV element to handle the displaying of data! Normally, this is where you would already be displaying pulled data from the database; this element is where all of the new data will also be displayed.
- Initialize autBoss.js on your desired element and pass the necessary options
$(function() {
$(".yourClassHere").autBoss({
baseUrl: 'http://yourdomain.com',
returnEl: 'autboss',
platform: 'users',
func: 'auto_search',
routing: true
});
});autBoss.js Options
| Property | Default | Description |
| -------- | ------- | ----------- |
| baseUrl | 'http://yourdomain.com/' | This sets the base URL that autBoss.js will use to handle all of the AJAX calls. This field is mandatory |
| returnEl | 'autboss' | This is the element where your autocomplete data will be displayed when the call is complete. This field is mandatory |
| platform | 'users' | This is the PHP class that the AJAX call will be made to. It holds the function that handles the data transferring and should be changed to the needed class name. This field is mandatory |
| func | 'auto_search' | This is the PHP class function/method that will handle the receiving/returning of the database information. This field is mandatory |
| routing | true | Change to false if you are not working with a PHP framework This tells autBoss.js whether or not you have framework routing or you are using your own method of routing. This will error if you are not using the correct boolean value. |