Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/hyoo-ru/mam_mol

$mol - fastest reactive micro-modular compact flexible lazy ui web framework.
https://github.com/hyoo-ru/mam_mol
bem bundler components framework isomorphic javascript lazy-evaluation lazy-loading lazy-rendering mam micro-modular mol oorp reactivity self-descriptive typescript virtual-rendering
Last synced: about 2 months ago
JSON representation
$mol - fastest reactive micro-modular compact flexible lazy ui web framework.
Host: GitHub
URL: https://github.com/hyoo-ru/mam_mol
Owner: hyoo-ru
License: mit
Created: 2016-05-10T09:01:32.000Z (over 8 years ago)
Default Branch: master
Last Pushed: 2024-06-04T07:23:07.000Z (4 months ago)
Last Synced: 2024-06-05T04:43:57.833Z (4 months ago)
Topics: bem, bundler, components, framework, isomorphic, javascript, lazy-evaluation, lazy-loading, lazy-rendering, mam, micro-modular, mol, oorp, reactivity, self-descriptive, typescript, virtual-rendering
Language: TypeScript
Homepage: http://mol.hyoo.ru
Size: 586 MB
Stars: 665
Watchers: 24
Forks: 56
Open Issues: 36
Metadata Files:
- Readme: readme.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Support: support/css/css.ts
Awesome Lists containing this project

awesome-list - mam_mol - fastest reactive micro-modular compact flexible lazy ui web framework. | hyoo-ru | 423 | (TypeScript)
README

        # $mol

Reactive micro-modular UI framework. Very simple, but very powerful!

