Astatine
Astatine || At - Simple Small Ajax and HTML Form Library
Overview
- 3.1KB uncompressed
- Install
npm install astatine
- Link
astatine.min.js
- ES5 browsers and up. (Probably older ones but who cares about those)
API
Astatine || At
Library entry point. Globally available by using At.
At.setup
At.setup.spinner
Sets up spinner color, thickness, and size. Defaults are listed bellow. Do this before any Astatine or At operations.
Usage
At.setup.spinner.size = '3px';
At.setup.spinner.thickness = '15px';
At.setup.spinner.colorTop = 'darkgray';
At.setup.spinner.colorBottom = 'lightgray';
At.submit
At.submit(options)
Submit form. Error and Success are your XHR response. Creates a spinner with the class .spinner
and hides type=submit
.
Features
application/json
automatically stringiifed to json string.application/x-www-form-urlencoded
automatically serialized to url params.radio
will only appear if it is checked.checkbox
will either be true
or false
.type="submit"
will automatically hide.
Options
- query:
String || Object
Query selector or element - *: Any
At.ajax
options
<form class="form-contact" method="POST" enctype="application/json" action="/examples/index.html">
<input type="text" name="name" placeholder="Name:" required/>
<input type="submit" value="Submit"/>
</form>
At.submit({
query: '.form-contact',
prepare: function (data) {
data.foo = 'bar';
},
complete: function (error, success) {
if (error) console.log(error);
else console.log(success);
}
});
At.ajax
At.ajax(options)
Ajax is a lower level utility function that allows for more control but less features than the submit method.
Options
- enctype:
String
Overwrites 'content-type' in headers - method:
String
Valid methods get, post, put, and delete - action:
String
Resource url - username:
String
- password:
String
- mimeType:
String
Overwrites return type - data:
Object
If method is GET
than data is concatenated to the action/url
as params - headers:
Object
- prepare:
Function
- complete:
Function
At.ajax({
data: { name: 'stuff' },
method: 'get',
action: '/examples/index.html',
success: function (xhr) {
console.log(xhr);
},
error: function (xhr) {
console.log(xhr);
}
});
At.formData
At.formData(element)
Parameter
var objectData = At.formData(element);
At.serialize
At.serialize(data)
Parameter
Object
Single level deep key value pare
var stringData = At.serialize(data);
License
Licensed Under MPL 2.0
Copyright 2016 Alexander Elias