@serenity-is / Modules / corelib/slick

Module: corelib/slick

This is the main entry point for @serenity-is/corelib/slick module. This module mainly contains some Serenity specific extensions for sleekgrid like RemoteView.

The types from this module are available by importing from "@serenity-is/corelib/slick" module:

import { RemoteView } from "@serenity-is/corelib/slick";
export class MyCustomView extends RemoveView {
}

When using classic namespaces instead of the ESM modules, the types and functions in this module are directly available from the global Slick namespace. e.g. Slick.RemoveView

Table of contents

Namespaces

• AggregateFormatting
• Aggregators

Classes

• RemoteView

Interfaces

• Formatter
• GroupInfo
• PagerOptions
• PagingInfo
• PagingOptions
• RemoteViewOptions
• SummaryOptions

Type Aliases

• CancellableViewCallback
• Format
• RemoteViewAjaxCallback
• RemoteViewFilter
• RemoteViewProcessCallback

Type Aliases

CancellableViewCallback

Ƭ CancellableViewCallback<TEntity>: (view: RemoteView<TEntity>) => boolean | void

Type parameters

Name
TEntity

Type declaration

▸ (view): boolean | void

Parameters

Name	Type
view	RemoteView<TEntity>

Returns

boolean | void

Defined in

src/slick/remoteview.ts:37

---

Format

Ƭ Format<TItem>: (ctx: FormatterContext<TItem>) => string

Type parameters

Name	Type
TItem	any

Type declaration

▸ (ctx): string

Parameters

Name	Type
ctx	FormatterContext<TItem>

Returns

string

Defined in

src/slick/slicktypes.ts:4

---

RemoteViewAjaxCallback

Ƭ RemoteViewAjaxCallback<TEntity>: (view: RemoteView<TEntity>, options: JQueryAjaxSettings) => boolean | void

Type parameters

Name
TEntity

Type declaration

▸ (view, options): boolean | void

Parameters

Name	Type
view	RemoteView<TEntity>
options	JQueryAjaxSettings

Returns

boolean | void

Defined in

src/slick/remoteview.ts:38

---

RemoteViewFilter

Ƭ RemoteViewFilter<TEntity>: (item: TEntity, view: RemoteView<TEntity>) => boolean

Type parameters

Name
TEntity

Type declaration

▸ (item, view): boolean

Parameters

Name	Type
item	TEntity
view	RemoteView<TEntity>

Returns

boolean

Defined in

src/slick/remoteview.ts:39

---

RemoteViewProcessCallback

Ƭ RemoteViewProcessCallback<TEntity>: (data: ListResponse<TEntity>, view: RemoteView<TEntity>) => ListResponse<TEntity>

Type parameters

Name
TEntity

Type declaration

▸ (data, view): ListResponse<TEntity>

Parameters

Name	Type
data	ListResponse<TEntity>
view	RemoteView<TEntity>

Returns

ListResponse<TEntity>

Defined in

src/slick/remoteview.ts:40