パッケージ、リポジトリ、アプリカテゴリを検索

パッケージ詳細v5.2.7

fform

FForm は、多数のフィールドと検証を備えたフォームを作成するためのDartパッケージです。

AndroidiOSWebmacOSWindowsLinux
30日間ダウンロード
137
いいね数
184
Pub ポイント
160

パッケージをインストール

flutter pub add fform

パッケージ概要

公開情報に基づく選定ガイドです。参考としてご利用ください。

FForm は、多数のフィールドと検証ルールを備えた複雑なフォームの作成を簡素化することを目的としたDartパッケージです。構造的で再利用可能なフォーム処理のアプローチを提供し、ボイラープレートコードを減らし、保守性を向上させます。Flutter専用に開発されており、Android、iOS、Web、macOS、Windows、Linuxなど主要プラットフォームをサポートしています。このパッケージは、フォームの状態管理、入力の検証、ユーザー操作への対応を効率的に行うことを可能にします。洗練された構文と直感的なAPIにより、FFormはFlutterアプリにおけるフォーム開発をスムーズにします。

用途

  • 多数の入力フィールドを使用して動的フォームを構築する
  • 複雑な検証ロジックの実装
  • 複数の画面間でフォームの状態を管理する
  • 再利用可能なフォームコンポーネントの作成
  • エラー通知付きでフォーム送信を処理する

主な機能

  • 組み込み検証サポート
  • フォームフィールドの状態管理
  • 再利用可能なフォームウィジェット
  • クロスプラットフォーム互換性
  • 最小限のボイラープレートコード
  • Flutter との簡単な統合

適している対象

  • 大規模なFlutterアプリを開発する開発者
  • 一貫したフォームパターンを必要とするチーム
  • 広範なフォーム検証を必要とするプロジェクト
  • 複数ステップまたはネストされたフォームを持つアプリケーション
  • UXおよびフォームの信頼性に注力するフロントエンド開発者

注意事項

  • 初心者にとっては学習曲線が必要になる場合があります
  • 人気のある代替品と比べてドキュメントが限られている
  • 大量のフォームを使用するプロジェクトに最適
  • 単回の簡単なフォームには適していない
  • 高度な機能には外部の依存関係に依存しています

元の README

関連するソースリポジトリの README 原文のスナップショットです。最新の内容はリポジトリをご覧ください。

Logo Frame

Getting Started with FForm 🌟

Step 1: Installation

First things first, let's get the FForm package into your Flutter project. Add FForm to your pubspec.yaml file under dependencies:

dependencies:
  fform: ^latest_version

Don't forget to run flutter pub get in your terminal to install the package.

Overview

FForm is a high-level Flutter package designed to make form creation and management a breeze, with simplified field validation. It offers two main components: FFormField and FFormBuilder, that together bring ease and flexibility to your form handling in Flutter apps.

🧱 Core (Logic and Form Model)

  • FForm — the base class for forms, managing fields, validation, and state.
  • FFormField<T, E> — a generic form field supporting values, errors, and reactions to changes.
  • FFormException — the base class for exceptions that define validation errors.
  • FFormObserver — a static observer that monitors events across all forms (e.g., for debugging, logging, side-effects).

🧩 Widget (UI Binding Widgets)

  • FFormBuilder — binds the form to the UI, updating the interface on changes.
  • FFormProvider — provides access to the form through BuildContext.

🎯 Mixin (Additional Behavior for Fields)

  • KeyedField — adds a unique key for identifying the field in the tree.
  • AsyncField — supports asynchronous validation of the field.
  • CachedField — stores the previous value for reuse.
  • FocusedField — tracks focus, allowing reactions to focus gain/loss.

Structure

