\n\nMithril is used by companies like Vimeo and Nike, and open source platforms like Lichess.\n\nIf you are an experienced developer and want to know how Mithril compares to other frameworks, see the [framework comparison](http://mithril.js.org/framework-comparison.html) page.\n\n---\n\n### Getting started\n\nThe easiest way to try out Mithril is to include it from a CDN, and follow this tutorial. It'll cover the majority of the API surface (including routing and XHR) but it'll only take 10 minutes.\n\nLet's create an HTML file to follow along:\n\n```markup\n\n\t\n\t\n\n```\n\n---\n\n### Hello world\n\nLet's start as small as well can: render some text on screen. Copy the code below into your file (and by copy, I mean type it out - you'll learn better)\n\n```javascript\nvar root = document.body\n\nm.render(root, \"Hello world\")\n```\n\nNow, let's change the text to something else. Add this line of code under the previous one:\n\n```javascript\nm.render(root, \"My first app\")\n```\n\nAs you can see, you use the same code to both create and update HTML. Mithril automatically figures out the most efficient way of updating the text, rather than blindly recreating it from scratch.\n\n---\n\n### DOM elements\n\nLet's wrap our text in an `
` tag.\n\n```javascript\nm.render(root, m(\"h1\", \"My first app\"))\n```\n\nThe `m()` function can be used to describe any HTML structure you want. So if you to add a class to the `
`:\n\n```javascript\nm(\"h1\", {class: \"title\"}, \"My first app\")\n```\n\nIf you want to have multiple elements:\n\n```javascript\n[\n\tm(\"h1\", {class: \"title\"}, \"My first app\"),\n\tm(\"button\", \"A button\"),\n]\n```\n\nAnd so on:\n\n```javascript\nm(\"main\", [\n\tm(\"h1\", {class: \"title\"}, \"My first app\"),\n\tm(\"button\", \"A button\"),\n])\n```\n\nNote: If you prefer `` syntax, [it's possible to use it via a Babel plugin](http://mithril.js.org/jsx.html).\n\n```jsx\n// HTML syntax via Babel's JSX plugin\n\n\t
My first app
\n\t\n\n```\n\n---\n\n### Components\n\nA Mithril component is just an object with a `view` function. Here's the code above as a component:\n\n```javascript\nvar Hello = {\n\tview: function() {\n\t\treturn m(\"main\", [\n\t\t\tm(\"h1\", {class: \"title\"}, \"My first app\"),\n\t\t\tm(\"button\", \"A button\"),\n\t\t])\n\t}\n}\n```\n\nTo activate the component, we use `m.mount`.\n\n```javascript\nm.mount(root, Hello)\n```\n\nAs you would expect, doing so creates this markup:\n\n```markup\n\n\t
My first app
\n\t\n\n```\n\nThe `m.mount` function is similar to `m.render`, but instead of rendering some HTML only once, it activates Mithril's auto-redrawing system. To understand what that means, let's add some events:\n\n```javascript\nvar count = 0 // added a variable\n\nvar Hello = {\n\tview: function() {\n\t\treturn m(\"main\", [\n\t\t\tm(\"h1\", {class: \"title\"}, \"My first app\"),\n\t\t\t// changed the next line\n\t\t\tm(\"button\", {onclick: function() {count++}}, count + \" clicks\"),\n\t\t])\n\t}\n}\n\nm.mount(root, Hello)\n```\n\nWe defined an `onclick` event on the button, which increments a variable `count` (which was declared at the top). We are now also rendering the value of that variable in the button label.\n\nYou can now update the label of the button by clicking the button. Since we used `m.mount`, you don't need to manually call `m.render` to apply the changes in the `count` variable to the HTML; Mithril does it for you.\n\nIf you're wondering about performance, it turns out Mithril is very fast at rendering updates, because it only touches the parts of the DOM it absolutely needs to. So in our example above, when you click the button, the text in it is the only part of the DOM Mithril actually updates.\n\n---\n\n### Routing\n\nRouting just means going from one screen to another in an application with several screens.\n\nLet's add a splash page that appears before our click counter. First we create a component for it:\n\n```javascript\nvar Splash = {\n\tview: function() {\n\t\treturn m(\"a\", {href: \"#!/hello\"}, \"Enter!\")\n\t}\n}\n```\n\nAs you can see, this component simply renders a link to `#!/hello`. The `#!` part is known as a hashbang, and it's a common convention used in Single Page Applications to indicate that the stuff after it (the `/hello` part) is a route path.\n\nNow that we going to have more than one screen, we use `m.route` instead of `m.mount`.\n\n```javascript\nm.route(root, \"/splash\", {\n\t\"/splash\": Splash,\n\t\"/hello\": Hello,\n})\n```\n\nThe `m.route` function still has the same auto-redrawing functionality that `m.mount` does, and it also enables URL awareness; in other words, it lets Mithril know what to do when it sees a `#!` in the URL.\n\nThe `\"/splash\"` right after `root` means that's the default route, i.e. if the hashbang in the URL doesn't point to one of the defined routes (`/splash` and `/hello`, in our case), then Mithril redirects to the default route. So if you open the page in a browser and your URL is `http://localhost`, then you get redirected to `http://localhost/#!/splash`.\n\nAlso, as you would expect, clicking on the link on the splash page takes you to the click counter screen we created earlier. Notice that now your URL will point to `http://localhost/#!/hello`. You can navigate back and forth to the splash page using the browser's back and next button.\n\n---\n\n### XHR\n\nBasically, XHR is just a way to talk to a server.\n\nLet's change our click counter to make it save data on a server. For the server, we'll use [REM](http://rem-rest-api.herokuapp.com), a mock REST API designed for toy apps like this tutorial.\n\nFirst we create a function that calls `m.request`. The `url` specifies an endpoint that represents a resource, the `method` specifies the type of action we're taking (typically the `PUT` method [upserts](https://en.wiktionary.org/wiki/upsert)), `data` is the payload that we're sending to the endpoint and `withCredentials` means to enable cookies (a requirement for the REM API to work)\n\n```javascript\nvar count = 0\nvar increment = function() {\n\tm.request({\n\t\tmethod: \"PUT\",\n\t\turl: \"http://rem-rest-api.herokuapp.com/api/tutorial/1\",\n\t\tdata: {count: count + 1},\n\t\twithCredentials: true,\n\t})\n\t.then(function(data) {\n\t\tcount = parseInt(data.count)\n\t})\n}\n```\n\nCalling the increment function [upserts](https://en.wiktionary.org/wiki/upsert) an object `{count: 1}` to the `/api/tutorial/1` endpoint. This endpoint returns an object with the same `count` value that was sent to it. Notice that the `count` variable is only updated after the request completes, and it's updated with the response value from the server now.\n\nLet's replace the event handler in the component to call the `increment` function instead of incrementing the `count` variable directly:\n\n```javascript\nvar Hello = {\n\tview: function() {\n\t\treturn m(\"main\", [\n\t\t\tm(\"h1\", {class: \"title\"}, \"My first app\"),\n\t\t\tm(\"button\", {onclick: increment}, count + \" clicks\"),\n\t\t])\n\t}\n}\n```\n\nClicking the button should now update the count.\n\n---\n\nWe covered how to create and update HTML, how to create components, routes for a Single Page Application, and interacted with a server via XHR.\n\nThis should be enough to get you started writing the frontend for a real application. Now that you are comfortable with the basics of the Mithril API, [be sure to check out the simple application tutorial](http://mithril.js.org/simple-application.html), which walks you through building a realistic application.\n",
"readmeFilename": "README.md",
"repository": {
"type": "git",
"url": "git+https://github.com/lhorie/mithril.js.git"
},
"scripts": {
"build": "npm run build-browser & npm run build-min",
"build-browser": "node bundler/cli browser.js -o mithril.js",
"build-min": "node bundler/cli browser.js -o mithril.min.js -m",
"cover": "istanbul cover --print both ospec/bin/ospec",
"dev": "node bundler/cli browser.js -o mithril.js -w",
"gendocs": "node docs/generate",
"lint": "eslint .",
"lintdocs": "node docs/lint",
"posttest": "npm run lint || true",
"postversion": "git push --follow-tags",
"preversion": "npm run test",
"test": "node ospec/bin/ospec",
"version": "npm run build && npm run gendocs && git add mithril.js mithril.min.js"
},
"version": "1.0.0"
}