Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FileInputField<SS>

Renders an input field for files with the given label and an option to clear the input field on update. Accepts a callback onChange which is invoked when the user updates the field.

param

Label for the input field

param

Callback invoked when the user changes the field

param

Whether the input field should be clear on update

Type parameters

  • SS

Hierarchy

Index

Constructors

constructor

  • Parameters

    Returns FileInputField

Properties

context

context: any

Private inputField

inputField: Nullable<HTMLInputElement>

props

props: Readonly<object> & Readonly<FileInputFieldProps>

refs

refs: object

Type declaration

  • [key: string]: ReactInstance

state

state: Readonly<__type>

Methods

Optional UNSAFE_componentWillMount

  • UNSAFE_componentWillMount(): void

Optional UNSAFE_componentWillReceiveProps

  • UNSAFE_componentWillReceiveProps(nextProps: Readonly<FileInputFieldProps>, nextContext: any): void

Optional UNSAFE_componentWillUpdate

  • UNSAFE_componentWillUpdate(nextProps: Readonly<FileInputFieldProps>, nextState: Readonly<__type>, nextContext: any): void

Optional componentDidCatch

  • componentDidCatch(error: Error, errorInfo: ErrorInfo): void
  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

Optional componentDidMount

  • componentDidMount(): void
  • Called immediately after a compoment is mounted. Setting state here will trigger re-rendering.

    Returns void

Optional componentDidUpdate

  • componentDidUpdate(prevProps: Readonly<FileInputFieldProps>, prevState: Readonly<__type>, snapshot?: SS): void
  • Called immediately after updating occurs. Not called for the initial render.

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    Parameters

    Returns void

Optional componentWillMount

  • componentWillMount(): void

componentWillReceiveProps

  • Invoked whenever the component's props receive an update. Clears the input field, provided the clear prop is set to true.

    Parameters

    Returns void

Optional componentWillUnmount

  • componentWillUnmount(): void
  • Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    Returns void

Optional componentWillUpdate

  • componentWillUpdate(nextProps: Readonly<FileInputFieldProps>, nextState: Readonly<__type>, nextContext: any): void

forceUpdate

  • forceUpdate(callBack?: undefined | function): void
  • Parameters

    • Optional callBack: undefined | function

    Returns void

Optional getSnapshotBeforeUpdate

  • getSnapshotBeforeUpdate(prevProps: Readonly<FileInputFieldProps>, prevState: Readonly<__type>): SS | null
  • Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it.

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.

    Parameters

    Returns SS | null

Private readSelectedFile

  • readSelectedFile(e: ChangeEvent<HTMLInputElement>): void
  • Gets files from the given event and tries to read them. Once the file is read successfully, triggers the onChange callback.

    Parameters

    • e: ChangeEvent<HTMLInputElement>

      The event triggered by the user

    Returns void

render

  • render(): Element
  • Renders the component

    Returns Element

setState

  • setState<K>(state: function | null | S | object, callback?: undefined | function): void
  • Type parameters

    • K: keyof __type

    Parameters

    • state: function | null | S | object
    • Optional callback: undefined | function

    Returns void

Optional shouldComponentUpdate

  • shouldComponentUpdate(nextProps: Readonly<FileInputFieldProps>, nextState: Readonly<__type>, nextContext: any): boolean
  • Called to determine whether the change in props and state should trigger a re-render.

    Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed.

    If false is returned, Component#render, componentWillUpdate and componentDidUpdate will not be called.

    Parameters

    Returns boolean

Generated using TypeDoc