fountainview 1.0.5

  • Readme
  • Changelog
  • Example
  • Installing
  • 48

Flutter Fountain View #

FountainView is a Flutter plugin used for displaying Fountain screenplay documents. It takes a single string and displays the formatted document in a widget.

This Flutter Plugin is created using the Xamarin library FountainSharp written in F#.

This is possible with the use of Embeddinator-4000 which allows the creation of native libraries from Xamarin .NET libraries. The native Android (.aar) and iOS (Framework) is then embedded in a Flutter Plugin that can then be reused in any Flutter application.

For example, the Big Fish sample fountain doc looks like this when rendered. image info

Usage #

Usage is very straight forward, simply construct a new FountainView widget and provide it with a string containing valid Fountain Markup text.

new FountainView(fountainText)

The text will be parsed and converted to HTML and displayed as using the flutter_html plugin.

Note I plan to switch to the recently released official webview_flutter once it is stable.

Known Issues #

If you get the following error on Android

 No assemblies found in '(null)' or '<unavailable>'. Assuming this is part of Fast Deployment.

Open the build.gradle file under android/app/ and add the follow config inside android {}

aaptOptions {
    noCompress 'dll'
}

Acknowledgments #

This plugin is made using FountainSharp with thanks to Bryan Costanich.

FountainSharp is an F# based Fountain Markdown processor for use via .NET/Xamarin projects.

1.0.1 #

  • First stable release

0.0.1 #

  • Initial published draft

example/README.md

fountainview example #

import 'package:flutter/material.dart';
import 'package:fountainview/fountainview.dart';

void main()
{
runApp(MaterialApp(
    title: "FountainView Example",
    home: MyApp()
));
}

class MyApp extends StatelessWidget {
@override
Widget build(BuildContext context) {
    return Scaffold(
        appBar: AppBar(
        title: const Text('FountainView example app'),
        ),
        body: new FountainView("Title: Big Fish\nCredit: written by\nAuthor: John August\nSource: based on the novel by Daniel Wallace"),
    );
}
}

Use this package as a library

1. Depend on it

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


dependencies:
  fountainview: ^1.0.5

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter pub get

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

3. Import it

Now in your Dart code, you can use:


import 'package:fountainview/fountainview.dart';
  
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]
90
Overall:
Weighted score of the above. [more]
48
Learn more about scoring.

We analyzed this package on Oct 11, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.5.1
  • pana: 0.12.21
  • Flutter: 1.9.1+hotfix.4

Platforms

Detected platforms: Flutter

References Flutter, and has no conflicting libraries.

Maintenance issues and suggestions

Support latest dependencies. (-10 points)

The version constraint in pubspec.yaml does not support the latest published versions for 1 dependency (flutter_html).

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.1.0 <3.0.0
flutter 0.0.0
flutter_html ^0.9.4 0.9.9 0.11.0
Transitive dependencies
charcode 1.1.2
collection 1.14.11 1.14.12
csslib 0.16.1
html 0.14.0+3
meta 1.1.7
path 1.6.4
sky_engine 0.0.99
source_span 1.5.5
term_glyph 1.1.0
typed_data 1.1.6
vector_math 2.0.8