# All files / src/Dropzone Dropzone.types.ts

100% Statements 2/2
100% Branches 0/0
100% Functions 0/0
100% Lines 2/2

Press n or j to go to the next uncovered block, b, p or k for the previous block.

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265
    266
    267
    268
    269
    270
    271
    272
    273
    274
    275
    276
    277
    278
    279
    280
    281
    282
    283
    284
    285
    286
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318
    319
    320
    321
    322
    323
    324
    325
    326
    327
    328
    329
    330
    331
    332
    333
    334
    335
    336

    5x

    5x

     import React from 'react'
    import {
      DropzoneInputProps as DropzoneInputPropsBase,
      DropzoneOptions,
      DropzoneRootProps as DropzoneRootPropsBase,
      DropzoneState,
      FileError as FileRejectionError,
      FileRejection,
    } from 'react-dropzone'

    export type DropzoneFile = any

    export type FileRejectionReason = FileRejectionError['code']

    export const fileRejectionReason: Record<string, FileRejectionReason> = {
      maxFiles: 'too-many-files',
      maxFileSize: 'file-too-large',
      minFileSize: 'file-too-small',
      fileType: 'file-invalid-type',
    }

    export { FileRejection, FileRejectionError }

    export interface DropzoneErrorBannerProps {
      /**
       * @since 10.19.0
       */
      error: DropzoneHookState['dropError']

      /**
       * Rejected files and why they were rejected
       * <CodeBlock>
       *  {`{
       *   file: File,
       *   errors: FileError[]
       *  }[]`}
       * </CodeBlock>
       * @since 10.19.0
       */
      fileRejections: DropzoneHookState['fileRejections']
      /**
       * @since 10.19.0
       */
      onDismiss: () => void
      /**
       * @since 10.19.0
       */
      className?: string
      /**
       * @since 10.19.0
       */
      qa?: {
        showErrorDetails?: string
        hideError?: string
      }
    }

    export interface MultipleErrorsProps {
      /**
       * @since 10.19.0
       */
      fileRejections: FileRejection[]
      /**
       * @since 10.19.0
       */
      maxFiles?: number
      /**
       * @since 10.19.0
       */
      maxSize?: number
      /**
       * @since 10.19.0
       */
      minSize?: number
    }

    export interface ContainerProps {
      /**
       * Additional props for dropzone container element
       * @since 10.19.0
       */
      rootProps: DropzoneRootProps

      /**
       * Returns the props you should apply to the root drop container you render
       * @since 10.19.0
       */
      getRootProps: DropzoneState['getRootProps']
      /**
       * @since 10.19.0
       */
      active: boolean

      /**
       * Enable/disable the dropzone container
       * @since 10.19.0
       */
      disabled: boolean
    }
    export interface ContentProps {
      /**
       * Force icon visibility
       * <Code>NOTICE:</Code> passing <Code>true</Code> or <Code>false</Code>
       * value explicitly will make component ignore resizing.
       * @since 10.19.0
       */
      isIconVisible: boolean

      /**
       * Enable/disable the dropzone content
       * @since 10.19.0
       */
      disabled: boolean
      /**
       * @since 10.19.0
       */
      contentMessage: React.ReactNode
    }

    export interface DropzoneContentProps {
      /**
       * Open the native file selection dialog
       * @since 10.19.0
       */
      open: () => void

      /**
       * Enable/disable the dropzone content
       * @since 10.19.0
       */
      disabled: boolean
      /**
       * @since 10.19.0
       */
      errorMessage?: string
    }

    export interface DropzoneHookProps
      extends Partial<Omit<DropzoneOptions, 'minSize' | 'maxSize'>> {
      /**
       * Array of already selected items
       * @since 10.19.0
       */
      value?: DropzoneFile[]

      /**
       * Maximum number files to the dropzone is allowed. All files above the limit
       * will be rejected.
       * @since 10.19.0
       */
      maxFileNumber?: number

      /**
       * Minimum file size (in bytes)
       * @since 10.19.0
       */
      minFileSize?: DropzoneOptions['minSize']

      /**
       * Maximum file size (in bytes)
       * @since 10.19.0
       */
      maxFileSize?: DropzoneOptions['maxSize']
    }

    export const dropErrors = {
      fileType: 'FILE_TYPE_ERROR',
      fileAmount: 'FILE_AMOUNT_ERROR',
      maxFileSize: 'MAX_FILE_SIZE',
      minFileSize: 'MIN_FILE_SIZE',
      oneFileAtATime: 'ONE_FILE_AT_A_TIME',
      multipleErrors: 'MULTIPLE_ERRORS',
      reset: 'RESET',
    } as const

    export type DropErrorType = typeof dropErrors[keyof typeof dropErrors]

    export type DropError = {
      /**
       * @since 10.19.0
       */
      type: DropErrorType
      /**
       * @since 10.19.0
       */
      title: string
      /**
       * @since 10.19.0
       */
      message: string
      /**
       * @since 10.19.0
       */
      body?: React.ReactNode
    }

    export type DropzoneHookState = DropzoneState & {
      /**
       * Allow drag 'n' drop (or selection from the file dialog) of multiple files
       * @default false
       * @since 10.19.0
       * */
      multiple: boolean

      /**
       * Error message if dragged files is rejected
       * <CodeBlock>
       *  {`{ type: DropErrorType, title: string, message: string }`}
       * </CodeBlock>
       * @since 10.19.0
       */
      dragError: string

      /**
       * Error message if dropped files is rejected
       * <CodeBlock>
       *  {`{ type: DropErrorType, title: string, message: string }`}
       * </CodeBlock>
       * @since 10.19.0
       */
      dropError: DropError

      /**
       * Enable/disable the dropzone
       * @default false
       * @since 10.19.0
       */
      disabled: boolean

      /**
       * Sets <Code>dropError</Code>.
       * <CodeBlock>{'(error: DropErrorType) => void'}</CodeBlock>
       * @since 10.19.0
       */
      dispatchDropError: (error: DropErrorType) => void
    }

    /**
     * WARNING
     * To keep component work as expected according to props passed to `useDropzone` hook
     * Some properties are omitted
     */
    type FrozenDropzoneRootKeys = 'disabled'

    type FrozenDropzoneRootProps = {
      [key in FrozenDropzoneRootKeys]?: never
    }

    type FrozenDropzoneInputKeys = 'accept' | 'multiple' | 'type'

    type FrozenDropzoneInputProps = {
      [key in FrozenDropzoneInputKeys]: never
    }

    export type DropzoneRootProps = DropzoneRootPropsBase & FrozenDropzoneRootProps

    export type DropzoneInputProps = DropzoneInputPropsBase &
      FrozenDropzoneInputProps

    export interface QaTags {
      /**
       * @since 10.19.0
       */
      dropzone?: string
      /**
       * @since 10.19.0
       */
      showErrorDetails?: string
      /**
       * @since 10.19.0
       */
      hideError?: string
    }

    export interface DropzoneProps extends DropzoneHookState {
      /**
       * Render prop to specify a custom dropzone body message
       * @since 10.19.0
       */
      contentRenderer?: (props: DropzoneContentProps) => React.ReactNode
      /**
       * <Code>NOTICE:</Code>
       * <br/>
       * <Code>true</Code> - will make Icon always visible, despite the component height
       * <br/>
       * <Code>false</Code> - will make Icon always hide, despite the component height
       * <br/>
       * <Code>undefined</Code> - will look on the component height to decide show or hide Icon
       * @since 10.19.0
       */
      isIconVisible?: boolean

      /**
       * Dropzone tooltip content
       * @since 10.19.0
       */
      tooltip?: React.ReactNode | string

      /**
       * Additional props for dropzone element
       * @since 10.19.0
       */
      rootProps?: DropzoneRootProps

      /**
       * Additional props for input element
       * @since 10.19.0
       */
      inputProps?: DropzoneInputProps
      /**
       * @since 10.19.0
       */
      className?: string
      /**
       * @since 10.19.0
       */
      qa?: QaTags
    }

    export interface DropzoneRef {
      /**
       * @since 10.19.0
       */
      rootRef: React.RefObject<HTMLElement>
      /**
       * @since 10.19.0
       */
      inputRef: React.RefObject<HTMLInputElement>

      /**
       * Open the native file selection dialog
       * @since 10.19.0
       */
      open: () => void
    }