![](https://habrastorage.org/webt/0r/l1/70/0rl170zizkwddstnp5mt5bruroa.png)

# Contents

- [Features](#features)

- [Review](#reviews)

- [Quick start](#quick-start)

- [Tutorials](#tutorials)

- [Rationale](#rationale)

- [Modules](#modules)

- [Usage from NPM](#usage-from-npm-ecosystem)

- [Contributors](#contributors)

- [Cool stuff](#cool-stuff)

- [Donate](#donate)

# Features

- [Zero configuration](#zero-configuration). Just checkout and use it.

- [Lazy rendering/evaluating/loading etc](#lazyness).

- [Full reactivity](#reactivity) in all application layers. Not only between View and ViewModel.

- [Automatic dependency tracking](#reactivity) between reactive containers. No need to manual publish/subscribe/unsubscribe and streams routing.

- [Effective state synchronization](wire) in right way. 

- Automatic inclusion of modules in package at compile time. No need for manually importing or installing them. [Just use it](#zero-configuration).

- Very small modules. [All of them are optional](#zero-configuration).

- Cross platform. [Support any environment](#zero-configuration) (NodeJS, Web browsers, Cordova).

- Static typing ([TypeScript](https://www.typescriptlang.org/)). Full IDE support.

- Full customization. No hidden implementation. [All aspects are overridable](#lego-components).

- [Lifecycle management](#reactivity). Automatic destruction of unnecessary objects.

- [Easy debugging](#debugging). User friendly id's of all objects. Quick access to all objects from console.

- Easy [user friendly logging](#debugging) of all state changes.

- Pseudosynchronous code. [Asynchrony is abstracted by reactivity](#reactivity). No callbacks/promises/streams hell. No async/await/yield virus.

- Automatic [BEM](https://en.bem.info/methodology/naming-convention/)-attributes generation for elements.

# Reviews

- [$mol — лучшее средство от геморроя](https://mol.hyoo.ru/#!section=slides/slides=https%3A%2F%2Fnin-jin.github.io%2Fslides%2Fmol%2F) - Quick introduction to $mol

- [$mol: реактивный микромодульный фреймворк](https://mol.hyoo.ru/#!section=articles/author=nin-jin/repo=HabHub/article=5) - First introduction to $mol

- [$mol: 4 года спустя](https://mol.hyoo.ru/#!section=articles/author=nin-jin/repo=HabHub/article=23) - State of $mol after 4 years

# Quick start

[Video of this process](https://www.youtube.com/watch?v=PyK3if5sgN0)

## Create MAM project

The easiest way is to checkout this [preconfigured MAM repository](http://github.com/hyoo-ru/mam) and start a dev server:

```sh

git clone https://github.com/hyoo-ru/mam.git ./mam && cd mam

npm install && npm start

```

Or simply use [![Gitpod Online Dev Workspace](https://img.shields.io/badge/Gitpod-Online--Dev--Workspace-blue.svg)](https://gitpod.io/#https://github.com/hyoo-ru/mam).

## Setup your editor

- Use MAM directory as root of your project in editor

- [Install VScode intellisense plugin for *.view.tree files](https://marketplace.visualstudio.com/items?itemName=valikov.tree-language-service)

- [Install plugin for *.tree files](https://github.com/nin-jin/tree.d#ide-support)

- [Install .editorconfig plugin](https://editorconfig.org/#download) or use these preferences: **TABs for indents, LF for line endings**.

## Create your application component

The following example uses the namespace "my" and the application name "hello", but you can use your own namespace and application name.

Let's create a component that allows you to enter your name and display greeting text: "Hello, " + your name.

You need to create next files:

- ./my/hello/index.html - Web entry point

- ./my/hello/hello.view.tree - Declarative component description

- ./my/hello/hello.view.ts - Behaviour/User interface logic

- ./my/hello/hello.test.ts - Tests

- ./my/hello/hello.view.css - Styles

Add **web entry point** at `./my/hello/index.html`:

```html

 

 

	

		 

		 

		 

		

	

	 

		
 

		 

	

```

Your application will be served at **`http://localhost:9080/my/hello/`**. Open it. You should refresh page to view your changes.

Add **[declarative component description](view)** at `./my/hello/hello.view.tree` with string input field and greeting message:

```tree

$my_hello $mol_view

	sub /

		<= Name $mol_string

			hint \Name

			value? <=> name? \

		<= message \

```

Add **your behaviour** at `./my/hello/hello.view.ts` by extending generated class:

```typescript

namespace $.$$ {

	export class $my_hello extends $.$my_hello {

		

		message() {

			let name = this.name()

			return name && `Hello, ${name}!`

		}

		

	}

}

```

Add **tests for your behaviour** at `./my/hello/hello.test.ts`

```typescript

namespace $.$$ {

	$mol_test({

		'Generating greeting message'() {

			const app = new $my_hello

			$mol_assert_equal( app.message() , '' )

			

			app.name( 'Jin' )

			$mol_assert_equal( app.message() , 'Hello, Jin!' )

		}

	})

}

```

Add **styles** at `./my/hello/hello.view.css`:

```css

/* Styling BEM-block by autogenerated attribute */

[my_hello] {

	display: flex;

	flex-direction: column;

	align-items: center;

	font: 1.5rem/1 sans-serif;

	box-shadow: 0 0 0 1px var(--mol_theme_line);

	flex: 1 1 auto;

	align-self: stretch;

	margin: 0;

}

/* Styling BEM-element by autogenerated attribute */

[my_hello_name] {

	flex-grow: 0;

	margin: 1rem;

	width: 14rem;

}

```

[That is all!](https://mol.js.org/app/hello/-)

# Tutorials

- [Путь друкона - учебный курс](https://www.youtube.com/playlist?list=PLXyFFhv8ucKRBg76o0YXnmQFT1LglSaND)

- [$mol_app_calc: вечеринка электронных таблиц](https://github.com/nin-jin/HabHub/issues/10)

- [$hyoo_bench: готовим JS бенчмарки быстро и просто](https://github.com/nin-jin/HabHub/issues/8)

- [$mol_app_habhub: чтение статей с GitHub](https://github.com/nin-jin/HabHub/issues/5)

# Rationale

## Zero configuration

Instead of ensuring configurability by any means, $mol concentrates on everything working good directly out of the box and does not bother $mol's developer by a typical configuration process. (Nevertheless, this doesn't exclude setup for your needs if required)

For example if you download **[base MAM-project](http://github.com/hyoo-ru/mam)** you'll get this:

**Building of JS and CSS bundles for different platforms.** A bundle can be built for any module. This bundle would contain sources of that module and sources of all other modules on which that module depends on. There also would not be any redundant modules in the bundle.  

Here is a full set of supported bundles:

- `-/web.js` - JS for browser

- `-/web.d.ts` - TypeScript definitions

- `-/web.test.js` - JS with tests for a browser

- `-/web.deps.json` - map of dependencies modules for browser

- `-/web.locale=en.json` - strings pulled from ```*.view.tree``` and ```*.locale=en.json``` sources

- `-/node.js` - JS for NodeJS

- `-/node.test.js` - JS with tests for NodeJS

- `-/node.deps.json` - a map of dependencies modules for NodeJS

**Support of Source Maps**. Sources are compiled and integrated into maps, they are fully self-sufficient.

**Development server**, which compiles bundles as needed. For example, when `http://localhost:9080/hyoo/todomvc/-/web.js` is requested, the `js` bundle is built from `hyoo/todomvc` for `web` environment. Rebuilding occurs only if any source files are changed.

**Transpilling [TypeScript](https://github.com/Microsoft/TypeScript) into JS**. 

In TS configuration enabled support decorators and disabled implicit `any` type, to prevent missing typing by change.

**Watching dependencies by fact of using** and automatic inclusion of the needed modules on further bundling. You don't need to write `include` and `require`. All you need is to refer instance by full name like `$mol_state_arg` and `$mol.state.arg` (depending on its definition) in `*.ts`, `*.view.ts`, `*.view.tree` and `*.jam.js` files. Dependencies in CSS files are looked for by entries like `[mol_check_checked]` , `[mol_check_checked=` and `.mol_check_checked`.

## Lego components

$mol uses the component approach to building interfaces, however **every component is self-sufficient** and can be used as a self-sufficient application. Small components are aggregated inside larger components etc.

Unlike another frameworks, $mol does not isolate the internals of its components. Vice versa, a comfortable mechanism is provided for developers to configure them, the creator of the component doesn't have to do any additional actions.

For example, to set the list of sub components you need to redefine `sub` property in view.tree

```tree

Confirm_delete $mol_row sub /

	<= Yes $mol_button_minor title \Yes

	<= No $mol_button_major title \No

```

Or the same code in TypeScript would be:

```typescript

@ $mol_mem

Confirm_delete() {

	return $mol_row.make({

		sub : ()=> [ this.Yes() , this.No() ] ,

	})

}

```

In both variants the compiler would verify the existence of the property and correspondence of the signature. Normally you don't need to work with fields of the object directly, all definable properties 

are public and can be safely overloaded.

Details about viewers and `view.tree` language: [$mol_view](view).

## Laziness

[$mol_view](view) implements lazy rendering. [$mol_scroll](scroll) watches scroll position and suggests the view height to embedded components. [$mol_list](list) knows the view height and minimal sizes of the embedded components, it excludes components definitely outside viewport from rendering. And all other components report their minimal size through `minimal_height` property.

```

$my_icon $mol_view

	minimal_height 16

```

As the result opening of any window occurs instantly. It's independent from output data size. And since data would not be rendered, any requests would not be proceeded. This allows us to download them partly, when they are needed. Such a feature is possible due to reactive architecture, that penetrates through all layers of the application.

## Reactivity

Unlike control-flow architectures, $mol implements the data-flow architecture. All applications are defined as a set of classes having properties. Every property is defined as some function from another property (and properties of another classes too). Properties, which were called while processing a function are saved as dependencies of current property. When their values change, all dependent properties would be invalidated cascading. Calling a non relevant property would lead to its pre-actualization.

In this way the whole application at the execution stage represents a huge tree of dependencies, with a special property at the root of the tree, which in case of invalidation would actualize itself automatically. And as any property always knows, whether something depends on it or not, then it is given a simple and reliable mechanism of controlling lifecycle of objects - they are created when dependence appears and are destroyed when nothing depends on them. This solves two fundamental problems: resources leaks and cache invalidation. 

Besides, the reactive architecture allows us to abstract code elegantly from asynchronous operations. If the function can't return value at the moment, it can throw `Promise` and is marked as part of the tree as "waiting of results". When result is retrieved, it can be inserted into property directly and an application would be reconstructed for the new state.

```typescript

namespace $ {

	export class $my_greeter {

		

		@ $mol_mem

		greeting() {

			const user_name = $mol_fetch.json( 'https://example.org/profile/name' )

			return `Hello, ${ user_name }!`

		}

		

	}

}

```

Details: [$mol_wire](wire).

## Debugging

$mol pays special attention to debugging possibilities and research of how its code works.

A human friendly `id` is automatically formed for every DOM-element, e.g. `$hyoo_todomvc.root(0).taskRow(0).titler()`, which is a valid javascript code, that could be executed in a console, returning a link to the component, which the DOM-element corresponds to. Unfolding the content of the component you'd see names and values for its fields like:

```

$hyoo_todomvc

    dom_node() : div#$hyoo_todomvc.root(0)

    task(1474385802391) : Object

    task(1474386443175) : Object

    taskRow(0) : $hyoo_todomvc_task_rowRow

    taskRow(1) : $hyoo_todomvc_task_rowRow

    taskrows() : Array[2]

```

The name of the field corresponds to calling the property, the content of the field would be available through. And thanks to naming classes and functions by underscoring, you always know which class instance you're looking at and can briefly find it in the code by searching the substring.

# Modules

## Flow

- **[$mol_fiber](fiber)** - Suspendable tasks

- **[$mol_atom2](atom2)** - Reactive container

- **[$mol_log2](log2)** - Logging

- **[$mol_import](import)** - Dynamic sources import

- **[$mol_after](after)** - Scheduled callbacks with unified api

- **[$mol_fail](fail)** - Throws all exceptions in one place to increase debug experience

## Object model

- **[$mol_wire](wire)** - Reactivity system

- **[$mol_object](object)** - Components base class

## Lifecycle

- **[$mol_ambient](ambient)** - Makes derived context

- **[$mol_owning](owning)** - Owning relation between objects

## Functions

- **[$mol_const](const)** - Const value returning function

- **[$mol_func_name](func/name)** - Name of function

- **[$mol_func_sandbox](func/sandbox)** - Sandbox for safe code evaluation

## Collections

- **[$mol_range2](range2)** - Lazy array

- **[$mol_maybe](maybe)** - [Maybe monad](https://en.wikipedia.org/wiki/Monad_(functional_programming)#The_Maybe_monad)

- **[$mol_conform](conform)** - Object tree reconciler

- **[$mol_dict](dict)** - Useful native `Map` extension

- **[$mol_array_chunks](array/chunks)** - Splits array by different chunks

- **[$mol_array_trim](array/trim)** - Shortens array without memory reallocation

## [State modules](state)

- **[$mol_state_arg](state/arg)** - Arguments state (location/argv)

- **[$mol_state_local](state/local)** - Persistent local state (localStorage)

- **[$mol_state_session](state/session)** - Session temporary state (sessionStorage)

- **[$mol_state_history](state/history)** - Browser history bound state

- **[$mol_state_stack](state/stack)** - State of current stack of execution

- **[$mol_state_time](state/time)** - Reactive current time stamp 

## Simple components

- **[$mol_view](view)** - Reactive view model base class with lazy error-proof renderer

- **[$mol_ghost](ghost)** - Node-less wrapper for another view

- **[$mol_filler](filler)** - Lorem ipsum

- **[$mol_svg](svg)** - SVG base components

- **[$mol_status](status)** - Prints error status of some property

- **[$mol_speck](speck)** - Attention speck

## Simple controls

- **[$mol_link](link)** - Navigation link

- **[$mol_button](button)** - Button

- **[$mol_check](check)** - Check box

- **[$mol_switch](switch)** - Radio buttons

- **[$mol_select](select)** - Select with search and lazy rendering support

- **[$mol_string](string)** - One string input control

- **[$mol_textarea](textarea)** - Multiple line input control

- **[$mol_search](search)** - Search string with suggests support

- **[$mol_number](number)** - One number input control

- **[$mol_code](code)** - Bar code scanner

- **[$mol_portion](portion)** - Portion visualizer

## Layout components

- **[$mol_scroll](scroll)** - Scroll pane with position saving

- **[$mol_tiler](tiler)** - Items in row with balanced wrapping

- **[$mol_row](row)** - Items in row with wrapping and padding between

- **[$mol_bar](bar)** - Group of controls as own control

- **[$mol_list](list)** - Vertical list of rows

- **[$mol_labeler](labeler)** - Labeled content

- **[$mol_section](section)** - Section with header

- **[$mol_book](book)** - Horizontal stack of pages

- **[$mol_page](page)** - Page with header, body and footer

- **[$mol_deck](deck)** - Deck of panels with tab bar

- **[$mol_card](card)** - Card with content

## Plugin components

- **[$mol_nav](nav)** - Keyboard navigation

- **[$mol_touch](touch)** - Touch/pointer gestures

- **[$mol_speech](speech)** - Speech recognition and synthesis

- **[$mol_hotkey](hotkey)** - Keyboard shortcuts

## Complex components

- **[$mol_form](form)** - Forms with validators

- **[$mol_attach](attach)** - Preview list and attach button

- **[$mol_cost](cost)** - Prints currency values

- **[$mol_message](message)** - User message

## Charts

- **[$mol_chart](chart)** - Plot pane with legend

- **[$mol_chart_legend](chart/legend)** - Simple legend for charts

- **[$mol_plot_pane](plot/pane)** - Pane for multiple graphs

- **[$mol_plot_graph](plot/graph)** - Plot graph base class

- **[$mol_plot_bar](plot/bar)** - Bar graph

- **[$mol_plot_line](plot/line)** - Linear graph

- **[$mol_plot_dot](plot/dot)** - Dots graph

- **[$mol_plot_fill](plot/fill)** - Filling graph

- **[$mol_plot_group](plot/group)** - Group of graph as single graph

- **[$mol_plot_ruler_vert](plot/ruler/vert)** - Vertical ruler

- **[$mol_plot_ruler_hor](plot/ruler/hor)** - Horizontal ruler

- **[$mol_plot_mark_hor](plot/mark/hor)** - Horizontal markers

## Data formats

- **[$mol_tree2](tree2)** - [Tree format](https://github.com/nin-jin/tree.d) (`view.tree` language described at [$mol_view](view))

- **[$mol_base64](base64)** - Base64 encode/decode

- **[$mol_leb128](leb128)** - LEB128 encode/decode

## Math

- **[$mol_graph](graph)** - Graph algorithms

- **[$mol_unit](unit)** - Typed number value

- **[$mol_merge_dict](merge/dict)** - Merge two dictionaries to new one

## Resources

- **[$mol_icon](https://github.com/nin-jin/mol_icon)** - CSS styled material design icons

- **[$mol_theme](theme)** - Theming

- **[$mol_gap](theme)** - Paddings, margins etc

- **[$mol_style](style)** - CSS-in-TS

## Testing

- **[$mol_test](test)** - Unit testing

- **[$mol_stub](stub)** - Stub data generators

- **[$mol_assert](assert)** - Assertion functions

## API

- **[$mol_window](window)** - Reactive view port configuration

- **[$mol_fetch](fetch)** - Reactive [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API)

- **[$mol_webdav](webdav)** - Reactive [WebDAV](https://wikipedia.org/wiki/WebDAV) client

- **[$mol_file](file)** - Isomorphic reactive file system wrapper

- **[$mol_exec](exec)** - Synchronous execute of system command

- **[$mol_cordova](cordova)** - [Apache Cordova](https://cordova.apache.org) API

## Time

- **[$mol_time_moment](time/moment)** - [Time moment](https://en.wikipedia.org/wiki/ISO_8601#Dates) representation with iso8601 support

- **[$mol_time_duration](time/duration)** - [Time duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) representation with iso8601 support

- **[$mol_time_interval](time/interval)** - [Time interval](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals) representation with iso8601 support

- **[$mol_state_time](state/time)** - Reactive current time stamp 

- **[$mol_date](date)** - Date picker

- **[$mol_calendar](calendar)** - Days of month as table

## Maps

- **[$mol_map_yandex](map/yandex)** - [Yandex Maps](https://tech.yandex.ru/maps/doc/jsapi/2.1/)

## WebAssemply

- **[$mol_wasm](wasm)** - WASM runner

- **[$mol_leb128](leb128)** - LEB128 encode/decode

- **[$mol_tree2_wasm](tree2/wasm)** - wasm.tree representation

## Web Services

- **[$mol_github](github)** - [GitHub API](https://developer.github.com/v3/)

- **[$mol_chat](chat)** - GitHub based comments everywhere

## Building

- **[$mol_build](build)** - MAM builder

- **[$mol_build_server](build/server)** - MAM developer server

## Usage from NPM ecosystem

You can manually build any $mol module as standalone lib:

```

git clone https://github.com/hyoo-ru/mam.git ./mam

cd mam

npm install

npm start path/to/module

cp path/to/module/-/* your/build/directory

```

Some libs are already published to NPM:

- [$mol_data](data) - Static typed DTO with strict runtime validation and user friendly error messages.

- [$mol_strict](strict) - Makes JS runtime more strict.

- [$mol_time](time) - Proper date/time/duration/interval arithmetic.

- [$mol_type](type) - TypeScript meta types for complex logic.

- [$mol_regexp](regexp) - Regular Expressions builder.

- [$mol_crypto](crypto) - Efficient cryptographic algorithms.

- [$mol_db](db) - Static typed IndexedDB wrapper with auto migrations.

- [$hyoo_crowd](https://github.com/hyoo-ru/crowd.hyoo.ru) - Conflict-free Reinterpretable Ordered Washed Data.

- [$mol_plot](plot) - [Fastest](https://bench.hyoo.ru/app/#!bench=https%3A%2F%2Fbench.hyoo.ru%2Fchart%2Frope%2F/sample=canvasjs~mol~chartjs/sort=update) plot lib for vector graphics.

All of them are very small, powerful and fastest. Use it for your pleasure.

# Contributors

This project exists thanks to all the people who contribute.

- [nin-jin](https://github.com/nin-jin)

- [ar2r13](https://github.com/ar2r13)

- [zerkalica](https://github.com/zerkalica)

- [muleronko](https://github.com/muleronko)

- [slava-viktorov](https://github.com/slava-viktorov)

- [CONTRIBUTING](https://github.com/hyoo-ru/mol/blob/master/CONTRIBUTING.md)

# Cool stuff

- **[Commits visualization](http://ghv.artzub.com/#repo=mam_mol&user=hyoo-ru&climit=100000)**

- **[Sources visualization (fennel)](http://veniversum.me/git-visualizer/?owner=hyoo-ru&repo=mam_mol)**

- **[Sources visualization (foam)](https://octo-repo-visualization.vercel.app/?repo=hyoo-ru%2Fmam_mol)**

# Donate

- **[Shut up and take my money](https://www.tinkoff.ru/cf/1VnW7ZtTeg2)**

- **[Long time support](https://boosty.to/hyoo)**