React Components Reference

Component prop reference generated from source via react-docgen.

src/components/Header/Header.jsx

Header

Name	Required	Default	Type
isDarkMode	No	false
onToggleDarkMode	No	() => {}
onImportClick	No	null
onShowExamples	No	null

src/components/MTA/TrainLineCluster.jsx

TrainLineCluster

Cluster of MTA train line icons Shows multiple train lines together with smart overflow handling

@param {string[]} lines - Array of train line identifiers @param {string} size - Size variant: 'small', 'medium', 'large' @param {number} maxVisible - Maximum number of icons to show before overflow @param {string} className - Additional CSS classes

Name	Required	Default	Type
lines	No	[]
size	No	'medium'
maxVisible	No	4
className	No	''

src/components/MTA/TrainLineIcon.jsx

TrainLineIcon

Individual MTA train line icon component Based on NYC Core Framework subway icon styles https://www.nyc.gov/assets/oti/html/nyc-core-framework/subway-icons.html

@param {string} line - Train line identifier (e.g., '1', 'A', 'Q') @param {string} size - Size variant: 'small' (16px), 'medium' (20px), 'large' (24px) @param {string} className - Additional CSS classes

Name	Required	Default	Type
size	No	'medium'
className	No	''

src/components/Map/ActiveToolIndicator.jsx

ActiveToolIndicator

No props

src/components/Map/ClickPopover.jsx

ClickPopover

Name	Required	Default	Type
dimensionUnits	No	'ft'

src/components/Map/CustomShapeLabels.jsx

CustomShapeLabels

Name	Required	Default	Type
showLabels	No	true

src/components/Map/DroppedObjectNoteEditor.jsx

DroppedObjectNoteEditor

No props

src/components/Map/DroppedObjects.jsx

DroppedObjects

Name	Required	Default	Type
objects	No	[]
placeableObjects	No	[]

src/components/Map/EdgeMarkers.jsx

EdgeMarkers

Name	Required	Default	Type
categories	No	['busStops', 'parkingMeters', 'subwayEntrances']

src/components/Map/LoadingOverlay.jsx

LoadingOverlay

Name	Required	Default	Type
showDebugInfo	No	false

src/components/Map/MapContainer.jsx

MapContainer

Name	Required	Default	Type
customShapes	No	[]
isSitePlanMode	No	false
isRightSidebarOpen	No	false

src/components/Map/MapTooltip.jsx

MapTooltip

No props

src/components/Map/NudgeMarkers.jsx

NudgeMarkers

Name	Required	Default	Type
nudges	No	[]
objectUpdateTrigger	No	0
highlightedIds	No	new Set()

src/components/Map/OverlapSelector.jsx

OverlapSelector

Name	Required	Default	Type
overlappingAreas	No	[]
selectedIndex	No	0
clickPosition	No	{ x: 0, y: 0 }

src/components/Map/PlacementPreview.jsx

PlacementPreview

No props

src/components/Map/RectangleDimensionsEditor.jsx

RectangleDimensionsEditor

No props

src/components/Map/ViewportInset.jsx

ViewportInset

Name	Required	Default	Type
isSitePlanMode	No	false
isRightSidebarOpen	No	false

src/components/Map/ZoneCreatorPills.jsx

ZoneCreatorPills

No props

src/components/MobileLanding.jsx

MobileLanding

No props

src/components/Modals/ConfirmModal.jsx

ConfirmModal

Name	Required	Default	Type
confirmText	No	'Confirm'
cancelText	No	'Cancel'

src/components/Modals/EventInfoModal.jsx

EventInfoModal

No props

src/components/Modals/ExamplesModal.jsx

ExamplesModal

No props

src/components/Modals/ExportOptionsModal.jsx

ExportOptionsModal

No props

src/components/Modals/FocusInfoPanel.jsx

FocusInfoPanel

Name	Required	Default	Type
hasSubFocus	No	false
onBeginSubFocus	No	null
onClearSubFocus	No	null

src/components/Modals/GeoclientSettingsModal.jsx

GeoclientSettingsModal

No props

src/components/Modals/GeographySelector.jsx

GeographySelector

No props

src/components/Modals/ImportProgressModal.jsx

ImportProgressModal

Name	Required	Default	Type
steps	No	[complex value]

src/components/Modals/InfoPanel.jsx

InfoPanel

Name	Required	Default	Type
showInfo	No	true

src/components/Modals/InfraProgressModal.jsx

InfraProgressModal

Name	Required	Default	Type
total	No	0
completed	No	0

src/components/Modals/ItemBrowserModal.jsx

ItemBrowserModal

Name	Required	Default	Type
mode	No	'objects'
droppedObjects	No	[]
placeableObjects	No	[]
annotations	No	[]

src/components/Nudges/NudgeCenter.jsx

NudgeCenter

Name	Required	Default	Type
nudges	No	[]

src/components/Nudges/ZoomBoundaryNudge.jsx

ZoomBoundaryNudge

No props

src/components/Sidebar/BasemapToggle.jsx

BasemapToggle

No props

src/components/Sidebar/CustomShapesList.jsx

CustomShapesList

Name	Required	Default	Type
showLabels	No	true

src/components/Sidebar/DrawingTools.jsx

DrawingTools

Name	Required	Default	Type
drawAvailable	No	true

src/components/Sidebar/DroppedObjectsList.jsx

DroppedObjectsList

Name	Required	Default	Type
objects	No	[]
placeableObjects	No	[]

src/components/Sidebar/GeographyCompactSelector.jsx

GeographyCompactSelector

No props

src/components/Sidebar/LayersPanel.jsx

LayersPanel

Name	Required	Default	Type
isSitePlanMode	No	false
hasSubFocus	No	false
onBeginSubFocus	No	null
onClearSubFocus	No	null
onToggleSubwayLines	No	null

src/components/Sidebar/OpenStreetsPanel.jsx

OpenStreetsPanel

Name	Required	Default	Type
focusedArea	No	null

src/components/Sidebar/PermitAreaSearch.jsx

PermitAreaSearch

Name	Required	Default	Type
title	No	'Search Zones'
placeholder	No	'Search zones...'
onChangeMode	No	null
permitAreasLayer	No	null
onToggleLayer	No	null
geographyType	No	'intersections'
geoclientResults	No	[]
geoclientLoading	No	false
geoclientStatus	No	null
geoclientError	No	null
geoclientCooldownMs	No	0
onSelectGeoclientResult	No	null

src/components/Sidebar/PlaceableObjectsPanel.jsx

PlaceableObjectsPanel

No props

src/components/Sidebar/RightSidebar.jsx

RightSidebar

Name	Required	Default	Type
mode	No	'expanded'
isOpen	No	true
onClose	No	() => {}
onToggle	No	() => {}

src/components/Sidebar/ShapeProperties.jsx

ShapeProperties

No props

src/components/Sidebar/Sidebar.jsx

Sidebar

Name	Required	Default	Type
isSitePlanMode	No	false
onCollapse	No	() => {}

src/components/Sidebar/ZoneCreatorPanel.jsx

ZoneCreatorPanel

Name	Required	Default	Type
showExpanded	No	false

src/components/SpaceStager.jsx

SpaceStager

No props

src/components/Tutorial/SapoWalkthroughModal.jsx

SapoWalkthroughModal

No props

src/components/Tutorial/TutorialTooltip.jsx

TutorialTooltip

No props

src/components/Tutorial/WelcomeOverlay.jsx

WelcomeOverlay

No props