@softheon/angular-forge
v1.0.0-beta.11
Published
This Angular library allows forms to be dynamically built for forms created in Softheon Forge. By providing a simple configuration to a ```<forge>``` Angular component, this library will dynamically render a form within the front end application.
Downloads
5
Keywords
Readme
Softheon Forge
Angular Form Rendering
This Angular library allows forms to be dynamically built for forms created in Softheon Forge. By providing a simple configuration to a <forge>
Angular component, this library will dynamically render a form within the front end application.
Using within your application
You can easily render a form within your Angular 7 application by referencing your form through a configuration as shown below.
<forge [formRendererConfig]="formRendererConfig">
Usage
First you will need to install it as a dependency within your project.
npm install --save @softheon/angular-forge
You can now include the module in your Angular application as follow.
import { FormRendererLibModule } from '@softheon/angular-forge'
@NgModule({
imports: [ BrowserModule, CommonModule, FormRendererLibModule ],
declarations: [ AppComponent ],
bootstrap: [ AppComponent ]
})
export class AppModule { }
Angular Form Builder
The Form builder part of this library allows you to create custom forms for your entities by providing a simple configuration to a '' Angular component, this will show the form builder within your application.
<forge-form-builder [formBuilderConfig]="formBuilderConfig">
Usage
First you will need to install it as a dependency within your project.
npm install --save @softheon/angular-forge
You can now include the module in your Angular application as follow.
import { FormBuilderModule } from '@softheon/angular-forge'
@NgModule({
imports: [ BrowserModule, CommonModule, FormBuilderModule ],
declarations: [ AppComponent ],
bootstrap: [ AppComponent ]
})
export class AppModule { }
API for forge
Properties
formRendererConfig
- (FormRendererConfig
) - configuration object. See using in ts demo and html demo
Parameters supported by this object:
forgeApiUrl
- URL of Softheon Forge API.oauthToken
- Auth token that will be applied as 'Authorization' header during file send.accountName
- Name of the account.formName
- Name of the form.displayFormName
- Whether the form name should be displayed and edited.
Parameters supported by this object:
forgeApiUrl
- URL of Softheon Forge API.oauthToken
- Auth token that will be applied as 'Authorization' header during file send.accountName
- Name of the account.
Events
finishedRendering
- fires after the form finishes rendering. See using in ts demo and html demo.formSubmitted
- fires after the form is submitted. See using in ts demo and html demo.
Troubleshooting
Please follow these guidelines when reporting bugs and feature requests:
- Use GitHub Issues board to report bugs and feature requests.
- Please always write steps to reproduce the error. That way we can focus on fixing the bug, not scratching our heads trying to reproduce it.