PlentyONE Shop Docs

Appearance

web / useBlockManager

Function: useBlockManager() ​

useBlockManager(): object

Defined in: apps/web/composables/useBlockManager/useBlockManager.ts:35

Returns ​

object

addNewBlock() ​

addNewBlock: (category, variationIndex, targetUuid, position) => Promise<void>

Parameters ​

category ​

string

variationIndex ​

number

targetUuid ​

string

position ​

BlockPosition

Returns ​

Promise<void>

blockHasData() ​

blockHasData: (block) => boolean

Parameters ​

block ​

Block

Returns ​

boolean

blocksListContext ​

blocksListContext: Ref<BlocksListContext, BlocksListContext>

blocksLists ​

blocksLists: Ref<BlocksList, BlocksList>

changeBlockPosition() ​

changeBlockPosition: (index, position) => void

Parameters ​

index ​

number

position ​

number

Returns ​

void

clickedBlockIndex ​

clickedBlockIndex: Ref<null | number, null | number>

currentBlock ​

currentBlock: Ref<null | {}, null | Block | {}>

currentBlockUuid ​

currentBlockUuid: Ref<null | string, null | string>

deleteBlock() ​

deleteBlock: (uuid) => void

Parameters ​

uuid ​

string

Returns ​

void

findOrDeleteBlockByUuid() ​

findOrDeleteBlockByUuid: (blocks, targetUuid, deleteBlock?) => null | Block

Parameters ​

blocks ​

Block[]

targetUuid ​

string

deleteBlock? ​

boolean

Returns ​

null | Block

getBlockDepth() ​

getBlockDepth: (uuid) => number

Parameters ​

uuid ​

string

Returns ​

number

getBlocksLists() ​

getBlocksLists: () => Promise<void>

Returns ​

Promise<void>

getLazyLoadConfig() ​

getLazyLoadConfig: (blockName) => null | LazyLoadConfig

Parameters ​

blockName ​

string

Returns ​

null | LazyLoadConfig

getLazyLoadKey() ​

getLazyLoadKey: (blockName, blockUuid?) => string

Parameters ​

blockName ​

string

blockUuid? ​

string

Returns ​

string

getLazyLoadRef() ​

getLazyLoadRef: (blockName, blockUuid) => RefCallback

Parameters ​

blockName ​

string

blockUuid ​

string

Returns ​

RefCallback

handleDragEnd() ​

handleDragEnd: () => void

Returns ​

void

handleDragStart() ​

handleDragStart: () => void

Returns ​

void

handleEdit() ​

handleEdit: (uuid) => void

Parameters ​

uuid ​

string

Returns ​

void

isClicked ​

isClicked: Ref<boolean, boolean>

isDragging ​

isDragging: ComputedRef<boolean>

isLastNonFooterBlock() ​

isLastNonFooterBlock: (index) => boolean

Parameters ​

index ​

number

Returns ​

boolean

isTablet ​

isTablet: ComputedRef<boolean>

lazyLoadRefs ​

lazyLoadRefs: Ref<Record<string, null | HTMLElement>, Record<string, null | HTMLElement>>

lazyLoadStates ​

lazyLoadStates: Ref<Record<string, boolean>, Record<string, boolean>>

multigridColumnUuid ​

multigridColumnUuid: Ref<null | string, null | string>

setBlocksListContext() ​

setBlocksListContext: (context) => void

Parameters ​

context ​

BlocksListContext

Returns ​

void

shouldLazyLoad() ​

shouldLazyLoad: (blockName) => boolean

Parameters ​

blockName ​

string

Returns ​

boolean

tabletEdit() ​

tabletEdit: (index) => void

Parameters ​

index ​

number

Returns ​

void

togglePlaceholder() ​

togglePlaceholder: (uuid, position) => void

Parameters ​

uuid ​

string

position ​

BlockPosition

Returns ​

void

updateBlock() ​

updateBlock: (index, updatedBlock) => void

Parameters ​

index ​

number

updatedBlock ​

Block

Returns ​

void

updateMultigridColumnUuid() ​

updateMultigridColumnUuid: (uuid) => void

Parameters ​

uuid ​

string

Returns ​

void

visiblePlaceholder ​

visiblePlaceholder: Ref<{ position: BlockPosition; uuid: string; }, { position: BlockPosition; uuid: string; } | { position: BlockPosition; uuid: string; }>