Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ImageUpload<SS>

Type parameters

  • SS

Hierarchy

Index

Constructors

constructor

Properties

Static FILE_UPLOAD_STATUS

FILE_UPLOAD_STATUS: FILE_UPLOAD_STATUS = FILE_UPLOAD_STATUS

Accessors

fileList

  • get fileList(): P["fileList"]

isControlled

  • get isControlled(): boolean

remainAmount

  • get remainAmount(): number

Methods

Optional UNSAFE_componentWillMount

  • UNSAFE_componentWillMount(): void

Optional UNSAFE_componentWillReceiveProps

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

Optional UNSAFE_componentWillUpdate

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 component is mounted. Setting state here will trigger re-rendering.

    Returns void

Optional componentDidUpdate

  • 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

Optional componentWillReceiveProps

  • componentWillReceiveProps(nextProps: Readonly<IImageUploadProps>, nextContext: any): 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

Protected createNewUploadFileItem

  • createNewUploadFileItem(file: File): Promise<IImageUploadFileItem & { _file?: File; _id?: string }>

deleteUploadItem

emitOnError

  • emitOnError(type: Type, data: IUploadErrorMessageConfigMap[Type]): void

emitOnUpload

Optional getSnapshotBeforeUpdate

  • 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

Protected getUploadSuccessOverrideProps

onTriggerUploadFile

  • onTriggerUploadFile(file: File): Promise<void>

render

  • render(): Element

Protected renderTips

  • renderTips(): React.ReactNode

Protected renderTrigger

Protected renderUploadList

retryUploadItem

Optional shouldComponentUpdate

  • 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

updateFileList

updateUploadItem

updateUploadItemPercent

  • updateUploadItemPercent(updateItemId: string, percent: number): void

updateUploadItemStatusToFailed

  • updateUploadItemStatusToFailed(updateItemId: string): void

updateUploadItemStatusToSuccess

Static getDerivedStateFromProps

Object literals

Static defaultProps

defaultProps: object

accept

accept: string = "image/*"

getThumbSrcFromFile

getThumbSrcFromFile: defaultGetThumbSrcFromFile = defaultGetThumbSrcFromFile

manualUpload

manualUpload: false = false

maxAmount

maxAmount: number = DEFAULT_MAX_AMOUNT

maxSize

maxSize: number = DEFAULT_MAX_SIZE

multiple

multiple: false = DEFAULT_ENABLE_MULTIPLE

preview

preview: defaultPreview = defaultPreview

Generated using TypeDoc