ui/build/kanban

Interfaces

KanbanColumnProps

Defined in: apps/website/.api-docs-entry/ui/build/kanban/index.d.ts:61

Properties

cardSnippet

cardSnippet: TCardSnippet;

Defined in: apps/website/.api-docs-entry/ui/build/kanban/index.d.ts:63

column

column: object;

Defined in: apps/website/.api-docs-entry/ui/build/kanban/index.d.ts:62

_id

readonly _id: string;

hasMore?

readonly optional hasMore?: boolean;

isFetchingNextPage?

readonly optional isFetchingNextPage?: boolean;

isLoading?

readonly optional isLoading?: boolean;

items

readonly items: readonly object[];

title

readonly title: string;

totalCount

readonly totalCount: number;

columnHeaderActionSnippet?

optional columnHeaderActionSnippet?: TColumnHeaderActionSnippet;

Defined in: apps/website/.api-docs-entry/ui/build/kanban/index.d.ts:72

columnTitleSnippet?

optional columnTitleSnippet?: TColumnTitleSnippet;

Defined in: apps/website/.api-docs-entry/ui/build/kanban/index.d.ts:73

dragHandleClass?

optional dragHandleClass?: string;

Defined in: apps/website/.api-docs-entry/ui/build/kanban/index.d.ts:71

groupName

groupName: string;

Defined in: apps/website/.api-docs-entry/ui/build/kanban/index.d.ts:68

itemHeight

itemHeight: number;

Defined in: apps/website/.api-docs-entry/ui/build/kanban/index.d.ts:66

minColumnWidth

minColumnWidth: number;

Defined in: apps/website/.api-docs-entry/ui/build/kanban/index.d.ts:67

onCardMove?

optional onCardMove?: (move) => void;

Defined in: apps/website/.api-docs-entry/ui/build/kanban/index.d.ts:64

Parameters

Parameter	Type	Description
move	{ fromColumnId: string; recordId: string; toColumnId: string; toIndex?: number; }	-
move.fromColumnId	string	-
move.recordId	string	-
move.toColumnId	string	-
move.toIndex?	number	Target index in the destination column (from Sortable newIndex).

Returns

void

onLoadMore

onLoadMore: (columnId, lastVirtualIndex) => Effect<void, unknown>;

Defined in: apps/website/.api-docs-entry/ui/build/kanban/index.d.ts:65

Parameters

Parameter	Type
columnId	string
lastVirtualIndex	number

Returns

Effect<void, unknown>

sortable

sortable: boolean;

Defined in: apps/website/.api-docs-entry/ui/build/kanban/index.d.ts:69

sortWithinColumn

sortWithinColumn: boolean;

Defined in: apps/website/.api-docs-entry/ui/build/kanban/index.d.ts:70

---

KanbanProps

Defined in: apps/website/.api-docs-entry/ui/build/kanban/index.d.ts:47

Properties

cardSnippet

cardSnippet: TCardSnippet;

Defined in: apps/website/.api-docs-entry/ui/build/kanban/index.d.ts:50

columnHeaderActionSnippet?

optional columnHeaderActionSnippet?: TColumnHeaderActionSnippet;

Defined in: apps/website/.api-docs-entry/ui/build/kanban/index.d.ts:58

columnTitleSnippet?

optional columnTitleSnippet?: TColumnTitleSnippet;

Defined in: apps/website/.api-docs-entry/ui/build/kanban/index.d.ts:59

dragHandleClass?

optional dragHandleClass?: string;

Defined in: apps/website/.api-docs-entry/ui/build/kanban/index.d.ts:57

groupName?

optional groupName?: string;

Defined in: apps/website/.api-docs-entry/ui/build/kanban/index.d.ts:54

itemHeight

itemHeight: number;

Defined in: apps/website/.api-docs-entry/ui/build/kanban/index.d.ts:52

minColumnWidth?

optional minColumnWidth?: number;

Defined in: apps/website/.api-docs-entry/ui/build/kanban/index.d.ts:53

onCardMove?

optional onCardMove?: (move) => void;

Defined in: apps/website/.api-docs-entry/ui/build/kanban/index.d.ts:49

Parameters

Parameter	Type	Description
move	{ fromColumnId: string; recordId: string; toColumnId: string; toIndex?: number; }	-
move.fromColumnId	string	-
move.recordId	string	-
move.toColumnId	string	-
move.toIndex?	number	Target index in the destination column (from Sortable newIndex).

Returns

void

onLoadMore

onLoadMore: (columnId, lastVirtualIndex) => Effect<void, unknown>;

Defined in: apps/website/.api-docs-entry/ui/build/kanban/index.d.ts:51

Parameters

Parameter	Type
columnId	string
lastVirtualIndex	number

Returns

Effect<void, unknown>

sortable?

optional sortable?: boolean;

Defined in: apps/website/.api-docs-entry/ui/build/kanban/index.d.ts:55

sortWithinColumn?

optional sortWithinColumn?: boolean;

Defined in: apps/website/.api-docs-entry/ui/build/kanban/index.d.ts:56

value

value: object[];

Defined in: apps/website/.api-docs-entry/ui/build/kanban/index.d.ts:48

_id

readonly _id: string;

hasMore?

readonly optional hasMore?: boolean;

isFetchingNextPage?

readonly optional isFetchingNextPage?: boolean;

isLoading?

readonly optional isLoading?: boolean;

items

readonly items: readonly object[];

title

readonly title: string;

totalCount

readonly totalCount: number;

Type Aliases

KanbanCardMove

type KanbanCardMove = typeof KanbanCardMoveSchema.Type;

Defined in: apps/website/.api-docs-entry/ui/build/kanban/index.d.ts:46

---

TCardSnippet

type TCardSnippet = Snippet<[TKanbanItem & object]>;

Defined in: apps/website/.api-docs-entry/ui/build/kanban/index.d.ts:26

---

TColumnHeaderActionSnippet

type TColumnHeaderActionSnippet = Snippet<[{
  columnId: string;
}]>;

Defined in: apps/website/.api-docs-entry/ui/build/kanban/index.d.ts:29

---

TColumnTitleSnippet

type TColumnTitleSnippet = Snippet<[{
  column: TKanbanColumnData;
  columnId: string;
  title: string;
}]>;

Defined in: apps/website/.api-docs-entry/ui/build/kanban/index.d.ts:32

---

TKanbanCardData

type TKanbanCardData = TKanbanItem & object;

Defined in: apps/website/.api-docs-entry/ui/build/kanban/index.d.ts:21

Type Declaration

description?

optional description?: string;

title

title: string;

type

type: "card";

---

TKanbanColumnData

type TKanbanColumnData = typeof TKanbanColumnDataSchema.Type;

Defined in: apps/website/.api-docs-entry/ui/build/kanban/index.d.ts:20

---

TKanbanItem

type TKanbanItem = typeof TKanbanItemSchema.Type;

Defined in: apps/website/.api-docs-entry/ui/build/kanban/index.d.ts:7

Variables

default

const default: object;

Defined in: apps/website/.api-docs-entry/ui/build/kanban/index.d.ts:78

Type Declaration

Column

readonly Column: Component;

Provider

readonly Provider: Component;

---

KanbanCardMoveSchema

const KanbanCardMoveSchema: Schema.Struct<{
  fromColumnId: Schema.String;
  recordId: Schema.String;
  toColumnId: Schema.String;
  toIndex: Schema.optional<Schema.Number>;
}>;

Defined in: apps/website/.api-docs-entry/ui/build/kanban/index.d.ts:39

---

TKanbanColumnDataSchema

const TKanbanColumnDataSchema: Schema.Struct<{
  _id: Schema.String;
  hasMore: Schema.optional<Schema.Boolean>;
  isFetchingNextPage: Schema.optional<Schema.Boolean>;
  isLoading: Schema.optional<Schema.Boolean>;
  items: Schema.$Array<Schema.Struct<{
     _id: Schema.String;
     type: Schema.Literals<readonly ["card", "column"]>;
  }>>;
  title: Schema.String;
  totalCount: Schema.Number;
}>;

Defined in: apps/website/.api-docs-entry/ui/build/kanban/index.d.ts:8

---

TKanbanItemSchema

const TKanbanItemSchema: Schema.Struct<{
  _id: Schema.String;
  type: Schema.Literals<readonly ["card", "column"]>;
}>;

Defined in: apps/website/.api-docs-entry/ui/build/kanban/index.d.ts:3