Unverified Commit c403825c authored by Sharath Prasad's avatar Sharath Prasad Committed by GitHub
Browse files

Update README.md

No related merge requests found
Showing with 64 additions and 2 deletions
+64 -2
......@@ -15,7 +15,69 @@ Contains Form component powered by angular. This component expects a configurat
## step3: Form component emits values on every input , To get value include event callbacks
<sb-form (valueChanges)="function($event)" (statusChanges)="function($event)" ></sb-form>
## Steps to Integrate the form
Please refer following link for sample config
https://github.com/Sunbird-Ed/SunbirdEd-forms/blob/release-4.1.0/projects/common-form-elements/src/lib/form/form.component.ts
The Form Can render following elements:
* Text Box
* Text Area
* Drop Down (Single)
* Multi Select Drop Down
Drop Down Data Sources:
Drop Down can be provided with multiple types of Data Sources:
* Static List
* Closure which is called as MARKER in above config (A function which returns Promise of FieldConfig)
* API Source - Currently Not Developed (Open For Contribution)
Example of Closure Implementation
```
buildStateListClosure(config: FieldConfig<any>, initial = false): FieldConfigOptionsBuilder<Location> {
return (formControl: FormControl, _: FormControl, notifyLoading, notifyLoaded) => {
return defer(async () => {
const req: LocationSearchCriteria = {
from: CachedItemRequestSourceFrom.SERVER,
filters: {
type: LocationType.TYPE_STATE
}
};
notifyLoading();
return this.fetchUserLocation(req)
.then((stateLocationList: Location[]) => {
notifyLoaded();
const list = stateLocationList.map((s) => ({ label: s.name, value: s }));
if (config.default && initial) {
const option = list.find((o) => o.value.id === config.default.id || o.label === config.default.name);
formControl.patchValue(option ? option.value : null, { emitModelToViewChange: false });
formControl.markAsPristine();
config.default['code'] = option ? option.value['code'] : config.default['code'];
}
initial = false;
return list;
})
.catch((e) => {
notifyLoaded();
this.commonUtilService.showToast('NO_DATA_FOUND');
console.error(e);
return [];
});
});
};
}
```
The Logic Inside can be customised to own needs of project.
Function Signature should be as follows:
\ No newline at end of file
```
functionName(config: FieldConfig<any>, initial = false): FieldConfigOptionsBuilder<T>
```
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment