Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FormInputProps<TInput>

Props passed to Vulcan Smart Form input Use those props to define custom inputs

Type parameters

  • TInput = HTMLInputElement

Hierarchy

  • FormComponentInnerProps
    • FormInputProps

Index

Properties

afterComponent

afterComponent: any

beforeComponent

beforeComponent: any

charsRemaining

charsRemaining: any

Optional clearField

clearField: MouseEventHandler<HTMLButtonElement>

Callback called when clicking on the "clear input" button

datatype

datatype: VulcanFieldType

Legacy type was Array<{type: Number | String | Boolean} = the "type" of a SimpleSchema object Now it's just the type from the JSON schema:

Optional defaultValue

defaultValue: any

Optional description

description: string

disabled

disabled: boolean

document

document: any

errors

errors: any

formComponents

formComponents: PossibleVulcanComponents

formInput

formInput: any

formType

formType: "new" | "edit"

Optional handleChange

handleChange: Function

TODO: not sure if it should be mandatory or not (eg for uncontrolled components?)

Optional help

help: string

Help text for the form

input

input: any

inputClassName

inputClassName: any

inputProperties

inputProperties: HTMLProps<TInput>

Input properties will contain all props that can be safely passed down to the root input (often an HTML "input" or textarea)

This includes the current "value", that can be obtained either from "props" or "props.inputProperties.value" in input components

inputType

inputType: VulcanCoreInput

Optional intlInput

intlInput: boolean

Optional intlKeys

intlKeys: any

itemProperties

itemProperties: any

Optional loading

loading: boolean

Optional locale

locale: string

Optional max

max: number

Optional name

name: string

Optional nestedInput

nestedInput: boolean

Optional options

options: FormOption<any>[] | ((fciProps?: any) => FormOption<any>[])

path

path: string

Path of the field if nested

Optional query

query: string

Graphql query you can pass to fetch the options asynchronously

renderComponent

renderComponent: any

showCharsRemaining

showCharsRemaining: any

submitForm

submitForm: any

Optional vulcanComponents

vulcanComponents: PossibleVulcanComponents

Generated using TypeDoc