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

パッケージ詳細v0.8.1

formz

Dartにおける一貫したフォーム表現で、汎用的な方法でフォームの表現と検証を簡素化することを目指しています。

AndroidiOSWebmacOSWindowsLinux
30日間ダウンロード
24.2万
いいね数
919
Pub ポイント
160

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

flutter pub add formz

パッケージ概要

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

Formz は、フォームの表現と検証に一貫した汎用的なアプローチを提供する Dart パッケージです。入力、検証ルール、エラーメッセージの処理に一貫した構造を提供することで、フォーム状態の管理を簡素化します。シンプルさと再利用性を意識して設計されており、最小限のボイラープレートコードでフォームを作成しつつ、タイプセーフティとプラットフォーム間でのスケーラビリティを維持できます。Flutter アプリケーションにシームレスに統合され、Android、iOS、Web、macOS、Windows、Linux といった主要プラットフォームすべてをサポートしています。

用途

  • 再利用可能なフォームコンポーネントの構築
  • 複雑なフォーム検証ロジックの管理
  • 一貫したフォーム状態の処理の作成
  • フォーム送信ワークフローの簡素化
  • ステート管理ソリューションとの統合
  • 国際化エラーメッセージのサポート

主な機能

  • 汎用フォーム状態の表現
  • 組み込み検証サポート
  • 拡張可能な検証ルール
  • 型安全なフォームフィールド
  • 最小限のボイラープレート
  • クロスプラットフォーム互換性

適している対象

  • クリーンなフォームパターンを探しているFlutter開発者
  • 堅牢なフォーム検証を必要とするプロジェクト
  • 再利用可能なフォームロジックを希望するチーム
  • 複数のプラットフォームをターゲットにするアプリ
  • 関数型またはリアクティブな状態管理を使用する開発者

注意事項

  • Dartのジェネリクスの理解が必要です
  • カスタムバリデーター用に追加のセットアップが必要になる場合があります
  • Bloc や Provider などの状態管理と最適に組み合わせる
  • 完全なUIソリューションではない—フォームロジックに焦点を当てる
  • 限定された組み込みUIコンポーネント

元の README

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

📝 Formz

Very Good Ventures Very Good Ventures

Developed with 💙 by Very Good Ventures 🦄

ci coverage pub package License: MIT style: very good analysis


A unified form representation in Dart. Formz aims to simplify form representation and validation in a generic way.

Create a FormzInput

import 'package:formz/formz.dart';

// Define input validation errors
enum NameInputError { empty }

// Extend FormzInput and provide the input type and error type.
class NameInput extends FormzInput<String, NameInputError> {
  // Call super.pure to represent an unmodified form input.
  const NameInput.pure() : super.pure('');

  // Call super.dirty to represent a modified form input.
  const NameInput.dirty({String value = ''}) : super.dirty(value);

  // Override validator to handle validating a given input value.
  @override
  NameInputError? validator(String value) {
    return value.isEmpty ? NameInputError.empty : null;
  }
}

Interact with a FormzInput

const name = NameInput.pure();
print(name.value); // ''
print(name.isValid); // false
print(name.error); // NameInputError.empty
print(name.displayError); // null

const joe = NameInput.dirty(value: 'joe');
print(joe.value); // 'joe'
print(joe.isValid); // true
print(joe.error); // null
print(name.displayError); // null

Validate Multiple FormzInput Items

const validInputs = <FormzInput>[
  NameInput.dirty(value: 'jan'),
  NameInput.dirty(value: 'jen'),
  NameInput.dirty(value: 'joe'),
];

print(Formz.validate(validInputs)); // true

const invalidInputs = <FormzInput>[
  NameInput.dirty(),
  NameInput.dirty(),
  NameInput.dirty(),
];

print(Formz.validate(invalidInputs)); // false

Automatic Validation

class LoginForm with FormzMixin {
  LoginForm({
    this.username = const Username.pure(),
    this.password = const Password.pure(),
  });

  final Username username;
  final Password password;

  @override
  List<FormzInput> get inputs => [username, password];
}

void main() {
  print(LoginForm().isValid); // false
}

Caching validation results

For cases where the validator method has an expensive implementation, consider using the FormzInputErrorCacheMixin mixin to cache the error result and improve performance.

import 'package:formz/formz.dart';

enum EmailValidationError { invalid }

class Email extends FormzInput<String, EmailValidationError>
    with FormzInputErrorCacheMixin {
  Email.pure([super.value = '']) : super.pure();

  Email.dirty([super.value = '']) : super.dirty();

  static final _emailRegExp = RegExp(
    r'^[a-zA-Z\d.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z\d-]+(?:\.[a-zA-Z\d-]+)*$',
  );

  @override
  EmailValidationError? validator(String value) {
    return _emailRegExp.hasMatch(value) ? null : EmailValidationError.invalid;
  }
}

カテゴリー

依存関係

依存関係一覧 1 件

ソースリポジトリ

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

ランキング