@jupyterlab/filebrowser
Version:
JupyterLab - FileBrowser Widget
59 lines (58 loc) • 1.62 kB
TypeScript
import { ITranslator } from '@jupyterlab/translation';
import { ToolbarButton } from '@jupyterlab/ui-components';
import { FileBrowserModel } from './model';
import { Contents } from '@jupyterlab/services';
import { ISignal } from '@lumino/signaling';
/**
* A widget which provides an upload button.
*/
export declare class Uploader extends ToolbarButton {
/**
* Construct a new file browser buttons widget.
*/
constructor(options: Uploader.IOptions);
/**
* A signal emitted with file info when a batch of upload completes.
*/
get filesUploaded(): ISignal<this, Contents.IModel[]>;
/**
* The underlying file browser fileBrowserModel for the widget.
*
* This cannot be named model as that conflicts with the model property of VDomRenderer.
*/
readonly fileBrowserModel: FileBrowserModel;
/**
* The 'change' handler for the input field.
*/
private _onInputChanged;
/**
* The 'click' handler for the input field.
*/
private _onInputClicked;
protected translator: ITranslator;
private _trans;
private _input;
private _filesUploaded;
}
/**
* The namespace for Uploader class statics.
*/
export declare namespace Uploader {
/**
* The options used to create an uploader.
*/
interface IOptions {
/**
* A file browser fileBrowserModel instance.
*/
model: FileBrowserModel;
/**
* The language translator.
*/
translator?: ITranslator;
/**
* An optional label.
*/
label?: string;
}
}