Interface IRenderer

The render interface for file browser listing options.

interface IRenderer {
    getCheckboxNode: ((node) => null | HTMLInputElement);
    createDragImage(node, count, trans, fileType?): HTMLElement;
    createItemNode(hiddenColumns?): HTMLElement;
    createNode(): HTMLElement;
    getNameNode(node): HTMLElement;
    handleHeaderClick(node, event): null | DirListing.ISortState;
    populateHeaderNode(node, translator?, hiddenColumns?): void;
    updateItemModified?(modified, modifiedDate, modifiedStyle): void;
    updateItemNode(node, model, fileType?, translator?, hiddenColumns?, selected?, modifiedStyle?): void;
}

Implemented by

DirListing.Renderer

Index

Properties

getCheckboxNode

Methods

createDragImage createItemNode createNode getNameNode handleHeaderClick populateHeaderNode updateItemModified? updateItemNode

Properties

getCheckboxNode

getCheckboxNode: ((node) => null | HTMLInputElement)

Get the checkbox input element node.

Downstream interface implementations,such as jupyterlab-unfold, that don't support checkboxes should simply always return null for this function.

Type declaration

- (node): null | HTMLInputElement
- Parameters
  - node: HTMLElement
    A node created by [[createItemNode]] or [[createHeaderItemNode]]
  Returns null | HTMLInputElement

Returns

The checkbox node.

Methods

createDragImage

createDragImage(node, count, trans, fileType?): HTMLElement
Create an appropriate drag image for an item.
Parameters
- node: HTMLElement
  A node created by [[createItemNode]].
- count: number
  The number of items being dragged.
- trans: IRenderMime.TranslationBundle
- Optional fileType: DocumentRegistry.IFileType
  The file type of the item, if applicable.
Returns HTMLElement
An element to use as the drag image.
- Defined in packages/filebrowser/src/listing.ts:2329

createItemNode

createItemNode(hiddenColumns?): HTMLElement
Create a new item node for a dir listing.
Parameters
- Optional hiddenColumns: Set<ToggleableColumn>
Returns HTMLElement
A new DOM node to use as a content item.
- Defined in packages/filebrowser/src/listing.ts:2255

createNode

createNode(): HTMLElement
Create the DOM node for a dir listing.

Returns HTMLElement
- Defined in packages/filebrowser/src/listing.ts:2226

getNameNode

getNameNode(node): HTMLElement
Get the node containing the file name.
Parameters
- node: HTMLElement
  A node created by [[createItemNode]].
Returns HTMLElement
The node containing the file name.
- Defined in packages/filebrowser/src/listing.ts:2302

handleHeaderClick

handleHeaderClick(node, event): null | DirListing.ISortState
Handle a header click.
Parameters
- node: HTMLElement
  A node populated by [[populateHeaderNode]].
- event: MouseEvent
  A click event on the node.
Returns null | DirListing.ISortState
The sort state of the header after the click event.
- Defined in packages/filebrowser/src/listing.ts:2248

populateHeaderNode

populateHeaderNode(node, translator?, hiddenColumns?): void
Populate and empty header node for a dir listing.
Parameters
- node: HTMLElement
  The header node to populate.
- Optional translator: ITranslator
- Optional hiddenColumns: Set<ToggleableColumn>
Returns void
- Defined in packages/filebrowser/src/listing.ts:2233

`Optional` updateItemModified

updateItemModified(modified, modifiedDate, modifiedStyle): void
Update an item's last modified date.
Parameters
- modified: HTMLElement
  Element containing the file's last modified date.
- modifiedDate: string
  String representation of the last modified date.
- modifiedStyle: HumanStyle
  The date style for the modified column: narrow, short, or long
Returns void
- Defined in packages/filebrowser/src/listing.ts:2268

updateItemNode

updateItemNode(node, model, fileType?, translator?, hiddenColumns?, selected?, modifiedStyle?): void
Update an item node to reflect the current state of a model.
Parameters
- node: HTMLElement
  A node created by [[createItemNode]].
- model: Contents.IModel
  The model object to use for the item state.
- Optional fileType: DocumentRegistry.IFileType
  The file type of the item, if applicable.
- Optional translator: ITranslator
- Optional hiddenColumns: Set<ToggleableColumn>
- Optional selected: boolean
- Optional modifiedStyle: HumanStyle
  The date style for the modified column: narrow, short, or long
Returns void
- Defined in packages/filebrowser/src/listing.ts:2285