Compare commits

..

No commits in common. "master" and "6.2.2" have entirely different histories.

38 changed files with 735 additions and 1336 deletions

View file

@ -1,14 +0,0 @@
name: Iconica Standard Component CI Workflow
# Workflow Caller version: 2.0.0
on:
pull_request:
workflow_dispatch:
jobs:
call-global-iconica-workflow:
uses: Iconica-Development/.github/.github/workflows/component-ci.yml@master
secrets: inherit
permissions: write-all
with:
subfolder: "." # add optional subfolder to run workflow in

View file

@ -1,14 +0,0 @@
name: Iconica Standard Component Documentation Workflow
# Workflow Caller version: 1.0.0
on:
release:
types: [published]
workflow_dispatch:
jobs:
call-iconica-component-documentation-workflow:
uses: Iconica-Development/.github/.github/workflows/component-documentation.yml@master
secrets: inherit
permissions: write-all

32
.github/workflows/flutter.yml vendored Normal file
View file

@ -0,0 +1,32 @@
name: CI
on:
push:
branches: [master]
pull_request:
branches:
- master
- feature/*
- bugfix/*
- hotfix/*
jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/cache@v3
with:
path: |
~/.gradle/wrapper
/opt/hostedtoolcache/flutter
key: ${{ runner.OS }}-flutter-install-cache
- uses: subosito/flutter-action@v2
with:
channel: "stable"
- name: Flutter pub get
run: flutter pub get
- name: Dart format
run: dart format -o none --set-exit-if-changed .
- name: Flutter analyze
run: flutter analyze

View file

@ -1,14 +0,0 @@
name: Iconica Standard Component Release Workflow
# Workflow Caller version: 1.0.0
on:
release:
types: [published]
workflow_dispatch:
jobs:
call-global-iconica-workflow:
uses: Iconica-Development/.github/.github/workflows/component-release.yml@master
secrets: inherit
permissions: write-all

7
.gitignore vendored
View file

@ -19,7 +19,7 @@ migrate_working_dir/
# The .vscode folder contains launch configuration and tasks you configure in
# VS Code which you may wish to be included in version control, so this line
# is commented out by default.
.vscode/
#.vscode/
# Flutter/Dart/Pub related
# Libraries should not include pubspec.lock, per https://dart.dev/guides/libraries/private-files#pubspeclock.
@ -28,8 +28,3 @@ migrate_working_dir/
.dart_tool/
.packages
build/
.metadata
# FVM Version Cache
.fvm/
.fvmrc

10
.metadata Normal file
View file

@ -0,0 +1,10 @@
# This file tracks properties of this Flutter project.
# Used by Flutter tool to assess capabilities and perform upgrades etc.
#
# This file should be version controlled and should not be manually edited.
version:
revision: 4f9d92fbbdf072a70a70d2179a9f87392b94104c
channel: stable
project_type: package

View file

@ -1,129 +1,117 @@
## 6.6.0 - September 5th 2024
- Added `onBack` callback to the `FlutterFormOptions` to detect when the back button is pressed
## 0.0.2 - October 10th 2022
## 6.5.0 - July 1st 2024
- Added `FlutterFormMultipleChoice` for multiple choice selection
- Initial release
## 6.4.0 - June 28th 2024
- Added `FlutterFormInputDropdown` for dropdown selection
- Added style property to `FlutterFormInputEmail`
## 0.1.0 - October 12th 2022
## 6.3.2 - May 15th 2024
- Loosened the dependency on intl to be more compatible with several Flutter versions
- Added a multi line plain text input widget
- Ability to set the scrolldirection of the pageview
- Ability to set the scrollphysics of the pages' scrollview.
## 6.3.1 - February 29th 2024
- Removed `TranslationService` and add `validationMessage` property to fields with validation.
- Added a way to override a input field validator.
- Exposed all properties for `FlutterFormInputDateTime` provided by `flutter_input_library`.
## 0.2.0 - October 13th 2022
## 6.3.0 - February 21st 2024
- Updated the `flutter_input_library` from 3.1.0 to 3.2.1
- Added `FlutterFormInputPhone` for phone number with dial code selection.
- Added `InputDecoration` parameter to the following input fields: `FlutterFormInputEmail` and `FlutterFormInputPassword`
- Added date input widget
## 6.2.5 - February 15th 2024
- Updated the `flutter_input_library` from 3.0.1 to 3.1.0
## 1.0.0 - October 13th 2022
## 6.2.4 - February 9th 2024
- Updated the `flutter_input_library` from 3.0.0 to 3.0.1
- Fix: Proper use of generics
- Inputcontrollers now have an onChange.
- Added switch input field
## 6.2.3 - February 7th 2024
- Added CI and linter
## 1.0.1 - October 13th 2022
## 6.2.2 - February 6th 2024
- Updated the `flutter_input_library` from 2.6.0 to 3.0.0
- Added forgotten onChanged parameter on date input field
## 6.2.1 - January 12th 2024
- Pass on the `initialValue` property to FlutterFormMultiLine
## 1.0.2 - October 13th 2022
## 6.2.0 - December 14th 2023
- Pass on the `textCapitalization` property to FlutterFormPlainText and FlutterFormMultiLine
- Added forgotten icon parameter on date input field and scrollpadding on text inputfield
## 2.0.0 - October 26th 2022
- Added the id of the input field on the input check widget.
- Ability to set the height of the carousel input field.
- InputController now contains the onSubmit callback.
## 2.0.1 - October 27th 2022
- onChange of switch input not firing fixed
## 4.0.2 - November 29th 2022
- Name change to flutter_form_wizard
## 4.0.3 - November 29th 2022
- Change from input to `flutter_input_library`
## 5.0.0 - November 29th 2022
- `flutter_input_library` now enforces 24h time requirements
## 5.0.4 - January 12th 2023
- Add FocusNode option to inputs
## 5.0.5 - January 12th 2023
- Expose translations
## 5.0.6 - January 12th 2023
- `flutter_input_library` datetime validator fix
## 5.0.7 - January 12th 2023
- `flutter_input_library` add styling text datetime fix
## 5.0.8 - January 18th 2023
- `flutter_input_library` add focusNode option to `FlutterFormInputMultiLine`
## 5.0.9 - January 18th 2023
- `flutter_input_library` add initial time picker parameter
## 6.0.0 - march 28th 2023
- Bump `flutter_input_library` to version 2.0.0
- Remove unnecessary `riverpod` dependency
## 6.1.0 - May 12th 2023
- Make compatible to flutter 3.10
## 6.1.1 - August 10th 2023
- Bump `flutter_input_library` to version 2.2.0
## 6.1.2 - August 11th 2023
- Bump `flutter_input_library` to version 2.2.1
## 6.1.3 - September 26th 2023
- Fix date format for datecontroller
## 6.1.4 - October 26th 2023
- Bump `flutter_input_library` to version 2.3.0
## 6.1.5 - October 26th 2023
- Bump `flutter_input_library` to version 2.4.0
## 6.1.6 - October 26th 2023
- Add enabled property to FlutterFormInputPlainText and FlutterFormInputDateTime
## 6.1.7 - November 1st 2023
- pass on the show icon property to flutter form input date time widget
## 6.1.8 - December 6th 2023
- Pass on the style property to the FlutterFormPlainText input widget
- Bump `flutter_input_library` to version 2.5.0
## 6.1.7 - November 1st 2023
- Pass on the show icon property to flutter form input date time widget
## 6.2.0 - December 14th 2023
- Pass on the `textCapitalization` property to FlutterFormPlainText and FlutterFormMultiLine
## 6.1.6 - October 26th 2023
- Add enabled property to FlutterFormInputPlainText and FlutterFormInputDateTime
## 6.2.1 - January 12th 2024
- Pass on the `initialValue` property to FlutterFormMultiLine
## 6.1.5 - October 26th 2023
- Bump `flutter_input_library` to version 2.4.0
## 6.1.4 - October 26th 2023
- Bump `flutter_input_library` to version 2.3.0
## 6.1.3 - September 26th 2023
- Fix date format for date controller
## 6.1.2 - August 11th 2023
- Bump `flutter_input_library` to version 2.2.1
## 6.1.1 - August 10th 2023
- Bump `flutter_input_library` to version 2.2.0
## 6.1.0 - May 12th 2023
- Make compatible with Flutter 3.10
## 6.0.0 - March 28th 2023
- Bump `flutter_input_library` to version 2.0.0
- Remove unnecessary `riverpod` dependency
## 5.0.9 - January 18th 2023
- `flutter_input_library` add initial time picker parameter
## 5.0.8 - January 18th 2023
- `flutter_input_library` add focusNode option to `FlutterFormInputMultiLine`
## 5.0.7 - January 12th 2023
- `flutter_input_library` add styling text datetime fix
## 5.0.6 - January 12th 2023
- `flutter_input_library` datetime validator fix
## 5.0.5 - January 12th 2023
- Expose translations
## 5.0.4 - January 12th 2023
- Add FocusNode option to inputs
## 5.0.0 - November 29th 2022
- `flutter_input_library` now enforces 24h time requirements
## 4.0.3 - November 29th 2022
- Change from input to `flutter_input_library`
## 4.0.2 - November 29th 2022
- Name change to flutter_form_wizard
## 2.0.1 - October 27th 2022
- onChange of switch input not firing fixed
## 2.0.0 - October 26th 2022
- Added the id of the input field on the input check widget.
- Ability to set the height of the carousel input field.
- InputController now contains the onSubmit callback.
## 1.0.2 - October 13th 2022
- Added forgotten icon parameter on date input field and scroll padding on text input field
## 1.0.1 - October 13th 2022
- Added forgotten onChanged parameter on date input field
## 1.0.0 - October 13th 2022
- Fix: Proper use of generics
- Input controllers now have an onChange.
- Added switch input field
## 0.2.0 - October 13th 2022
- Added date input widget
## 0.1.0 - October 12th 2022
- Added a multi-line plain text input widget
- Ability to set the scroll direction of the page view
- Ability to set the scroll physics of the pages' scroll view.
## 0.0.2 - October 10th 2022
- Initial release
## 6.2.2 - February 6th 2024
- Updated the `flutter_input_library` from 2.6.0 to 3.0.0

View file

@ -1,9 +1,4 @@
include: package:flutter_iconica_analysis/analysis_options.yaml
include: package:flutter_lints/flutter.yaml
# Possible to overwrite the rules from the package
analyzer:
exclude:
linter:
rules:
# Additional information about this file can be found at
# https://dart.dev/guides/language/analysis-options

45
example/.metadata Normal file
View file

@ -0,0 +1,45 @@
# This file tracks properties of this Flutter project.
# Used by Flutter tool to assess capabilities and perform upgrades etc.
#
# This file should be version controlled.
version:
revision: 4f9d92fbbdf072a70a70d2179a9f87392b94104c
channel: stable
project_type: app
# Tracks metadata for the flutter migrate command
migration:
platforms:
- platform: root
create_revision: 4f9d92fbbdf072a70a70d2179a9f87392b94104c
base_revision: 4f9d92fbbdf072a70a70d2179a9f87392b94104c
- platform: android
create_revision: 4f9d92fbbdf072a70a70d2179a9f87392b94104c
base_revision: 4f9d92fbbdf072a70a70d2179a9f87392b94104c
- platform: ios
create_revision: 4f9d92fbbdf072a70a70d2179a9f87392b94104c
base_revision: 4f9d92fbbdf072a70a70d2179a9f87392b94104c
- platform: linux
create_revision: 4f9d92fbbdf072a70a70d2179a9f87392b94104c
base_revision: 4f9d92fbbdf072a70a70d2179a9f87392b94104c
- platform: macos
create_revision: 4f9d92fbbdf072a70a70d2179a9f87392b94104c
base_revision: 4f9d92fbbdf072a70a70d2179a9f87392b94104c
- platform: web
create_revision: 4f9d92fbbdf072a70a70d2179a9f87392b94104c
base_revision: 4f9d92fbbdf072a70a70d2179a9f87392b94104c
- platform: windows
create_revision: 4f9d92fbbdf072a70a70d2179a9f87392b94104c
base_revision: 4f9d92fbbdf072a70a70d2179a9f87392b94104c
# User provided section
# List of Local paths (relative to this file) that should be
# ignored by the migrate tool.
#
# Files that are not part of the templates will be ignored by default.
unmanaged_files:
- 'lib/main.dart'
- 'ios/Runner.xcodeproj/project.pbxproj'

View file

@ -26,6 +26,6 @@ subprojects {
project.evaluationDependsOn(':app')
}
tasks.register("clean", Delete) {
task clean(type: Delete) {
delete rootProject.buildDir
}

View file

@ -35,7 +35,6 @@ class _AgePageState extends State<AgePage> {
minValue: 12,
maxValue: 120,
controller: widget.inputController,
validationMessage: 'Please fill in your age.',
),
],
);

View file

@ -34,10 +34,7 @@ class _CarouselPageState extends State<CarouselPage> {
amountOfPages: 4,
flutterFormWidgets: [
FlutterFormInputCarousel(
controller: widget.inputController,
items: getCars(),
validationMessage: 'Validation error message.',
)
controller: widget.inputController, items: getCars())
],
);
}

View file

@ -46,7 +46,6 @@ class _DatePageState extends State<DatePage> {
),
label: const Text("Custom date label"),
controller: widget.dateController,
validationMessage: 'Please fill in a date.',
),
),
],

View file

@ -40,7 +40,6 @@ class _NamePageState extends State<NamePage> {
child: FlutterFormInputPlainText(
label: const Text("First Name"),
controller: widget.firstNameController,
validationMessage: 'Please fill in your first name.',
),
),
if (widget.showLastName)
@ -49,7 +48,6 @@ class _NamePageState extends State<NamePage> {
child: FlutterFormInputPlainText(
label: const Text("Last Name"),
controller: widget.lastNameController,
validationMessage: 'Please fill in your last name.',
),
),
],

View file

@ -25,14 +25,6 @@ class _FormExampleState extends ConsumerState<FormExample> {
final String checkPageText = "All entered info: ";
final phoneInputController = FlutterFormInputPhoneController(
id: 'phone',
onChanged: (value) {
debugPrint(
'${value?.dialCode ?? 'no dial'} ${value?.number ?? 'no number'}');
},
);
final ageInputController = FlutterFormInputNumberPickerController(
id: "age",
checkPageTitle: (dynamic amount) {
@ -185,14 +177,6 @@ class _FormExampleState extends ConsumerState<FormExample> {
return Container();
},
pages: [
FlutterFormPage(
child: Center(
child: FlutterFormInputPhone(
controller: phoneInputController,
validationMessage: 'Please fill in a valid phone number',
),
),
),
FlutterFormPage(
child: AgePage(
inputController: ageInputController,

View file

@ -45,10 +45,10 @@ packages:
dependency: "direct main"
description:
name: cupertino_icons
sha256: ba631d1c7f7bef6b729a622b7b752645a2d076dba9976925b8f25725a30e1ee6
sha256: e35129dc44c9118cee2a5603506d823bab99c68393879edb440e0090d07586be
url: "https://pub.dev"
source: hosted
version: "1.0.8"
version: "1.0.5"
fake_async:
dependency: transitive
description:
@ -68,24 +68,24 @@ packages:
path: ".."
relative: true
source: path
version: "6.5.0"
version: "6.2.1"
flutter_input_library:
dependency: transitive
description:
path: "."
ref: "3.4.0"
resolved-ref: cdc06bbb7933ba7ac2835e29d2c8fabf69e5f5a6
ref: "3.0.0"
resolved-ref: "7024fb7e404fbeae0331bfe8f7c115283d0951ce"
url: "https://github.com/Iconica-Development/flutter_input_library"
source: git
version: "3.4.0"
version: "3.0.0"
flutter_lints:
dependency: "direct dev"
description:
name: flutter_lints
sha256: a25a15ebbdfc33ab1cd26c63a6ee519df92338a9c10f122adda92938253bef04
sha256: aeb0b80a8b3709709c9cc496cdc027c5b3216796bc0af0ce1007eaf24464fd4c
url: "https://pub.dev"
source: hosted
version: "2.0.3"
version: "2.0.1"
flutter_localizations:
dependency: transitive
description: flutter
@ -95,10 +95,10 @@ packages:
dependency: "direct main"
description:
name: flutter_riverpod
sha256: "0f1974eff5bbe774bf1d870e406fc6f29e3d6f1c46bd9c58e7172ff68a785d7d"
sha256: "371f6e8acb69dbe8aa3e0a50c8a65f8a9352b599134d585cc4923261cb5ae4d6"
url: "https://pub.dev"
source: hosted
version: "2.5.1"
version: "2.1.1"
flutter_test:
dependency: "direct dev"
description: flutter
@ -108,82 +108,58 @@ packages:
dependency: "direct main"
description:
name: intl
sha256: d6f56758b7d3014a48af9701c085700aac781a92a87a62b1333b46d8879661cf
sha256: "3bc132a9dbce73a7e4a21a17d06e1878839ffbf975568bc875c60537824b0c4d"
url: "https://pub.dev"
source: hosted
version: "0.19.0"
leak_tracker:
dependency: transitive
description:
name: leak_tracker
sha256: "3f87a60e8c63aecc975dda1ceedbc8f24de75f09e4856ea27daf8958f2f0ce05"
url: "https://pub.dev"
source: hosted
version: "10.0.5"
leak_tracker_flutter_testing:
dependency: transitive
description:
name: leak_tracker_flutter_testing
sha256: "932549fb305594d82d7183ecd9fa93463e9914e1b67cacc34bc40906594a1806"
url: "https://pub.dev"
source: hosted
version: "3.0.5"
leak_tracker_testing:
dependency: transitive
description:
name: leak_tracker_testing
sha256: "6ba465d5d76e67ddf503e1161d1f4a6bc42306f9d66ca1e8f079a47290fb06d3"
url: "https://pub.dev"
source: hosted
version: "3.0.1"
version: "0.18.1"
lints:
dependency: transitive
description:
name: lints
sha256: "0a217c6c989d21039f1498c3ed9f3ed71b354e69873f13a8dfc3c9fe76f1b452"
sha256: "5cfd6509652ff5e7fe149b6df4859e687fca9048437857cb2e65c8d780f396e3"
url: "https://pub.dev"
source: hosted
version: "2.1.1"
version: "2.0.0"
matcher:
dependency: transitive
description:
name: matcher
sha256: d2323aa2060500f906aa31a895b4030b6da3ebdcc5619d14ce1aada65cd161cb
sha256: "1803e76e6653768d64ed8ff2e1e67bea3ad4b923eb5c56a295c3e634bad5960e"
url: "https://pub.dev"
source: hosted
version: "0.12.16+1"
version: "0.12.16"
material_color_utilities:
dependency: transitive
description:
name: material_color_utilities
sha256: f7142bb1154231d7ea5f96bc7bde4bda2a0945d2806bb11670e30b850d56bdec
sha256: "9528f2f296073ff54cb9fee677df673ace1218163c3bc7628093e7eed5203d41"
url: "https://pub.dev"
source: hosted
version: "0.11.1"
version: "0.5.0"
meta:
dependency: transitive
description:
name: meta
sha256: bdb68674043280c3428e9ec998512fb681678676b3c54e773629ffe74419f8c7
sha256: a6e590c838b18133bb482a2745ad77c5bb7715fb0451209e1a7567d416678b8e
url: "https://pub.dev"
source: hosted
version: "1.15.0"
version: "1.10.0"
path:
dependency: transitive
description:
name: path
sha256: "087ce49c3f0dc39180befefc60fdb4acd8f8620e5682fe2476afd0b3688bb4af"
sha256: "8829d8a55c13fc0e37127c29fedf290c102f4e40ae94ada574091fe0ff96c917"
url: "https://pub.dev"
source: hosted
version: "1.9.0"
version: "1.8.3"
riverpod:
dependency: transitive
description:
name: riverpod
sha256: f21b32ffd26a36555e501b04f4a5dca43ed59e16343f1a30c13632b2351dfa4d
sha256: "899cd0999b2f3b798349d9b5639cfea81d406c011bd914097145ff92e91b29f9"
url: "https://pub.dev"
source: hosted
version: "2.5.1"
version: "2.1.1"
sky_engine:
dependency: transitive
description: flutter
@ -209,10 +185,10 @@ packages:
dependency: transitive
description:
name: state_notifier
sha256: b8677376aa54f2d7c58280d5a007f9e8774f1968d1fb1c096adcb4792fba29bb
sha256: "8fe42610f179b843b12371e40db58c9444f8757f8b69d181c97e50787caed289"
url: "https://pub.dev"
source: hosted
version: "1.0.0"
version: "0.7.2+1"
stream_channel:
dependency: transitive
description:
@ -241,10 +217,10 @@ packages:
dependency: transitive
description:
name: test_api
sha256: "5b8a98dafc4d5c4c9c72d8b31ab2b23fc13422348d2997120294d3bac86b4ddb"
sha256: "5c2f730018264d276c20e4f1503fd1308dfbbae39ec8ee63c5236311ac06954b"
url: "https://pub.dev"
source: hosted
version: "0.7.2"
version: "0.6.1"
vector_math:
dependency: transitive
description:
@ -253,14 +229,14 @@ packages:
url: "https://pub.dev"
source: hosted
version: "2.1.4"
vm_service:
web:
dependency: transitive
description:
name: vm_service
sha256: "5c5f338a667b4c644744b661f309fb8080bb94b18a7e91ef1dbd343bed00ed6d"
name: web
sha256: afe077240a270dcfd2aafe77602b4113645af95d0ad31128cc02bce5ac5d5152
url: "https://pub.dev"
source: hosted
version: "14.2.5"
version: "0.3.0"
sdks:
dart: ">=3.3.0 <4.0.0"
flutter: ">=3.18.0-18.0.pre.54"
dart: ">=3.2.0-194.0.dev <4.0.0"
flutter: ">=3.0.0"

View file

@ -16,7 +16,7 @@ dependencies:
flutter_riverpod: ^2.1.1
flutter_form_wizard:
path: ../
intl: any
intl: ^0.18.0
dev_dependencies:
flutter_test:

View file

@ -2,10 +2,10 @@
//
// SPDX-License-Identifier: BSD-3-Clause
export 'package:flutter_input_library/flutter_input_library.dart'
show FlutterFormDateTimeType;
export 'src/form.dart';
export 'src/widgets/input/abstractions.dart';
export 'src/widgets/input/input_types/input_types.dart';
export 'package:flutter_input_library/flutter_input_library.dart'
show FlutterFormDateTimeType;
export 'utils/translation_service.dart';
export 'utils/form.dart';

View file

@ -3,23 +3,18 @@
// SPDX-License-Identifier: BSD-3-Clause
import 'package:flutter/material.dart';
import 'package:flutter_form_wizard/flutter_form.dart';
import 'package:flutter_form_wizard/src/utils/form_page_controller.dart';
import 'package:flutter_form_wizard/src/utils/formstate.dart' as fs;
import '../flutter_form.dart';
import 'utils/form_page_controller.dart';
import 'utils/formstate.dart' as fs;
/// A wrapper for flutters [Form] that can be controlled by a controller and
/// provides multiple pre-defined input types/fields
/// [FlutterForm] also provides multi page forms and a check page
/// for validation.
/// A wrapper for flutters [Form] that can be controlled by a controller and provides multiple pre-defined input types/fields
/// [FlutterForm] also provides multi page forms and a check page for validation.
///
/// A [FlutterFormController] has to be given to control what happens to values
/// and pages within the FlutterForm.
/// A [FlutterFormController] has to be given to control what happens to values and pages within the FlutterForm.
///
/// [FlutterFormOptions] have to be provided to control the appearance of
/// the form.
/// [FlutterFormOptions] have to be provided to control the appearance of the form.
///
/// WARNING Define your FormInputController above your FlutterForm. Otherwise
/// when rebuild the controller will differ from the registered ones.
/// WARNING Define your FormInputController above your FlutterForm. Otherwise when rebuild the controller will differ from the registered ones.
/// ``` dart
/// FlutterFormInputEmailController emailController =
/// FlutterFormInputEmailController(id: 'email');
@ -185,10 +180,10 @@ import 'package:flutter_form_wizard/src/utils/formstate.dart' as fs;
/// ```
class FlutterForm extends StatefulWidget {
const FlutterForm({
Key? key,
required this.options,
required this.formController,
super.key,
});
}) : super(key: key);
final FlutterFormOptions options;
final FlutterFormController formController;
@ -208,9 +203,9 @@ class _FlutterFormState extends State<FlutterForm> {
_formController.setFlutterFormOptions(widget.options);
var keys = <GlobalKey<FormState>>[];
List<GlobalKey<FormState>> keys = [];
for (var _ in widget.options.pages) {
for (FlutterFormPage _ in widget.options.pages) {
keys.add(GlobalKey<FormState>());
}
@ -220,9 +215,9 @@ class _FlutterFormState extends State<FlutterForm> {
setState(() {});
});
var controllers = <FlutterFormPageController>[];
List<FlutterFormPageController> controllers = [];
for (var i = 0; i < widget.options.pages.length; i++) {
for (int i = 0; i < widget.options.pages.length; i++) {
controllers.add(FlutterFormPageController());
}
@ -230,7 +225,10 @@ class _FlutterFormState extends State<FlutterForm> {
}
@override
Widget build(BuildContext context) => Stack(
Widget build(BuildContext context) {
var _ = getTranslator(context);
return Stack(
children: [
PageView(
scrollDirection: _formController._options.scrollDirection,
@ -280,35 +278,25 @@ class _FlutterFormState extends State<FlutterForm> {
),
],
),
if (widget.options.nextButton != null)
widget.options.nextButton!(
_formController.getCurrentStep(),
_formController.getCheckpages(),
)
else
Align(
widget.options.nextButton != null
? widget.options.nextButton!(_formController.getCurrentStep(),
_formController.getCheckpages())
: Align(
alignment: AlignmentDirectional.bottomCenter,
child: ElevatedButton(
style: ElevatedButton.styleFrom(
backgroundColor: Theme.of(context).primaryColor,
padding: const EdgeInsets.symmetric(
horizontal: 40,
vertical: 15,
),
horizontal: 40, vertical: 15),
textStyle: const TextStyle(
fontSize: 20,
fontWeight: FontWeight.bold,
),
),
fontSize: 20, fontWeight: FontWeight.bold)),
onPressed: () async {
await _formController.autoNextStep();
},
child: Text(
_formController.getCurrentStep() >=
child: Text(_formController.getCurrentStep() >=
widget.options.pages.length - 1
? 'Finish'
: 'Next',
),
? "Finish"
: "Next"),
),
),
if (widget.options.backButton != null)
@ -319,14 +307,15 @@ class _FlutterFormState extends State<FlutterForm> {
),
],
);
}
List<Widget> getResultWidgets() {
var widgets = <Widget>[];
List<Widget> widgets = [];
_formController.getAllResults().forEach(
(pageNumber, pageResults) {
pageResults.forEach((inputId, inputResult) {
var inputController = _formController
FlutterFormInputController? inputController = _formController
.getFormPageControllers()[pageNumber]
.getController(inputId);
@ -338,8 +327,10 @@ class _FlutterFormState extends State<FlutterForm> {
inputController.checkPageTitle != null
? inputController.checkPageTitle!(inputController.value)
: inputController.value.toString(),
inputController.checkPageDescription
?.call(inputController.value),
inputController.checkPageDescription != null
? inputController
.checkPageDescription!(inputController.value)
: null,
() async {
await _formController.jumpToPage(pageNumber);
},
@ -387,7 +378,7 @@ class _FlutterFormState extends State<FlutterForm> {
Text(
inputController.checkPageDescription!(inputResult),
style: const TextStyle(fontSize: 16),
),
)
],
),
),
@ -421,14 +412,15 @@ class FlutterFormController extends ChangeNotifier {
late List<FlutterFormPageController> _formPageControllers;
List<FlutterFormPageController> getFormPageControllers() =>
_formPageControllers;
List<FlutterFormPageController> getFormPageControllers() {
return _formPageControllers;
}
void setFormPageControllers(List<FlutterFormPageController> controllers) {
setFormPageControllers(List<FlutterFormPageController> controllers) {
_formPageControllers = controllers;
}
void voidisableCheckingPages() {
disableCheckingPages() {
_checkingPages = false;
for (var controller in _formPageControllers) {
@ -444,9 +436,7 @@ class FlutterFormController extends ChangeNotifier {
FocusManager.instance.primaryFocus?.unfocus();
_options.onNext(
_currentStep,
_formPageControllers[_currentStep].getAllValues(),
);
_currentStep, _formPageControllers[_currentStep].getAllValues());
if (_currentStep >= _options.pages.length - 1 &&
_options.checkPage == null ||
@ -459,11 +449,9 @@ class FlutterFormController extends ChangeNotifier {
notifyListeners();
await _pageController.animateToPage(
_currentStep,
await _pageController.animateToPage(_currentStep,
duration: const Duration(milliseconds: 250),
curve: Curves.ease,
);
curve: Curves.ease);
} else {
_currentStep += 1;
@ -474,11 +462,9 @@ class FlutterFormController extends ChangeNotifier {
notifyListeners();
await _pageController.animateToPage(
_currentStep,
await _pageController.animateToPage(_currentStep,
duration: const Duration(milliseconds: 250),
curve: Curves.ease,
);
curve: Curves.ease);
}
}
}
@ -487,7 +473,7 @@ class FlutterFormController extends ChangeNotifier {
Future<void> previousStep() async {
_currentStep -= 1;
_options.onBack?.call(_currentStep);
_checkingPages = false;
notifyListeners();
@ -521,14 +507,13 @@ class FlutterFormController extends ChangeNotifier {
return false;
}
Map<String, dynamic> getCurrentStepResults() =>
_formPageControllers[_currentStep].getAllValues();
Map<String, dynamic> getCurrentStepResults() {
return _formPageControllers[_currentStep].getAllValues();
}
Future<void> nextStep() async {
_options.onNext(
_currentStep,
_formPageControllers[_currentStep].getAllValues(),
);
_currentStep, _formPageControllers[_currentStep].getAllValues());
_currentStep += 1;
@ -538,19 +523,16 @@ class FlutterFormController extends ChangeNotifier {
notifyListeners();
await _pageController.animateToPage(
_currentStep,
duration: const Duration(milliseconds: 250),
curve: Curves.ease,
);
await _pageController.animateToPage(_currentStep,
duration: const Duration(milliseconds: 250), curve: Curves.ease);
}
void finishForm() {
finishForm() {
_options.onFinished(getAllResults());
}
Map<int, Map<String, dynamic>> getAllResults() {
var allValues = <int, Map<String, dynamic>>{};
Map<int, Map<String, dynamic>> allValues = {};
for (var i = 0; i < _options.pages.length; i++) {
allValues.addAll({i: _formPageControllers[i].getAllValues()});
@ -558,19 +540,27 @@ class FlutterFormController extends ChangeNotifier {
return allValues;
}
void setFlutterFormOptions(FlutterFormOptions options) {
setFlutterFormOptions(FlutterFormOptions options) {
_options = options;
}
void setKeys(List<GlobalKey<FormState>> keys) {
setKeys(List<GlobalKey<FormState>> keys) {
_keys = keys;
}
List<GlobalKey<FormState>> getKeys() => _keys;
int getCurrentStep() => _currentStep;
bool getCheckpages() => _checkingPages;
PageController getPageController() => _pageController;
List<GlobalKey<FormState>> getKeys() {
return _keys;
}
int getCurrentStep() {
return _currentStep;
}
bool getCheckpages() {
return _checkingPages;
}
PageController getPageController() {
return _pageController;
}
}

View file

@ -4,26 +4,21 @@
import 'package:flutter_form_wizard/flutter_form.dart';
/// Controller class for managing input controllers in a Flutter form.
class FlutterFormPageController {
/// List of input controllers.
List<FlutterFormInputController> _controllers = [];
/// Registers an input controller.
void register(FlutterFormInputController inputController) {
_controllers.add(inputController);
}
/// Clears all registered input controllers.
void clearControllers() {
clearControllers() {
_controllers = [];
}
/// Checks if an input controller is registered with a given ID.
bool _isRegisteredById(String id) =>
_controllers.any((element) => element.id == id);
bool _isRegisteredById(String id) {
return _controllers.any((element) => (element.id == id));
}
/// Retrieves the input controller associated with the provided ID.
FlutterFormInputController? getController(String key) {
if (_isRegisteredById(key)) {
return _controllers.firstWhere((element) => element.id == key);
@ -31,11 +26,10 @@ class FlutterFormPageController {
return null;
}
/// Retrieves all values from registered input controllers.
Map<String, dynamic> getAllValues() {
var values = <String, dynamic>{};
Map<String, dynamic> values = {};
for (var controller in _controllers) {
for (FlutterFormInputController controller in _controllers) {
if (controller.value != null) {
values.addAll({controller.id!: controller.value});
}

View file

@ -3,23 +3,20 @@
// SPDX-License-Identifier: BSD-3-Clause
import 'package:flutter/material.dart';
import 'package:flutter_form_wizard/src/utils/form_page_controller.dart';
import 'form_page_controller.dart';
/// Widget for managing form state and providing access to form controller.
class FormState extends InheritedWidget {
/// Constructor for FormState.
const FormState({
required super.child,
Key? key,
required Widget child,
required this.formController,
super.key,
});
}) : super(key: key, child: child);
/// The form controller associated with this FormState.
final FlutterFormPageController formController;
/// Retrieves the nearest ancestor FormState from the given context.
static FormState of(BuildContext context) {
var result = context.dependOnInheritedWidgetOfExactType<FormState>();
final FormState? result =
context.dependOnInheritedWidgetOfExactType<FormState>();
assert(result != null, 'No FormStat found in context');
return result!;
}

View file

@ -3,7 +3,7 @@
// SPDX-License-Identifier: BSD-3-Clause
import 'package:flutter/material.dart';
import 'package:flutter_form_wizard/src/utils/formstate.dart' as fs;
import '/src/utils/formstate.dart' as fs;
/// Abstract class for the input widgets used in a [FlutterForm].
///
@ -12,19 +12,18 @@ import 'package:flutter_form_wizard/src/utils/formstate.dart' as fs;
///
/// label is a standard parameter to normally sets the label of the input.
///
/// [registerController] should be called to register the given [controller] to
/// the form page.
/// [registerController] should be called to register the given [controller] to the form page.
abstract class FlutterFormInputWidget<T> extends StatelessWidget {
const FlutterFormInputWidget({
Key? key,
required this.controller,
super.key,
this.focusNode,
this.label,
this.enabled = true,
});
String? hintText,
}) : super(key: key);
/// The [controller] which determines how the value is handled and how the
/// value is shown on the checkpage.
/// The [controller] which determines how the value is handled and how the value is shown on the checkpage.
final FlutterFormInputController<T> controller;
/// [label] is a standard parameter to normally sets the label of the input.
@ -34,10 +33,9 @@ abstract class FlutterFormInputWidget<T> extends StatelessWidget {
final bool enabled;
/// [registerController] should be called to register the given [controller]
/// to the form page.
void registerController(BuildContext context) {
var localController =
/// [registerController] should be called to register the given [controller] to the form page.
registerController(BuildContext context) {
FlutterFormInputController? localController =
fs.FormState.of(context).formController.getController(controller.id!);
if (localController == null) {
@ -50,13 +48,11 @@ abstract class FlutterFormInputWidget<T> extends StatelessWidget {
///
/// The [id] determines the key in the [Map] returned by the [FlutterForm].
///
/// [value] is a way to set a initial value and will be the value when change
/// by the user.
/// [value] is a way to set a initial value and will be the value when change by the user.
///
/// [mandatory] determines if the input is mandatory.
///
/// [checkPageTitle] is a function where you can transform the value from the
/// input into something representable.
/// [checkPageTitle] is a function where you can transform the value from the input into something representable.
/// This value will be given when defining the check page widgets.
/// If this function is not set, the value will be used as is.
/// Example:
@ -66,32 +62,27 @@ abstract class FlutterFormInputWidget<T> extends StatelessWidget {
/// },
/// ```
///
/// [checkPageDescription] is the same as checkPageTitle but for the
/// description. If null no description will be shown.
/// [checkPageDescription] is the same as checkPageTitle but for the description.
/// If null no description will be shown.
///
/// [onChanged] can be set to get the value whenever the user changes it.
/// Should not be used to save the value.
/// [onChanged] can be set to get the value whenever the user changes it. Should not be used to save the value.
///
/// [onSubmit] can be set to get the value whenever the user submits it.
/// Should not be used to save the value.
/// [onSubmit] can be set to get the value whenever the user submits it. Should not be used to save the value.
///
/// [onSaved] goes of when the save function is called for the page if
/// [onValidate] return null.
/// [onSaved] goes of when the save function is called for the page if [onValidate] return null.
///
/// [onValidate] is used to validate the given input by the user.
abstract class FlutterFormInputController<T> {
/// The [id] determines the key in the [Map] returned by the [FlutterForm].
String? id;
/// [value] is a way to set a initial value and will be the value when
/// change by the user.
/// [value] is a way to set a initial value and will be the value when change by the user.
T? value;
/// [mandatory] determines if the input is mandatory.
bool mandatory = false;
/// [checkPageTitle] is a function where you can transform the value from the
/// input into something representable.
/// [checkPageTitle] is a function where you can transform the value from the input into something representable.
/// This value will be given when defining the check page widgets.
/// If this function is not set, the value will be used as is.
/// Example:
@ -102,26 +93,20 @@ abstract class FlutterFormInputController<T> {
/// ```
String Function(T? value)? checkPageTitle;
/// [checkPageDescription] is the same as checkPageTitle but for the
/// description.
/// [checkPageDescription] is the same as checkPageTitle but for the description.
/// If null no description will be shown.
String Function(T? value)? checkPageDescription;
/// [onChanged] can be set to get the value whenever the user changes it.
/// Should not be used to save the value.
/// [onChanged] can be set to get the value whenever the user changes it. Should not be used to save the value.
void Function(T? value)? onChanged;
/// [onSubmit] can be set to get the value whenever the user submits it.
/// Should not be used to save the value.
/// [onSubmit] can be set to get the value whenever the user submits it. Should not be used to save the value.
void Function(T? value)? onSubmit;
/// [onSaved] goes of when the save function is called for the page if
/// [onValidate] return null.
/// [onSaved] goes of when the save function is called for the page if [onValidate] return null.
void onSaved(T? value);
/// [onValidate] is used to validate the given input by the user.
String? onValidate(
T? value,
String validationMessage,
);
T? value, String Function(String, {List<String>? params}) translator);
}

View file

@ -15,28 +15,25 @@ import 'package:flutter_input_library/flutter_input_library.dart' as input;
/// Height sets the height of the inputfield. Default to 425.
class FlutterFormInputCarousel extends FlutterFormInputWidget<int> {
const FlutterFormInputCarousel({
required super.controller,
required this.validationMessage,
Key? key,
required FlutterFormInputController<int> controller,
Widget? label,
required this.items,
super.key,
super.label,
this.validator,
this.height = 425,
});
}) : super(key: key, controller: controller, label: label);
final List<Widget> items;
final double height;
final String validationMessage;
final String? Function(int?)? validator;
@override
Widget build(BuildContext context) {
String Function(String, {List<String>? params}) _ = getTranslator(context);
super.registerController(context);
return input.FlutterFormInputCarousel(
onSaved: controller.onSaved,
validator: validator ??
(value) => controller.onValidate(value, validationMessage),
onSaved: (value) => controller.onSaved(value),
validator: (value) => controller.onValidate(value, _),
onChanged: controller.onChanged,
initialValue: controller.value ?? 0,
items: items,
@ -45,8 +42,7 @@ class FlutterFormInputCarousel extends FlutterFormInputWidget<int> {
}
}
/// Controller for the carousel used by a [FlutterFormInputWidget] used in
/// a [FlutterForm].
/// Controller for the carousel used by a [FlutterFormInputWidget] used in a [FlutterForm].
///
/// Mainly used by [FlutterFormInputCarousel].
class FlutterFormInputCarouselController
@ -88,9 +84,7 @@ class FlutterFormInputCarouselController
@override
String? onValidate(
int? value,
String validationMessage,
) {
int? value, String Function(String, {List<String>? params}) translator) {
if (mandatory) {}
return null;

View file

@ -5,85 +5,53 @@
// ignore_for_file: overridden_fields, annotate_overrides
import 'package:flutter/material.dart';
import 'package:flutter_form_wizard/flutter_form.dart';
import 'package:flutter_input_library/flutter_input_library.dart' as input;
import 'package:intl/intl.dart';
import '../../../../../flutter_form.dart';
/// Input for a dateTime used in a [FlutterForm].
///
/// Standard controller is [FlutterFormInputDateController].
class FlutterFormInputDateTime extends FlutterFormInputWidget<String> {
/// Creates a [FlutterFormInputDateTime].
///
/// The [controller], [inputType], [dateFormat] are required parameters.
/// The [label] parameter specifies the label of the input field.
/// The [showIcon] parameter determines whether to show an icon
/// with the input field.
/// The [firstDate] and [lastDate] parameters specify the range
/// of selectable dates.
/// The [initialDate] parameter specifies the initial date for
/// the input field.
/// The [initialDateTimeRange] parameter specifies the initial
/// date time range for the input field.
/// The [icon] parameter specifies the icon to show with the input field.
/// The [enabled] parameter specifies whether the input field is enabled.
/// The [onTapEnabled] parameter specifies whether tapping on
/// the input field is enabled.
const FlutterFormInputDateTime({
required super.controller,
Key? key,
required FlutterFormInputController<String> controller,
Widget? label,
this.showIcon = true,
required this.inputType,
required this.dateFormat,
required this.validationMessage,
this.decoration,
this.style,
super.key,
this.label,
this.showIcon = true,
this.firstDate,
this.lastDate,
this.initialDate,
this.initialDateTimeRange,
this.initialTime,
this.icon = Icons.calendar_today,
this.initialValue,
this.onChanged,
this.onSaved,
this.validator,
this.autovalidateMode = AutovalidateMode.disabled,
this.timePickerEntryMode = TimePickerEntryMode.dial,
this.enabled = true,
this.onTapEnabled = true,
});
final TextStyle? style;
final InputDecoration? decoration;
final Widget? label;
}) : super(
key: key,
controller: controller,
label: label,
);
final bool showIcon;
final input.FlutterFormDateTimeType inputType;
final DateFormat dateFormat;
final DateTime? initialDate;
final DateTimeRange? initialDateTimeRange;
final TimeOfDay? initialTime;
final DateTime? firstDate;
final DateTime? lastDate;
final IconData icon;
final String? initialValue;
final String? Function(String?)? validator;
final String validationMessage;
final void Function(String?)? onSaved;
final void Function(String?)? onChanged;
final AutovalidateMode autovalidateMode;
final TimePickerEntryMode timePickerEntryMode;
final bool enabled;
final bool onTapEnabled;
@override
Widget build(BuildContext context) {
String Function(String, {List<String>? params}) _ = getTranslator(context);
super.registerController(context);
return input.FlutterFormInputDateTime(
enabled: enabled,
showIcon: showIcon,
decoration: decoration,
onTapEnabled: onTapEnabled,
label: label,
icon: icon,
@ -91,9 +59,8 @@ class FlutterFormInputDateTime extends FlutterFormInputWidget<String> {
lastDate: lastDate,
inputType: inputType,
onChanged: (value) => controller.onChanged?.call(value),
onSaved: controller.onSaved,
validator: validator ??
(value) => controller.onValidate(value, validationMessage),
onSaved: (value) => controller.onSaved(value),
validator: (value) => controller.onValidate(value, _),
initialValue: controller.value,
dateFormat: dateFormat,
initialDate: initialDate,
@ -102,28 +69,21 @@ class FlutterFormInputDateTime extends FlutterFormInputWidget<String> {
}
}
/// Controller for dates used by a [FlutterFormInputWidget] used in a
/// [FlutterForm].
/// Controller for dates used by a [FlutterFormInputWidget] used in a [FlutterForm].
///
/// Mainly used by [FlutterFormInputDateTime].
class FlutterFormInputDateTimeController
implements FlutterFormInputController<String> {
/// Creates a [FlutterFormInputDateTimeController].
///
/// The [id], [dateTimeType], and [dateFormat] are required parameters.
/// The [mandatory] parameter specifies whether the input is mandatory.
/// The [value], [initialDate], [initialDateTimeRange], [checkPageTitle],
/// [checkPageDescription], and [onChanged] parameters are optional.
FlutterFormInputDateTimeController({
required this.id,
required this.dateTimeType,
required this.dateFormat,
this.mandatory = true,
this.value,
this.checkPageTitle,
this.checkPageDescription,
this.initialDate,
this.initialDateTimeRange,
required this.dateTimeType,
required this.dateFormat,
this.onChanged,
}) {
if (value != null) {
@ -158,18 +118,16 @@ class FlutterFormInputDateTimeController
void Function(String? value)? onSubmit;
@override
void onSaved(value) {
void onSaved(dynamic value) {
this.value = value;
}
@override
String? onValidate(
String? value,
String validationMessage,
) {
String? onValidate(String? value,
String Function(String, {List<String>? params}) translator) {
if (mandatory) {
if (value == null || value.isEmpty) {
return validationMessage;
return translator('shell.form.error.empty');
}
}

View file

@ -1,164 +0,0 @@
import 'package:flutter/material.dart';
import 'package:flutter_form_wizard/flutter_form.dart';
import 'package:flutter_input_library/flutter_input_library.dart' as input;
class FlutterFormInputDropdown extends FlutterFormInputWidget<Object> {
const FlutterFormInputDropdown({
required super.controller,
required this.validationMessage,
this.items,
this.selectedItemBuilder,
this.value,
this.hint,
this.disabledHint,
this.onChanged,
this.onTap,
this.elevation = 8,
this.style,
this.icon,
this.iconDisabledColor,
this.iconEnabledColor,
this.iconSize = 24.0,
this.isDense = false,
this.isExpanded = false,
this.itemHeight,
this.focusColor,
this.autofocus = false,
this.dropdownColor,
this.decoration,
this.onSaved,
this.validator,
this.autovalidateMode,
this.menuMaxHeight,
this.enableFeedback,
this.alignment = Alignment.centerLeft,
this.borderRadius,
this.padding,
super.key,
super.focusNode,
super.label,
});
final List<DropdownMenuItem<Object?>>? items;
final List<Widget> Function(BuildContext)? selectedItemBuilder;
final Object? value;
final Widget? hint;
final Widget? disabledHint;
final void Function(Object?)? onChanged;
final void Function()? onTap;
final int elevation;
final TextStyle? style;
final Widget? icon;
final Color? iconDisabledColor;
final Color? iconEnabledColor;
final double iconSize;
final bool isDense;
final bool isExpanded;
final double? itemHeight;
final Color? focusColor;
final bool autofocus;
final Color? dropdownColor;
final InputDecoration? decoration;
final void Function(Object?)? onSaved;
final String? Function(Object?)? validator;
final AutovalidateMode? autovalidateMode;
final double? menuMaxHeight;
final bool? enableFeedback;
final AlignmentGeometry alignment;
final BorderRadius? borderRadius;
final EdgeInsetsGeometry? padding;
final String validationMessage;
@override
Widget build(BuildContext context) {
super.registerController(context);
return input.FlutterFormInputDropdown(
items: items,
selectedItemBuilder: selectedItemBuilder,
value: value,
hint: hint,
disabledHint: disabledHint,
onChanged: controller.onChanged,
onTap: () => onTap?.call(),
elevation: elevation,
style: style,
icon: icon,
iconDisabledColor: iconDisabledColor,
iconEnabledColor: iconEnabledColor,
iconSize: iconSize,
isDense: isDense,
isExpanded: isExpanded,
itemHeight: itemHeight,
focusColor: focusColor,
focusNode: focusNode,
autofocus: autofocus,
dropdownColor: dropdownColor,
decoration: decoration,
onSaved: controller.onSaved,
validator: validator ??
(value) => controller.onValidate(
value,
validationMessage,
),
autovalidateMode: autovalidateMode,
menuMaxHeight: menuMaxHeight,
enableFeedback: enableFeedback,
alignment: alignment,
borderRadius: borderRadius,
padding: padding,
);
}
}
class FlutterFormInputDropdownController
implements FlutterFormInputController<Object> {
FlutterFormInputDropdownController({
required this.id,
this.mandatory = false,
this.value,
this.checkPageTitle,
this.checkPageDescription,
this.onChanged,
this.onSubmit,
});
@override
String? id;
@override
Object? value;
@override
bool mandatory;
@override
String Function(Object? value)? checkPageTitle;
@override
String Function(Object? value)? checkPageDescription;
@override
void Function(Object? value)? onChanged;
@override
void Function(Object? value)? onSubmit;
@override
void onSaved(Object? value) {
this.value = value;
}
@override
String? onValidate(
Object? value,
String validationMessage,
) {
if (mandatory) {
if (value == null) {
return validationMessage;
}
}
return null;
}
}

View file

@ -3,68 +3,56 @@
// SPDX-License-Identifier: BSD-3-Clause
import 'package:flutter/material.dart';
import 'package:flutter_form_wizard/flutter_form.dart';
import 'package:flutter_input_library/flutter_input_library.dart' as input;
import '../../../../flutter_form.dart';
/// Input for an email used in a [FlutterForm].
///
/// Standard controller is [FlutterFormInputEmailController].
class FlutterFormInputEmail extends FlutterFormInputWidget<String> {
/// Creates a [FlutterFormInputEmail].
///
/// The [controller] parameter is required.
/// The [key], [focusNode], [label], and [enabled] parameters are optional.
const FlutterFormInputEmail({
required super.controller,
required this.validationMessage,
super.key,
super.focusNode,
super.label,
Key? key,
required FlutterFormInputController<String> controller,
FocusNode? focusNode,
Widget? label,
bool? enabled,
this.validator,
this.decoration,
this.style,
}) : super(
key: key,
controller: controller,
focusNode: focusNode,
label: label,
enabled: enabled ?? true,
);
final InputDecoration? decoration;
final String validationMessage;
final String? Function(String?)? validator;
final TextStyle? style;
@override
Widget build(BuildContext context) {
String Function(String, {List<String>? params}) _ = getTranslator(context);
super.registerController(context);
return input.FlutterFormInputPlainText(
style: style,
enabled: enabled,
initialValue: controller.value,
onSaved: (value) {
controller.onSaved(value);
},
focusNode: focusNode,
validator: validator ??
(value) => controller.onValidate(value, validationMessage),
validator: (value) => controller.onValidate(value, _),
onChanged: (value) => controller.onChanged?.call(value),
decoration: decoration,
decoration: InputDecoration(
focusColor: Theme.of(context).primaryColor,
label: label ?? const Text("Email"),
),
);
}
}
/// Controller for emails used by a [FlutterFormInputWidget] used in
/// a [FlutterForm].
/// Controller for emails used by a [FlutterFormInputWidget] used in a [FlutterForm].
///
/// Mainly used by [FlutterFormInputEmail].
class FlutterFormInputEmailController
implements FlutterFormInputController<String> {
/// Creates a [FlutterFormInputEmailController].
///
/// The [id] parameter specifies the unique identifier for the controller.
/// The [mandatory] parameter specifies whether the input is mandatory.
/// The [value], [checkPageTitle], [checkPageDescription], [onChanged],
/// and [onSubmit] parameters are optional.
FlutterFormInputEmailController({
required this.id,
this.mandatory = true,
@ -97,24 +85,22 @@ class FlutterFormInputEmailController
void Function(String? value)? onSubmit;
@override
void onSaved(value) {
void onSaved(dynamic value) {
this.value = value;
}
@override
String? onValidate(
String? value,
String validationMessage,
) {
String? onValidate(String? value,
String Function(String, {List<String>? params}) translator) {
if (mandatory) {
if (value == null || value.isEmpty) {
return validationMessage;
return translator('shell.form.error.empty');
}
if (!RegExp(
r"^[a-zA-Z0-9.a-zA-Z0-9.!#$%&'*+-/=?^_`{|}~]+@[a-zA-Z0-9]+\.[a-zA-Z]+",
).hasMatch(value)) {
return validationMessage;
r"^[a-zA-Z0-9.a-zA-Z0-9.!#$%&'*+-/=?^_`{|}~]+@[a-zA-Z0-9]+\.[a-zA-Z]+")
.hasMatch(value)) {
return translator('shell.form.error.email.notValid');
}
}

View file

@ -3,8 +3,8 @@
// SPDX-License-Identifier: BSD-3-Clause
import 'package:flutter/material.dart';
import 'package:flutter_form_wizard/flutter_form.dart';
import 'package:flutter_input_library/flutter_input_library.dart' as input;
import '../../../../../flutter_form.dart';
/// Input for a number used in a [FlutterForm].
///
@ -14,48 +14,37 @@ import 'package:flutter_input_library/flutter_input_library.dart' as input;
/// Standard controller is [FlutterFormInputNumberPickerController].
class FlutterFormInputNumberPicker extends FlutterFormInputWidget<int> {
const FlutterFormInputNumberPicker({
required super.controller,
required this.validationMessage,
super.key,
super.label,
this.validator,
Key? key,
required FlutterFormInputController<int> controller,
Widget? label,
FocusNode? focusNode,
this.minValue = 0,
this.maxValue = 100,
}) : assert(minValue < maxValue, 'minValue must be less than maxValue');
}) : assert(minValue < maxValue),
super(key: key, controller: controller, label: label);
final int minValue;
final int maxValue;
final String validationMessage;
final String? Function(int?)? validator;
@override
Widget build(BuildContext context) {
String Function(String, {List<String>? params}) _ = getTranslator(context);
super.registerController(context);
return input.FlutterFormInputNumberPicker(
minValue: minValue,
maxValue: maxValue,
onSaved: controller.onSaved,
validator: validator ??
(value) => controller.onValidate(value, validationMessage),
onSaved: (value) => controller.onSaved(value),
validator: (value) => controller.onValidate(value, _),
onChanged: (value) => controller.onChanged?.call(value),
initialValue: controller.value ?? minValue,
);
}
}
/// Controller for numbers used by a [FlutterFormInputWidget] used in a
/// [FlutterForm].
///
/// Mainly used by [FlutterFormInputNumberPicker].
class FlutterFormInputNumberPickerController
implements FlutterFormInputController<int> {
/// Creates a [FlutterFormInputNumberPickerController].
///
/// The [id] parameter specifies the unique identifier for the controller.
/// The [mandatory] parameter specifies whether the input is mandatory.
/// The [value], [checkPageTitle], [checkPageDescription],
/// and [onChanged] parameters are optional.
FlutterFormInputNumberPickerController({
required this.id,
this.mandatory = true,
@ -93,9 +82,7 @@ class FlutterFormInputNumberPickerController
@override
String? onValidate(
int? value,
String validationMessage,
) {
int? value, String Function(String, {List<String>? params}) translator) {
if (mandatory) {}
return null;

View file

@ -3,59 +3,50 @@
// SPDX-License-Identifier: BSD-3-Clause
import 'package:flutter/material.dart';
import 'package:flutter_form_wizard/flutter_form.dart';
import 'package:flutter_input_library/flutter_input_library.dart' as input;
import '../../../../../flutter_form.dart';
/// Input for a password used in a [FlutterForm].
///
/// Standard controller is [FlutterFormInputEmailController].
class FlutterFormInputPassword extends FlutterFormInputWidget<String> {
const FlutterFormInputPassword({
required super.controller,
required this.validationMessage,
super.key,
super.focusNode,
super.label,
Key? key,
required FlutterFormInputController<String> controller,
FocusNode? focusNode,
Widget? label,
bool? enabled,
this.validator,
this.decoration,
}) : super(
key: key,
controller: controller,
focusNode: focusNode,
label: label,
enabled: enabled ?? true,
);
final InputDecoration? decoration;
final String validationMessage;
final String? Function(String?)? validator;
@override
Widget build(BuildContext context) {
super.registerController(context);
String Function(String, {List<String>? params}) _ = getTranslator(context);
return input.FlutterFormInputPassword(
enabled: enabled,
initialValue: controller.value,
focusNode: focusNode,
onSaved: controller.onSaved,
validator: validator ??
(value) => controller.onValidate(value, validationMessage),
onSaved: (value) => controller.onSaved(value),
validator: (value) => controller.onValidate(value, _),
onChanged: (value) => controller.onChanged?.call(value),
onFieldSubmitted: (value) => controller.onSubmit?.call(value),
decoration: decoration,
);
}
}
/// Controller for passwords used by a [FlutterFormInputWidget] used in a
/// [ShellFrom].
/// Controller for passwords used by a [FlutterFormInputWidget] used in a [ShellFrom].
///
/// Mainly used by [FlutterFormInputPassword].
class FlutterFormInputPasswordController
implements FlutterFormInputController<String> {
/// Creates a [FlutterFormInputPasswordController].
///
/// The [id] parameter specifies the unique identifier for the controller.
/// The [mandatory] parameter specifies whether the input is mandatory.
/// The [value], [checkPageTitle], [checkPageDescription], [onChanged],
/// and [onSubmit] parameters are optional.
FlutterFormInputPasswordController({
required this.id,
this.mandatory = true,
@ -88,22 +79,20 @@ class FlutterFormInputPasswordController
void Function(String? value)? onSubmit;
@override
void onSaved(value) {
void onSaved(dynamic value) {
this.value = value;
}
@override
String? onValidate(
String? value,
String validationMessage,
) {
String? onValidate(String? value,
String Function(String, {List<String>? params}) translator) {
if (mandatory) {
if (value == null || value.isEmpty) {
return validationMessage;
return translator('Field can not be empty');
}
if (value.length < 6) {
return validationMessage;
return translator('Field should be atleast 6 characters long');
}
}

View file

@ -1,116 +0,0 @@
// SPDX-FileCopyrightText: 2022 Iconica
//
// SPDX-License-Identifier: BSD-3-Clause
// ignore_for_file: overridden_fields
import 'package:flutter/material.dart';
import 'package:flutter_form_wizard/flutter_form.dart';
import 'package:flutter_input_library/flutter_input_library.dart' as input;
/// Input for plain text input used in a [FlutterForm].
///
/// Standard controller is [FlutterFormInputPlainTextController].
class FlutterFormInputPhone extends FlutterFormInputWidget<input.PhoneNumber?> {
const FlutterFormInputPhone({
required super.controller,
required this.validationMessage,
super.key,
super.focusNode,
super.label,
this.decoration,
this.enabled = true,
this.numberFieldStyle,
this.validator,
this.dialCodeSelectorStyle,
this.dialCodeSelectorPadding = const EdgeInsets.only(top: 6),
this.textAlignVertical = TextAlignVertical.top,
});
final InputDecoration? decoration;
@override
final bool enabled;
final TextStyle? numberFieldStyle;
final TextStyle? dialCodeSelectorStyle;
final EdgeInsets dialCodeSelectorPadding;
final TextAlignVertical textAlignVertical;
final String validationMessage;
final String? Function(PhoneNumber?)? validator;
@override
Widget build(BuildContext context) {
super.registerController(context);
var inputDecoration = decoration ??
InputDecoration(
label: label ?? const Text('Phone field'),
);
return input.FlutterFormInputPhone(
numberFieldStyle: numberFieldStyle,
dialCodeSelectorStyle: dialCodeSelectorStyle,
enabled: enabled,
initialValue: controller.value,
onSaved: controller.onSaved,
validator: validator ??
(value) => controller.onValidate(value, validationMessage),
onChanged: (value) => controller.onChanged?.call(value),
onFieldSubmitted: (value) => controller.onSubmit?.call(value),
decoration: inputDecoration,
dialCodeSelectorPadding: dialCodeSelectorPadding,
textAlignVertical: textAlignVertical,
);
}
}
class FlutterFormInputPhoneController
implements FlutterFormInputController<input.PhoneNumber?> {
FlutterFormInputPhoneController({
required this.id,
this.mandatory = true,
this.value,
this.checkPageTitle,
this.checkPageDescription,
this.onChanged,
});
@override
String? id;
@override
input.PhoneNumber? value;
@override
bool mandatory;
@override
String Function(input.PhoneNumber? value)? checkPageTitle;
@override
String Function(input.PhoneNumber? value)? checkPageDescription;
@override
void Function(input.PhoneNumber? value)? onChanged;
@override
void Function(input.PhoneNumber? value)? onSubmit;
@override
void onSaved(input.PhoneNumber? value) {
this.value = value;
}
@override
String? onValidate(
input.PhoneNumber? value,
String validationMessage,
) {
if (mandatory) {
if (value == null || value.number == null) {
return validationMessage;
}
}
return null;
}
}

View file

@ -5,25 +5,19 @@
// ignore_for_file: overridden_fields
import 'package:flutter/material.dart';
import 'package:flutter_form_wizard/flutter_form.dart';
import 'package:flutter_input_library/flutter_input_library.dart' as input;
import '../../../../flutter_form.dart';
/// Input for plain text input used in a [FlutterForm].
///
/// Standard controller is [FlutterFormInputPlainTextController].
class FlutterFormInputPlainText extends FlutterFormInputWidget<String> {
/// Creates a [FlutterFormInputPlainText].
///
/// The [controller] parameter is required.
/// The [key], [focusNode], [label], [decoration], [textAlignVertical],
/// [expands], [maxLines], [scrollPadding], [maxLength], [keyboardType],
/// [enabled], [style], and [textCapitalization] parameters are optional.
const FlutterFormInputPlainText({
required super.controller,
required this.validationMessage,
super.key,
super.focusNode,
super.label,
Key? key,
required FlutterFormInputController<String> controller,
FocusNode? focusNode,
Widget? label,
this.decoration,
this.textAlignVertical,
this.expands = false,
@ -31,11 +25,14 @@ class FlutterFormInputPlainText extends FlutterFormInputWidget<String> {
this.scrollPadding,
this.maxLength,
this.keyboardType,
this.validator,
this.enabled = true,
this.style,
this.textCapitalization = TextCapitalization.none,
});
}) : super(
key: key,
controller: controller,
focusNode: focusNode,
label: label);
final InputDecoration? decoration;
final TextAlignVertical? textAlignVertical;
@ -48,16 +45,16 @@ class FlutterFormInputPlainText extends FlutterFormInputWidget<String> {
final bool enabled;
final TextStyle? style;
final TextCapitalization textCapitalization;
final String validationMessage;
final String? Function(String?)? validator;
@override
Widget build(BuildContext context) {
String Function(String, {List<String>? params}) _ = getTranslator(context);
super.registerController(context);
var inputDecoration = decoration ??
InputDecoration inputDecoration = decoration ??
InputDecoration(
label: label ?? const Text('Plain text'),
label: label ?? const Text("Plain text"),
);
return input.FlutterFormInputPlainText(
@ -66,9 +63,8 @@ class FlutterFormInputPlainText extends FlutterFormInputWidget<String> {
scrollPadding: scrollPadding ?? const EdgeInsets.all(20.0),
initialValue: controller.value,
focusNode: focusNode,
onSaved: controller.onSaved,
validator: validator ??
(value) => controller.onValidate(value, validationMessage),
onSaved: (value) => controller.onSaved(value),
validator: (value) => controller.onValidate(value, _),
onChanged: (value) => controller.onChanged?.call(value),
onFieldSubmitted: (value) => controller.onSubmit?.call(value),
decoration: inputDecoration,
@ -91,45 +87,30 @@ class FlutterFormInputPlainText extends FlutterFormInputWidget<String> {
/// MaxCharacters can be set to set a maximum amount of characters.
class FlutterFormInputMultiLine extends StatelessWidget {
const FlutterFormInputMultiLine({
Key? key,
required this.controller,
required this.validationMessage,
super.key,
this.focusNode,
this.label,
this.hint,
this.validator,
this.maxCharacters,
this.enabled = true,
this.textCapitalization = TextCapitalization.sentences,
});
}) : super(key: key);
/// The controller for the multi-line input.
final FlutterFormInputController<String> controller;
/// The optional label widget for the input.
final Widget? label;
/// The optional focus node for the input.
final FocusNode? focusNode;
/// The optional hint text displayed inside the input field.
final String? hint;
/// The optional maximum number of characters allowed in the input field.
final int? maxCharacters;
/// A flag indicating whether the input field is enabled.
final bool enabled;
/// The capitalization behavior for the input field.
final TextCapitalization textCapitalization;
final String validationMessage;
final String? Function(String?)? validator;
@override
Widget build(BuildContext context) => input.FlutterFormInputMultiLine(
Widget build(BuildContext context) {
String Function(String, {List<String>? params}) _ = getTranslator(context);
return input.FlutterFormInputMultiLine(
enabled: enabled,
label: label,
hint: hint,
@ -138,24 +119,17 @@ class FlutterFormInputMultiLine extends StatelessWidget {
maxCharacters: maxCharacters,
onChanged: controller.onChanged,
onSaved: controller.onSaved,
validator: validator ??
(value) => controller.onValidate(value, validationMessage),
validator: (v) => controller.onValidate(v, _),
textCapitalization: textCapitalization,
);
}
}
/// Controller for plain text used by a [FlutterFormInputWidget] used in a
/// [FlutterForm].
/// Controller for plain text used by a [FlutterFormInputWidget] used in a [FlutterForm].
///
/// Mainly used by [FlutterFormInputPlainText].
class FlutterFormInputPlainTextController
implements FlutterFormInputController<String> {
/// Creates a [FlutterFormInputPlainTextController].
///
/// The [id] parameter specifies the unique identifier for the controller.
/// The [mandatory] parameter specifies whether the input is mandatory.
/// The [value], [checkPageTitle], [checkPageDescription], [onChanged],
/// and [onSubmit] parameters are optional.
FlutterFormInputPlainTextController({
required this.id,
this.mandatory = false,
@ -193,13 +167,11 @@ class FlutterFormInputPlainTextController
}
@override
String? onValidate(
String? value,
String validationMessage,
) {
String? onValidate(String? value,
String Function(String, {List<String>? params}) translator) {
if (mandatory) {
if (value == null || value.isEmpty) {
return validationMessage;
return translator('Field can not be empty');
}
}

View file

@ -3,61 +3,50 @@
// SPDX-License-Identifier: BSD-3-Clause
import 'package:flutter/material.dart';
import 'package:flutter_form_wizard/flutter_form.dart';
import 'package:flutter_input_library/flutter_input_library.dart' as input;
/// Input for a number value between two values via a slider. Used in a
/// [FlutterForm].
import '../../../../../flutter_form.dart';
/// Input for a number value between two values via a slider. Used in a [FlutterForm].
///
/// Standard controller is [FlutterFormInputSliderController].
class FlutterFormInputSlider extends FlutterFormInputWidget<double> {
/// Creates a [FlutterFormInputPassword].
///
/// The [controller] parameter is required.
/// The [focusNode] parameter specifies the focus node of the input field.
/// The [label] parameter specifies the label of the input field.
/// The [enabled] parameter specifies whether the input field is enabled.
const FlutterFormInputSlider({
required super.controller,
required this.validationMessage,
super.key,
super.focusNode,
super.label,
this.validator,
Key? key,
required FlutterFormInputController<double> controller,
FocusNode? focusNode,
Widget? label,
this.minValue = 0,
this.maxValue = 100,
}) : assert(minValue < maxValue, 'minValue must be less than maxValue');
}) : assert(minValue < maxValue),
super(
key: key,
controller: controller,
focusNode: focusNode,
label: label);
final int minValue;
final int maxValue;
final String validationMessage;
final String? Function(double?)? validator;
@override
Widget build(BuildContext context) {
String Function(String, {List<String>? params}) _ = getTranslator(context);
super.registerController(context);
return input.FlutterFormInputSlider(
focusNode: focusNode,
onSaved: controller.onSaved,
validator: validator ??
(value) => controller.onValidate(value, validationMessage),
onSaved: (value) => controller.onSaved(value),
validator: (value) => controller.onValidate(value, _),
);
}
}
/// Controller for slider used by a [FlutterFormInputWidget] used in a
/// [FlutterForm].
/// Controller for slider used by a [FlutterFormInputWidget] used in a [FlutterForm].
///
/// Mainly used by [FlutterFormInputSlider].
class FlutterFormInputSliderController
implements FlutterFormInputController<double> {
/// Creates a [FlutterFormInputPasswordController].
///
/// The [id] parameter specifies the unique identifier for the controller.
/// The [mandatory] parameter specifies whether the input is mandatory.
/// The [value], [checkPageTitle], [checkPageDescription], [onChanged],
/// and [onSubmit] parameters are optional.
FlutterFormInputSliderController({
required this.id,
this.mandatory = true,
@ -94,10 +83,8 @@ class FlutterFormInputSliderController
}
@override
String? onValidate(
double? value,
String validationMessage,
) {
String? onValidate(double? value,
String Function(String, {List<String>? params}) translator) {
if (mandatory) {}
return null;

View file

@ -2,8 +2,6 @@
//
// SPDX-License-Identifier: BSD-3-Clause
// ignore_for_file: avoid_positional_boolean_parameters
import 'package:flutter/material.dart';
import 'package:flutter_form_wizard/flutter_form.dart';
import 'package:flutter_input_library/flutter_input_library.dart' as input;
@ -13,45 +11,38 @@ import 'package:flutter_input_library/flutter_input_library.dart' as input;
/// Standard controller is [FlutterFormInputSwitchController].
class FlutterFormInputSwitch extends FlutterFormInputWidget<bool> {
const FlutterFormInputSwitch({
required super.controller,
required this.validationMessage,
super.key,
super.focusNode,
super.label,
this.validator,
});
final String validationMessage;
final String? Function(bool?)? validator;
Key? key,
required FlutterFormInputController<bool> controller,
FocusNode? focusNode,
Widget? label,
}) : super(
key: key,
controller: controller,
focusNode: focusNode,
label: label);
@override
Widget build(BuildContext context) {
String Function(String, {List<String>? params}) _ = getTranslator(context);
super.registerController(context);
return input.FlutterFormInputBool(
focusNode: focusNode,
onSaved: controller.onSaved,
onSaved: (value) => controller.onSaved(value),
onChanged: controller.onChanged,
validator: validator ??
(value) => controller.onValidate(value, validationMessage),
validator: (value) => controller.onValidate(value, _),
initialValue: controller.value ?? false,
widgetType: input.BoolWidgetType.switchWidget,
);
}
}
/// Controller for the switch used by a [FlutterFormInputWidget] used in a
/// [FlutterForm].
/// Controller for the switch used by a [FlutterFormInputWidget] used in a [FlutterForm].
///
/// Mainly used by [FlutterFormInputSwitch].
class FlutterFormInputSwitchController
implements FlutterFormInputController<bool> {
/// Creates a [FlutterFormInputSwitchController].
///
/// The [id] parameter specifies the unique identifier for the controller.
/// The [mandatory] parameter specifies whether the input is mandatory.
/// The [value], [checkPageTitle], [checkPageDescription],
/// and [onChanged] parameters are optional.
FlutterFormInputSwitchController({
required this.id,
this.mandatory = true,
@ -89,8 +80,7 @@ class FlutterFormInputSwitchController
@override
String? onValidate(
bool? value,
String validationMessage,
) =>
null;
bool? value, String Function(String, {List<String>? params}) translator) {
return null;
}
}

View file

@ -2,17 +2,11 @@
//
// SPDX-License-Identifier: BSD-3-Clause
export 'package:flutter_input_library/flutter_input_library.dart'
show PhoneNumber;
export 'input_carousel/input_carousel.dart';
export 'input_date_picker/input_date_picker.dart';
export 'input_dropdown.dart';
export 'input_email.dart';
export 'input_number_picker/input_number_picker.dart';
export 'input_password/input_password.dart';
export 'input_phone.dart';
export 'input_plain_text.dart';
export 'input_slider/input_slider.dart';
export 'input_switch/input_switch.dart';
export 'multiple_choice.dart';
export 'input_date_picker/input_date_picker.dart';

View file

@ -1,159 +0,0 @@
import 'package:flutter/material.dart';
import 'package:flutter_form_wizard/flutter_form.dart';
class FlutterFormInputMultipleChoice extends FlutterFormInputWidget<String> {
/// Creates a [FlutterFormInputMultipleChoice].
///
/// The [controller], [options], [builder], [validationMessage] parameters
/// are required.
/// The [key], [focusNode], [label] are optional.
const FlutterFormInputMultipleChoice({
required super.controller,
required this.options,
required this.builder,
required this.validationMessage,
super.focusNode,
super.label,
super.key,
this.mainAxisExtent,
this.childAspectRatio = 1,
this.mainAxisSpacing = 0,
this.crossAxisSpacing = 0,
this.crossAxisCount = 3,
this.height,
this.shrinkwrap = true,
this.validator,
});
final List<String> options;
final double? mainAxisExtent;
final double childAspectRatio;
final double mainAxisSpacing;
final double crossAxisSpacing;
final int crossAxisCount;
final double? height;
final bool shrinkwrap;
final Widget Function(
BuildContext context,
int index,
ValueNotifier<int?> selectedIndex,
FlutterFormInputController controller,
List<String> options,
FormFieldState<String> state,
) builder;
final String? Function(String? value, String validationMessage)? validator;
final String validationMessage;
@override
Widget build(BuildContext context) {
super.registerController(context);
var selectedIndex = ValueNotifier<int?>(null);
return FormField<String>(
onSaved: controller.onSaved,
validator: (value) =>
validator?.call(value, validationMessage) ??
controller.onValidate(value, validationMessage),
builder: (state) => SizedBox(
height: height,
child: Column(
children: [
GridView.builder(
physics: const NeverScrollableScrollPhysics(),
itemCount: options.length,
shrinkWrap: shrinkwrap,
gridDelegate: SliverGridDelegateWithFixedCrossAxisCount(
mainAxisExtent: mainAxisExtent,
childAspectRatio: childAspectRatio,
mainAxisSpacing: mainAxisSpacing,
crossAxisSpacing: crossAxisSpacing,
crossAxisCount: crossAxisCount,
),
itemBuilder: (context, index) => ListenableBuilder(
listenable: selectedIndex,
builder: (context, widget) => builder.call(
context,
index,
selectedIndex,
controller,
options,
state,
),
),
),
if (state.hasError)
Text(
state.errorText!,
style: const TextStyle(
color: Color(0xFFAD3645),
fontSize: 14.0,
fontWeight: FontWeight.bold,
),
)
else
const SizedBox.shrink(),
],
),
),
);
}
}
class FlutterFormInputMultipleChoiceController
implements FlutterFormInputController<String> {
/// Creates a [FlutterFormInputMultipleChoiceController].
///
/// The [id] parameter specifies the unique identifier for the controller.
/// The [mandatory] parameter specifies whether the input is mandatory.
/// The [value], [checkPageTitle], [checkPageDescription], [onChanged],
/// and [onSubmit] parameters are optional.
FlutterFormInputMultipleChoiceController({
required this.id,
this.mandatory = false,
this.value,
this.checkPageTitle,
this.checkPageDescription,
this.onChanged,
this.onSubmit,
});
@override
String? id;
@override
String? value;
@override
bool mandatory;
@override
String Function(String? value)? checkPageTitle;
@override
String Function(String? value)? checkPageDescription;
@override
void Function(String? value)? onChanged;
@override
void Function(String? value)? onSubmit;
@override
void onSaved(String? value) {
this.value = value;
}
@override
String? onValidate(
String? value,
String validationMessage,
) {
if (mandatory) {
if (value == null || value.isEmpty) {
return validationMessage;
}
}
return null;
}
}

View file

@ -2,47 +2,27 @@
//
// SPDX-License-Identifier: BSD-3-Clause
// ignore_for_file: avoid_positional_boolean_parameters
import 'package:flutter/material.dart';
/// The options used to set parameters to a [FlutterForm].
///
/// The pages determine what pages the pageview will contain via a [List] of
/// [FlutterFormPage]s.
/// The pages determine what pages the pageview will contain via a [List] of [FlutterFormPage]s.
///
/// Using a checkpage gives the ability for the user to check all input values
/// before commiting by [CheckPage].
/// Using a checkpage gives the ability for the user to check all input values before commiting by [CheckPage].
/// If [checkPage] is null no check page will be shown.
///
/// [nextButton] and [backButton] are both a way to give controls to user.
/// Both are just plain widgets used in a [Stack]. So the widgets can be
/// aligned where ever.
/// Both are just plain widgets used in a [Stack]. So the widgets can be aligned where ever.
/// The formcontroller of [FlutterForm] should be used to give control to the widgets/buttons.
///
/// [onFinished] and [onNext] are both callbacks which give the users results.
/// [onNext] is called when the user goes to the next page.
/// [onBack] is called when the user goes back a page.
/// [onFinished] is called when the form is finished. When checkpage is set
/// [onFinished] is called when the checkpage is finished.
/// [onFinished] is called when the form is finished. When checkpage is set [onFinished] is called when the checkpage is finished.
///
/// [scrollDirection] can be set to change the Axis on which the pageview
/// slides. Defaults to horizontal.
/// [scrollDirection] can be set to change the Axis on which the pageview slides. Defaults to horizontal.
///
/// [scrollPhysics] can be set to set the scroll phyisics of the scroll views
/// in each page. Default to [ClampingScrollPhysics].
/// [scrollPhysics] can be set to set the scroll phyisics of the scroll views in each page. Default to [ClampingScrollPhysics].
class FlutterFormOptions {
const FlutterFormOptions({
required this.pages,
required this.onFinished,
required this.onNext,
this.onBack,
this.checkPage,
this.nextButton,
this.backButton,
this.scrollDirection = Axis.horizontal,
this.scrollPhysics,
});
final List<FlutterFormPage> pages;
final CheckPage? checkPage;
@ -51,26 +31,32 @@ class FlutterFormOptions {
backButton;
final void Function(Map<int, Map<String, dynamic>>) onFinished;
final void Function(int pageNumber, Map<String, dynamic>) onNext;
/// [onBack] is called when the user goes back a page. The [pageNumber] is the
/// page the user is going back to. Not the page that the user was on when the
/// user pressed the back button.
final void Function(int pageNumber)? onBack;
final Axis scrollDirection;
final ScrollPhysics? scrollPhysics;
const FlutterFormOptions({
required this.pages,
this.checkPage,
this.nextButton,
this.backButton,
required this.onFinished,
required this.onNext,
this.scrollDirection = Axis.horizontal,
this.scrollPhysics,
});
}
/// The defines every page in a [FlutterForm].
class FlutterFormPage {
final Widget child;
FlutterFormPage({
required this.child,
});
final Widget child;
}
/// [CheckPage] is used to set a check page at the end of a [FlutterForm].
/// A [CheckPage] is a page where the user can check all input values before
/// commiting.
/// A [CheckPage] is a page where the user can check all input values before commiting.
///
/// [title] is the widget shown at the top of the page.
///
@ -78,28 +64,22 @@ class FlutterFormPage {
///
/// [inputCheckWidget] determines how every input is represented on the page.
/// [title] is the value given in the input.
/// This input can be modified by setting the [checkPageTitle] of that input
/// controller.
/// This input can be modified by setting the [checkPageTitle] of that input controller.
///
/// Same for the [description] but if the description is not set in the input
/// controller no description will be given.
/// Same for the [description] but if the description is not set in the input controller no description will be given.
///
/// [onPressed] can be set so that when the user triggers it the user will be
/// sent back to the page including the input.
/// Here the user can modify the input and save it. Afterwards the user will be
/// sent back to the check page.
/// [onPressed] can be set so that when the user triggers it the user will be sent back to the page including the input.
/// Here the user can modify the input and save it. Afterwards the user will be sent back to the check page.
class CheckPage {
final Widget? title;
final MainAxisAlignment mainAxisAlignment;
final Widget Function(
String id, String title, String? description, Function onPressed)?
inputCheckWidget;
const CheckPage({
this.title,
this.inputCheckWidget,
this.mainAxisAlignment = MainAxisAlignment.start,
});
final Widget? title;
final MainAxisAlignment mainAxisAlignment;
final Widget Function(
String id,
String title,
String? description,
Function onPressed,
)? inputCheckWidget;
}

View file

@ -0,0 +1,53 @@
// SPDX-FileCopyrightText: 2022 Iconica
//
// SPDX-License-Identifier: BSD-3-Clause
import 'package:flutter/material.dart';
abstract class TranslationService {
TranslationService._();
String translate(
BuildContext context,
String key, {
List<String>? params,
});
String number(double value);
}
typedef Translator = String Function(
String, {
List<String>? params,
});
class ShellTranslationService implements TranslationService {
@override
String number(double value) {
return value.toStringAsFixed(2);
}
@override
String translate(BuildContext context, String key, {List<String>? params}) {
return key;
}
}
Translator getTranslator(BuildContext context) {
try {
var translator = ShellTranslationService().translate;
return (
String key, {
List<String>? params,
}) {
return translator(context, key, params: params);
};
} catch (e) {
return (
String key, {
List<String>? params,
}) {
return key;
};
}
}

View file

@ -1,12 +1,12 @@
name: flutter_form_wizard
description: A new Flutter package project.
version: 6.6.0
version: 6.2.2
homepage: https://github.com/Iconica-Development/flutter_form_wizard
publish_to: https://forgejo.internal.iconica.nl/api/packages/internal/pub
publish_to: none
environment:
sdk: ">=3.0.0 <4.0.0"
sdk: ">=2.18.0 <3.0.0"
flutter: ">=1.17.0"
dependencies:
@ -14,16 +14,46 @@ dependencies:
sdk: flutter
flutter_localizations:
sdk: flutter
intl: ">=0.18.0 <1.0.0"
intl: ^0.18.0
flutter_input_library:
hosted: https://forgejo.internal.iconica.nl/api/packages/internal/pub
version: ^3.4.0
git:
url: https://github.com/Iconica-Development/flutter_input_library
ref: 3.0.0
dev_dependencies:
flutter_test:
sdk: flutter
flutter_iconica_analysis:
git:
url: https://github.com/Iconica-Development/flutter_iconica_analysis
ref: 6.0.0
flutter_lints: ^2.0.0
flutter:
# To add assets to your package, add an assets section, like this:
# assets:
# - images/a_dot_burr.jpeg
# - images/a_dot_ham.jpeg
#
# For details regarding assets in packages, see
# https://flutter.dev/assets-and-images/#from-packages
#
# An image asset can refer to one or more resolution-specific "variants", see
# https://flutter.dev/assets-and-images/#resolution-aware
# To add custom fonts to your package, add a fonts section here,
# in this "flutter" section. Each entry in this list should have a
# "family" key with the font family name, and a "fonts" key with a
# list giving the asset and other descriptors for the font. For
# example:
# fonts:
# - family: Schyler
# fonts:
# - asset: fonts/Schyler-Regular.ttf
# - asset: fonts/Schyler-Italic.ttf
# style: italic
# - family: Trajan Pro
# fonts:
# - asset: fonts/TrajanPro.ttf
# - asset: fonts/TrajanPro_Bold.ttf
# weight: 700
#
# For details regarding fonts in packages, see
# https://flutter.dev/custom-fonts/#from-packages

View file

@ -8,7 +8,7 @@ import 'package:flutter_test/flutter_test.dart';
void main() {
testWidgets('Normal walk through without check page', (tester) async {
var formController = FlutterFormController();
FlutterFormController formController = FlutterFormController();
var testField1Controller = FlutterFormInputPlainTextController(
id: 'Field1',
@ -28,21 +28,21 @@ void main() {
home: Material(
child: FlutterForm(
options: FlutterFormOptions(
nextButton: (pageNumber, checkingPages) => Align(
nextButton: (pageNumber, checkingPages) {
return Align(
alignment: Alignment.bottomCenter,
child: ElevatedButton(
onPressed: () async {
await formController.autoNextStep();
},
child: Text(
pageNumber == 0
child: Text(pageNumber == 0
? 'next1'
: pageNumber == 1
? 'next2'
: 'finish',
),
),
: 'finish'),
),
);
},
onFinished: (Map<int, Map<String, dynamic>> results) {
onFinishResults = results;
},
@ -56,7 +56,6 @@ void main() {
child: FlutterFormInputPlainText(
label: const Text('Field1Label'),
controller: testField1Controller,
validationMessage: 'Please fill in this field',
),
),
),
@ -65,7 +64,6 @@ void main() {
child: FlutterFormInputPlainText(
label: const Text('Field2Label'),
controller: testField2Controller,
validationMessage: 'Please fill in this field',
),
),
),
@ -78,9 +76,7 @@ void main() {
);
await tester.enterText(
find.widgetWithText(TextFormField, 'Field1Label'),
'Field1Input',
);
find.widgetWithText(TextFormField, 'Field1Label'), 'Field1Input');
await tester.tap(find.widgetWithText(ElevatedButton, 'next1'));
await tester.pumpAndSettle();
@ -88,26 +84,21 @@ void main() {
expect({'Field1': 'Field1Input'}, onNextResults);
await tester.enterText(
find.widgetWithText(TextFormField, 'Field2Label'),
'Field2Input',
);
find.widgetWithText(TextFormField, 'Field2Label'), 'Field2Input');
await tester.tap(find.widgetWithText(ElevatedButton, 'next2'));
await tester.pumpAndSettle();
expect(1, onNextPageNumber);
expect({'Field2': 'Field2Input'}, onNextResults);
expect(
{
expect({
0: {'Field1': 'Field1Input'},
1: {'Field2': 'Field2Input'},
},
onFinishResults,
);
1: {'Field2': 'Field2Input'}
}, onFinishResults);
});
testWidgets('Normal walk through with check page', (tester) async {
var formController = FlutterFormController();
FlutterFormController formController = FlutterFormController();
var testField1Controller = FlutterFormInputPlainTextController(
id: 'Field1',
@ -128,21 +119,21 @@ void main() {
child: FlutterForm(
options: FlutterFormOptions(
checkPage: const CheckPage(),
nextButton: (pageNumber, checkingPages) => Align(
nextButton: (pageNumber, checkingPages) {
return Align(
alignment: Alignment.bottomCenter,
child: ElevatedButton(
onPressed: () async {
await formController.autoNextStep();
},
child: Text(
pageNumber == 0
child: Text(pageNumber == 0
? 'next1'
: pageNumber == 1
? 'next2'
: 'finish',
),
),
: 'finish'),
),
);
},
onFinished: (Map<int, Map<String, dynamic>> results) {
onFinishResults = results;
},
@ -156,7 +147,6 @@ void main() {
child: FlutterFormInputPlainText(
label: const Text('Field1Label'),
controller: testField1Controller,
validationMessage: 'Please fill in this field',
),
),
),
@ -165,7 +155,6 @@ void main() {
child: FlutterFormInputPlainText(
label: const Text('Field2Label'),
controller: testField2Controller,
validationMessage: 'Please fill in this field',
),
),
),
@ -178,9 +167,7 @@ void main() {
);
await tester.enterText(
find.widgetWithText(TextFormField, 'Field1Label'),
'Field1Input',
);
find.widgetWithText(TextFormField, 'Field1Label'), 'Field1Input');
await tester.tap(find.widgetWithText(ElevatedButton, 'next1'));
await tester.pumpAndSettle();
@ -188,9 +175,7 @@ void main() {
expect({'Field1': 'Field1Input'}, onNextResults);
await tester.enterText(
find.widgetWithText(TextFormField, 'Field2Label'),
'Field2Input',
);
find.widgetWithText(TextFormField, 'Field2Label'), 'Field2Input');
await tester.tap(find.widgetWithText(ElevatedButton, 'next2'));
await tester.pumpAndSettle();
@ -201,29 +186,24 @@ void main() {
await tester.pumpAndSettle();
await tester.enterText(
find.widgetWithText(TextFormField, 'Field1Label'),
'Field1Input2',
);
find.widgetWithText(TextFormField, 'Field1Label'), 'Field1Input2');
await tester.tap(find.widgetWithText(ElevatedButton, 'next1'));
await tester.pumpAndSettle();
expect(0, onNextPageNumber);
expect({'Field1': 'Field1Input2'}, onNextResults);
await tester.tap(find.widgetWithText(ElevatedButton, 'finish'));
await tester.tap(find.widgetWithText(ElevatedButton, "finish"));
await tester.pumpAndSettle();
expect(
{
expect({
0: {'Field1': 'Field1Input2'},
1: {'Field2': 'Field2Input'},
},
onFinishResults,
);
1: {'Field2': 'Field2Input'}
}, onFinishResults);
});
testWidgets('Wrong input with mandatory validator', (tester) async {
var formController = FlutterFormController();
FlutterFormController formController = FlutterFormController();
var testField1Controller = FlutterFormInputPlainTextController(
id: 'Field1',
@ -240,7 +220,8 @@ void main() {
home: Material(
child: FlutterForm(
options: FlutterFormOptions(
nextButton: (pageNumber, checkingPages) => Align(
nextButton: (pageNumber, checkingPages) {
return Align(
alignment: Alignment.bottomCenter,
child: ElevatedButton(
onPressed: () async {
@ -248,7 +229,8 @@ void main() {
},
child: const Text('finish'),
),
),
);
},
onFinished: (Map<int, Map<String, dynamic>> results) {
// print('finished results: $results');
onFinishResults = results;
@ -264,7 +246,6 @@ void main() {
child: FlutterFormInputPlainText(
label: const Text('Field1Label'),
controller: testField1Controller,
validationMessage: 'Field can not be empty',
),
),
),
@ -282,25 +263,20 @@ void main() {
expect(null, onNextPageNumber);
expect(null, onNextResults);
var errorMessageFinder = find.text('Field can not be empty');
final errorMessageFinder = find.text('Field can not be empty');
expect(errorMessageFinder, findsOneWidget);
await tester.enterText(
find.widgetWithText(TextFormField, 'Field1Label'),
'Field1Input',
);
find.widgetWithText(TextFormField, 'Field1Label'), 'Field1Input');
await tester.tap(find.widgetWithText(ElevatedButton, 'finish'));
await tester.pumpAndSettle();
expect(0, onNextPageNumber);
expect({'Field1': 'Field1Input'}, onNextResults);
expect(
{
expect({
0: {'Field1': 'Field1Input'},
},
onFinishResults,
);
}, onFinishResults);
});
}