FormQL selectors

FormQL selectors

There are two selectors to use FormQL: formql and formql-editor

FormQL (imported from @formql/core)

<formql
    [formName]
    [ids]
    [mode]
    [reactiveForm]
    [customMetadata]

    (formLoaded)
    (formSaveStart)
    (formSaveEnd)
    (formError)
/>

Input parameters:

• formName (string - required): name of the form to load.
• ids (Array<string> - default: null): list of ids used for retrieving the data for the form.
• mode (FormQLMode - default: FormQLMode.View): mode to load the form (View or Edit mode)
• reactiveForm (FormGroup - default: null): reactive form to be used to load the form, this is used if the parent component needs to have access to the form.
• customMetadata (any - default: null): custom metadata to be used in components. NOTE: This property is not being used at the moment, the functionality will be released in version 0.4

Output parameters:

• formLoaded (EventEmitter<boolean>): event triggered when the form finished loading
• formSaveStart (EventEmitter<boolean>): event triggered when the form begins saving the data
• formSaveEnd (EventEmitter<boolean>): event triggered when the form finishes saving the data
• formError (EventEmitter<any>): event triggered when there is an error on the form, it returns a value with the error message

FormQL Editor (imported from @formql/editor)

<formql-editor
    [formName]
    [ids]
    [mode]
    [pathOpenViewMode]
/>

Input parameters:

• formName (string - required): name of the form to load.
• ids (Array<string> - default: null): list of ids used for retrieving the data for the form.
• mode (FormQLMode - default: FormQLMode.Edit): mode to load the form (View or Edit mode)
• pathOpenViewMode (string - default: '/#/form/{0}'): path to for opening the form in View Mode, this is used when the user clicks on "Open View Mode" in the top right hand side of the FormQL editor