@burtson-labs/bandit-engine 2.0.32 → 2.0.34
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -3
- package/dist/cli/cli.js +2 -2
- package/dist/cli/cli.js.map +1 -1
- package/docs/api_reference/assets/highlight.css +6 -6
- package/docs/api_reference/classes/DebugLogger.html +11 -11
- package/docs/api_reference/classes/FeatureFlagService.html +13 -13
- package/docs/api_reference/classes/NotificationService.html +10 -10
- package/docs/api_reference/classes/StreamingTTSClient.html +9 -9
- package/docs/api_reference/classes/VectorDatabaseService.html +24 -24
- package/docs/api_reference/classes/VectorMigrationService.html +8 -8
- package/docs/api_reference/classes/VoiceService.html +2 -2
- package/docs/api_reference/enums/TTSState.html +2 -2
- package/docs/api_reference/functions/Chat.html +1 -1
- package/docs/api_reference/functions/ChatModal.html +3 -3
- package/docs/api_reference/functions/ChatProvider.html +3 -3
- package/docs/api_reference/functions/FeatureFlagProvider.html +3 -3
- package/docs/api_reference/functions/FeedbackButton.html +3 -3
- package/docs/api_reference/functions/FeedbackModal.html +3 -3
- package/docs/api_reference/functions/Management.html +1 -1
- package/docs/api_reference/functions/NotificationProvider.html +3 -3
- package/docs/api_reference/functions/SubscriptionExpiredGuard.html +3 -3
- package/docs/api_reference/functions/SubscriptionExpiredModal.html +3 -3
- package/docs/api_reference/functions/defineCustomElement.html +1 -1
- package/docs/api_reference/functions/getCriticalConfig.html +1 -1
- package/docs/api_reference/functions/getFeatureMatrix.html +1 -1
- package/docs/api_reference/functions/getStreamingTTSClient.html +1 -1
- package/docs/api_reference/functions/getSystemConstants.html +1 -1
- package/docs/api_reference/functions/getTTSState.html +1 -1
- package/docs/api_reference/functions/handleHttpError.html +1 -1
- package/docs/api_reference/functions/handleSubscriptionUpgrade.html +1 -1
- package/docs/api_reference/functions/handleValidationError.html +1 -1
- package/docs/api_reference/functions/initializeCoreSystem.html +1 -1
- package/docs/api_reference/functions/pauseTTS.html +1 -1
- package/docs/api_reference/functions/previewTierUpgrade.html +1 -1
- package/docs/api_reference/functions/resumeTTS.html +1 -1
- package/docs/api_reference/functions/showInfoNotification.html +1 -1
- package/docs/api_reference/functions/showSuccessNotification.html +1 -1
- package/docs/api_reference/functions/speakWithStreaming.html +1 -1
- package/docs/api_reference/functions/stopTTS.html +1 -1
- package/docs/api_reference/functions/syncSubscriptionWithAPI.html +1 -1
- package/docs/api_reference/functions/updateSubscriptionTier.html +1 -1
- package/docs/api_reference/functions/useFeatureFlag.html +1 -1
- package/docs/api_reference/functions/useFeatureVisibility.html +1 -1
- package/docs/api_reference/functions/useFeatures.html +1 -1
- package/docs/api_reference/functions/useGatewayHealth.html +1 -1
- package/docs/api_reference/functions/useGatewayMemory.html +1 -1
- package/docs/api_reference/functions/useGatewayModels.html +1 -1
- package/docs/api_reference/functions/useGlobalTTS.html +1 -1
- package/docs/api_reference/functions/useNotification.html +1 -1
- package/docs/api_reference/functions/useNotificationService.html +1 -1
- package/docs/api_reference/functions/useTTS.html +1 -1
- package/docs/api_reference/functions/useVectorStore.html +1 -1
- package/docs/api_reference/functions/useVoiceStore.html +2 -2
- package/docs/api_reference/functions/useVoices.html +1 -1
- package/docs/api_reference/functions/validateEnvironment.html +1 -1
- package/docs/api_reference/functions/validateSystemIntegrity.html +1 -1
- package/docs/api_reference/index.html +66 -15
- package/docs/api_reference/interfaces/AIChatRequest.html +2 -2
- package/docs/api_reference/interfaces/AIChatResponse.html +2 -2
- package/docs/api_reference/interfaces/AIGenerateRequest.html +2 -2
- package/docs/api_reference/interfaces/AIGenerateResponse.html +2 -2
- package/docs/api_reference/interfaces/AIMessage.html +2 -2
- package/docs/api_reference/interfaces/AIModel.html +2 -2
- package/docs/api_reference/interfaces/AIProviderConfig.html +2 -2
- package/docs/api_reference/interfaces/ChatConfig.html +3 -3
- package/docs/api_reference/interfaces/ChatModalProps.html +3 -3
- package/docs/api_reference/interfaces/CreateMemoryOptions.html +2 -2
- package/docs/api_reference/interfaces/FeatureEvaluation.html +7 -7
- package/docs/api_reference/interfaces/FeatureFlagConfig.html +9 -9
- package/docs/api_reference/interfaces/FeatureFlagContextValue.html +8 -8
- package/docs/api_reference/interfaces/FeatureFlagProviderProps.html +2 -2
- package/docs/api_reference/interfaces/FeedbackButtonProps.html +10 -10
- package/docs/api_reference/interfaces/FeedbackCategories.html +2 -2
- package/docs/api_reference/interfaces/FeedbackModalProps.html +2 -2
- package/docs/api_reference/interfaces/FeedbackPriorities.html +2 -2
- package/docs/api_reference/interfaces/FeedbackRequest.html +2 -2
- package/docs/api_reference/interfaces/FeedbackResponse.html +2 -2
- package/docs/api_reference/interfaces/FileUploadResult.html +2 -2
- package/docs/api_reference/interfaces/GatewayChatRequest.html +2 -2
- package/docs/api_reference/interfaces/GatewayChatResponse.html +2 -2
- package/docs/api_reference/interfaces/GatewayContract.html +2 -2
- package/docs/api_reference/interfaces/GatewayGenerateRequest.html +2 -2
- package/docs/api_reference/interfaces/GatewayGenerateResponse.html +2 -2
- package/docs/api_reference/interfaces/GatewayHealthResponse.html +2 -2
- package/docs/api_reference/interfaces/GatewayMemoryRecord.html +2 -2
- package/docs/api_reference/interfaces/GatewayMemoryResponse.html +2 -2
- package/docs/api_reference/interfaces/GatewayMessage.html +2 -2
- package/docs/api_reference/interfaces/GatewayMessageContent.html +2 -2
- package/docs/api_reference/interfaces/GatewayModel.html +2 -2
- package/docs/api_reference/interfaces/GatewayModelsResponse.html +2 -2
- package/docs/api_reference/interfaces/MemorySearchFilters.html +2 -2
- package/docs/api_reference/interfaces/MigrationProgress.html +2 -2
- package/docs/api_reference/interfaces/MigrationStatus.html +2 -2
- package/docs/api_reference/interfaces/NotificationConfig.html +2 -2
- package/docs/api_reference/interfaces/NotificationContextType.html +2 -2
- package/docs/api_reference/interfaces/NotificationProviderProps.html +2 -2
- package/docs/api_reference/interfaces/PackageSettings.html +2 -2
- package/docs/api_reference/interfaces/SearchOptions.html +2 -2
- package/docs/api_reference/interfaces/SearchResult.html +2 -2
- package/docs/api_reference/interfaces/SubscriptionExpiredGuardProps.html +2 -2
- package/docs/api_reference/interfaces/SubscriptionExpiredModalProps.html +2 -2
- package/docs/api_reference/interfaces/TTSOptions.html +2 -2
- package/docs/api_reference/interfaces/TTSProgress.html +2 -2
- package/docs/api_reference/interfaces/TrialUsage.html +2 -2
- package/docs/api_reference/interfaces/UploadRequest.html +3 -3
- package/docs/api_reference/interfaces/UseTTSReturn.html +2 -2
- package/docs/api_reference/interfaces/VectorDocument.html +2 -2
- package/docs/api_reference/interfaces/VectorMemory.html +2 -2
- package/docs/api_reference/interfaces/VectorMemoryMetadata.html +2 -2
- package/docs/api_reference/interfaces/VectorStoreStatus.html +2 -2
- package/docs/api_reference/interfaces/VoiceModelsResponse.html +2 -2
- package/docs/api_reference/interfaces/VoiceState.html +2 -2
- package/docs/api_reference/types/FeatureKey.html +1 -1
- package/docs/api_reference/types/FeatureMatrix.html +1 -1
- package/docs/api_reference/types/GatewayQueryOptions.html +1 -1
- package/docs/api_reference/types/LogContext.html +1 -1
- package/docs/api_reference/types/SubscriptionTier.html +1 -1
- package/docs/api_reference/variables/DEFAULT_TIER_FEATURES.html +1 -1
- package/docs/api_reference/variables/FeatureFlagContext.html +1 -1
- package/docs/api_reference/variables/OSS_DEFAULT_FEATURES.html +1 -1
- package/docs/api_reference/variables/SYSTEM_FLAGS.html +1 -1
- package/docs/api_reference/variables/authenticationService.html +1 -1
- package/docs/api_reference/variables/debugLogger-1.html +1 -1
- package/docs/api_reference/variables/featureFlagService-1.html +1 -1
- package/docs/api_reference/variables/notificationService-1.html +1 -1
- package/docs/api_reference/variables/vectorDatabaseService-1.html +1 -1
- package/docs/api_reference/variables/vectorMigrationService-1.html +1 -1
- package/docs/api_reference/variables/voiceService-1.html +1 -1
- package/package.json +2 -2
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ChatProvider | @burtson-labs/bandit-engine</title><meta name="description" content="Documentation for @burtson-labs/bandit-engine"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@burtson-labs/bandit-engine</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@burtson-labs/bandit-engine</a></li><li><a href="ChatProvider.html">ChatProvider</a></li></ul><h1>Function ChatProvider</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="ChatProvider" class="tsd-anchor"></a><span class="tsd-kind-call-signature">Chat<wbr/>Provider</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">props</span>, <span class="tsd-kind-parameter">deprecatedLegacyContext</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ReactNode</span><a href="#ChatProvider" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">props</span>: <a href="../interfaces/ChatConfig.html" class="tsd-signature-type tsd-kind-interface">ChatConfig</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">deprecatedLegacyContext</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><div class="tsd-tag-Deprecated"><h4 class="tsd-anchor-link"><a id="Deprecated" class="tsd-anchor"></a>Deprecated<a href="#Deprecated" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4></div><div class="tsd-tag-See"><h4 class="tsd-anchor-link"><a id="See" class="tsd-anchor"></a>See<a href="#See" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods">React Docs</a></p>
|
|
2
|
-
</div></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ReactNode</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Burtson-Labs/bandit/blob/
|
|
2
|
+
</div></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ReactNode</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Burtson-Labs/bandit-engine/blob/main/packages/bandit-engine/src/chat-provider.tsx#L51">packages/bandit-engine/src/chat-provider.tsx:51</a></li></ul></aside></li></ul></section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="ChatProvider.html#contextTypes" class="tsd-index-link deprecated tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>context<wbr/>Types?</span></a>
|
|
3
3
|
<a href="ChatProvider.html#defaultProps" class="tsd-index-link deprecated tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>default<wbr/>Props?</span></a>
|
|
4
4
|
<a href="ChatProvider.html#displayName" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>display<wbr/>Name?</span></a>
|
|
5
5
|
<a href="ChatProvider.html#propTypes" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prop<wbr/>Types?</span></a>
|
|
@@ -9,7 +9,7 @@ this component.</p>
|
|
|
9
9
|
</div></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/react/index.d.ts:1156</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="defaultProps" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span class="deprecated">default<wbr/>Props</span><a href="#defaultProps" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">default<wbr/>Props</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ChatConfig.html" class="tsd-signature-type tsd-kind-interface">ChatConfig</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Used to define default values for the props accepted by
|
|
10
10
|
the component.</p>
|
|
11
11
|
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-See"><h4 class="tsd-anchor-link"><a id="See-2" class="tsd-anchor"></a>See<a href="#See-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="https://react.dev/reference/react/Component#static-defaultprops">React Docs</a></p>
|
|
12
|
-
</div><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example" class="tsd-anchor"></a>Example<a href="#Example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="tsx"><span class="hl-6">type</span><span class="hl-1"> </span><span class="hl-10">Props</span><span class="hl-1"> = { </span><span class="hl-5">name</span><span class="hl-1">?: </span><span class="hl-10">string</span><span class="hl-1"> }</span><br/><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-0">MyComponent</span><span class="hl-1">: </span><span class="hl-10">FC</span><span class="hl-1"><</span><span class="hl-10">Props</span><span class="hl-1">> = (</span><span class="hl-5">props</span><span class="hl-1">) </span><span class="hl-6">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">return</span><span class="hl-1"> </span><span class="hl-9"><</span><span class="hl-
|
|
12
|
+
</div><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example" class="tsd-anchor"></a>Example<a href="#Example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="tsx"><span class="hl-6">type</span><span class="hl-1"> </span><span class="hl-10">Props</span><span class="hl-1"> = { </span><span class="hl-5">name</span><span class="hl-1">?: </span><span class="hl-10">string</span><span class="hl-1"> }</span><br/><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-0">MyComponent</span><span class="hl-1">: </span><span class="hl-10">FC</span><span class="hl-1"><</span><span class="hl-10">Props</span><span class="hl-1">> = (</span><span class="hl-5">props</span><span class="hl-1">) </span><span class="hl-6">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">return</span><span class="hl-1"> </span><span class="hl-9"><</span><span class="hl-13">div</span><span class="hl-9">></span><span class="hl-6">{</span><span class="hl-5">props</span><span class="hl-14">.</span><span class="hl-5">name</span><span class="hl-6">}</span><span class="hl-9"></</span><span class="hl-13">div</span><span class="hl-9">></span><br/><span class="hl-1">}</span><br/><br/><span class="hl-5">MyComponent</span><span class="hl-1">.</span><span class="hl-5">defaultProps</span><span class="hl-1"> = {</span><br/><span class="hl-1"> </span><span class="hl-5">name:</span><span class="hl-1"> </span><span class="hl-2">'John Doe'</span><br/><span class="hl-1">}</span>
|
|
13
13
|
</code><button type="button">Copy</button></pre>
|
|
14
14
|
|
|
15
15
|
</div><div class="tsd-tag-Deprecated"><h4 class="tsd-anchor-link"><a id="Deprecated-2" class="tsd-anchor"></a>Deprecated<a href="#Deprecated-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Use <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Destructuring_assignment#default_value|default">values for destructuring assignments instead</a>.</p>
|
|
@@ -17,7 +17,7 @@ the component.</p>
|
|
|
17
17
|
explicitly if you want to display a different name for
|
|
18
18
|
debugging purposes.</p>
|
|
19
19
|
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-See"><h4 class="tsd-anchor-link"><a id="See-3" class="tsd-anchor"></a>See<a href="#See-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="https://legacy.reactjs.org/docs/react-component.html#displayname">Legacy React Docs</a></p>
|
|
20
|
-
</div><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example-1" class="tsd-anchor"></a>Example<a href="#Example-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="tsx"><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-0">MyComponent</span><span class="hl-1">: </span><span class="hl-10">FC</span><span class="hl-1"> = () </span><span class="hl-6">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">return</span><span class="hl-1"> </span><span class="hl-9"><</span><span class="hl-
|
|
20
|
+
</div><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example-1" class="tsd-anchor"></a>Example<a href="#Example-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="tsx"><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-0">MyComponent</span><span class="hl-1">: </span><span class="hl-10">FC</span><span class="hl-1"> = () </span><span class="hl-6">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">return</span><span class="hl-1"> </span><span class="hl-9"><</span><span class="hl-13">div</span><span class="hl-9">></span><span class="hl-1">Hello!</span><span class="hl-9"></</span><span class="hl-13">div</span><span class="hl-9">></span><br/><span class="hl-1">}</span><br/><br/><span class="hl-5">MyComponent</span><span class="hl-1">.</span><span class="hl-5">displayName</span><span class="hl-1"> = </span><span class="hl-2">'MyAwesomeComponent'</span>
|
|
21
21
|
</code><button type="button">Copy</button></pre>
|
|
22
22
|
|
|
23
23
|
</div></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/react/index.d.ts:1198</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="propTypes" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>prop<wbr/>Types</span><a href="#propTypes" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prop<wbr/>Types</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">WeakValidationMap</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ChatConfig.html" class="tsd-signature-type tsd-kind-interface">ChatConfig</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Used to declare the types of the props accepted by the
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>FeatureFlagProvider | @burtson-labs/bandit-engine</title><meta name="description" content="Documentation for @burtson-labs/bandit-engine"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@burtson-labs/bandit-engine</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@burtson-labs/bandit-engine</a></li><li><a href="FeatureFlagProvider.html">FeatureFlagProvider</a></li></ul><h1>Function FeatureFlagProvider</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Feature Flag Provider Component</p>
|
|
2
2
|
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="FeatureFlagProvider" class="tsd-anchor"></a><span class="tsd-kind-call-signature">Feature<wbr/>Flag<wbr/>Provider</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">props</span>, <span class="tsd-kind-parameter">deprecatedLegacyContext</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ReactNode</span><a href="#FeatureFlagProvider" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">props</span>: <a href="../interfaces/FeatureFlagProviderProps.html" class="tsd-signature-type tsd-kind-interface">FeatureFlagProviderProps</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">deprecatedLegacyContext</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><div class="tsd-tag-Deprecated"><h4 class="tsd-anchor-link"><a id="Deprecated" class="tsd-anchor"></a>Deprecated<a href="#Deprecated" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4></div><div class="tsd-tag-See"><h4 class="tsd-anchor-link"><a id="See" class="tsd-anchor"></a>See<a href="#See" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods">React Docs</a></p>
|
|
3
|
-
</div></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ReactNode</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Burtson-Labs/bandit/blob/
|
|
3
|
+
</div></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ReactNode</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Burtson-Labs/bandit-engine/blob/main/packages/bandit-engine/src/contexts/FeatureFlagContext.tsx#L123">packages/bandit-engine/src/contexts/FeatureFlagContext.tsx:123</a></li></ul></aside></li></ul></section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="FeatureFlagProvider.html#contextTypes" class="tsd-index-link deprecated tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>context<wbr/>Types?</span></a>
|
|
4
4
|
<a href="FeatureFlagProvider.html#defaultProps" class="tsd-index-link deprecated tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>default<wbr/>Props?</span></a>
|
|
5
5
|
<a href="FeatureFlagProvider.html#displayName" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>display<wbr/>Name?</span></a>
|
|
6
6
|
<a href="FeatureFlagProvider.html#propTypes" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prop<wbr/>Types?</span></a>
|
|
@@ -10,7 +10,7 @@ this component.</p>
|
|
|
10
10
|
</div></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/react/index.d.ts:1156</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="defaultProps" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span class="deprecated">default<wbr/>Props</span><a href="#defaultProps" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">default<wbr/>Props</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/FeatureFlagProviderProps.html" class="tsd-signature-type tsd-kind-interface">FeatureFlagProviderProps</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Used to define default values for the props accepted by
|
|
11
11
|
the component.</p>
|
|
12
12
|
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-See"><h4 class="tsd-anchor-link"><a id="See-2" class="tsd-anchor"></a>See<a href="#See-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="https://react.dev/reference/react/Component#static-defaultprops">React Docs</a></p>
|
|
13
|
-
</div><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example" class="tsd-anchor"></a>Example<a href="#Example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="tsx"><span class="hl-6">type</span><span class="hl-1"> </span><span class="hl-10">Props</span><span class="hl-1"> = { </span><span class="hl-5">name</span><span class="hl-1">?: </span><span class="hl-10">string</span><span class="hl-1"> }</span><br/><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-0">MyComponent</span><span class="hl-1">: </span><span class="hl-10">FC</span><span class="hl-1"><</span><span class="hl-10">Props</span><span class="hl-1">> = (</span><span class="hl-5">props</span><span class="hl-1">) </span><span class="hl-6">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">return</span><span class="hl-1"> </span><span class="hl-9"><</span><span class="hl-
|
|
13
|
+
</div><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example" class="tsd-anchor"></a>Example<a href="#Example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="tsx"><span class="hl-6">type</span><span class="hl-1"> </span><span class="hl-10">Props</span><span class="hl-1"> = { </span><span class="hl-5">name</span><span class="hl-1">?: </span><span class="hl-10">string</span><span class="hl-1"> }</span><br/><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-0">MyComponent</span><span class="hl-1">: </span><span class="hl-10">FC</span><span class="hl-1"><</span><span class="hl-10">Props</span><span class="hl-1">> = (</span><span class="hl-5">props</span><span class="hl-1">) </span><span class="hl-6">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">return</span><span class="hl-1"> </span><span class="hl-9"><</span><span class="hl-13">div</span><span class="hl-9">></span><span class="hl-6">{</span><span class="hl-5">props</span><span class="hl-14">.</span><span class="hl-5">name</span><span class="hl-6">}</span><span class="hl-9"></</span><span class="hl-13">div</span><span class="hl-9">></span><br/><span class="hl-1">}</span><br/><br/><span class="hl-5">MyComponent</span><span class="hl-1">.</span><span class="hl-5">defaultProps</span><span class="hl-1"> = {</span><br/><span class="hl-1"> </span><span class="hl-5">name:</span><span class="hl-1"> </span><span class="hl-2">'John Doe'</span><br/><span class="hl-1">}</span>
|
|
14
14
|
</code><button type="button">Copy</button></pre>
|
|
15
15
|
|
|
16
16
|
</div><div class="tsd-tag-Deprecated"><h4 class="tsd-anchor-link"><a id="Deprecated-2" class="tsd-anchor"></a>Deprecated<a href="#Deprecated-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Use <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Destructuring_assignment#default_value|default">values for destructuring assignments instead</a>.</p>
|
|
@@ -18,7 +18,7 @@ the component.</p>
|
|
|
18
18
|
explicitly if you want to display a different name for
|
|
19
19
|
debugging purposes.</p>
|
|
20
20
|
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-See"><h4 class="tsd-anchor-link"><a id="See-3" class="tsd-anchor"></a>See<a href="#See-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="https://legacy.reactjs.org/docs/react-component.html#displayname">Legacy React Docs</a></p>
|
|
21
|
-
</div><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example-1" class="tsd-anchor"></a>Example<a href="#Example-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="tsx"><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-0">MyComponent</span><span class="hl-1">: </span><span class="hl-10">FC</span><span class="hl-1"> = () </span><span class="hl-6">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">return</span><span class="hl-1"> </span><span class="hl-9"><</span><span class="hl-
|
|
21
|
+
</div><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example-1" class="tsd-anchor"></a>Example<a href="#Example-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="tsx"><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-0">MyComponent</span><span class="hl-1">: </span><span class="hl-10">FC</span><span class="hl-1"> = () </span><span class="hl-6">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">return</span><span class="hl-1"> </span><span class="hl-9"><</span><span class="hl-13">div</span><span class="hl-9">></span><span class="hl-1">Hello!</span><span class="hl-9"></</span><span class="hl-13">div</span><span class="hl-9">></span><br/><span class="hl-1">}</span><br/><br/><span class="hl-5">MyComponent</span><span class="hl-1">.</span><span class="hl-5">displayName</span><span class="hl-1"> = </span><span class="hl-2">'MyAwesomeComponent'</span>
|
|
22
22
|
</code><button type="button">Copy</button></pre>
|
|
23
23
|
|
|
24
24
|
</div></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/react/index.d.ts:1198</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="propTypes" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>prop<wbr/>Types</span><a href="#propTypes" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prop<wbr/>Types</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">WeakValidationMap</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/FeatureFlagProviderProps.html" class="tsd-signature-type tsd-kind-interface">FeatureFlagProviderProps</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Used to declare the types of the props accepted by the
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>FeedbackButton | @burtson-labs/bandit-engine</title><meta name="description" content="Documentation for @burtson-labs/bandit-engine"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@burtson-labs/bandit-engine</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@burtson-labs/bandit-engine</a></li><li><a href="FeedbackButton.html">FeedbackButton</a></li></ul><h1>Function FeedbackButton</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="FeedbackButton" class="tsd-anchor"></a><span class="tsd-kind-call-signature">Feedback<wbr/>Button</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">props</span>, <span class="tsd-kind-parameter">deprecatedLegacyContext</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ReactNode</span><a href="#FeedbackButton" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">props</span>: <a href="../interfaces/FeedbackButtonProps.html" class="tsd-signature-type tsd-kind-interface">FeedbackButtonProps</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">deprecatedLegacyContext</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><div class="tsd-tag-Deprecated"><h4 class="tsd-anchor-link"><a id="Deprecated" class="tsd-anchor"></a>Deprecated<a href="#Deprecated" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4></div><div class="tsd-tag-See"><h4 class="tsd-anchor-link"><a id="See" class="tsd-anchor"></a>See<a href="#See" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods">React Docs</a></p>
|
|
2
|
-
</div></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ReactNode</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Burtson-Labs/bandit/blob/
|
|
2
|
+
</div></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ReactNode</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Burtson-Labs/bandit-engine/blob/main/packages/bandit-engine/src/components/feedback/FeedbackButton.tsx#L59">packages/bandit-engine/src/components/feedback/FeedbackButton.tsx:59</a></li></ul></aside></li></ul></section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="FeedbackButton.html#contextTypes" class="tsd-index-link deprecated tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>context<wbr/>Types?</span></a>
|
|
3
3
|
<a href="FeedbackButton.html#defaultProps" class="tsd-index-link deprecated tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>default<wbr/>Props?</span></a>
|
|
4
4
|
<a href="FeedbackButton.html#displayName" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>display<wbr/>Name?</span></a>
|
|
5
5
|
<a href="FeedbackButton.html#propTypes" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prop<wbr/>Types?</span></a>
|
|
@@ -9,7 +9,7 @@ this component.</p>
|
|
|
9
9
|
</div></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/react/index.d.ts:1156</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="defaultProps" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span class="deprecated">default<wbr/>Props</span><a href="#defaultProps" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">default<wbr/>Props</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/FeedbackButtonProps.html" class="tsd-signature-type tsd-kind-interface">FeedbackButtonProps</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Used to define default values for the props accepted by
|
|
10
10
|
the component.</p>
|
|
11
11
|
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-See"><h4 class="tsd-anchor-link"><a id="See-2" class="tsd-anchor"></a>See<a href="#See-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="https://react.dev/reference/react/Component#static-defaultprops">React Docs</a></p>
|
|
12
|
-
</div><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example" class="tsd-anchor"></a>Example<a href="#Example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="tsx"><span class="hl-6">type</span><span class="hl-1"> </span><span class="hl-10">Props</span><span class="hl-1"> = { </span><span class="hl-5">name</span><span class="hl-1">?: </span><span class="hl-10">string</span><span class="hl-1"> }</span><br/><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-0">MyComponent</span><span class="hl-1">: </span><span class="hl-10">FC</span><span class="hl-1"><</span><span class="hl-10">Props</span><span class="hl-1">> = (</span><span class="hl-5">props</span><span class="hl-1">) </span><span class="hl-6">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">return</span><span class="hl-1"> </span><span class="hl-9"><</span><span class="hl-
|
|
12
|
+
</div><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example" class="tsd-anchor"></a>Example<a href="#Example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="tsx"><span class="hl-6">type</span><span class="hl-1"> </span><span class="hl-10">Props</span><span class="hl-1"> = { </span><span class="hl-5">name</span><span class="hl-1">?: </span><span class="hl-10">string</span><span class="hl-1"> }</span><br/><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-0">MyComponent</span><span class="hl-1">: </span><span class="hl-10">FC</span><span class="hl-1"><</span><span class="hl-10">Props</span><span class="hl-1">> = (</span><span class="hl-5">props</span><span class="hl-1">) </span><span class="hl-6">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">return</span><span class="hl-1"> </span><span class="hl-9"><</span><span class="hl-13">div</span><span class="hl-9">></span><span class="hl-6">{</span><span class="hl-5">props</span><span class="hl-14">.</span><span class="hl-5">name</span><span class="hl-6">}</span><span class="hl-9"></</span><span class="hl-13">div</span><span class="hl-9">></span><br/><span class="hl-1">}</span><br/><br/><span class="hl-5">MyComponent</span><span class="hl-1">.</span><span class="hl-5">defaultProps</span><span class="hl-1"> = {</span><br/><span class="hl-1"> </span><span class="hl-5">name:</span><span class="hl-1"> </span><span class="hl-2">'John Doe'</span><br/><span class="hl-1">}</span>
|
|
13
13
|
</code><button type="button">Copy</button></pre>
|
|
14
14
|
|
|
15
15
|
</div><div class="tsd-tag-Deprecated"><h4 class="tsd-anchor-link"><a id="Deprecated-2" class="tsd-anchor"></a>Deprecated<a href="#Deprecated-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Use <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Destructuring_assignment#default_value|default">values for destructuring assignments instead</a>.</p>
|
|
@@ -17,7 +17,7 @@ the component.</p>
|
|
|
17
17
|
explicitly if you want to display a different name for
|
|
18
18
|
debugging purposes.</p>
|
|
19
19
|
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-See"><h4 class="tsd-anchor-link"><a id="See-3" class="tsd-anchor"></a>See<a href="#See-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="https://legacy.reactjs.org/docs/react-component.html#displayname">Legacy React Docs</a></p>
|
|
20
|
-
</div><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example-1" class="tsd-anchor"></a>Example<a href="#Example-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="tsx"><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-0">MyComponent</span><span class="hl-1">: </span><span class="hl-10">FC</span><span class="hl-1"> = () </span><span class="hl-6">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">return</span><span class="hl-1"> </span><span class="hl-9"><</span><span class="hl-
|
|
20
|
+
</div><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example-1" class="tsd-anchor"></a>Example<a href="#Example-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="tsx"><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-0">MyComponent</span><span class="hl-1">: </span><span class="hl-10">FC</span><span class="hl-1"> = () </span><span class="hl-6">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">return</span><span class="hl-1"> </span><span class="hl-9"><</span><span class="hl-13">div</span><span class="hl-9">></span><span class="hl-1">Hello!</span><span class="hl-9"></</span><span class="hl-13">div</span><span class="hl-9">></span><br/><span class="hl-1">}</span><br/><br/><span class="hl-5">MyComponent</span><span class="hl-1">.</span><span class="hl-5">displayName</span><span class="hl-1"> = </span><span class="hl-2">'MyAwesomeComponent'</span>
|
|
21
21
|
</code><button type="button">Copy</button></pre>
|
|
22
22
|
|
|
23
23
|
</div></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/react/index.d.ts:1198</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="propTypes" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>prop<wbr/>Types</span><a href="#propTypes" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prop<wbr/>Types</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">WeakValidationMap</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/FeedbackButtonProps.html" class="tsd-signature-type tsd-kind-interface">FeedbackButtonProps</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Used to declare the types of the props accepted by the
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>FeedbackModal | @burtson-labs/bandit-engine</title><meta name="description" content="Documentation for @burtson-labs/bandit-engine"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@burtson-labs/bandit-engine</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@burtson-labs/bandit-engine</a></li><li><a href="FeedbackModal.html">FeedbackModal</a></li></ul><h1>Function FeedbackModal</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="FeedbackModal" class="tsd-anchor"></a><span class="tsd-kind-call-signature">Feedback<wbr/>Modal</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">props</span>, <span class="tsd-kind-parameter">deprecatedLegacyContext</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ReactNode</span><a href="#FeedbackModal" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">props</span>: <a href="../interfaces/FeedbackModalProps.html" class="tsd-signature-type tsd-kind-interface">FeedbackModalProps</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">deprecatedLegacyContext</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><div class="tsd-tag-Deprecated"><h4 class="tsd-anchor-link"><a id="Deprecated" class="tsd-anchor"></a>Deprecated<a href="#Deprecated" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4></div><div class="tsd-tag-See"><h4 class="tsd-anchor-link"><a id="See" class="tsd-anchor"></a>See<a href="#See" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods">React Docs</a></p>
|
|
2
|
-
</div></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ReactNode</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Burtson-Labs/bandit/blob/
|
|
2
|
+
</div></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ReactNode</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Burtson-Labs/bandit-engine/blob/main/packages/bandit-engine/src/components/feedback/FeedbackModal.tsx#L143">packages/bandit-engine/src/components/feedback/FeedbackModal.tsx:143</a></li></ul></aside></li></ul></section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="FeedbackModal.html#contextTypes" class="tsd-index-link deprecated tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>context<wbr/>Types?</span></a>
|
|
3
3
|
<a href="FeedbackModal.html#defaultProps" class="tsd-index-link deprecated tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>default<wbr/>Props?</span></a>
|
|
4
4
|
<a href="FeedbackModal.html#displayName" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>display<wbr/>Name?</span></a>
|
|
5
5
|
<a href="FeedbackModal.html#propTypes" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prop<wbr/>Types?</span></a>
|
|
@@ -9,7 +9,7 @@ this component.</p>
|
|
|
9
9
|
</div></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/react/index.d.ts:1156</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="defaultProps" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span class="deprecated">default<wbr/>Props</span><a href="#defaultProps" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">default<wbr/>Props</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/FeedbackModalProps.html" class="tsd-signature-type tsd-kind-interface">FeedbackModalProps</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Used to define default values for the props accepted by
|
|
10
10
|
the component.</p>
|
|
11
11
|
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-See"><h4 class="tsd-anchor-link"><a id="See-2" class="tsd-anchor"></a>See<a href="#See-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="https://react.dev/reference/react/Component#static-defaultprops">React Docs</a></p>
|
|
12
|
-
</div><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example" class="tsd-anchor"></a>Example<a href="#Example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="tsx"><span class="hl-6">type</span><span class="hl-1"> </span><span class="hl-10">Props</span><span class="hl-1"> = { </span><span class="hl-5">name</span><span class="hl-1">?: </span><span class="hl-10">string</span><span class="hl-1"> }</span><br/><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-0">MyComponent</span><span class="hl-1">: </span><span class="hl-10">FC</span><span class="hl-1"><</span><span class="hl-10">Props</span><span class="hl-1">> = (</span><span class="hl-5">props</span><span class="hl-1">) </span><span class="hl-6">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">return</span><span class="hl-1"> </span><span class="hl-9"><</span><span class="hl-
|
|
12
|
+
</div><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example" class="tsd-anchor"></a>Example<a href="#Example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="tsx"><span class="hl-6">type</span><span class="hl-1"> </span><span class="hl-10">Props</span><span class="hl-1"> = { </span><span class="hl-5">name</span><span class="hl-1">?: </span><span class="hl-10">string</span><span class="hl-1"> }</span><br/><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-0">MyComponent</span><span class="hl-1">: </span><span class="hl-10">FC</span><span class="hl-1"><</span><span class="hl-10">Props</span><span class="hl-1">> = (</span><span class="hl-5">props</span><span class="hl-1">) </span><span class="hl-6">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">return</span><span class="hl-1"> </span><span class="hl-9"><</span><span class="hl-13">div</span><span class="hl-9">></span><span class="hl-6">{</span><span class="hl-5">props</span><span class="hl-14">.</span><span class="hl-5">name</span><span class="hl-6">}</span><span class="hl-9"></</span><span class="hl-13">div</span><span class="hl-9">></span><br/><span class="hl-1">}</span><br/><br/><span class="hl-5">MyComponent</span><span class="hl-1">.</span><span class="hl-5">defaultProps</span><span class="hl-1"> = {</span><br/><span class="hl-1"> </span><span class="hl-5">name:</span><span class="hl-1"> </span><span class="hl-2">'John Doe'</span><br/><span class="hl-1">}</span>
|
|
13
13
|
</code><button type="button">Copy</button></pre>
|
|
14
14
|
|
|
15
15
|
</div><div class="tsd-tag-Deprecated"><h4 class="tsd-anchor-link"><a id="Deprecated-2" class="tsd-anchor"></a>Deprecated<a href="#Deprecated-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Use <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Destructuring_assignment#default_value|default">values for destructuring assignments instead</a>.</p>
|
|
@@ -17,7 +17,7 @@ the component.</p>
|
|
|
17
17
|
explicitly if you want to display a different name for
|
|
18
18
|
debugging purposes.</p>
|
|
19
19
|
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-See"><h4 class="tsd-anchor-link"><a id="See-3" class="tsd-anchor"></a>See<a href="#See-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="https://legacy.reactjs.org/docs/react-component.html#displayname">Legacy React Docs</a></p>
|
|
20
|
-
</div><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example-1" class="tsd-anchor"></a>Example<a href="#Example-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="tsx"><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-0">MyComponent</span><span class="hl-1">: </span><span class="hl-10">FC</span><span class="hl-1"> = () </span><span class="hl-6">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">return</span><span class="hl-1"> </span><span class="hl-9"><</span><span class="hl-
|
|
20
|
+
</div><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example-1" class="tsd-anchor"></a>Example<a href="#Example-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="tsx"><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-0">MyComponent</span><span class="hl-1">: </span><span class="hl-10">FC</span><span class="hl-1"> = () </span><span class="hl-6">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">return</span><span class="hl-1"> </span><span class="hl-9"><</span><span class="hl-13">div</span><span class="hl-9">></span><span class="hl-1">Hello!</span><span class="hl-9"></</span><span class="hl-13">div</span><span class="hl-9">></span><br/><span class="hl-1">}</span><br/><br/><span class="hl-5">MyComponent</span><span class="hl-1">.</span><span class="hl-5">displayName</span><span class="hl-1"> = </span><span class="hl-2">'MyAwesomeComponent'</span>
|
|
21
21
|
</code><button type="button">Copy</button></pre>
|
|
22
22
|
|
|
23
23
|
</div></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/react/index.d.ts:1198</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="propTypes" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>prop<wbr/>Types</span><a href="#propTypes" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prop<wbr/>Types</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">WeakValidationMap</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/FeedbackModalProps.html" class="tsd-signature-type tsd-kind-interface">FeedbackModalProps</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Used to declare the types of the props accepted by the
|
|
@@ -1 +1 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Management | @burtson-labs/bandit-engine</title><meta name="description" content="Documentation for @burtson-labs/bandit-engine"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@burtson-labs/bandit-engine</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@burtson-labs/bandit-engine</a></li><li><a href="Management.html">Management</a></li></ul><h1>Function Management</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="Management" class="tsd-anchor"></a><span class="tsd-kind-call-signature">Management</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Element</span><a href="#Management" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Element</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Burtson-Labs/bandit/blob/
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Management | @burtson-labs/bandit-engine</title><meta name="description" content="Documentation for @burtson-labs/bandit-engine"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@burtson-labs/bandit-engine</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@burtson-labs/bandit-engine</a></li><li><a href="Management.html">Management</a></li></ul><h1>Function Management</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="Management" class="tsd-anchor"></a><span class="tsd-kind-call-signature">Management</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Element</span><a href="#Management" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Element</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Burtson-Labs/bandit-engine/blob/main/packages/bandit-engine/src/management/management.tsx#L71">packages/bandit-engine/src/management/management.tsx:71</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@burtson-labs/bandit-engine</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>NotificationProvider | @burtson-labs/bandit-engine</title><meta name="description" content="Documentation for @burtson-labs/bandit-engine"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@burtson-labs/bandit-engine</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@burtson-labs/bandit-engine</a></li><li><a href="NotificationProvider.html">NotificationProvider</a></li></ul><h1>Function NotificationProvider</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="NotificationProvider" class="tsd-anchor"></a><span class="tsd-kind-call-signature">Notification<wbr/>Provider</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">props</span>, <span class="tsd-kind-parameter">deprecatedLegacyContext</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ReactNode</span><a href="#NotificationProvider" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">props</span>: <a href="../interfaces/NotificationProviderProps.html" class="tsd-signature-type tsd-kind-interface">NotificationProviderProps</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">deprecatedLegacyContext</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><div class="tsd-tag-Deprecated"><h4 class="tsd-anchor-link"><a id="Deprecated" class="tsd-anchor"></a>Deprecated<a href="#Deprecated" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4></div><div class="tsd-tag-See"><h4 class="tsd-anchor-link"><a id="See" class="tsd-anchor"></a>See<a href="#See" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods">React Docs</a></p>
|
|
2
|
-
</div></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ReactNode</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Burtson-Labs/bandit/blob/
|
|
2
|
+
</div></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ReactNode</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Burtson-Labs/bandit-engine/blob/main/packages/bandit-engine/src/shared/components/NotificationProvider.tsx#L59">packages/bandit-engine/src/shared/components/NotificationProvider.tsx:59</a></li></ul></aside></li></ul></section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="NotificationProvider.html#contextTypes" class="tsd-index-link deprecated tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>context<wbr/>Types?</span></a>
|
|
3
3
|
<a href="NotificationProvider.html#defaultProps" class="tsd-index-link deprecated tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>default<wbr/>Props?</span></a>
|
|
4
4
|
<a href="NotificationProvider.html#displayName" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>display<wbr/>Name?</span></a>
|
|
5
5
|
<a href="NotificationProvider.html#propTypes" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prop<wbr/>Types?</span></a>
|
|
@@ -9,7 +9,7 @@ this component.</p>
|
|
|
9
9
|
</div></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/react/index.d.ts:1156</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="defaultProps" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span class="deprecated">default<wbr/>Props</span><a href="#defaultProps" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">default<wbr/>Props</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/NotificationProviderProps.html" class="tsd-signature-type tsd-kind-interface">NotificationProviderProps</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Used to define default values for the props accepted by
|
|
10
10
|
the component.</p>
|
|
11
11
|
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-See"><h4 class="tsd-anchor-link"><a id="See-2" class="tsd-anchor"></a>See<a href="#See-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="https://react.dev/reference/react/Component#static-defaultprops">React Docs</a></p>
|
|
12
|
-
</div><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example" class="tsd-anchor"></a>Example<a href="#Example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="tsx"><span class="hl-6">type</span><span class="hl-1"> </span><span class="hl-10">Props</span><span class="hl-1"> = { </span><span class="hl-5">name</span><span class="hl-1">?: </span><span class="hl-10">string</span><span class="hl-1"> }</span><br/><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-0">MyComponent</span><span class="hl-1">: </span><span class="hl-10">FC</span><span class="hl-1"><</span><span class="hl-10">Props</span><span class="hl-1">> = (</span><span class="hl-5">props</span><span class="hl-1">) </span><span class="hl-6">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">return</span><span class="hl-1"> </span><span class="hl-9"><</span><span class="hl-
|
|
12
|
+
</div><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example" class="tsd-anchor"></a>Example<a href="#Example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="tsx"><span class="hl-6">type</span><span class="hl-1"> </span><span class="hl-10">Props</span><span class="hl-1"> = { </span><span class="hl-5">name</span><span class="hl-1">?: </span><span class="hl-10">string</span><span class="hl-1"> }</span><br/><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-0">MyComponent</span><span class="hl-1">: </span><span class="hl-10">FC</span><span class="hl-1"><</span><span class="hl-10">Props</span><span class="hl-1">> = (</span><span class="hl-5">props</span><span class="hl-1">) </span><span class="hl-6">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">return</span><span class="hl-1"> </span><span class="hl-9"><</span><span class="hl-13">div</span><span class="hl-9">></span><span class="hl-6">{</span><span class="hl-5">props</span><span class="hl-14">.</span><span class="hl-5">name</span><span class="hl-6">}</span><span class="hl-9"></</span><span class="hl-13">div</span><span class="hl-9">></span><br/><span class="hl-1">}</span><br/><br/><span class="hl-5">MyComponent</span><span class="hl-1">.</span><span class="hl-5">defaultProps</span><span class="hl-1"> = {</span><br/><span class="hl-1"> </span><span class="hl-5">name:</span><span class="hl-1"> </span><span class="hl-2">'John Doe'</span><br/><span class="hl-1">}</span>
|
|
13
13
|
</code><button type="button">Copy</button></pre>
|
|
14
14
|
|
|
15
15
|
</div><div class="tsd-tag-Deprecated"><h4 class="tsd-anchor-link"><a id="Deprecated-2" class="tsd-anchor"></a>Deprecated<a href="#Deprecated-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Use <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Destructuring_assignment#default_value|default">values for destructuring assignments instead</a>.</p>
|
|
@@ -17,7 +17,7 @@ the component.</p>
|
|
|
17
17
|
explicitly if you want to display a different name for
|
|
18
18
|
debugging purposes.</p>
|
|
19
19
|
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-See"><h4 class="tsd-anchor-link"><a id="See-3" class="tsd-anchor"></a>See<a href="#See-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="https://legacy.reactjs.org/docs/react-component.html#displayname">Legacy React Docs</a></p>
|
|
20
|
-
</div><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example-1" class="tsd-anchor"></a>Example<a href="#Example-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="tsx"><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-0">MyComponent</span><span class="hl-1">: </span><span class="hl-10">FC</span><span class="hl-1"> = () </span><span class="hl-6">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">return</span><span class="hl-1"> </span><span class="hl-9"><</span><span class="hl-
|
|
20
|
+
</div><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example-1" class="tsd-anchor"></a>Example<a href="#Example-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="tsx"><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-0">MyComponent</span><span class="hl-1">: </span><span class="hl-10">FC</span><span class="hl-1"> = () </span><span class="hl-6">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">return</span><span class="hl-1"> </span><span class="hl-9"><</span><span class="hl-13">div</span><span class="hl-9">></span><span class="hl-1">Hello!</span><span class="hl-9"></</span><span class="hl-13">div</span><span class="hl-9">></span><br/><span class="hl-1">}</span><br/><br/><span class="hl-5">MyComponent</span><span class="hl-1">.</span><span class="hl-5">displayName</span><span class="hl-1"> = </span><span class="hl-2">'MyAwesomeComponent'</span>
|
|
21
21
|
</code><button type="button">Copy</button></pre>
|
|
22
22
|
|
|
23
23
|
</div></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/react/index.d.ts:1198</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="propTypes" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>prop<wbr/>Types</span><a href="#propTypes" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prop<wbr/>Types</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">WeakValidationMap</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/NotificationProviderProps.html" class="tsd-signature-type tsd-kind-interface">NotificationProviderProps</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Used to declare the types of the props accepted by the
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SubscriptionExpiredGuard | @burtson-labs/bandit-engine</title><meta name="description" content="Documentation for @burtson-labs/bandit-engine"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@burtson-labs/bandit-engine</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@burtson-labs/bandit-engine</a></li><li><a href="SubscriptionExpiredGuard.html">SubscriptionExpiredGuard</a></li></ul><h1>Function SubscriptionExpiredGuard</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Guard component that shows subscription expired modal for expired users
|
|
2
2
|
Wraps children and shows modal when subscription is expired</p>
|
|
3
3
|
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="SubscriptionExpiredGuard" class="tsd-anchor"></a><span class="tsd-kind-call-signature">Subscription<wbr/>Expired<wbr/>Guard</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">props</span>, <span class="tsd-kind-parameter">deprecatedLegacyContext</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ReactNode</span><a href="#SubscriptionExpiredGuard" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">props</span>: <a href="../interfaces/SubscriptionExpiredGuardProps.html" class="tsd-signature-type tsd-kind-interface">SubscriptionExpiredGuardProps</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">deprecatedLegacyContext</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><div class="tsd-tag-Deprecated"><h4 class="tsd-anchor-link"><a id="Deprecated" class="tsd-anchor"></a>Deprecated<a href="#Deprecated" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4></div><div class="tsd-tag-See"><h4 class="tsd-anchor-link"><a id="See" class="tsd-anchor"></a>See<a href="#See" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods">React Docs</a></p>
|
|
4
|
-
</div></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ReactNode</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Burtson-Labs/bandit/blob/
|
|
4
|
+
</div></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ReactNode</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Burtson-Labs/bandit-engine/blob/main/packages/bandit-engine/src/guards/SubscriptionExpiredGuard.tsx#L36">packages/bandit-engine/src/guards/SubscriptionExpiredGuard.tsx:36</a></li></ul></aside></li></ul></section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="SubscriptionExpiredGuard.html#contextTypes" class="tsd-index-link deprecated tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>context<wbr/>Types?</span></a>
|
|
5
5
|
<a href="SubscriptionExpiredGuard.html#defaultProps" class="tsd-index-link deprecated tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>default<wbr/>Props?</span></a>
|
|
6
6
|
<a href="SubscriptionExpiredGuard.html#displayName" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>display<wbr/>Name?</span></a>
|
|
7
7
|
<a href="SubscriptionExpiredGuard.html#propTypes" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prop<wbr/>Types?</span></a>
|
|
@@ -11,7 +11,7 @@ this component.</p>
|
|
|
11
11
|
</div></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/react/index.d.ts:1156</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="defaultProps" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span class="deprecated">default<wbr/>Props</span><a href="#defaultProps" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">default<wbr/>Props</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/SubscriptionExpiredGuardProps.html" class="tsd-signature-type tsd-kind-interface">SubscriptionExpiredGuardProps</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Used to define default values for the props accepted by
|
|
12
12
|
the component.</p>
|
|
13
13
|
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-See"><h4 class="tsd-anchor-link"><a id="See-2" class="tsd-anchor"></a>See<a href="#See-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="https://react.dev/reference/react/Component#static-defaultprops">React Docs</a></p>
|
|
14
|
-
</div><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example" class="tsd-anchor"></a>Example<a href="#Example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="tsx"><span class="hl-6">type</span><span class="hl-1"> </span><span class="hl-10">Props</span><span class="hl-1"> = { </span><span class="hl-5">name</span><span class="hl-1">?: </span><span class="hl-10">string</span><span class="hl-1"> }</span><br/><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-0">MyComponent</span><span class="hl-1">: </span><span class="hl-10">FC</span><span class="hl-1"><</span><span class="hl-10">Props</span><span class="hl-1">> = (</span><span class="hl-5">props</span><span class="hl-1">) </span><span class="hl-6">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">return</span><span class="hl-1"> </span><span class="hl-9"><</span><span class="hl-
|
|
14
|
+
</div><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example" class="tsd-anchor"></a>Example<a href="#Example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="tsx"><span class="hl-6">type</span><span class="hl-1"> </span><span class="hl-10">Props</span><span class="hl-1"> = { </span><span class="hl-5">name</span><span class="hl-1">?: </span><span class="hl-10">string</span><span class="hl-1"> }</span><br/><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-0">MyComponent</span><span class="hl-1">: </span><span class="hl-10">FC</span><span class="hl-1"><</span><span class="hl-10">Props</span><span class="hl-1">> = (</span><span class="hl-5">props</span><span class="hl-1">) </span><span class="hl-6">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">return</span><span class="hl-1"> </span><span class="hl-9"><</span><span class="hl-13">div</span><span class="hl-9">></span><span class="hl-6">{</span><span class="hl-5">props</span><span class="hl-14">.</span><span class="hl-5">name</span><span class="hl-6">}</span><span class="hl-9"></</span><span class="hl-13">div</span><span class="hl-9">></span><br/><span class="hl-1">}</span><br/><br/><span class="hl-5">MyComponent</span><span class="hl-1">.</span><span class="hl-5">defaultProps</span><span class="hl-1"> = {</span><br/><span class="hl-1"> </span><span class="hl-5">name:</span><span class="hl-1"> </span><span class="hl-2">'John Doe'</span><br/><span class="hl-1">}</span>
|
|
15
15
|
</code><button type="button">Copy</button></pre>
|
|
16
16
|
|
|
17
17
|
</div><div class="tsd-tag-Deprecated"><h4 class="tsd-anchor-link"><a id="Deprecated-2" class="tsd-anchor"></a>Deprecated<a href="#Deprecated-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Use <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Destructuring_assignment#default_value|default">values for destructuring assignments instead</a>.</p>
|
|
@@ -19,7 +19,7 @@ the component.</p>
|
|
|
19
19
|
explicitly if you want to display a different name for
|
|
20
20
|
debugging purposes.</p>
|
|
21
21
|
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-See"><h4 class="tsd-anchor-link"><a id="See-3" class="tsd-anchor"></a>See<a href="#See-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="https://legacy.reactjs.org/docs/react-component.html#displayname">Legacy React Docs</a></p>
|
|
22
|
-
</div><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example-1" class="tsd-anchor"></a>Example<a href="#Example-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="tsx"><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-0">MyComponent</span><span class="hl-1">: </span><span class="hl-10">FC</span><span class="hl-1"> = () </span><span class="hl-6">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">return</span><span class="hl-1"> </span><span class="hl-9"><</span><span class="hl-
|
|
22
|
+
</div><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example-1" class="tsd-anchor"></a>Example<a href="#Example-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="tsx"><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-0">MyComponent</span><span class="hl-1">: </span><span class="hl-10">FC</span><span class="hl-1"> = () </span><span class="hl-6">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">return</span><span class="hl-1"> </span><span class="hl-9"><</span><span class="hl-13">div</span><span class="hl-9">></span><span class="hl-1">Hello!</span><span class="hl-9"></</span><span class="hl-13">div</span><span class="hl-9">></span><br/><span class="hl-1">}</span><br/><br/><span class="hl-5">MyComponent</span><span class="hl-1">.</span><span class="hl-5">displayName</span><span class="hl-1"> = </span><span class="hl-2">'MyAwesomeComponent'</span>
|
|
23
23
|
</code><button type="button">Copy</button></pre>
|
|
24
24
|
|
|
25
25
|
</div></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/react/index.d.ts:1198</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="propTypes" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>prop<wbr/>Types</span><a href="#propTypes" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prop<wbr/>Types</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">WeakValidationMap</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/SubscriptionExpiredGuardProps.html" class="tsd-signature-type tsd-kind-interface">SubscriptionExpiredGuardProps</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Used to declare the types of the props accepted by the
|