cc7a0f427d
- Fix missing screenshots - Move tutorial assets into source tree - Add ToC - Change codestyle to lowercase events - Change codestyle to only actions PascalCase - Rewrite to teach custom effects / subs - Use GitHub raw URLs for tutorial screenshots - Get rid of .prettierrc Authored-by: Zacharias Enochsson <zache@axis.com> |
||
|---|---|---|
| .github | ||
| docs | ||
| lib | ||
| src | ||
| test | ||
| .gitignore | ||
| .travis.yml | ||
| LICENSE.md | ||
| README.md | ||
| package.json | ||
README.md
Hyperapp 
The tiny framework for building web interfaces.
- Do more with less—We have minimized the concepts you need to learn to be productive. Views, actions, effects, and subscriptions are all pretty easy to get to grips with and work together seamlessly.
- Write what, not how—With a declarative syntax that's easy to read and natural to write, Hyperapp is your tool of choice to develop purely functional, feature-rich, browser-based applications.
- Hypercharged—Hyperapp is a modern VDOM engine, state management solution, and application design pattern all-in-one. Once you learn to use it, there'll be no end to what you can do.
To learn more, go to https://hyperapp.dev for documentation, guides, and examples.
Quickstart
Install Hyperapp with npm or Yarn:
npm i hyperapp
Then with a module bundler like Parcel or Webpack import it in your application and get right down to business.
import { h, app } from "hyperapp"
Don't want to set up a build step? Import Hyperapp in a <script> tag as a module. Don't worry; modules are supported in all evergreen, self-updating desktop, and mobile browsers.
<script type="module">
import { h, app } from "https://unpkg.com/hyperapp"
</script>
Here's the first example to get you started: a counter that can go up or down. You can try it online here.
<!DOCTYPE html>
<html lang="en">
<head>
<script type="module">
import { h, app } from "https://unpkg.com/hyperapp"
app({
init: 0,
view: state =>
h("main", {}, [
h("h1", {}, state),
h("button", { onClick: state => state - 1 }, "-"),
h("button", { onClick: state => state + 1 }, "+")
]),
node: document.getElementById("app")
})
</script>
</head>
<body>
<main id="app"></main>
</body>
</html>
The app starts off with init as the initial state. Our code doesn't explicitly maintain any state. Instead, we define actions to transform it and a view to visualize it. The view returns a plain object representation of the DOM known as a virtual DOM, and Hyperapp updates the real DOM to match it whenever the state changes.
Now it's your turn! Experiment with the code a bit. Spend some time thinking about how the view reacts to changes in the state. Can you add a button that resets the counter back to zero? Or how about multiple counters?
Help, I'm stuck!
We love to talk JavaScript and Hyperapp. If you've hit a stumbling block, hop on the Hyperapp Slack or drop by Spectrum to get support, and if you don't receive an answer, or if you remain stuck, please file an issue, and we'll try to help you out.
Is anything wrong, unclear, missing? Help us improve this page.