Why It Rocks 🎸

  • State Management Simplified: Automatically handles the state of both individual form fields and the form as a whole.
  • Built-in Validation with a Twist: Supports on-the-fly validation and error handling for each field, ensuring a smooth user experience.
  • Flexibility at Its Finest: Supports any data type for field values and validation errors thanks to generics.
  • Reactive Forms for the Win: Leverages streams for tracking form state changes, ensuring your UI is always in sync.
  • Multiple Forms, No Problem: Create multiple forms with custom fields and validation rules, all managed seamlessly by FForm.
  • Custom Exceptions for Custom Needs: Define custom exceptions for form fields to handle complex validation rules and error messages with ease.
  • AsyncValidator: Supports asynchronous validation for form fields, allowing you to validate data against external sources or APIs.
  • CachedField: Provides cached value for field, used to manage the state of the widget and access it in the widget tree.
  • FFormObserver: Allows you to observe the form state and trigger side effects based on the form's state changes.

Previews

Usage Examples

FFormField

FFormField is a base class for all form fields, supporting values, on-the-fly validation, and change handling. It provides a set of getters and methods to manage the field state, including checking the field's validity, retrieving the current value, and handling exceptions.

Example
enum EmailError {
  empty,
  not;

  @override
  String toString() {
    switch (this) {
      case empty:
        return 'emailEmpty';
      case not:
        return 'invalidFormatEmail';
      default:
        return 'invalidFormatEmail';
    }
  }
}

class EmailField extends FFormField<String, EmailError> {

  EmailField({required String value}) : super(value);

  @override
  EmailError? validator(value) {
    if (value.isEmpty) return EmailError.empty;
    return null;
  }
}
FForm

FForm is a base class for creating custom form classes with specific fields and validation rules. It provides a set of getters and methods to manage the form state, including checking the form's validity, retrieving answers, and handling exceptions.

Example

This is a simple example of how to create a form with a single field. You can extend the FForm class to create custom forms with specific fields and validation rules.

class LoginForm extends FForm {
  EmailField email;
  
  LoginForm({
    required this.email,
  }): super(fields: [email]);
}

This is a more complex example of how to create a form with multiple fields. You can extend the FForm class to create custom forms with specific fields and validation rules.

class Form extends FForm {
  List<Form> forms;

  Form({
    required this.forms,
  }): super(subForms: forms);
}
FFormBuilder

FFormBuilder is a widget that constructs and manages the form state, utilizing streams to refresh the UI dynamically as data changes. It provides a builder function that takes the form and returns a widget tree based on the form's state.

Example

This is an example of how to use FFormBuilder to create a form with a single field. The builder function takes the form as a parameter and returns a widget tree based on the form's state.

void _submit() {
  if(_form.check()) { // .isValid or .isInvalid start rebuild in FFormBuilder and returned boolean
    print('Form Valid');
  };
}

@override
Widget build(BuildContext context) {
  return FFormBuilder<LoginForm>(
    form: _form,
    builder: (context, form, child) {
      EmailField email = form.email; // or FFormProvider.of<LoginForm>(context).get<NameField>()
      
      return Column(
        children: [
          TextField(
            key: email.key,
            controller: _emailController,
            decoration: InputDecoration(
              labelText: 'Email',
              errorText: email.exception.toString(),
            ),
          ),
          ElevatedButton(
            onPressed: _submit,
            child: const Text('Submit'),
          ),
        ],
      );
    },
  );
}

You can use ListenableBuilder to rebuild only the field that has changed, but you can use FFormProvider to rebuild all fields in the form.

void _submit() {
  if(_form.check()) { // .isValid or .isInvalid start rebuild in FFormBuilder and returned boolean
    print('Form Valid');
  };
}

@override
Widget build(BuildContext context) {
  return ListenableBuilder<LoginForm>(
    listenable: _form,
    builder: (context, form, child) {
      EmailField email = form.email; // or FFormProvider.of<LoginForm>(context).get<NameField>()
      
      return Column(
        children: [
          TextField(
            key: email.key,
            controller: _emailController,
            decoration: InputDecoration(
              labelText: 'Email',
              errorText: email.exception.toString(),
            ),
          ),
          ElevatedButton(
            onPressed: _submit,
            child: const Text('Submit'),
          ),
        ],
      );
    },
  );
}

FFormProvider

FFormProvider is a widget that allows you to access the form in the widget tree without passing it as a parameter.

