BlockSuite API Documentation / @blocksuite/blocks / AttachmentBlockModel

Class: AttachmentBlockModel

Contents

• Extends
• Constructors
  • new AttachmentBlockModel(undefined)
• Properties
  • caption?
  • childrenUpdated
  • created
  • deleted
  • embed
  • flavour
  • id
  • keys
  • name
  • page
  • pop
  • propsUpdated
  • role
  • size
  • sourceId?
  • stash
  • text?
  • type
  • yBlock
• Accessors
  • childMap
  • children
• Methods
  • clone()
  • dispose()
  • firstChild()
  • isEmpty()
  • lastChild()
  • lastItem()

Extends

• BlockModel<AttachmentBlockProps>

Constructors

new AttachmentBlockModel(undefined)

new AttachmentBlockModel(): AttachmentBlockModel

Returns

AttachmentBlockModel

Inherited from

@blocksuite/store.BlockModel.constructor

Source

packages/store/dist/schema/base.d.ts:100

Properties

caption?

caption?: string

Inherited from

BlockModel.caption

Source

packages/blocks/src/attachment-block/attachment-model.ts:28

---

childrenUpdated

childrenUpdated: Slot<void>

Inherited from

@blocksuite/store.BlockModel.childrenUpdated

Source

packages/store/dist/schema/base.d.ts:116

---

created

created: Slot<void>

Inherited from

@blocksuite/store.BlockModel.created

Source

packages/store/dist/schema/base.d.ts:111

---

deleted

deleted: Slot<void>

Inherited from

@blocksuite/store.BlockModel.deleted

Source

packages/store/dist/schema/base.d.ts:112

---

embed

embed: undefined | boolean

Whether to show the attachment as an embed view.

Inherited from

BlockModel.embed

Source

packages/blocks/src/attachment-block/attachment-model.ts:37

---

flavour

flavour: string

Inherited from

@blocksuite/store.BlockModel.flavour

Source

packages/store/dist/schema/base.d.ts:102

---

id

id: string

Inherited from

@blocksuite/store.BlockModel.id

Source

packages/store/dist/schema/base.d.ts:105

---

keys

keys: string[]

Inherited from

@blocksuite/store.BlockModel.keys

Source

packages/store/dist/schema/base.d.ts:107

---

name

name: string

Inherited from

BlockModel.name

Source

packages/blocks/src/attachment-block/attachment-model.ts:22

---

page

page: Page

Inherited from

@blocksuite/store.BlockModel.page

Source

packages/store/dist/schema/base.d.ts:104

---

pop

pop: (prop) => void

Parameters

• prop: "size" | "caption" | "embed" | "type" | "name" | "sourceId"

Returns

void

Inherited from

@blocksuite/store.BlockModel.pop

Source

packages/store/dist/schema/base.d.ts:109

---

propsUpdated

propsUpdated: Slot<Object>

Type declaration

key

key: string

Inherited from

@blocksuite/store.BlockModel.propsUpdated

Source

packages/store/dist/schema/base.d.ts:113

---

role

role: "content" | "root" | "hub"

Inherited from

@blocksuite/store.BlockModel.role

Source

packages/store/dist/schema/base.d.ts:103

---

size

size: number

Inherited from

BlockModel.size

Source

packages/blocks/src/attachment-block/attachment-model.ts:23

---

sourceId?

sourceId?: string

Inherited from

BlockModel.sourceId

Source

packages/blocks/src/attachment-block/attachment-model.ts:33

---

stash

stash: (prop) => void

Parameters

• prop: "size" | "caption" | "embed" | "type" | "name" | "sourceId"

Returns

void

Inherited from

@blocksuite/store.BlockModel.stash

Source

packages/store/dist/schema/base.d.ts:108

---

text?

text?: Text

Inherited from

@blocksuite/store.BlockModel.text

Source

packages/store/dist/schema/base.d.ts:110

---

type

type: string

MIME type

Inherited from

BlockModel.type

Source

packages/blocks/src/attachment-block/attachment-model.ts:27

---

yBlock

yBlock: YBlock

Inherited from

@blocksuite/store.BlockModel.yBlock

Source

packages/store/dist/schema/base.d.ts:106

Accessors

childMap

get childMap(): Map<string, number>

Returns

Map<string, number>

Source

packages/store/dist/schema/base.d.ts:117

---

children

get children(): BlockModel<object>[]

Returns

BlockModel<object>[]

Source

packages/store/dist/schema/base.d.ts:118

Methods

clone()

clone(): AttachmentBlockModel

Returns

AttachmentBlockModel

Inherited from

@blocksuite/store.BlockModel.clone

Source

packages/store/dist/schema/base.d.ts:124

---

dispose()

dispose(): void

Returns

void

Inherited from

@blocksuite/store.BlockModel.dispose

Source

packages/store/dist/schema/base.d.ts:123

---

firstChild()

firstChild(): null | BlockModel<object>

Returns

null | BlockModel<object>

Inherited from

@blocksuite/store.BlockModel.firstChild

Source

packages/store/dist/schema/base.d.ts:120

---

isEmpty()

isEmpty(): boolean

Returns

boolean

Inherited from

@blocksuite/store.BlockModel.isEmpty

Source

packages/store/dist/schema/base.d.ts:119

---

lastChild()

lastChild(): null | BlockModel<object>

Returns

null | BlockModel<object>

Inherited from

@blocksuite/store.BlockModel.lastChild

Source

packages/store/dist/schema/base.d.ts:121

---

lastItem()

lastItem(): null | BlockModel<object>

Returns

null | BlockModel<object>

Inherited from

@blocksuite/store.BlockModel.lastItem

Source

packages/store/dist/schema/base.d.ts:122

---

Generated using typedoc-plugin-markdown and TypeDoc