From 42333adfc1ea2abc2292097843ef59e7dd0de4a0 Mon Sep 17 00:00:00 2001 From: Vick Top Date: Tue, 13 Feb 2024 13:35:54 +0100 Subject: [PATCH 1/2] feat(documentation): Create component-documentation.yml workflow file --- .github/workflows/component-documentation.yml | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 .github/workflows/component-documentation.yml diff --git a/.github/workflows/component-documentation.yml b/.github/workflows/component-documentation.yml new file mode 100644 index 0000000..c12e46a --- /dev/null +++ b/.github/workflows/component-documentation.yml @@ -0,0 +1,14 @@ +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 From b51a4fec210f577540985acfaee8df0302b16375 Mon Sep 17 00:00:00 2001 From: Vick Top Date: Tue, 13 Feb 2024 15:51:39 +0100 Subject: [PATCH 2/2] fix(ci): run dart format --- lib/src/widgets/input/abstractions.dart | 20 +++++++++---------- .../input_carousel/input_carousel.dart | 2 +- .../input_date_picker/input_date_picker.dart | 2 +- lib/utils/form.dart | 10 +++++----- 4 files changed, 17 insertions(+), 17 deletions(-) diff --git a/lib/src/widgets/input/abstractions.dart b/lib/src/widgets/input/abstractions.dart index 72eb640..4846eab 100644 --- a/lib/src/widgets/input/abstractions.dart +++ b/lib/src/widgets/input/abstractions.dart @@ -66,16 +66,16 @@ abstract class FlutterFormInputWidget extends StatelessWidget { /// }, /// ``` /// -/// [checkPageDescription] is the same as checkPageTitle but for the +/// [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. +/// [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. +/// [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 +/// [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. @@ -83,14 +83,14 @@ abstract class FlutterFormInputController { /// 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 + /// [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 + /// [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. @@ -102,20 +102,20 @@ abstract class FlutterFormInputController { /// ``` String Function(T? value)? checkPageTitle; - /// [checkPageDescription] is the same as checkPageTitle but for the + /// [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. + /// [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. + /// [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 + /// [onSaved] goes of when the save function is called for the page if /// [onValidate] return null. void onSaved(T? value); diff --git a/lib/src/widgets/input/input_types/input_carousel/input_carousel.dart b/lib/src/widgets/input/input_types/input_carousel/input_carousel.dart index 57834c5..941e27f 100644 --- a/lib/src/widgets/input/input_types/input_carousel/input_carousel.dart +++ b/lib/src/widgets/input/input_types/input_carousel/input_carousel.dart @@ -42,7 +42,7 @@ class FlutterFormInputCarousel extends FlutterFormInputWidget { } } -/// Controller for the carousel used by a [FlutterFormInputWidget] used in +/// Controller for the carousel used by a [FlutterFormInputWidget] used in /// a [FlutterForm]. /// /// Mainly used by [FlutterFormInputCarousel]. diff --git a/lib/src/widgets/input/input_types/input_date_picker/input_date_picker.dart b/lib/src/widgets/input/input_types/input_date_picker/input_date_picker.dart index a9e30f5..323f6c5 100644 --- a/lib/src/widgets/input/input_types/input_date_picker/input_date_picker.dart +++ b/lib/src/widgets/input/input_types/input_date_picker/input_date_picker.dart @@ -64,7 +64,7 @@ class FlutterFormInputDateTime extends FlutterFormInputWidget { } } -/// Controller for dates used by a [FlutterFormInputWidget] used in a +/// Controller for dates used by a [FlutterFormInputWidget] used in a /// [FlutterForm]. /// /// Mainly used by [FlutterFormInputDateTime]. diff --git a/lib/utils/form.dart b/lib/utils/form.dart index 95139b9..d6f4418 100644 --- a/lib/utils/form.dart +++ b/lib/utils/form.dart @@ -62,7 +62,7 @@ class FlutterFormPage { } /// [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 +/// 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. @@ -71,15 +71,15 @@ 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 +/// 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 +/// 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 +/// [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 +/// Here the user can modify the input and save it. Afterwards the user will be /// sent back to the check page. class CheckPage { const CheckPage({