Example
FFormBuilder<LoginForm>(
  form: _form,
  builder: (context, form) {
    
    FFormProvider.of<LoginForm>(context).email; // or form.email;
    FFormProvider.of<LoginForm>(context).get<NameField>(); // or form.get<NameField>();

    return YourForm();
  },
)
FFormException

FFormException is a base class for creating custom exceptions for form fields. It allows you to define custom validation rules and error messages for form fields, enabling you to handle complex validation scenarios with ease.

Example

You can create a custom exception class that extends FFormException to define specific validation rules and error messages for a form field.

class PasswordValidationException extends FFormException {
  final bool isMinLengthValid;
  final bool isSpecialCharValid;
  final bool isNumberValid;

  PasswordValidationException({
    required this.isMinLengthValid,
    required this.isSpecialCharValid,
    required this.isNumberValid,
  });

  @override
  bool get isValid => isMinLengthValid && isSpecialCharValid && isNumberValid;
}

class PasswordField extends FFormField<String, PasswordValidationException> {
  PasswordField(String value) : super(value);

  @override
  PasswordValidationException? validator(String value) {
    final validator = FFormValidator(value);
    return PasswordValidationException(
      isMinLengthValid: validator.isMinLength(8),
      isSpecialCharValid: validator.isHaveSpecialChar,
      isNumberValid: validator.isHaveNumber,
    );
  }
}
FFormObserver

FFormObserver is a widget that allows you to observe the form state and trigger side effects based on the form's state changes. It provides a builder function that takes the form as a parameter and returns a widget tree based on the form's state.

Example
class MyFFormObserver extends FFormObserver {
  @override
  void check(FForm form) {
    if (kDebugMode) {
      print('Form has been checked and is ${form.isValid ? 'valid' : 'invalid'}');
    }
  }
}
FFormField mixins
And you can add KeyedField mixin to get a unique key for identifying the form field widget.
class EmailField extends FFormField<String, EmailError> with KeyedField {

  EmailField({required String value}) : super(value);

  @override
  EmailError? validator(value) {
    if (value.isEmpty) return EmailError.empty;
    return null;
  }
}

// and get GlobalKey -> form.email.key 
And you can use AsyncValidator
class EmailField extends FFormField<String, EmailError> with AsyncField<String, EmailError> {

  EmailField({required String value}) : super(value);

  @override
  EmailError? validator(value) {
    if (value.isEmpty) return EmailError.empty;
    return null;
  }

  @override
  Future<EmailError?> asyncValidator(value) async {
    await Future.delayed(Duration(seconds: 1));
    if (!value.contains('@')) return EmailError.not;
    return null;
  }
}

// final field = EmailField();
// if(await field.check()) {
//     
// }
Cached value for field
class EmailField extends FFormField<String, EmailError> with CachedField<String, EmailError> {

  EmailField({required String value}) : super(value);

  @override
  EmailError? validator(value) {
    if (value.isEmpty) return EmailError.empty;
    return null;
  }

}
Focused Field
class EmailField extends FFormField<String, EmailError> with FocusField<String, EmailError> {

  EmailField({required String value}) : super(value);

  @override
  EmailError? validator(value) {
    if (value.isEmpty) return EmailError.empty;
    return null;
  }

}

// final field = EmailField();
// if(field.check()) {
//   ....
// } else {
//    field.focus.requestFocus();
// }
FFormStatus

FFormStatus is an enum that represents the various states of a form (FForm) during its lifecycle. It helps track the form's status, such as whether it's idle, processing, successfully validated, or has encountered errors.

Enum Values
  • initial: The default state of the form before any action is taken.
  • loading: Indicates that the form is currently processing, such as during validation or submission.
  • success: Indicates that the form has successfully completed its operation with no validation errors.
  • exception: Indicates that the form has encountered errors, such as validation failures.
Example
switch(_form.status) {
   FFormStatus.initial => print('initial'),
   FFormStatus.loading => print('loading'),
   FFormStatus.success => print('success'),
   FFormStatus.exception => print('exception'),
};

Examples

Codecov

Codecov

カテゴリー

依存関係

依存関係一覧 2 件

ソースリポジトリ

このパッケージを使用しているプロジェクト

データはまだありません。