1. Class methods

self.new(sub_blocks = [], width_ratio: nil) → ColumnBlock

Creates a ColumnBlock object that contains the blocks displayed in one column. A ColumnBlock can also be created without child blocks and populated later.

[PARAM] sub_blocks
- Block ... a single child Block
- Array<Block> ... multiple child Blocks in the specified order
- omitted or [] ... creates an empty ColumnBlock
[KEYWORD] width_ratio
- Numeric ... the column width ratio
- nil ... omits width_ratio from the generated JSON
[RETURN] ColumnBlock

When a ColumnBlock is retrieved from Notion, its width_ratio value is preserved in the generated JSON.

Create a column with child blocks

column = ColumnBlock.new(
  [
    ParagraphBlock.new("First block"),
    CalloutBlock.new("Second block", emoji: "✅"),
  ],
  width_ratio: 0.4,
)

Create an empty column

column = ColumnBlock.new

<aside> ⚠️

A ColumnBlock is a public API and may be created independently, but it can only be appended as a child of a ColumnListBlock. A ColumnBlock can contain regular Blocks and can receive additional child Blocks through append_block_children after it exists in Notion.

</aside>

2. Instance methods

append_block_children(*blocks, position: nil, dry_run: false)

Appends one or more regular Blocks to an existing ColumnBlock.

[PARAM] blocks ... one or more child Blocks
[KEYWORD] position ... the previous block ID, start, end, or nil
[KEYWORD] dry_run ... returns the request script without sending it when true
[RETURN] the created Block, an Array of created Blocks, or a String when dry_run is true