update docs, add descriptions for api methods
This commit is contained in:
parent
d56c30cc4a
commit
cdb9017a72
25 changed files with 613 additions and 40 deletions
190
docs/api.md
190
docs/api.md
|
|
@ -1,22 +1,174 @@
|
|||
# API
|
||||
|
||||
- [m](hyperscript.md)
|
||||
- [m.render](render.md)
|
||||
- [m.mount](mount.md)
|
||||
- [m.route](route.md)
|
||||
- [m.route.set](route.md#routeset)
|
||||
- [m.route.get](route.md#routeget)
|
||||
- [m.route.prefix](route.md#routeprefix)
|
||||
- [m.route.link](route.md#routelink)
|
||||
- [m.request](request.md)
|
||||
- [m.jsonp](jsonp.md)
|
||||
- [m.parseQueryString](parseQueryString.md)
|
||||
- [m.buildQueryString](buildQueryString.md)
|
||||
- [m.withAttr](withAttr.md)
|
||||
- [m.trust](trust.md)
|
||||
- [m.fragment](fragment.md)
|
||||
- [m.redraw](redraw.md)
|
||||
- [m.version](version.md)
|
||||
### Cheatsheet
|
||||
|
||||
Here are examples for the most commonly used methods. If a method is not listed below, it's meant for advanced usage.
|
||||
|
||||
#### m(selector, attrs, children) - [docs](hyperscript.md)
|
||||
|
||||
```javascript
|
||||
m("div.class#id", {title: "title"}, ["children"])
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
#### m.mount(element, component) - [docs](mount.md)
|
||||
|
||||
```javascript
|
||||
var state = {
|
||||
count: 0,
|
||||
inc: function() {state.count++}
|
||||
}
|
||||
|
||||
var Counter = {
|
||||
view: function() {
|
||||
return m("div", {onclick: state.inc}, state.count)
|
||||
}
|
||||
}
|
||||
|
||||
m.mount(document.body, Counter)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
#### m.route(root, defaultRoute, routes) - [docs](route.md)
|
||||
|
||||
```javascript
|
||||
var Home = {
|
||||
view: function() {
|
||||
return "Welcome"
|
||||
}
|
||||
}
|
||||
|
||||
m.route(document.body, "/home", {
|
||||
"/home": Home, // defines `http://localhost/#!/home`
|
||||
})
|
||||
```
|
||||
|
||||
#### m.route.set(path) - [docs](route.md#routeset)
|
||||
|
||||
```javascript
|
||||
m.route.set("/home")
|
||||
```
|
||||
|
||||
#### m.route.get() - [docs](route.md#routeget)
|
||||
|
||||
```javascript
|
||||
var currentRoute = m.route.get()
|
||||
```
|
||||
|
||||
#### m.route.prefix(prefix) - [docs](route.md#routeprefix)
|
||||
|
||||
Call this before `m.route()`
|
||||
|
||||
```javascript
|
||||
m.route.prefix("#!")
|
||||
```
|
||||
|
||||
#### m.route.link() - [docs](route.md#routelink)
|
||||
|
||||
```javascript
|
||||
m("a[href='/Home']", {oncreate: m.route.link}, "Go to home page")
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
#### m.request(options) - [docs](request.md)
|
||||
|
||||
```javascript
|
||||
m.request({
|
||||
method: "PUT",
|
||||
url: "/api/v1/users/:id",
|
||||
data: {id: 1, name: "test"}
|
||||
})
|
||||
.then(function(result) {
|
||||
console.log(result)
|
||||
})
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
#### m.jsonp(options) - [docs](jsonp.md)
|
||||
|
||||
```javascript
|
||||
m.jsonp({
|
||||
url: "/api/v1/users/:id",
|
||||
data: {id: 1},
|
||||
callbackKey: "callback",
|
||||
})
|
||||
.then(function(result) {
|
||||
console.log(result)
|
||||
})
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
#### m.parseQueryString(querystring) - [docs](parseQueryString.md)
|
||||
|
||||
```javascript
|
||||
var object = m.parseQueryString("a=1&b=2")
|
||||
// {a: "1", b: "2"}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
#### m.buildQueryString(object) - [docs](buildQueryString.md)
|
||||
|
||||
```javascript
|
||||
var querystring = m.buildQueryString({a: "1", b: "2"})
|
||||
// "a=1&b=2"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
#### m.withAttr(attrName, callback) - [docs](withAttr.md)
|
||||
|
||||
```javascript
|
||||
var state: {
|
||||
value = ""
|
||||
setValue: function(v) {value = v}
|
||||
}
|
||||
|
||||
var Component = {
|
||||
view: function() {
|
||||
return m("input", {
|
||||
oninput: m.withAttr("value", state.setValue),
|
||||
value: state.value,
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
m.mount(document.body, Component)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
#### m.trust(htmlString) - [docs](trust.md)
|
||||
|
||||
```javascript
|
||||
m.render(document.body, m.trust("<h1>Hello</h1>"))
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
#### m.redraw() - [docs](redraw.md)
|
||||
|
||||
```javascript
|
||||
var count = 0
|
||||
function inc() {
|
||||
setInterval(function() {
|
||||
count++
|
||||
m.redraw()
|
||||
}, 1000)
|
||||
}
|
||||
|
||||
var Counter = {
|
||||
oninit: inc,
|
||||
view: function() {
|
||||
return m("div", count)
|
||||
}
|
||||
}
|
||||
|
||||
m.mount(document.body, Counter)
|
||||
```
|
||||
|
||||
- [Promise](promise.md)
|
||||
- [Stream](stream.md)
|
||||
Loading…
Add table
Add a link
Reference in a new issue