Skip to main content

đŸ–ŧī¸ Props: Image & Initialization

PropTypeRequiredDefaultDescription
originUrlstringyes*—Origin image URL (file://, absolute path, or http(s)://)
maskUrlstringyes*—Mask image URL (semantic color-block image; recommended same dimensions as origin)
originImgPathstring——Deprecated — use originUrl
maskImgPathstring——Deprecated — use maskUrl
initialSessionMaskSegmentSessionno—Draft restored from MMKV etc.; automatically calls loadSession after regions are ready
initialPaintColorBgrColorno—Optional. Initial custom brush color { b, g, r }; if omitted, no brush is selected by default; user must select a color or call ref.setPaintColor
initialPaintConfigJsonRecord<string, unknown>no—Optional. Accompanying brush config for initialPaintColor; passed back via onPaintCallback on successful paint

* At least one of originUrl / maskUrl is required per usage context.