docs: docs fixes and changelog
This commit is contained in:
parent
5cb05c1ee7
commit
e88bddb3c8
3 changed files with 5 additions and 42 deletions
|
|
@ -1,18 +1,18 @@
|
||||||
# Change log
|
# Change log
|
||||||
|
|
||||||
- [v1.0.2](#v101)
|
- [v1.1.0](#v110)
|
||||||
- [v1.0.1](#v101)
|
- [v1.0.1](#v101)
|
||||||
- [Migrating from v0.2.x](#migrating-from-v02x)
|
- [Migrating from v0.2.x](#migrating-from-v02x)
|
||||||
- [Older docs](http://mithril.js.org/archive/v0.2.5/index.html)
|
- [Older docs](http://mithril.js.org/archive/v0.2.5/index.html)
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### v1.0.2
|
### v1.1.0
|
||||||
|
|
||||||
#### News
|
#### News
|
||||||
|
|
||||||
- support for ES6 class components
|
- support for ES6 class components
|
||||||
- updated typescript definitions
|
- support for closure components
|
||||||
|
|
||||||
#### Bug fixes
|
#### Bug fixes
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -276,44 +276,6 @@ Be aware that when using ES5 functions, the value of `this` in nested anonymous
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### ES6 classes
|
|
||||||
|
|
||||||
Components can also be written using ES6 class syntax:
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
class ES6ClassComponent {
|
|
||||||
view() {
|
|
||||||
return m("div", "Hello from an ES6 class")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
They can be consumed in the same way regular components can.
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
// EXAMPLE: via m.render
|
|
||||||
m.render(document.body, m(ES6ClassComponent))
|
|
||||||
|
|
||||||
// EXAMPLE: via m.mount
|
|
||||||
m.mount(document.body, ES6ClassComponent)
|
|
||||||
|
|
||||||
// EXAMPLE: via m.route
|
|
||||||
m.route(document.body, "/", {
|
|
||||||
"/": ES6ClassComponent
|
|
||||||
})
|
|
||||||
|
|
||||||
// EXAMPLE: component composition
|
|
||||||
class AnotherES6ClassComponent {
|
|
||||||
view() {
|
|
||||||
return m("main", [
|
|
||||||
m(ES6ClassComponent)
|
|
||||||
])
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Avoid anti-patterns
|
### Avoid anti-patterns
|
||||||
|
|
||||||
Although Mithril is flexible, some code patterns are discouraged:
|
Although Mithril is flexible, some code patterns are discouraged:
|
||||||
|
|
|
||||||
|
|
@ -79,6 +79,7 @@ Property | Type | Description
|
||||||
`instance` | `Object?` | For components, a storage location for the value returned by the `view`. This property is only used internally by Mithril, do not use or modify it.
|
`instance` | `Object?` | For components, a storage location for the value returned by the `view`. This property is only used internally by Mithril, do not use or modify it.
|
||||||
`skip` | `Boolean` | This property is only used internally by Mithril when diffing keyed lists, do not use or modify it.
|
`skip` | `Boolean` | This property is only used internally by Mithril when diffing keyed lists, do not use or modify it.
|
||||||
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### Vnode types
|
### Vnode types
|
||||||
|
|
@ -88,7 +89,7 @@ The `tag` property of a vnode determines its type. There are five vnode types:
|
||||||
Vnode type | Example | Description
|
Vnode type | Example | Description
|
||||||
------------ | ------------------------------ | ---
|
------------ | ------------------------------ | ---
|
||||||
Element | `{tag: "div"}` | Represents a DOM element.
|
Element | `{tag: "div"}` | Represents a DOM element.
|
||||||
Fragment | `{tag: "[", children: []}` | Represents a list of DOM elements whose parent DOM element may also contain other elements that are not in the fragment. When using the [`m()`](hyperscript.md) helper function, fragment vnodes can only be created by nesting arrays into the `children` parameter of `m()`. `m("[")` does not create a valid vnode.
|
Fragment | `{tag: "[", children: []}` | Represents a list of DOM elements whose parent DOM element may also contain other elements that are not in the fragment. When using the [`m()`](hyperscript.md) helper function, fragment vnodes can only be created by nesting arrays into the `children` parameter of `m()`. `m("[")` does not create a valid vnode.
|
||||||
Text | `{tag: "#", children: ""}` | Represents a DOM text node.
|
Text | `{tag: "#", children: ""}` | Represents a DOM text node.
|
||||||
Trusted HTML | `{tag: "<", children: "<br>"}` | Represents a list of DOM elements from an HTML string.
|
Trusted HTML | `{tag: "<", children: "<br>"}` | Represents a list of DOM elements from an HTML string.
|
||||||
Component | `{tag: ExampleComponent}` | If `tag` is a Javascript object with a `view` method, the vnode represents the DOM generated by rendering the component.
|
Component | `{tag: ExampleComponent}` | If `tag` is a Javascript object with a `view` method, the vnode represents the DOM generated by rendering the component.
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue