schlechtenburg/packages/docs/lib/api/@schlechtenburg/core.md

5.5 KiB

@schlechtenburg/core

SbMode

  • Type

      Enumeration
    
  • Members

    • Display: undefined
    • Edit: undefined

IBlockData<T>

Schlechtenburg inputs and outputs a plain JS Object that can be JSON stringified. This is the interface type for that data structure. will be the data type of the specific block being

  • Type

      Interface
    
  • Members

    • data: T
    • id: string
    • name: string

IBlockDefinition<T>

Any Block that you create

  • Type

      Interface
    
  • Members

    • display: Component
    • edit: Component
    • getDefaultData: T
    • icon: string
    • name: string

IBlockLibrary

Schlechtenburg maintains a library of blocks that are available

  • Type

      Interface
    
  • Members

IBlockProps<T>

Any Block that you create

  • Type

      Interface
    
  • Members

    • blockId: string
    • data: T
    • onActivateNext: OnActivateNextCb
    • onActivatePrevious: OnActivatePreviousCb
    • onAppendBlock: OnAppendBlockCb
    • onPrependBlock: OnPrependBlockCb
    • onRemoveSelf: OnRemoveSelfCb
    • onUpdate: OnUpdateSelfCb

ITreeNode

Schlechtenburg keeps track of the rendered block tree. This is useful for e.g. the tree select component in the editor header.

  • Type

      Interface
    
  • Members

    • children: undefined
    • icon: string
    • id: string
    • name: string

OnActivateNextCb

  • Type

      Type alias
    
  • Members

OnActivatePreviousCb

  • Type

      Type alias
    
  • Members

OnAppendBlockCb

  • Type

      Type alias
    
  • Members

OnPrependBlockCb

  • Type

      Type alias
    
  • Members

OnRemoveSelfCb

  • Type

      Type alias
    
  • Members

OnUpdateBlockCb

  • Type

      Type alias
    
  • Members

OnUpdateSelfCb<T>

  • Type

      Type alias
    
  • Members

Mode

  • Type

      Variable
    
  • Members

SbBlock

Displays a Schlechtenburg block either the mode of the schlechtenburg instance. You can use this to display child blocks inside your own blocks.

  • Type

      Component
    

Props

block

The state for the block.

  • Type
      IBlockData<any>
    

onUpdate

Called when the block should be updated.

  • Type

      OnUpdateBlockCb
    
  • Default value

      () => {}
    

onPrependBlock

Called when a sibling block should be inserted before the block

  • Type

      OnPrependBlockCb
    
  • Default value

      () => {}
    

onAppendBlock

Called when a sibling block should be inserted after the block

  • Type

      OnAppendBlockCb
    
  • Default value

      () => {}
    

onRemoveSelf

Called when the block should be removed

  • Type

      OnRemoveSelfCb
    
  • Default value

      () => {}
    

onActivatePrevious

Called when the previous sibling block should be activated

  • Type

      OnActivatePreviousCb
    
  • Default value

      () => {}
    

onActivateNext

Called when the next sibling block should be activated

  • Type

      OnActivateNextCb
    
  • Default value

      () => {}
    

SbBlockOrdering

  • Type

      Component
    

Props

orientation

  • Type

      string
    
  • Default value

      null
    

onRemove

  • Type

      func
    
  • Default value

      () => {}
    

onMoveBackward

  • Type

      func
    
  • Default value

      () => {}
    

onMoveForward

  • Type

      func
    
  • Default value

      () => {}
    

SbBlockPicker

  • Type

      Component
    

Props

onPickedBlock

  • Type

      func
    
  • Default value

      () => {}
    

SbBlockPlaceholder

A placeholder for a block. Displays a placeholder for a block, allowing the user to select a block to insert.

  • Type

      Component
    

Props

onInsertBlock

Called when the user picked a block that should be inserted here.

  • Type

      func
    
  • Default value

      () => {}
    

SbButton

A button in the schlechtenburg theme

  • Type

      Component
    

Props

SbMain

  • Type

      Variable
    
  • Members

SbSelect

A select input in the schlechtenburg theme

  • Type

      Component
    

Props

SbToolbar

Toolbar in the schlechtenburg theme

  • Type

      Component
    

Props

SymActiveBlock

  • Type

      Variable
    
  • Members

SymBlockDimensions

  • Type

      Variable
    
  • Members

SymBlockLibrary

  • Type

      Variable
    
  • Members

SymEditorDimensions

  • Type

      Variable
    
  • Members

blockProps

  • Type

      Variable
    
  • Members

model

  • Type

      Variable
    
  • Members

generateBlockId

  • Type

      Function
    
  • Members

useActivation

  • Type

      Function
    
  • Members

useBlockSizing

  • Type

      Function
    
  • Members

useDynamicBlocks

  • Type

      Function
    
  • Members

useResizeObserver

  • Type

      Function
    
  • Members