bdaya_form

A mason brick to generate a form using reactive_forms_annotations + reactive_forms_generator

Generated by [mason][1] 🧱

Note that we use bdaya_flutter_common as a base library for the generated code We also need build_runner as a dev dependency.

Usage

1. Activate mason_cli
   • dart pub global activate mason_cli
2. Add Brick

   mason add bdaya_form
   

3. mason get
4. Make

   mason make bdaya_form -o lib/src/dialogs --name EditUser
   

   Note that bdaya_form requires some dependencies, which you can add using this command:

   dart pub add reactive_forms_annotations --dev reactive_forms_generator

Variables

• name: The form name

Generated code:

assuming input is EditUser

view.dart

import 'package:bdaya_flutter_common/bdaya_flutter_common.dart';
import 'controller.dart';
import 'package:flutter/material.dart';
import 'form.dart';

class EditUserView extends StatelessWidget {
  const EditUserView({
    super.key,
    required this.controller,
  });

  static Widget hooked({
    BdayaGetItHookMode hookMode = BdayaGetItHookMode.factory,
    String? instanceName,
    Object? param1,
    Object? param2,
    List<Object?>? keys,
  }) => HookBuilder(
      builder: (context) => EditUserView(
        controller: useBdayaViewController(
          hookMode: hookMode,
          instanceName: instanceName,
          keys: keys,
          param1: param1,
          param2: param2,
        ),
      ),
    );
  

  //TODO: Replace T with the expected modal result
  static Future<T?> showModal<T>(
    BuildContext context, {
    EditUserFormParameters? params,
  }) async {
    return await showDialog<T>(
      context: context,
      builder: (context) => Dialog(
        //TODO: assign dialog properties
        child: hooked(
          param1: params,
        ),
      ),
    );
  }
  
  final EditUserController controller;

  @override
  Widget build(BuildContext context) {    
    //see also BdayaMultiLoadableAreaWrapper, and BdayaLoadableAreaWrapper.custom
    return EditUserModelFormBuilder(
      model: controller.initialModelRx.of(context),
      initState: (context, formModel) => controller.formRx.$ = formModel,      
      builder: (context, form, _) {        
        return Column(
          children: [
            //Add form controls ...
          ],
        );
      },
    );
  }
}

controller.dart

import 'package:bdaya_flutter_common/bdaya_flutter_common.dart';
import 'package:flutter/widgets.dart';
import 'form.dart';

class EditUserFormParameters {

}

@injectable
class EditUserController extends BdayaCombinedController {    
  final EditUserFormParameters parameters;

  EditUserController(@factoryParam this.parameters);
  
  final initialModelRx = SharedValue<EditUserModel?>(value: null);
  final formRx = SharedValue<EditUserModelForm?>(value: null);
  

  @override
  void beforeRender(BuildContext context) {
    super.beforeRender(context);
    //initialize initialModelRx from the passed parameters here
    //initialModelRx.$ = ... 
  }
}

form.dart

import 'package:reactive_forms/reactive_forms.dart';
import 'package:reactive_forms_annotations/reactive_forms_annotations.dart';

part 'form.gform.dart';

@ReactiveFormAnnotation()
class EditUserModel {

  const EditUserModel({
    @FormControlAnnotation() this.name,
  });  

  final String? name;
}

Setup 🧑‍💻

Ensure you have the mason_cli installed.

# 🎯 Activate from https://pub.dev
dart pub global activate mason_cli

# 🍺 Or install from https://brew.sh
brew tap felangel/mason
brew install mason

Installation ☁️

# Install locally
mason add bdaya_form

# Install globally
mason add -g bdaya_form

Usage 🚀

mason make bdaya_form

Variables ✨

Hooks 🪝

• ❌   Pre-Gen
• ❌   Post-Gen

Environment 🌎

mason: ">=0.1.0-dev.49 <0.1.0"

0.2.0+1

• Mark parameters as required

0.1.0+1

• Initial release

MIT License

Copyright (c) 2023 Bdaya Development

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.