Skip to content
SparkleTree Docs
Search
Ctrl
K
Cancel
GitLab
Select theme
Dark
Light
Auto
Developers
SDK
Quickstart
Fragments
Origins, CSP & privacy
Run the examples
What your visitors see
Provider, components & useIsland
Copy the source (CLI)
When things go wrong
Signed minting
Impressions & clicks
Using it without React
Changelog
API reference
@sparkletree/core
Classes
CopyChoreographer
ImpressionRecorder
SseParser
VariantRegistry
Interfaces
AnalyticsContext
AudioBlock
AudioCapabilities
AudioHandle
AudioState
ChoreographerOptions
ChromeDecision
ContentSnapshot
CreateClientOptions
CreativeState
DeclaredContext
DoneMeta
FetchFragmentsOptions
FieldState
FollowerReservation
FragmentField
FragmentsResponse
FragmentsResult
ImpressionDetail
LeaderReservation
NormalizedFragmentField
NormalizeResult
PublishableKeyPayload
ResolvedPublishableConfig
ResolvedTheme
SparkletreeClient
SseMessage
StreamHandle
StreamOptions
StreamTarget
ThemePayload
VisibilityOptions
Type Aliases
AudioEvent
AudioProvider
CanonicalDims
ContentSource
CopyField
CopyMode
DegradeReason
EventType
FragmentFieldSpec
FragmentKind
FragmentSwapPolicy
FragmentWarmth
MintTokenSource
Phase
PublishableKeyEnv
VariantReservation
WireEventName
Variables
CONTEXT_DAY_TYPES
CONTEXT_DAYPARTS
CONTEXT_DEVICES
CONTEXT_INTENTS
CONTEXT_SURFACE_TYPES
CONTEXT_TEMP_BANDS
CONTEXT_WEATHER
COPY_FIELDS
COPY_HOLD_MS
FRAGMENT_KIND_FLOORS
FRAGMENT_KINDS
FRAGMENT_WARMTHS
MAX_CUSTOM_DIMS
MAX_FALLBACK_CHARS
MAX_FRAGMENT_FIELDS
MAX_NOTES_LENGTH
pageVariants
PROTOCOL_CURRENT
PROTOCOL_DEFAULT
PROTOCOL_HEADER
PROTOCOL_PARAM
PROTOCOL_VERSIONS
RESERVATION_TIMEOUT_MS
SDK_PARAM
SDK_PARAM_VALUE
STANDARD_MODE_KEY
TOKEN_PREFIX
VARIANT_PARAM
Functions
activePlayer
applyTheme
buildContentUrl
buildStreamUrl
canonicalContextString
computeContextHash
computeFieldBudget
computeSchemaHash
createClient
decideChrome
declaredToDims
decodePublishableKey
destroyActiveAudio
encodePublishableKey
expandFieldSpecs
fetchContent
fetchFragments
fragmentSwapPolicy
hashDeclaredContext
inDevelopment
isFirstPartyApiBase
isSecureApiBase
mountAudio
negotiatedProtocol
normalizeDims
normalizeFieldSpecs
normalizeNotes
observeVisibility
openStream
plainText
readableTextColor
readSseStream
resolvePublishableConfig
safeActionUrl
sessionId
setViewerPrefersStandard
strongestFragmentSource
themeStyle
tokenName
tokenSource
track
viewerPrefersStandard
warnDev
@sparkletree/react
Interfaces
CopyCardProps
CreativeState
CtaProps
FieldState
FragmentGroupProps
FragmentGroupState
FragmentTextProps
HeroParts
HeroProps
ProductCardProps
SparkletreeContextValue
SparkletreeProviderProps
StreamTextProps
UseFragmentsOptions
UseIslandOptions
UseIslandResult
Type Aliases
ContentSource
CopyField
Phase
UseFragmentsResult
Variables
DEFAULT_MARK_LABEL
pageVariants
Functions
CopyCard
Cta
FragmentGroup
fragmentList
FragmentText
heldReserve
Hero
InlineMark
MarkGlyph
ProductCard
SparkletreeProvider
staticField
StreamText
useFragments
useIsland
useSparkletree
withReserve
Agents & MCP
SparkleTree for agents
Install and connect
Ready prompt for your AI
Example prompts
Tips & tricks for agents
Advanced workflows
Platform
Platform docs
Getting started
What is SparkleTree?
Setup guide
Your first 30 minutes
Connect SparkleTree to your AI
Campaigns & products
Create your first campaign
Products
Campaign settings
Campaign tips & tricks
Brand
Your brand in SparkleTree
Publishing your brand page
How your page gets found — by people and by AIs
Socials
Socials overview
Connect your accounts
Automatic ad management
Meet Florence
Teams & permissions
Managing your team
Roles and permissions
Plans and limits
Integrations
Integrations overview
Shopify
Social accounts and posting
Deployment cookbook
System guide
Capabilities and use cases
Analytics
Advanced settings
MCP connector setup
GitLab
Select theme
Dark
Light
Auto
inDevelopment
inDevelopment
():
boolean
Defined in:
devwarn.ts:38
Returns
Section titled “Returns”
boolean
