ScaleBun
Skip to article

Exports

react-nativeDeveloperv0.1.0-alpha.4

Every value and type exported from the SDK entry point.

Updated Reviewed

The SDK's entry point is the only module consumers should import from — anything not listed here is an implementation detail and may change without a major version.

Values#

ExportGroup
defaultDefault Export: SDK Facade Singleton
ScaleBunProviderDefault Export: SDK Facade Singleton
ScaleBunErrorBoundaryDefault Export: SDK Facade Singleton
ScaleBunDebugRootReact Components & Hooks (consumer-facing)
ScaleBunScreenReact Components & Hooks (consumer-facing)
useScaleBunScreenReact Components & Hooks (consumer-facing)
ScaleBunScrollViewReact Components & Hooks (consumer-facing)
ScaleBunFlatListReact Components & Hooks (consumer-facing)
ScaleBunSectionListReact Components & Hooks (consumer-facing)
ScaleBunImpressionReact Components & Hooks (consumer-facing)
EngagePromptProviderEngage Campaign Overlay (shared cross-platform JS renderer, D4)
useEngagePromptEngage Campaign Overlay (shared cross-platform JS renderer, D4)
EngageAnchorProviderEngage Campaign Overlay (shared cross-platform JS renderer, D4)
ScaleBunAnchorEngage Campaign Overlay (shared cross-platform JS renderer, D4)
useScaleBunAnchorEngage Campaign Overlay (shared cross-platform JS renderer, D4)
ScaleBunInlineSlotEngage Campaign Overlay (shared cross-platform JS renderer, D4)
EngagePromptViewEngage Campaign Overlay (shared cross-platform JS renderer, D4)
PROMPT_RENDERERSEngage Campaign Overlay (shared cross-platform JS renderer, D4)
resolvePromptRendererEngage Campaign Overlay (shared cross-platform JS renderer, D4)
EngageInAppViewEngage Campaign Overlay (shared cross-platform JS renderer, D4)
INAPP_RENDERERSEngage Campaign Overlay (shared cross-platform JS renderer, D4)
resolveInAppRendererEngage Campaign Overlay (shared cross-platform JS renderer, D4)
resolveInAppLayoutEngage Campaign Overlay (shared cross-platform JS renderer, D4)
EngageThrottleStoreEngage Campaign Overlay (shared cross-platform JS renderer, D4)
isCampaignEligibleEngage Campaign Overlay (shared cross-platform JS renderer, D4)
isInAppEligibleEngage Campaign Overlay (shared cross-platform JS renderer, D4)
selectCampaignToRenderEngage Campaign Overlay (shared cross-platform JS renderer, D4)
selectInAppToRenderEngage Campaign Overlay (shared cross-platform JS renderer, D4)
selectInAppVariantEngage Campaign Overlay (shared cross-platform JS renderer, D4)
getDebugTransportDebug Utilities (for demo/test apps)
getPerformanceFeatureDebug Utilities (for demo/test apps)
getProfilerFeatureDebug Utilities (for demo/test apps)
createTypedTrackerTyped tracking plan (compile-time checking for track())
defineTrackingPlanTyped tracking plan (compile-time checking for track())

Types#

