spasm 0.0.7
A framework for writing single page applications
To use this package, run the following command in your project's root directory:
Manual usage
Put the following dependency into your project's dependences section:
This package provides sub packages which can be used individually:
spasm:bootstrap-webpack - A minimal D application.
Spasm
Spasm is a libary to develop single page applications in D that compile to webassembly.
It uses D's compile time feature to generate optimized rendering code specific for your application.
Not only are your applications fast, they are also small. The todo-mvc example project is only 5995 (wasm) + 2199 (html+js) bytes when gzipped.
How to start
- run
dub init
in a fresh folder - add spasm to your dub dependencies
- run
dub run spasm:bootstrap-webpack
to generate the webpack/dev-server boilerplate - start writing!
You can add any extra css/js you'll need to the index.template.html
, or you can use any of the myriad features of webpack to include what you need.
How to compile your application
run dub build --compiler=ldc2 --build=release
to compile your application, then run npx webpack
to generate the index.html
.
You can also npm run start
to start a webpack development server that serves your application on localhost:3000 (it builds anytime the app.js
or index.template.html
changes).
- Note: I could not get it to build on my aged mac (el capitan). Instead I use docker to run ldc in ubuntu.
Example
There is todo-mvc example project in this repo. It implements the famous todo mvc application.
Limitations
This project uses betterC, which means there is no D runtime. This also means that most phobos functions don't work, as well any D features that rely on the D runtime. If you get any weird errors, this is probably the reason why.
WIP
- Generated CSS stylesets from D are currently disabled.
- Currently no memory is freed.
- The generated webassembly binaries needs manual stripping to reduce code bloat.
- Most js host api's are missing (xhr, localstorage, etc.).
How it works
Each html element is mapped to a D struct. Each attribute, property, eventlistener and any children nodes are (annotated) members of that struct.
Here is an example of rendering a div node.
struct App {
mixin Node!"div";
}
mixin Spa!App;
The mixin ensures the app is rendered and integrates with the js runtime code.
The following example shows how to set properties on the rendered node.
struct App {
mixin Node!"div";
@prop innerText = "Hello World!";
}
mixin Spa!App;
Properties can also be a result of a function.
struct App {
mixin Node!"div";
@prop bool innerText() {
return "Hello World!"
};
}
mixin Spa!App;
Here we add a button child component.
struct Button {
mixin Node!"button";
@prop innerText = "Click me!";
}
struct App {
mixin Node!"div";
@child Button button;
}
mixin Spa!App;
Now we add a event listener to the button.
struct Button {
mixin Node!"button";
mixin Slot!"click";
@prop innerText = "Click me!";
@callback void onClick(MouseEvent event) {
this.emit(click);
}
}
struct App {
mixin Node!"div";
@child Button button;
}
mixin Spa!App;
The onClick
function is called whenever an onclick event is generated on the dom node.
In order to propagate events between structs - often you have a parent component that has logic - a Slot!click
is mixed into the struct. The separation between the slot and the callback function is on purpose. It provides isolation from dom events and it simplifies event listeners on arrays (doesn't require keying).
Here we connect the slot from the App.
struct Button {
mixin Node!"button";
mixin Slot!"click";
@prop innerText = "Click me!";
@callback void onClick(MouseEvent event) {
this.emit(click);
}
}
struct App {
mixin Node!"div";
@child Button button;
@connect!"button.click" void click() {
}
}
mixin Spa!App;
The @connect
annotation ensures the click
function is called whenever there is an this.emit!(click)
call in Button.
In the next example we show how to propagate properties from one component down into another.
struct Button {
mixin Node!"button";
mixin Slot!"click"
@prop string* innerText;
@callback void onClick(MouseEvent event) {
this.emit!(click);
}
}
struct App {
mixin Node!"div";
@child Button button;
string innerText = "Click Me!";
@connect!"button.click" void click() {
this.update!(innerText)("Clicked!");
}
}
mixin Spa!App;
The result is when the button is clicked the text is changed into "Clicked!".
We have inserted a string innerText
field into App, and made the one in Button a pointer. During the first rendering any pointers from a struct will be assigned to their parent. This approach is chosen due to its low performance impact (just a extra pointer to store) and simplicity (no need to pass prop structs between components).
The second piece is the update
template function, this function uses static introspection to determine exactly what to update. This is almost always inlined in the resulting wasm code. Here we deviate the most from traditional virtual-dom approaches. Instead of completely rendering the App component and diffing the result, the update
template function knows exactly what to update.
Here we show how lists are implemented.
struct Item {
mixin Node!"li";
@prop string innerText;
}
struct Button {
mixin Node!"button";
mixin Slot!"click";
@prop string innerText = "Add";
@callback void onClick(MouseEvent event) {
this.emit!(click);
}
}
struct App {
mixin Node!"div";
@child Button button;
@child UnorderedList!Item items;
@connect!"button.click" void click() {
Item* item = allocator.make!Item;
item.innerText = "Item";
items.put(item);
}
}
mixin Spa!App;
We added an UnorderedList!Item
child. This is a standard component and renders an <ul>
node with children.
Here we show how to do event listeners on arrays.
struct Item {
mixin Node!"li";
mixin Slot!"click";
@prop string innerText;
@callback void onClick(MouseEvent event) {
this.emit!(click);
}
}
struct Button {
mixin Node!"button";
mixin Slot!"click";
@prop string innerText = "Add";
@callback void onClick(MouseEvent event) {
this.emit!(click);
}
}
struct App {
mixin Node!"div";
@child Button button;
@child UnorderedList!Item list;
@connect!"button.click" void click() {
Item* item = allocator.make!Item;
item.innerText = "Item";
list.put(item);
}
@connect!("list.items","click") void itemClick(size_t idx) {
}
}
mixin Spa!App;
In the @connect
annotation we split the part to the underlying DynamicArray in UnorderedList
and the path to the slot from the Item component. Plus there is an extra argument signifying the index of the item in the array.
This is works with a simple pointer range search in the array. It introduces no memory overhead or keying.
In this example we show how we can use standard range algorithms to transform arrays.
struct Item {
mixin Node!"li";
mixin Slot!"click";
@prop string innerText;
@style!"active" bool active = false;
@callback void onClick(MouseEvent event) {
this.emit!(click);
}
void toggle() {
this.update!(active)(!active);
}
}
struct Button {
mixin Node!"button";
mixin Slot!"click";
@prop string innerText = "Add";
@callback void onClick(MouseEvent event) {
this.emit!(click);
}
}
struct App {
mixin Node!"div";
@child Button addButton;
@child Button toggleButton = {innerText: "Only Active"};
@child UnorderedList!Item list;
bool onlyActive;
DynamicArray!(Item*) items;
@connect!"toggleButton.click" void toggleClick() {
this.update!(onlyActive)(!onlyActive);
}
@connect!"addButton.click" void addClick() {
Item* item = allocator.make!Item;
item.innerText = "Item";
items.put(item);
this.update!(items);
}
@connect!("list.items","click") void itemClick(size_t idx) {
list.items[idx].toggle();
this.update!(items);
}
auto transform(ref DynamicArray!(Item*) items, bool onlyActive) {
import std.algorithm : filter;
items[].filter!(i=>(i.active || !onlyActive)).update(list);
}
}
mixin Spa!App;
Before showing the standard range usage we had to make some adjustments and additions to the example.
In the Item Component we added an active
bool, and we annotated this with @style!"active"
. Whenever active is true the active style is added, and vice versa. We added a toggle
function that toggles the active
bool.
We reused the Button component in the App for a Toggle, using D's struct initializer to overwrite the innerText property.
We added the onlyActive
bool and this is updated by clicking on the toggleButton.
We also added an DynamicArray!(Item*) items
field. This will contain our complete list and the UnorderedList's appender will only contain the items we want.
The itemClick
function is updated to call the items toggle function and updates the items.
Now we can discuss the transform
function. This function does the filtering of Item's based on the value of onlyActive
compared to the Item's active
bool.
Anytime there is a call to the templated update
function (e.g. in toggleClick
and in addClick
), besides updating what is necessary it will also call any member function which has a parameter which correspronds with the value that is being updated.
Since the transform function has the items
and onlyActive
as parameters, the update function will call it whenever items
or onlyActive
is changed.
In the transform
function we have our normal D range programming with an update(list)
at the end. This will make sure our UnorderedList!Item
field will get the items from the range. Essentially the UnorderedList!Item
acts as an Sink or OutputRange where each element of the InputRange will be placed into, it also does any necessary diffing with the dom.
There is a little caveat here. Since the transform function works by filtering on the active field of the Item, whenever the active field of an Item changes we need to call update
on items
again to ensure the list is updated. Therefore we needed to hoist the toggling from the Item Component into the App Component. The update function only works downwards and it cannot update parent properties.
The next example shows how we can do inline css styles.
struct AppStyle {
struct root {
auto margin = "10px";
}
struct button {
auto backgroundColor = "white";
@("hover") struct Hover {
auto backgroundColor = "gray";
}
}
struct toggle {
auto backgroundColor = "purple";
}
}
@styleset!(AppStyle)
struct App {
@style!"root" mixin Node!"div";
@child Button button;
@connect("button.click") void toggle() {
button.update!(button.toggle)(!button.toggle);
}
}
@styleset!(AppStyle)
struct Button {
mixin Event!"click";
@style!"button" mixin Node!"button";
@style!"toggle" bool toggle;
@callback void onClick(MouseEvent event) {
this.click.emit;
}
}
mixin Spa!App;
Here you see the AppStyle struct, which contains some nested structs which themselves contains properties known from css. The idea is that Component can apply any of these nested structs.
Both the App and the Button struct have a @styleset!(AppStyle)
annotation.
The App Component has a @style!"root"
applied to its Node mixin. This means it will get a css class set with all the css properties defined in AppStyle.root
.
The Button Component has the AppStyle.button
on its Node mixin, and the AppStyle.toggle
applies to the toggle
bool. Whenever toggle is true, the toggle class is applied and vica versa.
The css is created at compile time and injected on startup into the html page. The class names are converted to hashes based on css name + css properties. This allows use to deduplicate classes with same css content.
- 0.0.7 released 6 years ago
- skoppe/spasm
- MIT
- Copyright © 2018, Sebastiaan Koppe
- Authors:
- Sub packages:
- spasm:bootstrap-webpack
- Dependencies:
- stdx-allocator
- Versions:
-
0.2.0-beta.8 2020-Sep-12 0.2.0-beta.7 2020-Apr-05 0.2.0-beta.6 2020-Mar-08 0.2.0-beta.5 2019-Aug-14 0.2.0-beta.4 2019-Aug-14 - Download Stats:
-
-
0 downloads today
-
0 downloads this week
-
0 downloads this month
-
1081 downloads total
-
- Score:
- 2.3
- Short URL:
- spasm.dub.pm