UNPKG

2.27 kBTypeScriptView Raw
1import { ITranslator } from '@jupyterlab/translation';
2import { Message } from '@lumino/messaging';
3import { Widget } from '@lumino/widgets';
4import { FileBrowserModel } from './model';
5/**
6 * A class which hosts folder breadcrumbs.
7 */
8export declare class BreadCrumbs extends Widget {
9 /**
10 * Construct a new file browser crumb widget.
11 *
12 * @param model - The file browser view model.
13 */
14 constructor(options: BreadCrumbs.IOptions);
15 /**
16 * Handle the DOM events for the bread crumbs.
17 *
18 * @param event - The DOM event sent to the widget.
19 *
20 * #### Notes
21 * This method implements the DOM `EventListener` interface and is
22 * called in response to events on the panel's DOM node. It should
23 * not be called directly by user code.
24 */
25 handleEvent(event: Event): void;
26 /**
27 * A message handler invoked on an `'after-attach'` message.
28 */
29 protected onAfterAttach(msg: Message): void;
30 /**
31 * A message handler invoked on a `'before-detach'` message.
32 */
33 protected onBeforeDetach(msg: Message): void;
34 /**
35 * A handler invoked on an `'update-request'` message.
36 */
37 protected onUpdateRequest(msg: Message): void;
38 /**
39 * Handle the `'click'` event for the widget.
40 */
41 private _evtClick;
42 /**
43 * Handle the `'lm-dragenter'` event for the widget.
44 */
45 private _evtDragEnter;
46 /**
47 * Handle the `'lm-dragleave'` event for the widget.
48 */
49 private _evtDragLeave;
50 /**
51 * Handle the `'lm-dragover'` event for the widget.
52 */
53 private _evtDragOver;
54 /**
55 * Handle the `'lm-drop'` event for the widget.
56 */
57 private _evtDrop;
58 protected translator: ITranslator;
59 private _trans;
60 private _model;
61 private _hasPreferred;
62 private _crumbs;
63 private _crumbSeps;
64}
65/**
66 * The namespace for the `BreadCrumbs` class statics.
67 */
68export declare namespace BreadCrumbs {
69 /**
70 * An options object for initializing a bread crumb widget.
71 */
72 interface IOptions {
73 /**
74 * A file browser model instance.
75 */
76 model: FileBrowserModel;
77 /**
78 * The application language translator.
79 */
80 translator?: ITranslator;
81 }
82}