dhis2_flutter_ui - Dart API docs

DHIS2 FLUTTER UI

This Library support common components in Dhis2 used in Flutter

About
Getting Started
Supported Components

About

DHIS2 Flutter UI is a library combine different UI experience used to in DHIS2 to deliver solution.It is consists of different form components ,common components and models that support dhis2 api data structure with reference to their metadata.

Supported Components

The following are list of supported components and models in the packages.

i. Input Components

list of input components

components	props
SearchInput
RadioInputFieldContainer
BooleanInputFieldContainer
CheckBoxInputField
CoordinateInputFieldContainer
DateInputFieldContainer
InputClearIcon
NumericalInputFieldContainer
SelectInputField
TextInputFieldContainer
TrueOnlyInputFieldContainer
InputFieldContainer
PercentageInputFieldContainer
TimeInputFieldContainer
FormFieldInputIcon

ii. Generic Components

list of generic components

components	props
CircularProcessLoader
MaterialCard
LineSeparator
CustomButton

iii. Models Supported

list of models

Models	props
Application	String id; String label ; String iconPath; List
InputField	String id;String name; String? translatedName;String? description; String? translatedDescription; String valueType; Color? labelColor; Color? inputColor; Color? background; bool? renderAsRadio; bool? isReadOnly; bool? isPasswordField; bool? shouldCapitalize;bool? allowFuturePeriod; bool? disablePastPeriod; bool? hasError; int? minYear; int? maxYear;DateTime? minDate,DateTime? maxDate, int? numberOfMonth; String? suffixLabel;String? prefixLabel; String? hint; String? translatedHint; List
InputFieldOption	String name; String? translatedName; dynamic code;

iv. Utils Supported

 List of Utils

Name	Functions
FormValidator	`Validators.pattern('regex','message')`
InputMask	`InputMask(pattern:'xxxx-xxx-xxx',separator:'-')`

Permissions

When using the Coordinate Input Field component within the DHIS2 Flutter UI library, it's important to ensure that the necessary permissions are granted for the seamless functionality of location-related features. The following permissions are required:

Android Permissions:: For Android, you need to add the required permissions to the AndroidManifest.xml file. You can find this file in the android/app/src/main directory of your Flutter project.

Add the following lines within the

    <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
    <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
    <uses-permission android:name="android.permission.ACCESS_BACKGROUND_LOCATION" />

iOS Permissions:: For iOS, you need to include the appropriate keys in your app's Info.plist file. You can find this file in the ios/Runner directory of your Flutter project.

Open the Info.plist file and add the following keys:

    <key>NSLocationWhenInUseUsageDescription</key>
    <string>Your app's explanation for using location services while in use</string>
    <key>NSLocationAlwaysUsageDescription</key>
    <string>Your app's explanation for using location services in the background</string>

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

 git clone <github_repository_url>

🔧 Running the tests

Explain how to run the automated tests for this system.

Break down into end to end tests

Explain what these tests test and why

Give an example

And coding style tests