https://github.com/shannonhochkins/jquery.fw8get
Repository for framework automating the ajax calls for modules.
https://github.com/shannonhochkins/jquery.fw8get
Last synced: 2 months ago
JSON representation
Repository for framework automating the ajax calls for modules.
- Host: GitHub
- URL: https://github.com/shannonhochkins/jquery.fw8get
- Owner: shannonhochkins
- Created: 2014-08-06T06:15:11.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2015-07-27T03:05:38.000Z (over 9 years ago)
- Last Synced: 2025-01-04T06:25:53.812Z (4 months ago)
- Language: JavaScript
- Size: 148 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
jQuery - fw8Get
===============
Repository for framework automating the ajax calls for modules.
### Index
--------------
- General
- [Usage][0]
- [Options][1]
- [How To][2]
- Modules
- [Get Products By Tag][3]
- [Get Blogs By Tag][4]
- [Get Gallery][5]
- [Get Listings][6]
- [Get Template Block][7]
- [Get Category][8]
- [Get Custom Content][9]
[0]: #usage
[1]: #options
[2]: #how-to-get-module-content
[3]: #get-products-by-tag---available-options
[4]: #get-blogs-by-tag---available-options
[5]: #get-gallery---available-options
[6]: #get-listings---available-options
[7]: #get-template-block---available-options
[8]: #get-category---available-options
[9]: #getting-custom-content
Usage
--------------
```javascript
$('.element').fw8Get({
format: 'json',
module: '',
reference: '',
type: '',
subTemplate: '',
tags: '',
loadingHTML: '
',
onSuccess: null,
onError: null,
});
```
Options
--------------
| Options | Type | Description |
| ------------- |:-------------:|:-----|
| format | string | The main format of the request |
| module | string | The module name |
| reference | string | The reference name of an item in the module. |
| type | string | The type of the reference. |
| subTemplate | string | The subtemplate of the reference. |
| tags | string | Get the references by tags |
| loadingHTML | string | The default html used to add to the container. |
| custom | string | A custom url format option. See [example][10] at the bottom for more information. |
| onSuccess | function() {elem, data, plugin} | Callback if the ajax call was successful. |
| onError | function() {elem, data, plugin} | Callback if the ajax call failed. |
[10]: #getting-custom-content
## How to get module content
===============
All Modules have the following options, some modules don't allow certain parameters but these are allowed in all.
```javascript
$('.element').fw8Get({
format: 'json',
module: 'moduleName',
loadingHTML: 'loading...',
onSuccess: null,
onError: null,
});
```
Not all modules are set up yet, but here's a list of the available modules currently setup with fw8Get
##### Get Products By Tag - Available Options
---------------
```javascript
$('.element').fw8Get({
module: 'productsByTag',
tags: 'tag~another+tag', // Note: ~ seperates multiple tags.
subTemplate: 'categorySubtemplateName',
});
```
##### Get Blogs By Tag - Available Options
---------------
```javascript
$('.element').fw8Get({
module: 'blogsByTag',
reference: 'blogGroupName',
tags: 'tag~another+tag', // Note: ~ seperates multiple tags.
subTemplate: 'blogSubtemplate',
});
```
##### Get Gallery - Available Options
---------------
```javascript
$('.element').fw8Get({
module: 'gallery',
reference: 'galleryName',
subTemplate: 'gallerySubtemplateName',
});
```
##### Get Listings - Available Options
---------------
```javascript
$('.element').fw8Get({
module: 'listings',
reference: 'listingsGroupName',
type: 'mapbubble', // Type can be: mapbubble,recent,user,geosearchbox,searchbox,geosearch,search
subTemplate: 'lisitingOfItemsSubtemplateName',
});
```
##### Get Template Block - Available Options
---------------
```javascript
$('.element').fw8Get({
module: 'blocks',
reference: 'blockName',
});
```
##### Get Category - Available Options
---------------
```javascript
$('.element').fw8Get({
module: 'category',
reference: 'categoryName',
subTemplate: 'categorySubtemplate',
});
```
##### Getting Custom Content
---------------
The standard available options are available here too, however module, type, reference, tags & subtemplate are all overwritten as you're creating your own custom url.
This was added as a means to get any data, but not be restricted by the limitations of this plugin.
```javascript
$('.element').fw8Get({
custom: 'menu, menuname'
// The actual request will look like this: /_get/json/menu,menuname
});
```