Interface UseCubicWebFormQueryParams<E, EntityType>

Parameters to describe how to build queries to the API when handling forms.

Type Parameters

  • E extends EntityRawSchemaArray

  • EntityType extends E[number]["type"]

Hierarchy

  • UseCubicWebFormQueryParams

Properties

eid? includeObjectRelations? omittedFields? onSuccess? type

Properties

Optional eid

eid?: number

The eid of the entity you want to edit. If provided, the hook will fetch the initial values.

Optional includeObjectRelations

includeObjectRelations?: boolean

True if you want to include object relations. Defaults to false.

Optional omittedFields

omittedFields?: string[]

Which attributes/relations you want to ignore while editting the entity.

Optional onSuccess

onSuccess?: ((eid) => void)

Type declaration

    • (eid): void

    • Handler to execute when the form successfully submits

      Parameters

      • eid: number

      Returns void

type

type: EntityType

The entity type you want to edit. Allows the lib to know which entity schema to return.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc