kanban

Interfaces

KanbanProps

Defined in: packages/ui/build/kanban/index.d.ts:40

Properties

cardSnippet

cardSnippet: TCardSnippet;

Defined in: packages/ui/build/kanban/index.d.ts:43

columnHeaderActionSnippet?

optional columnHeaderActionSnippet?: TColumnHeaderActionSnippet;

Defined in: packages/ui/build/kanban/index.d.ts:51

columnTitleSnippet?

optional columnTitleSnippet?: TColumnTitleSnippet;

Defined in: packages/ui/build/kanban/index.d.ts:52

dragHandleClass?

optional dragHandleClass?: string;

Defined in: packages/ui/build/kanban/index.d.ts:50

groupName?

optional groupName?: string;

Defined in: packages/ui/build/kanban/index.d.ts:47

itemHeight

itemHeight: number;

Defined in: packages/ui/build/kanban/index.d.ts:45

minColumnWidth?

optional minColumnWidth?: number;

Defined in: packages/ui/build/kanban/index.d.ts:46

onCardMove?

optional onCardMove?: (move) => void;

Defined in: packages/ui/build/kanban/index.d.ts:42

Parameters

Parameter	Type
move	KanbanCardMove

Returns

void

onLoadMore

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

Defined in: packages/ui/build/kanban/index.d.ts:44

Parameters

Parameter	Type
columnId	string
lastVirtualIndex	number

Returns

Promise<void>

sortable?

optional sortable?: boolean;

Defined in: packages/ui/build/kanban/index.d.ts:48

sortWithinColumn?

optional sortWithinColumn?: boolean;

Defined in: packages/ui/build/kanban/index.d.ts:49

value

value: TKanbanColumnData[];

Defined in: packages/ui/build/kanban/index.d.ts:41

---

TKanbanCardData

Defined in: packages/ui/build/kanban/index.d.ts:15

Extends

• TKanbanItem

Properties

_id

_id: string;

Defined in: packages/ui/build/kanban/index.d.ts:3

Inherited from

TKanbanItem._id

description?

optional description?: string;

Defined in: packages/ui/build/kanban/index.d.ts:18

title

title: string;

Defined in: packages/ui/build/kanban/index.d.ts:17

type

type: "card";

Defined in: packages/ui/build/kanban/index.d.ts:16

Overrides

TKanbanItem.type

---

TKanbanColumnData

Defined in: packages/ui/build/kanban/index.d.ts:6

Properties

_id

_id: string;

Defined in: packages/ui/build/kanban/index.d.ts:7

hasMore?

optional hasMore?: boolean;

Defined in: packages/ui/build/kanban/index.d.ts:11

isFetchingNextPage?

optional isFetchingNextPage?: boolean;

Defined in: packages/ui/build/kanban/index.d.ts:13

isLoading?

optional isLoading?: boolean;

Defined in: packages/ui/build/kanban/index.d.ts:12

items

items: TKanbanItem[];

Defined in: packages/ui/build/kanban/index.d.ts:9

title

title: string;

Defined in: packages/ui/build/kanban/index.d.ts:8

totalCount

totalCount: number;

Defined in: packages/ui/build/kanban/index.d.ts:10

---

TKanbanItem

Defined in: packages/ui/build/kanban/index.d.ts:2

Extended by

• TKanbanCardData

Properties

_id

_id: string;

Defined in: packages/ui/build/kanban/index.d.ts:3

type

type: "card" | "column";

Defined in: packages/ui/build/kanban/index.d.ts:4

Type Aliases

Column

type Column = ReturnType<typeof Column>;

Defined in: packages/ui/build/kanban/kanban-column.svelte.d.ts:16

---

KanbanCardMove

type KanbanCardMove = object;

Defined in: packages/ui/build/kanban/index.d.ts:33

Properties

Property	Type	Description	Defined in
fromColumnId	string	-	packages/ui/build/kanban/index.d.ts:35
recordId	string	-	packages/ui/build/kanban/index.d.ts:34
toColumnId	string	-	packages/ui/build/kanban/index.d.ts:36
toIndex?	number	Target index in the destination column (from Sortable newIndex).	packages/ui/build/kanban/index.d.ts:38

---

Provider

type Provider = ReturnType<typeof Provider>;

Defined in: packages/ui/build/kanban/kanban.svelte.d.ts:16

---

TCardSnippet

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

Defined in: packages/ui/build/kanban/index.d.ts:20

---

TColumnHeaderActionSnippet

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

Defined in: packages/ui/build/kanban/index.d.ts:23

---

TColumnTitleSnippet

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

Defined in: packages/ui/build/kanban/index.d.ts:26

Variables

Column

const Column: Component;

Defined in: packages/ui/build/kanban/kanban-column.svelte.d.ts:16

---

default

const default: object;

Defined in: packages/ui/build/kanban/index.d.ts:57

Type Declaration

Column

readonly Column: Component;

Provider

readonly Provider: Component;

---

Provider

const Provider: Component;

Defined in: packages/ui/build/kanban/kanban.svelte.d.ts:16