Profectus
On this page

Interface: BoardOptions ​

features/boards/board.BoardOptions

An object that configures a Board.

Properties ​

classes ​

• Optional classes: Computable<Record<string, boolean>>

Dictionary of CSS classes to apply to this feature.

Defined in ​

profectus/src/features/boards/board.ts:224

height ​

• Optional height: Computable<string>

The height of the board. Defaults to 100%

Defined in ​

profectus/src/features/boards/board.ts:220

• Optional links: Computable<null | BoardNodeLink[]>

An array of board node links to display.

Defined in ​

profectus/src/features/boards/board.ts:234

startNodes ​

• startNodes: () => Omit<BoardNode, "id">[]

Type declaration ​

▸ (): Omit<BoardNode, "id">[]

A function that returns an array of initial board nodes, without IDs.

Returns ​

Omit<BoardNode, "id">[]

Defined in ​

profectus/src/features/boards/board.ts:228

state ​

• Optional state: Computable<BoardData>

The persistent state of the board.

Defined in ​

profectus/src/features/boards/board.ts:232

style ​

• Optional style: Computable<StyleValue>

CSS to apply to this feature.

Defined in ​

profectus/src/features/boards/board.ts:226

types ​

• types: Record<string, NodeTypeOptions>

A dictionary of node types that can appear on the board.

Defined in ​

profectus/src/features/boards/board.ts:230

visibility ​

• Optional visibility: Computable<boolean | Visibility>

Whether this board should be visible.

Defined in ​

profectus/src/features/boards/board.ts:218

width ​

• Optional width: Computable<string>

The width of the board. Defaults to 100%

Defined in ​

profectus/src/features/boards/board.ts:222