TypeGroup
ScaleBunErrorBoundaryPropsDefault Export: SDK Facade Singleton
ScaleBunImpressionPropsReact Components & Hooks (consumer-facing)
ScaleBunInitConfigPublic Types
ScaleBunUserPublic Types
ScaleBunFeaturesPublic Types
ScaleBunProviderPropsPublic Types
SimplifiedInitConfigPublic Types
DebugConnectionConfigPublic Types
PrivacyConfigPublic Types
BrandingConfigPublic Types
ExportPresetNamePublic Types
SimplifiedExportOptionsPublic Types
ExportResultPublic Types
DebugConfigPublic Types
EngageConfigResponseEngage Surface Types (foundation)
CoachConfigResponseEngage Surface Types (foundation)
CoachTourConfigEngage Surface Types (foundation)
CoachTourStepEngage Surface Types (foundation)
EngageConfigContextEngage Surface Types (foundation)
EngageCampaignConfigEngage Surface Types (foundation)
EngageCampaignTypeEngage Surface Types (foundation)
InAppMessageConfigEngage Surface Types (foundation)
InAppRenderSpecEngage Surface Types (foundation)
InAppRenderAssetsEngage Surface Types (foundation)
InAppRenderExtEngage Surface Types (foundation)
InAppMediaSizeEngage Surface Types (foundation)
InAppOutcomeIconEngage Surface Types (foundation)
InAppOutcomeActionTypeEngage Surface Types (foundation)
InAppOutcomeActionEngage Surface Types (foundation)
InAppOutcomeConfigEngage Surface Types (foundation)
InAppCtaEngage Surface Types (foundation)
InAppCoachmarkStepEngage Surface Types (foundation)
InAppCoachmarkPlacementEngage Surface Types (foundation)
InAppExperimentEngage Surface Types (foundation)
InAppVariantIdEngage Surface Types (foundation)
InAppGameVariantKeyEngage Surface Types (foundation)
InAppGameActionEngage Surface Types (foundation)
InAppGameRequestEngage Surface Types (foundation)
InAppGameOutcomeEngage Surface Types (foundation)
InAppGameResultEngage Surface Types (foundation)
InAppGameRequestHandlerEngage Surface Types (foundation)
QuestionSpecEngage Surface Types (foundation)
TargetingEngage Surface Types (foundation)
ThrottleEngage Surface Types (foundation)
EngageResponseInputEngage Surface Types (foundation)
EngageEventInputEngage Surface Types (foundation)
DeviceTokenInputEngage Surface Types (foundation)
SurveyAnswerEngage Surface Types (foundation)
EngagePromptProviderPropsEngage Overlay Types (renderer public surface)
EngagePromptControllerEngage Overlay Types (renderer public surface)
EngageRendererFacadeEngage Overlay Types (renderer public surface)
EngageRatingRoutingEngage Overlay Types (renderer public surface)
ShowEngagePromptOptionsEngage Overlay Types (renderer public surface)
ShowInAppMessageOptionsEngage Overlay Types (renderer public surface)
InAppDeepLinkHandlerEngage Overlay Types (renderer public surface)
EngageAnchorHandleEngage Overlay Types (renderer public surface)
EngageAnchorRectEngage Overlay Types (renderer public surface)
ScaleBunAnchorPropsEngage Overlay Types (renderer public surface)
ScaleBunInlineSlotPropsEngage Overlay Types (renderer public surface)
EngagePromptResultEngage Overlay Types (renderer public surface)
PromptRendererEngage Overlay Types (renderer public surface)
PromptBranchPropsEngage Overlay Types (renderer public surface)
RatingPromptConfigEngage Overlay Types (renderer public surface)
RatingRouteEngage Overlay Types (renderer public surface)
EngageInAppViewPropsEngage Overlay Types (renderer public surface)
InAppRendererEngage Overlay Types (renderer public surface)
InAppBranchPropsEngage Overlay Types (renderer public surface)
InAppMechanicInteractionEngage Overlay Types (renderer public surface)
InAppLayoutEngage Overlay Types (renderer public surface)
CampaignThrottleStateEngage Overlay Types (renderer public surface)
PushNotificationPush Notification Types (consumer-facing)
EnablePushOptionsPush Notification Types (consumer-facing)
EnablePushResultPush Notification Types (consumer-facing)
NotificationPermissionStatusPush Notification Types (consumer-facing)
AndroidChannelConfigPush Notification Types (consumer-facing)
AdapterIdPush Notification Types (consumer-facing)
TypedTrackerTyped tracking plan (compile-time checking for track())
TypedTrackerPlanTyped tracking plan (compile-time checking for track())
TrackedEventMapTyped tracking plan (compile-time checking for track())
TrackedEventSpecTyped tracking plan (compile-time checking for track())
PlanPropTypeTyped tracking plan (compile-time checking for track())
PropsForTyped tracking plan (compile-time checking for track())
TrackTargetTyped tracking plan (compile-time checking for track())

Peer dependencies#

PackageRangeRequired
react*Yes
react-native*Yes
react-native-view-shot>=3.0.0Optional
@notifee/react-native>=5.0.0Optional
expo-router>=1.0.0Optional

Optional peer dependencies#

Three of the SDK's peer dependencies are marked optional. Each backs one integration, is loaded through a guarded lazy require() at runtime, and is genuinely unnecessary if you do not use that integration:

PackageBacksAbsent means
react-native-view-shotScreenshot capture for the journey and replay screenshot helperNo screenshot capture; session replay loses its frame path
@notifee/react-nativeNotification-channel handling in the FCM push adapterNo channel configuration; push still delivers
expo-routerExpo Router navigation-mode detectionRouter mode is not auto-detected; set the navigation reference yourself

react and react-native are required, not optional.

Why the stub list is deliberately short#

Only ScaleBun's own optional integrations are stubbed. That is a design constraint rather than an oversight: stubbing broadly would mean an unrelated missing module — one of your dependencies, genuinely absent — silently resolved to a stub instead of failing. You would get a mysterious runtime error in place of a clear resolution failure at build time.

So the list covers three names and no more, and any other unresolved module fails normally.

About this surface#

The SDK's entry point declares itself the only module consumers should import from. That makes this list the definition of the public API: exported here means public and supported, absent means an implementation detail that can change without a major version.

It is also what lets docs:audit assert full reference coverage — every export on this page has a documented counterpart, and a new export with no documentation fails the build.

Exports · API reference · React Native SDK · ScaleBun