Interface ViewData

interface ViewData {
    caption?: string;
    columns?: Column[];
    defaultSortKey?: string;
    emptyCaption?: string;
    emptyTitle?: string;
    emptyView?: (div: HTMLDivElement) => void;
    expanded?: boolean;
    getContents: (path: string) => Promise<ContentsWithRoot>;
    icon: string;
    id: string;
    loadChildViews?: (view: View) => Promise<void>;
    name: string;
    order?: number;
    params?: Record<string, string>;
    parent?: string;
    sticky?: boolean;
}

Implemented by

Properties

caption? columns? defaultSortKey? emptyCaption? emptyTitle? emptyView? expanded? getContents icon id loadChildViews? name order? params? parent? sticky?

Properties

Optionalcaption

caption?: string

Translated accessible description of the view

Optionalcolumns

columns?: Column[]

This view column(s). Name and actions are by default always included

OptionaldefaultSortKey

defaultSortKey?: string

Will be used as default if the user haven't customized their sorting column

OptionalemptyCaption

emptyCaption?: string

Translated description of the empty view

OptionalemptyTitle

emptyTitle?: string

Translated title of the empty view

OptionalemptyView

emptyView?: (div: HTMLDivElement) => void

The empty view element to render your empty content into

Optionalexpanded

expanded?: boolean

This view has children and is expanded (by default) or not. This will be overridden by user config.

getContents

getContents: (path: string) => Promise<ContentsWithRoot>

Method return the content of the provided path This ideally should be a cancellable promise. promise.cancel(reason) will be called when the directory change and the promise is not resolved yet. You must also return the current directory information alongside with its content.

icon

icon: string

The view icon as an inline svg

id

id: string

Unique view ID

OptionalloadChildViews

loadChildViews?: (view: View) => Promise<void>

Method called to load child views if any

name

name: string

Translated view name

Optionalorder

order?: number

The view order. If not set will be natural sorted by view name.

Optionalparams

params?: Record<string, string>

Custom params to give to the router on click If defined, will be treated as a dummy view and will just redirect and not fetch any contents.

Optionalparent

parent?: string

The parent unique ID

Optionalsticky

sticky?: boolean

This view is sticky (sent at the bottom)

Settings

Member Visibility

On This Page

Properties