This commit is contained in:
Leo Horie 2016-10-26 11:17:16 -04:00
parent 04ffdae2a3
commit 4b40d2d3b5
3 changed files with 52 additions and 1 deletions

View file

@ -1,6 +1,6 @@
# Mithril.js - A framework for building brilliant applications
[Documentation](docs) | [Migration Guide](docs/v1.x-migration.md)
[Installation](docs/installation.md) | [API](docs/api.md) | [Migration Guide](docs/v1.x-migration.md)
Note: This branch is a sneak peek for the upcoming version 1.0. It's a rewrite from the ground up and it's not backwards compatible with [Mithril 0.2.x](http://mithril.js.org). You can find preliminary [documentation here](docs) and [migration guide here](docs/v1.x-migration.md)

24
docs/redraw.md Normal file
View file

@ -0,0 +1,24 @@
# redraw()
- [API](#api)
- [How it works](#how-it-works)
---
### API
`m.redraw()`
Argument | Type | Required | Description
----------- | -------------------- | -------- | ---
**returns** | | | Returns nothing
---
### How it works
When callbacks outside of Mithril run, you need to notify Mithril's rendering engine that a redraw is needed. External callbacks could be `setTimeout`/`setInterval`/`requestAnimationFrame` callbacks, web socket library callbacks, event handlers in jQuery plugins, third party XHR request callbacks, etc.
To trigger a redraw, call `m.redraw()`
You should not call m.redraw from a [lifecycle method](lifecycle-methods.md). Doing so will result in undefined behavior.

27
docs/version.md Normal file
View file

@ -0,0 +1,27 @@
# version
- [API](#api)
- [How it works](#how-it-works)
---
### API
`m.version`
Argument | Type | Required | Description
----------- | -------------------- | -------- | ---
**returns** | String | | Returns the version number
---
### How it works
The `m.version` property is a string containing the [semver](http://semver.org/) value for the current release.
Semver (or Semantic Versioning) specifies that a version number must follow the syntax "0.0.0", where the first number is the MAJOR number, the second is the MINOR number and the third is the PATCH number.
- The MAJOR number changes when there are backwards-incompatible API changes,
- The MINOR number changes when functionality is added in a backwards-compatible manner, and
- The PATCH number changes when there are backwards-compatible bug fixes