web / UseBlocks

Interface: UseBlocks

Defined in: composables/useBlocks/types.ts:11

Properties

allBlocks

allBlocks: Readonly<Ref<Block[]>>

Defined in: composables/useBlocks/types.ts:17

---

blocks

blocks: Readonly<Ref<Block[]>>

Defined in: composables/useBlocks/types.ts:16

Deprecated

Use pageBlocks instead

---

cleanData

cleanData: Readonly<Ref<GetBlocksResponse>>

Defined in: composables/useBlocks/types.ts:13

---

data

data: Ref<GetBlocksResponse>

Defined in: composables/useBlocks/types.ts:12

---

defaultTemplateData

defaultTemplateData: Readonly<Ref<Block[]>>

Defined in: composables/useBlocks/types.ts:21

---

discardChanges()

discardChanges: () => void

Defined in: composables/useBlocks/types.ts:26

Returns

void

---

fetchBlocks()

fetchBlocks: (identifier, type) => Promise<void>

Defined in: composables/useBlocks/types.ts:22

Parameters

identifier

string | number

type

string

Returns

Promise<void>

---

footer

footer: Readonly<Ref<Block | undefined>>

Defined in: composables/useBlocks/types.ts:19

---

FOOTER_SWITCH_DEFINITIONS

FOOTER_SWITCH_DEFINITIONS: FooterSwitchDefinition[]

Defined in: composables/useBlocks/types.ts:29

---

headerContainer

headerContainer: Readonly<Ref<Block | undefined>>

Defined in: composables/useBlocks/types.ts:18

---

isSettling

isSettling: Ref<boolean>

Defined in: composables/useBlocks/types.ts:28

---

loading

loading: Readonly<Ref<boolean>>

Defined in: composables/useBlocks/types.ts:20

---

pageBlocks

pageBlocks: Readonly<Ref<Block[]>>

Defined in: composables/useBlocks/types.ts:14

---

saveBlocks()

saveBlocks: (identifier, type, content) => Promise<boolean>

Defined in: composables/useBlocks/types.ts:23

Parameters

identifier

string | number

type

string

content

string

Returns

Promise<boolean>

---

setDefaultTemplate()

setDefaultTemplate: (blocks) => void

Defined in: composables/useBlocks/types.ts:27

Parameters

blocks

Block[]

Returns

void

---

setupFakeBlocks()

setupFakeBlocks: (rawBlocks, type?) => void

Defined in: composables/useBlocks/types.ts:24

Parameters

rawBlocks

Block[]

type?

string

Returns

void

---

updateBlocks()

updateBlocks: (blocks) => void

Defined in: composables/useBlocks/types.ts:25

Parameters

blocks

Block[]

Returns

void