Interface FieldEventMap<Type>

Component events

See

ComponentEventMap

Type Parameters

  • Type

Hierarchy

Properties

added: ((comp, index, parent) => void)

Type declaration

    • (comp, index, parent): void
    • Fires when this component is added to a parent but before rendering

      Parameters

      • comp: Type
      • index: number

        the index in the parents' items

      • parent: Component

      Returns void

beforehide: ((comp) => false | void)

Type declaration

    • (comp): false | void
    • Fires before hide. You can cancel the hide by returning false.

      Parameters

      • comp: Type

      Returns false | void

      See

      Component.hide()

beforeremove: ((comp) => false | void)

Type declaration

    • (comp): false | void
    • Fires before the element is removed. You can cancel the remove by returning false

      Parameters

      • comp: Type

      Returns false | void

      See

      Component.remove()

beforerender: ((comp) => void)

Type declaration

    • (comp): void
    • Fires just before rendering

      Parameters

      • comp: Type

      Returns void

      See

      Component.render()

beforeshow: ((comp) => false | void)

Type declaration

    • (comp): false | void
    • Fires before show. You can cancel the show by returning false

      Parameters

      • comp: Type

      Returns false | void

      See

      Component.show()

change: ((field, newValue, oldValue) => void)

Type declaration

    • (field, newValue, oldValue): void
    • Fires when the field changes. It fires on blur.

      Note: this event does not fire on {@see ContainerField} and {@see Form}

      Parameters

      • field: Type
      • newValue: any
      • oldValue: any

      Returns void

focus: ((comp, o?) => void)

Type declaration

    • (comp, o?): void
    • Fires on focus

      Parameters

      • comp: Type
      • Optional o: FocusOptions

      Returns void

hide: ((comp) => void)

Type declaration

    • (comp): void
    • Fires after hiding the component

      Parameters

      • comp: Type

      Returns void

      See

      Component.show()

invalid: ((field) => void)

Type declaration

    • (field): void
    • Fires when the field is invalid

      Use {@see setInvalid()} to mark field invalid

      Parameters

      • field: Type

      Returns void

remove: ((comp) => void)

Type declaration

    • (comp): void
    • Fires after the component has been removed

      Parameters

      • comp: Type

      Returns void

      See

      Component.remove()

render: ((comp) => void)

Type declaration

    • (comp): void
    • Fires when the component renders and is added to the DOM

      Parameters

      • comp: Type

      Returns void

      See

      Component.render()

reset: ((field, newValue, oldValue) => void)

Type declaration

    • (field, newValue, oldValue): void
    • Fires when field is reset

      Parameters

      • field: Type
      • newValue: any
      • oldValue: any

      Returns void

setvalue: ((field, newValue, oldValue) => void)

Type declaration

    • (field, newValue, oldValue): void
    • Fires when setValue() is called

      Parameters

      • field: Type
      • newValue: any
      • oldValue: any

      Returns void

show: ((comp) => void)

Type declaration

    • (comp): void
    • Fires after showing the component

      Parameters

      • comp: Type

      Returns void

      See

      Component.show()

validate: ((field) => void)

Type declaration

    • (field): void
    • Fires when validated

      Use {@see setInvalid()} to mark field invalid

      Parameters

      • field: Type

      Returns void

Generated using TypeDoc