Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PassedDownFormProps

Props that can be passed to the FormContainer (= SmartForm) and will be passed down to the Form

TODO: this might not be complete yet. We need to move relevant props from "FormProps" to this type, based on current usage of the SmartForm in existing apps

Hierarchy

Index

Properties

Optional disabled

disabled: boolean

Disable the form

Optional itemProperties

itemProperties: Object

Optional mutationFragment

mutationFragment: string | DocumentNode

A GraphQL fragment used to specify the data to return once a mutation is complete.

If no fragment is passed, SmartForm will only return fields used in the form, but note that this might sometimes lead to discrepancies when compared with documents already loaded on the client.

An example would be a createdAt date added automatically on creation even though it’s not part of the actual form. If you’d like that field to be returned after the mutation, you can define a custom mutationFragment that includes it explicitly.

Can be either a string or a DocumentNode (using "gql" tag)

Optional mutationFragmentName

mutationFragmentName: string

Force a mutation fragment name

NOTE: needed only for string fragments If you use a DocumentNode (with "gql" tag), it will be computed automatically

deprecated

Prefer using DocumentNode fragment, using the gql tag

Optional queryFragment

queryFragment: string | DocumentNode

A GraphQL fragment used to specify the data to fetch to populate edit forms. If no fragment is passed, SmartForm will do its best to figure out what data to load based on the fields included in the form.

Can be either a string or a DocumentNode (using "gql" tag)

Optional queryFragmentName

queryFragmentName: string

Force a query fragment name

NOTE: needed only for string fragments If you use a DocumentNode (with "gql" tag), it will be computed automatically

deprecated

Prefer using DocumentNode fragment, using the gql tag

Optional showDelete

showDelete: boolean

Optional warnUnsavedChanges

warnUnsavedChanges: boolean

Will prevent leaving the page/unmounting the form on unsaved changes

Methods

Optional errorCallback

  • errorCallback(document: any, error: any, meta: { form: any }): void
  • Parameters

    • document: any
    • error: any
    • meta: { form: any }
      • form: any

    Returns void

Optional submitCallback

  • submitCallback(data: any): any
  • Parameters

    • data: any

    Returns any

Optional successCallback

  • successCallback(document: any, meta: { form: any }): void
  • Parameters

    • document: any
    • meta: { form: any }
      • form: any

    Returns void

Generated using TypeDoc