@tilfin/flatout

v0.10.10

Published

2 years ago

Lightweight Single-Page-Application framework for JavaScript

Downloads

0High
0Medium
0Low

tilfin

view framework SPA

flatout

Lightweight Single-Page-Application framework for JavaScript

Concepts

Built by pure JavaScript/ECMAScript
Supports only latest browsers
Not require compilation
Not use Virtual DOM
Keeping minimized size less than 16KB

Features

Rendering by the component views tree and data mapped for each the view
Realization of short codes by automatic object mapping and binding events

Provides Classes

Core
Http
View
ListView
FormView
Page
Item
List
App

Document

https://tilfin.github.io/flatout/

Setup

$ npm install -save @tilfin/flatout

Generate documents

$ npm run doc

Start example apps

$ npm run example

Routing

Support 2 type

HASH mode (hash path with Static Web server)
HISTORY mode (HTML5 history API with Web App server)

Specify the root path by the base tag if it isn't /. ex) <base href="/<root path>/">

Plain data or event handling

Plain data

Plain data is an Object or an Array.

Data with binding views

An Object is an Item that you can add, update or destroy itself.
An Array is a Collection that you can add, update or remove item and reset itself.

Use Application

History mode

<!DOCTYPE html>
<html>
<head>
<title>History mode</title>
<base href="/app/">
</head>
<body>
<nav><a href="about">About</a></nav>
<main id="frame">
<!-- content area -->
</main>
<script type="module">
import { App, Page, View } from 'flatout.js'

class MainView extends View {
  constructor() {
    super(document.body, { container: 'frame' })
  }
}

const routeMap = {
  index: HomePage,   // /
  about: AboutPage,  // /about
  ':userId': UserPage  // /:userId
}

App.activate(MainView, routeMap, { mode: 'HISTORY' })
</script>
</body>
</html>

Hash mode

<!DOCTYPE html>
<html>
<head>
<title>Hash mode</title>
</head>
<body>
<nav><a href="#!/about">About</a></nav>
<main id="frame">
<!-- content area -->
</main>
<script type="module">
import { App, Page, View } from 'flatout.js'

class MainView extends View {
  constructor() {
    super(document.body, { container: 'frame' })
  }
}

const routeMap = {
  index: HomePage,       // /
  about: AboutPage,      // /about
  books: {
    index: BookListPage, // /books/
    ':bookId': BookPage, // /books/:bookId
  }
}

App.activate(MainView, routeMap, { mode: 'HASH' })
</script>
</body>
</html>