BlockSuite API Documentation / @blocksuite/data-view / DataViewProps

Interface: DataViewProps<T, Selection>

Defined in: packages/affine/data-view/src/core/view/types.ts:20

Type Parameters

T

T extends SingleView = SingleView

Selection

Selection extends DataViewSelection = DataViewSelection

Properties

bindHotkey()

bindHotkey: (hotkeys) => Disposable

Defined in: packages/affine/data-view/src/core/view/types.ts:31

Parameters

hotkeys

Record<string, UIEventHandler>

Returns

Disposable

---

clipboard

clipboard: Clipboard

Defined in: packages/affine/data-view/src/core/view/types.ts:43

---

dataSource

dataSource: DataSource

Defined in: packages/affine/data-view/src/core/view/types.ts:29

---

dataViewEle

dataViewEle: DataViewRenderer

Defined in: packages/affine/data-view/src/core/view/types.ts:24

---

eventTrace

eventTrace: EventTraceFn<DatabaseAllViewEvents>

Defined in: packages/affine/data-view/src/core/view/types.ts:49

---

handleEvent()

handleEvent: (name, handler) => Disposable

Defined in: packages/affine/data-view/src/core/view/types.ts:33

Parameters

name

"blur" | "click" | "copy" | "cut" | "focus" | "paste" | "wheel" | "doubleClick" | "tripleClick" | "pointerDown" | "pointerMove" | "pointerUp" | "pointerOut" | "dragStart" | "dragMove" | "dragEnd" | "pinch" | "pan" | "keyDown" | "keyUp" | "selectionChange" | "compositionStart" | "compositionUpdate" | "compositionEnd" | "nativeDragStart" | "nativeDragMove" | "nativeDragEnd" | "nativeDrop" | "nativeDragOver" | "nativeDragLeave" | "beforeInput" | "contextMenu"

handler

UIEventHandler

Returns

Disposable

---

headerWidget?

optional headerWidget: DataViewWidget

Defined in: packages/affine/data-view/src/core/view/types.ts:26

---

notification

notification: object

Defined in: packages/affine/data-view/src/core/view/types.ts:45

toast()

toast: (message) => void

Parameters

message

string

Returns

void

---

onDrag()?

optional onDrag: (evt, id) => () => void

Defined in: packages/affine/data-view/src/core/view/types.ts:41

Parameters

evt

MouseEvent

id

string

Returns

Function

Returns

void

---

selection$

selection$: ReadonlySignal<undefined | Selection>

Defined in: packages/affine/data-view/src/core/view/types.ts:37

---

setSelection()

setSelection: (selection?) => void

Defined in: packages/affine/data-view/src/core/view/types.ts:35

Parameters

selection?

Selection

Returns

void

---

view

view: T

Defined in: packages/affine/data-view/src/core/view/types.ts:28

---

virtualPadding$

virtualPadding$: ReadonlySignal<number>

Defined in: packages/affine/data-view/src/core/view/types.ts:39