Pakete, Repositories und App-Kategorien suchen

Paketdetailsv0.8.1

formz

Eine einheitliche Formularrepräsentation in Dart, die darauf abzielt, die Darstellung und Validierung von Formularen auf generische Weise zu vereinfachen.

AndroidiOSWebmacOSWindowsLinux
30-Tage-Downloads
242.000
Likes
919
Pub-Punkte
160

Paket installieren

flutter pub add formz

Paketübersicht

Aus öffentlichen Paketdaten erstellte Orientierung.

Formz ist ein Dart-Paket, das einen einheitlichen und generischen Ansatz für die Darstellung und Validierung von Formularen bietet. Es vereinfacht die Verwaltung von Formularzuständen durch eine konsistente Struktur zur Handhabung von Eingaben, Validierungsregeln und Fehlermeldungen. Mit Fokus auf Einfachheit und Wiederverwendbarkeit ermöglicht Formz Entwicklern die Erstellung von Formularen mit minimalem Boilerplate-Code, während gleichzeitig Typsicherheit und Skalierbarkeit über Plattformen hinweg gewährleistet sind. Es integriert sich nahtlos in Flutter-Anwendungen und unterstützt alle wichtigen Plattformen wie Android, iOS, Web, macOS, Windows und Linux.

Anwendungsfälle

  • Wiederverwendbare Formularkomponenten erstellen
  • Komplexe Formularvalidierungslogik verwalten
  • Konsistente Formularzustandsverwaltung erstellen
  • Vereinfachung von Formularübermittlungsworkflows
  • Integration mit State-Management-Lösungen
  • Unterstützung internationalisierter Fehlermeldungen

Hauptmerkmale

  • Generische Darstellung des Formularzustands
  • Integrierte Validierungssupport
  • Erweiterbare Überprüfungsregeln
  • typsichere Formularfelder
  • Minimales Boilerplate
  • Plattformübergreifende Kompatibilität

Geeignet für

  • Flutter-Entwickler, die saubere Formularmuster suchen
  • Projekte, die eine robuste Formularvalidierung erfordern
  • Teams, die wiederverwendbare Formularelogik wollen
  • Anwendungen für mehrere Plattformen
  • Entwickler, die funktionalen oder reaktiven Zustandsmanagement verwenden

Hinweise

  • Kenntnisse über Dart-Generika erforderlich
  • Kann zusätzliche Einrichtung für benutzerdefinierte Validatoren erfordern
  • Am besten kombiniert mit Statusverwaltung wie Bloc oder Provider
  • Keine vollständige UI-Lösung – konzentriert sich auf Formularlogik
  • Eingeschränkte integrierte Benutzeroberflächenkomponenten

Original-README

Originaler README-Schnappschuss aus dem verknüpften Quell-Repository. Aktuelle Inhalte finden Sie im Repository.

📝 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;
  }
}

Kategorien

Abhängigkeiten

Abhängigkeiten 1 Einträge

Quell-Repository

Projekte, die dieses Paket verwenden

Ranglisten