CreateMaelstromConfig
Defined in: packages/react/src/lib/create-maelstrom.ts:28
Configuration used to create one typed React Maelstrom instance.
Type Parameters
Section titled “Type Parameters”T extends readonly AnyVesselEntry[]
Properties
Section titled “Properties”cellSizePx?
Section titled “cellSizePx?”
optionalcellSizePx?:number
Defined in: packages/react/src/lib/create-maelstrom.ts:35
Grid cell size in pixels. Defaults to 80, must be positive, and may be overridden by the Provider.
debug?
Section titled “debug?”
optionaldebug?:boolean
Defined in: packages/react/src/lib/create-maelstrom.ts:42
Enables client diagnostic logging. Defaults to false.
motion?
Section titled “motion?”
optionalmotion?:ChartMotionConfig
Defined in: packages/react/src/lib/create-maelstrom.ts:47
Chart motion/choreography settings. A motion prop on the Provider
overrides this as a whole object (no per-field merge).
tilingPaddingPx?
Section titled “tilingPaddingPx?”
optionaltilingPaddingPx?:number
Defined in: packages/react/src/lib/create-maelstrom.ts:40
Pixel gap inset around computed tiling regions. Defaults to 8, must be non-negative, and may be overridden by the Provider.
vessels
Section titled “vessels”vessels:
AssertNarrowIds<T> &T
Defined in: packages/react/src/lib/create-maelstrom.ts:30
Vessel entries available to the Provider and generated hooks.