schemani_formini 0.0.1-alpha.1

  • Readme
  • Changelog
  • Installing
  • new56

schemani_formini #

A bridge validator class for validating formini values using schemas built with schemani. #roadmap

Please note that the schemani/formini packages are under development. There are still some issues to resolve before this has any help for real use cases.

Installation #

schemani and formini packages are required to be installed along with this package.

Usage #

import 'package:formini/formini.dart';
import 'package:schemani/schemani.dart';
import 'package:schemani_formini/schemani_formini.dart';

class LoginForm extends StatelessWidget {
  /// The schema for validating the form values.
  static const schema = MapSchema({
    'email': [Required(), Email()],
    'password': [Required()],
  });
  
  @override
  Widget build(BuildContext context) {
    return Formini(
      validator: const ForminiSchemaniValidator(schema),
      initialValues: const {'email': 'foo'},
      onSubmit: _authenticate,
      child: Column(children: [
        // ...
      ]),
    );
  }
}

Customization #

The ForminiSchemaniValidator class is very simple. Just go and grab it into your project if you need something special.

API reference #

https://pub.dev/documentation/schemani_formini

Contributing #

Please open an issue or pull request in GitHub. Any help and feedback is much appreciated.

Licence #

MIT

Roadmap #

  • Run tests really against formini

[0.0.1-alpha.1] - 2019/09/26

  • First release

Use this package as a library

1. Depend on it

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


dependencies:
  schemani_formini: ^0.0.1-alpha.1

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:schemani_formini/schemani_formini.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
30
Health:
Code health derived from static analysis. [more]
99
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
55
Overall:
Weighted score of the above. [more]
56
Learn more about scoring.

We analyzed this package on Oct 9, 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.

Health issues and suggestions

Document public APIs. (-1 points)

5 out of 5 API elements have no dartdoc comment.Providing good documentation for libraries, classes, functions, and other API elements improves code readability and helps developers find and use your API.

Maintenance suggestions

The package description is too short. (-20 points)

Add more detail to the description field of pubspec.yaml. Use 60 to 180 characters to describe the package, what it does, and its target use case.

Maintain an example. (-10 points)

Create a short demo in the example/ directory to show how to use this package.

Common filename patterns include main.dart, example.dart, and schemani_formini.dart. Packages with multiple examples should provide example/README.md.

For more information see the pub package layout conventions.

Package is pre-v0.1 release. (-10 points)

While nothing is inherently wrong with versions of 0.0.*, it might mean that the author is still experimenting with the general direction of the API.

Package is pre-release. (-5 points)

Pre-release versions should be used with caution; their API can change in breaking ways.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.1.0 <3.0.0
flutter 0.0.0
formini ^0.0.1-alpha 0.0.1-alpha.1
schemani ^0.0.1-alpha 0.0.1-alpha.3
Transitive dependencies
bloc 0.15.0
collection 1.14.11 1.14.12
flutter_bloc 0.21.0
meta 1.1.7
provider 3.1.0
rxdart 0.22.3
sky_engine 0.0.99
typed_data 1.1.6
vector_math 2.0.8
Dev dependencies
flutter_test