mariposa 1.0.1

  • README.md
  • CHANGELOG.md
  • Example
  • Installing
  • Versions
  • 46

mariposa

Stupid-simple, low-level Web application library built with Incremental DOM and html_builder. Somewhat comparable to React.

Mariposa offers no state management; this is by design. Handling state should be handled via dart:async, Redux, or some other mechanism. Calling for a re-render is not memory-intensive, thanks to Incremental DOM.

Thanks to libraries like zen and html_builder/elements.dart, it is possible to cleanly build HTML AST's with a Dart DSL that looks exactly like an HTML AST.

Usage

The most simple example:

import 'dart:html' hide Node;
import 'package:html_builder/elements.dart';
import 'package:html_builder/html_builder.dart';
import 'package:mariposa/dom.dart' as mariposa_dom;

Node greeting({String message}) => b(c: [text(message)]);

void main() {
  mariposa_dom.render(
    () => greeting(message: 'Hello!'),
    querySelector('#app'),
  );
}

This is a super-small example of an application without state. See web/main.dart for an example of an application with state. Complex applications should consider dart:async, Redux, Flux, or some similar state management architecture to create manageable applications.

Widgets

Note: Not the same as Flutter widgets.

In real-world applications, oftentimes one will need to interact with the state of the DOM, or whatever tree is being rendered.

For this, create a Widget. Not only can widgets be rendered like normal nodes, but upon rendering, their afterRender method is called. Right before destruction, beforeDestroy is invoked.

Both methods are passed an AbstractElement, which prevents a platform-agnostic way to handle events, perform query selectors, and other things. Abstract elements always provide a handle to the nativeElement.

This makes it possible to manage the state of a specific node in the tree, among other things.

import 'dart:io';
import 'package:html_builder/html_builder.dart';
import 'package:html_builder/elements.dart';
import 'package:mariposa/dom.dart' as mariposa;

Passing down state and context

Passing state down a stateless tree can become ugly very quickly. However, Mariposa provides a class called ContextAwareWidget, which can interact with a RenderContext, a scoped state handled internally by Mariposa.

The Context class has provisions for dependency injection, so you don't need any hacks to have fully independent, context-aware widgets:

class MyWidget extends ContextAwareWidget {
  @override
  Node contextAwareRender(RenderContext ctx) {
    // Return something...
  }
}

Server-side Rendering

It's easy; in fact, server-side rendering is Mariposa's bread-and-butter. DOM support was added long after string rendering:

import 'dart:io';
import 'package:html_builder/html_builder.dart';
import 'package:html_builder/elements.dart';
import 'package:mariposa/string.dart' as mariposa;

main() async {
  var server = await HttpServer.bind(InternetAddress.loopbackIPv4, 3000);
  print('Listening at http://${server.address.address}:${server.port}');

  await for (var request in server) {
    var html = mariposa.render(myApp());
    request.response
      ..headers.contentType = ContentType.HTML
      ..write(html)
      ..close();
  }
}

Node myApp() {
  return html(c: [
    head(c: [
      meta(
        name: 'viewport',
        content: 'width=device-width, initial-scale=1',
      ),
      title(c: [
        text('Hello, Mariposa!'),
      ]),
    ]),
    body(c: [
      h1(c: [
        text('Hello, Mariposa!'),
      ]),
      i(c: [
        text('Server-side rendering is easy!'),
      ]),
    ]),
  ]);
}

1.0.1

  • Add RenderContext and ContextAwareWidget.

1.0.0+1

  • Dart 2 fixes

example/main.dart

import 'dart:html' hide Node;
import 'package:html_builder/elements.dart';
import 'package:html_builder/html_builder.dart';
import 'package:mariposa/dom.dart' as mariposa_dom;

Node greeting({String message}) => b(c: [text(message)]);

void main() {
  mariposa_dom.render(
    () => greeting(message: 'Hello!'),
    querySelector('#app'),
  );
}

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  mariposa: ^1.0.1

2. Install it

You can install packages from the command line:

with pub:


$ pub get

with Flutter:


$ flutter packages get

Alternatively, your editor might support pub get or flutter packages get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:mariposa/mariposa.dart';
  
Version Uploaded Documentation Archive
1.0.1 Jun 25, 2018 Go to the documentation of mariposa 1.0.1 Download mariposa 1.0.1 archive
1.0.0+1 Jun 23, 2018 Go to the documentation of mariposa 1.0.0+1 Download mariposa 1.0.0+1 archive
1.0.0 Jun 2, 2018 Go to the documentation of mariposa 1.0.0 Download mariposa 1.0.0 archive
1.1.0-alpha.3 Aug 30, 2018 Go to the documentation of mariposa 1.1.0-alpha.3 Download mariposa 1.1.0-alpha.3 archive
1.1.0-alpha.2 Aug 30, 2018 Go to the documentation of mariposa 1.1.0-alpha.2 Download mariposa 1.1.0-alpha.2 archive
1.1.0-alpha.1 Aug 30, 2018 Go to the documentation of mariposa 1.1.0-alpha.1 Download mariposa 1.1.0-alpha.1 archive
1.1.0-alpha Aug 30, 2018 Go to the documentation of mariposa 1.1.0-alpha Download mariposa 1.1.0-alpha archive
Popularity:
Describes how popular the package is relative to other packages. [more]
0
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
80
Overall:
Weighted score of the above. [more]
46
Learn more about scoring.

We analyzed this package on Dec 5, 2018, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.1.0
  • pana: 0.12.7

Platforms

Detected platforms: Flutter, web, other

No platform restriction found in primary library package:mariposa/mariposa.dart.

Health suggestions

Format lib/src/mariposa_string.dart.

Run dartfmt to format lib/src/mariposa_string.dart.

Maintenance suggestions

The description is too short. (-20 points)

Add more detail about the package, what it does and what is its target use case. Try to write at least 60 characters.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0-dev <3.0.0
html_builder ^1.0.0 1.0.5
js ^0.6.1 0.6.1+1
zen ^1.0.0 1.0.0
Transitive dependencies
args 1.5.1
charcode 1.1.2
collection 1.14.11
csslib 0.14.6
logging 0.11.3+2
path 1.6.2
source_span 1.4.1
Dev dependencies
build_runner >=0.8.0 <=0.9.0
build_web_compilers ^0.4.0