A widget which hosts a file browser.

The widget uses the Jupyter Contents API to retrieve contents, and presents itself as a flat list of files and directories with breadcrumbs.

Hierarchy

Constructors

Properties

_content: Panel
_createNew: any
_directoryPending: any
_filePending: any
_header: Panel
_manager: any
_navigateToCurrentDirectory: any
_onConnectionFailure: any

Handle a connection lost signal from the model.

_showFileCheckboxes: any
_showFileSizeColumn: any
_showHiddenFiles: any
_showLastModifiedColumn: any
_sortNotebooksFirst: any
_toolbar: Toolbar<Widget>
crumbs: BreadCrumbs
listing: DirListing
mainPanel: Panel

The model used by the file browser.

Get the DOM node owned by the widget.

translator: ITranslator

Accessors

  • get content(): Panel
  • The content hosted by the widget.

    Returns Panel

  • get dataset(): DOMStringMap
  • The dataset for the widget's DOM node.

    Returns DOMStringMap

  • get disposed(): ISignal<this, void>
  • A signal emitted when the widget is disposed.

    Returns ISignal<this, void>

  • get header(): Panel
  • A panel for widgets that sit on top of the widget.

    Returns Panel

  • get hiddenMode(): HiddenMode
  • Get the method for hiding the widget.

    Returns HiddenMode

  • set hiddenMode(value): void
  • Set the method for hiding the widget.

    Parameters

    • value: HiddenMode

    Returns void

  • get id(): string
  • Get the id of the widget's DOM node.

    Returns string

  • set id(value): void
  • Set the id of the widget's DOM node.

    Parameters

    • value: string

    Returns void

  • get isAttached(): boolean
  • Test whether the widget's node is attached to the DOM.

    Returns boolean

  • get isDisposed(): boolean
  • Test whether the widget has been disposed.

    Returns boolean

  • get isHidden(): boolean
  • Test whether the widget is explicitly hidden.

    Returns boolean

  • get isVisible(): boolean
  • Test whether the widget is visible.

    Notes

    A widget is visible when it is attached to the DOM, is not explicitly hidden, and has no explicitly hidden ancestors.

    Returns boolean

  • get layout(): Layout
  • Get the layout for the widget.

    Returns Layout

  • set layout(value): void
  • Set the layout for the widget.

    Notes

    The layout is single-use only. It cannot be changed after the first assignment.

    The layout is disposed automatically when the widget is disposed.

    Parameters

    • value: Layout

    Returns void

  • Whether to show active file in file browser

    Returns boolean

  • Parameters

    • value: boolean

    Returns void

  • get parent(): Widget
  • Get the parent of the widget.

    Returns Widget

  • set parent(value): void
  • Set the parent of the widget.

    Notes

    Children are typically added to a widget by using a layout, which means user code will not normally set the parent widget directly.

    The widget will be automatically removed from its old parent.

    This is a no-op if there is no effective parent change.

    Parameters

    Returns void

  • get showFileCheckboxes(): boolean
  • Whether to show checkboxes next to files and folders

    Returns boolean

  • set showFileCheckboxes(value): void
  • Parameters

    • value: boolean

    Returns void

  • get showFileSizeColumn(): boolean
  • Whether to show the file size column

    Returns boolean

  • set showFileSizeColumn(value): void
  • Parameters

    • value: boolean

    Returns void

  • get showFullPath(): boolean
  • Whether to show the full path in the breadcrumbs

    Returns boolean

  • set showFullPath(value): void
  • Parameters

    • value: boolean

    Returns void

  • get showHiddenFiles(): boolean
  • Whether to show hidden files

    Returns boolean

  • set showHiddenFiles(value): void
  • Parameters

    • value: boolean

    Returns void

  • get showLastModifiedColumn(): boolean
  • Whether to show the last modified column

    Returns boolean

  • set showLastModifiedColumn(value): void
  • Parameters

    • value: boolean

    Returns void

  • get sortNotebooksFirst(): boolean
  • Whether to sort notebooks above other files

    Returns boolean

  • set sortNotebooksFirst(value): void
  • Parameters

    • value: boolean

    Returns void

  • get title(): Title<Widget>
  • The title object for the widget.

    Notes

    The title object is used by some container widgets when displaying the widget alongside some title, such as a tab panel or side bar.

    Since not all widgets will use the title, it is created on demand.

    The owner property of the title is set to this widget.

    Returns Title<Widget>

  • get toolbar(): Toolbar<Widget>
  • The toolbar hosted by the widget.

    It sits between the header and the content

    Returns Toolbar<Widget>

  • get widgets(): readonly Widget[]
  • A read-only array of the widgets in the content panel.

    Returns readonly Widget[]

