UNPKG

2.01 kBTypeScriptView Raw
1import Uppy = require('@uppy/core')
2import StatusBar = require('@uppy/status-bar')
3import DashboardLocale = require('./generatedLocale')
4
5type FieldRenderOptions = {
6 value: string,
7 onChange: (newVal: string) => void
8}
9
10type PreactRender = (node: any, params: object | null, ...children: any[]) => any
11
12interface MetaField {
13 id: string
14 name: string
15 placeholder?: string
16 render?: (field: FieldRenderOptions, h: PreactRender) => any
17}
18
19declare module Dashboard {
20 interface DashboardOptions extends Uppy.PluginOptions {
21 animateOpenClose?: boolean
22 browserBackButtonClose?: boolean
23 closeAfterFinish?: boolean
24 closeModalOnClickOutside?: boolean
25 disableInformer?: boolean
26 disablePageScrollWhenModalOpen?: boolean
27 disableStatusBar?: boolean
28 disableThumbnailGenerator?: boolean
29 height?: string | number
30 hideCancelButton?: boolean
31 hidePauseResumeButton?: boolean
32 hideProgressAfterFinish?: boolean
33 hideRetryButton?: boolean
34 hideUploadButton?: boolean
35 inline?: boolean
36 locale?: DashboardLocale & StatusBar.StatusBarLocale
37 metaFields?: MetaField[]
38 note?: string | null
39 onRequestCloseModal?: () => void
40 plugins?: string[]
41 fileManagerSelectionType?: 'files' | 'folders' | 'both';
42 proudlyDisplayPoweredByUppy?: boolean
43 showLinkToFileUploadResult?: boolean
44 showProgressDetails?: boolean
45 showSelectedFiles?: boolean
46 showRemoveButtonAfterComplete?: boolean
47 replaceTargetContent?: boolean
48 target?: Uppy.PluginTarget
49 theme?: 'auto' | 'dark' | 'light'
50 thumbnailWidth?: number
51 trigger?: string
52 width?: string | number
53 autoOpenFileEditor?: boolean
54 disabled?: boolean
55 }
56}
57
58declare class Dashboard extends Uppy.Plugin<Dashboard.DashboardOptions> {
59 addTarget (plugin: Uppy.Plugin): HTMLElement
60 hideAllPanels (): void
61 openModal (): void
62 closeModal (): void
63 isModalOpen (): boolean
64 render (state: object): void
65 install (): void
66 uninstall (): void
67}
68
69export = Dashboard