Skip to content

Commit 5c03e92

Browse files
github-automation-metabaseMetabase Docs bot
andauthored
[auto] adding content to release-x.56.x->release-x.56.x (#748)
Co-authored-by: Metabase Docs bot <[email protected]>
1 parent ca85c14 commit 5c03e92

File tree

16 files changed

+36
-20
lines changed

16 files changed

+36
-20
lines changed

_docs/latest/embedding/sdk/api/MetabaseProvider.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5 id="classname"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">className</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>A custom class name to be added to the root element.</p>
1919
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5 id="errorcomponent"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">errorComponent</span><span class="tsd-signature-symbol">?: </span><a href="SdkErrorComponent.html" class="tsd-signature-type tsd-kind-type-alias">SdkErrorComponent</a></h5><div class="tsd-comment tsd-typography"><p>A custom error component to display when the SDK encounters an error.</p>
2020
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5 id="eventhandlers"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">eventHandlers</span><span class="tsd-signature-symbol">?: </span><a href="SdkEventHandlersConfig.html" class="tsd-signature-type tsd-kind-type-alias">SdkEventHandlersConfig</a></h5><div class="tsd-comment tsd-typography"><p>See <a href="https://www.metabase.com/docs/latest/embedding/sdk/config#global-event-handlers">Global event handlers</a>.</p>
21-
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5 id="loadercomponent"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">loaderComponent</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <a href="https://github.com/DefinitelyTyped/DefinitelyTyped/blob/0b728411cd1dfb4bd26992bb35a73cf8edaa22e7/types/react/index.d.ts#L4240" class="tsd-signature-type external" target="_blank">Element</a></h5><div class="tsd-comment tsd-typography"><p>A custom loader component to display while the SDK is loading.</p>
21+
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5 id="islocalhost"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">isLocalHost</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5 id="loadercomponent"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">loaderComponent</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <a href="https://github.com/DefinitelyTyped/DefinitelyTyped/blob/0b728411cd1dfb4bd26992bb35a73cf8edaa22e7/types/react/index.d.ts#L4240" class="tsd-signature-type external" target="_blank">Element</a></h5><div class="tsd-comment tsd-typography"><p>A custom loader component to display while the SDK is loading.</p>
2222
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5 id="locale"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">locale</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Defines the display language. Accepts an ISO language code such as <code>en</code> or <code>de</code>.
2323
Defaults to the instance locale.</p>
2424
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5 id="pluginsconfig"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">pluginsConfig</span><span class="tsd-signature-symbol">?: </span><a href="MetabasePluginsConfig.html" class="tsd-signature-type tsd-kind-type-alias">MetabasePluginsConfig</a></h5><div class="tsd-comment tsd-typography"><p>See <a href="https://www.metabase.com/docs/latest/embedding/sdk/plugins">Plugins</a>.</p>

_docs/latest/embedding/sdk/api/MetabaseProviderProps.html

Lines changed: 4 additions & 3 deletions
Large diffs are not rendered by default.

_docs/latest/embedding/sdk/api/assets/search.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

_docs/latest/embedding/sdk/api/snippets/MetabaseProviderProps.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ latest: true
3636
| <a id="classname"></a> `className?` | `string` | A custom class name to be added to the root element. |
3737
| <a id="errorcomponent"></a> `errorComponent?` | [`SdkErrorComponent`](./api/SdkErrorComponent) | A custom error component to display when the SDK encounters an error. |
3838
| <a id="eventhandlers"></a> `eventHandlers?` | [`SdkEventHandlersConfig`](./api/SdkEventHandlersConfig) | See [Global event handlers](/docs/latest/embedding/sdk/config#global-event-handlers). |
39+
| <a id="islocalhost"></a> `isLocalHost?` | `boolean` | - |
3940
| <a id="loadercomponent"></a> `loaderComponent?` | () => [`Element`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/0b728411cd1dfb4bd26992bb35a73cf8edaa22e7/types/react/index.d.ts#L4240) | A custom loader component to display while the SDK is loading. |
4041
| <a id="locale"></a> `locale?` | `string` | Defines the display language. Accepts an ISO language code such as `en` or `de`. Defaults to the instance locale. |
4142
| <a id="pluginsconfig"></a> `pluginsConfig?` | [`MetabasePluginsConfig`](./api/MetabasePluginsConfig) | See [Plugins](/docs/latest/embedding/sdk/plugins). |

_docs/v0.56/embedding/sdk/api/MetabaseProvider.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5 id="classname"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">className</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>A custom class name to be added to the root element.</p>
1717
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5 id="errorcomponent"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">errorComponent</span><span class="tsd-signature-symbol">?: </span><a href="SdkErrorComponent.html" class="tsd-signature-type tsd-kind-type-alias">SdkErrorComponent</a></h5><div class="tsd-comment tsd-typography"><p>A custom error component to display when the SDK encounters an error.</p>
1818
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5 id="eventhandlers"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">eventHandlers</span><span class="tsd-signature-symbol">?: </span><a href="SdkEventHandlersConfig.html" class="tsd-signature-type tsd-kind-type-alias">SdkEventHandlersConfig</a></h5><div class="tsd-comment tsd-typography"><p>See <a href="https://www.metabase.com/docs/v0.56/embedding/sdk/config#global-event-handlers">Global event handlers</a>.</p>
19-
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5 id="loadercomponent"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">loaderComponent</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <a href="https://github.com/DefinitelyTyped/DefinitelyTyped/blob/0b728411cd1dfb4bd26992bb35a73cf8edaa22e7/types/react/index.d.ts#L4240" class="tsd-signature-type external" target="_blank">Element</a></h5><div class="tsd-comment tsd-typography"><p>A custom loader component to display while the SDK is loading.</p>
19+
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5 id="islocalhost"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">isLocalHost</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5 id="loadercomponent"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">loaderComponent</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <a href="https://github.com/DefinitelyTyped/DefinitelyTyped/blob/0b728411cd1dfb4bd26992bb35a73cf8edaa22e7/types/react/index.d.ts#L4240" class="tsd-signature-type external" target="_blank">Element</a></h5><div class="tsd-comment tsd-typography"><p>A custom loader component to display while the SDK is loading.</p>
2020
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5 id="locale"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">locale</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Defines the display language. Accepts an ISO language code such as <code>en</code> or <code>de</code>.
2121
Defaults to the instance locale.</p>
2222
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5 id="pluginsconfig"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">pluginsConfig</span><span class="tsd-signature-symbol">?: </span><a href="MetabasePluginsConfig.html" class="tsd-signature-type tsd-kind-type-alias">MetabasePluginsConfig</a></h5><div class="tsd-comment tsd-typography"><p>See <a href="https://www.metabase.com/docs/v0.56/embedding/sdk/plugins">Plugins</a>.</p>

0 commit comments

Comments
 (0)