Methods

  • Post an 'activate-request' message to the widget.

    Notes

    This is a simple convenience method for posting the message.

    Returns void

  • Add a class name to the widget's DOM node.

    Parameters

    • name: string

      The class name to add to the node.

      Notes

      If the class name is already added to the node, this is a no-op.

      The class name must not contain whitespace.

    Returns void

  • Add a widget to the content panel bottom.

    Parameters

    Returns void

  • Create an iterator over the widget's children.

    Returns IterableIterator<Widget>

    A new iterator over the children of the widget.

    Notes

    The widget must have a populated layout in order to have children.

    If a layout is not installed, the returned iterator will be empty.

  • Clear the given widget flag.

    Notes

    This will not typically be called directly by user code.

    Parameters

    • flag: Flag

    Returns void

  • Returns void

  • Send a 'close-request' message to the widget.

    Notes

    This is a simple convenience method for sending the message.

    Returns void

  • Test whether a widget is a descendant of this widget.

    Parameters

    • widget: Widget

      The descendant widget of interest.

    Returns boolean

    true if the widget is a descendant, false otherwise.

  • Copy the selected items.

    Returns void

  • Create the underlying DirListing instance.

    Parameters

    Returns DirListing

    The created DirListing instance.

  • Cut the selected items.

    Returns void

  • Delete the currently selected item(s).

    Returns Promise<void>

    A promise that resolves when the operation is complete.

  • Dispose of the widget and its descendant widgets.

    Notes

    It is unsafe to use the widget after it has been disposed.

    All calls made to this method after the first are a no-op.

    Returns void

  • Download the currently selected item(s).

    Returns Promise<void>

  • Duplicate the currently selected item(s).

    Returns Promise<void>

    A promise that resolves when the operation is complete.

  • Post a 'fit-request' message to the widget.

    Notes

    This is a simple convenience method for posting the message.

    Returns void

  • cd ..

    Go up one level in the directory tree.

    Returns Promise<void>

  • Test whether the widget's DOM node has the given class name.

    Parameters

    • name: string

      The class name of interest.

    Returns boolean

    true if the node has the class, false otherwise.

  • Hide the widget and make it hidden to its parent widget.

    Notes

    This causes the isHidden property to be true.

    If the widget is explicitly hidden, this is a no-op.

    Returns void

  • Insert a widget at the given position in the content panel.

    Parameters

    Returns void

  • Find a model given a click.

    Parameters

    Returns Contents.IModel

    The model for the selected file.

  • Invoke the message processing routine of the widget's layout.

    Parameters

    • msg: Message

      The message to dispatch to the layout.

      Notes

      This is a no-op if the widget does not have a layout.

      This will not typically be called directly by user code.

    Returns void

  • A message handler invoked on an 'activate-request' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

  • A message handler invoked on an 'after-attach' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

  • A message handler invoked on an 'after-detach' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

  • A message handler invoked on an 'after-hide' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

  • A message handler invoked on an 'after-show' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

  • A message handler invoked on a 'before-attach' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

  • A message handler invoked on a 'before-detach' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

  • A message handler invoked on a 'before-hide' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

  • A message handler invoked on a 'before-show' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

  • A message handler invoked on a 'child-added' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: ChildMessage

    Returns void

  • A message handler invoked on a 'child-removed' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: ChildMessage

    Returns void

  • A message handler invoked on a 'close-request' message.

    Notes

    The default implementation unparents or detaches the widget.

    Parameters

    • msg: Message

    Returns void

  • A message handler invoked on a 'fit-request' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

  • A message handler invoked on a 'resize' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: ResizeMessage

    Returns void

  • A message handler invoked on an 'update-request' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

  • Paste the items from the clipboard.

    Returns Promise<void>

    A promise that resolves when the operation is complete.

  • Process a message sent to the widget.

    Parameters

    • msg: Message

      The message sent to the widget.

      Notes

      Subclasses may reimplement this method as needed.

    Returns void

  • Remove a class name from the widget's DOM node.

    Parameters

    • name: string

      The class name to remove from the node.

      Notes

      If the class name is not yet added to the node, this is a no-op.

      The class name must not contain whitespace.

    Returns void

  • Rename the first currently selected item.

    Returns Promise<string>

    A promise that resolves with the new name of the item.

  • Select an item by name.

    Parameters

    • name: string

      The name of the item to select.

    Returns Promise<void>

  • Select next item.

    Returns void

  • Select previous item.

    Returns void

  • Create an iterator over the listing's selected items.

    Returns IterableIterator<Contents.IModel>

    A new iterator over the listing's selected items.

  • Set the given widget flag.

    Notes

    This will not typically be called directly by user code.

    Parameters

    • flag: Flag

    Returns void

  • Show or hide the widget according to a boolean value.

    Parameters

    • hidden: boolean

      true to hide the widget, or false to show it.

      Notes

      This is a convenience method for hide() and show().

    Returns void

  • Show the widget and make it visible to its parent widget.

    Notes

    This causes the isHidden property to be false.

    If the widget is not explicitly hidden, this is a no-op.

    Returns void

  • Shut down kernels on the applicable currently selected items.

    Returns Promise<void>

    A promise that resolves when the operation is complete.

  • Test whether the given widget flag is set.

    Notes

    This will not typically be called directly by user code.

    Parameters

    • flag: Flag

    Returns boolean

  • Toggle a class name on the widget's DOM node.

    Parameters

    • name: string

      The class name to toggle on the node.

    • Optional force: boolean

      Whether to force add the class (true) or force remove the class (false). If not provided, the presence of the class will be toggled from its current state.

    Returns boolean

    true if the class is now present, false otherwise.

    Notes

    The class name must not contain whitespace.

  • Post an 'update-request' message to the widget.

    Notes

    This is a simple convenience method for posting the message.

    Returns void

Generated using TypeDoc