패키지, 저장소 및 앱 카테고리 검색

패키지 상세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 개

소스 저장소

이 패키지를 사용하는 프로젝트

순위