grafana/docs/sources/packages_api/ui/suggestionsplugin.md

+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "SuggestionsPlugin"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
+++

## SuggestionsPlugin() function

### SuggestionsPlugin() function

<b>Signature</b>

```typescript
export declare function SuggestionsPlugin({ onTypeahead, cleanText, onWillApplySuggestion, portalOrigin, }: {
    onTypeahead?: (typeahead: TypeaheadInput) => Promise<TypeaheadOutput>;
    cleanText?: (text: string) => string;
    onWillApplySuggestion?: (suggestion: string, state: SuggestionsState) => string;
    portalOrigin: string;
}): SlatePlugin;
```
<b>Import</b>

```typescript
import { SuggestionsPlugin } from '@grafana/ui';
```
<b>Parameters</b>

|  Parameter | Type | Description |
|  --- | --- | --- |
|  { onTypeahead, cleanText, onWillApplySuggestion, portalOrigin, } | <code>{</code><br/><code>    onTypeahead?: (typeahead: TypeaheadInput) =&gt; Promise&lt;TypeaheadOutput&gt;;</code><br/><code>    cleanText?: (text: string) =&gt; string;</code><br/><code>    onWillApplySuggestion?: (suggestion: string, state: SuggestionsState) =&gt; string;</code><br/><code>    portalOrigin: string;</code><br/><code>}</code> |  |

<b>Returns:</b>

`SlatePlugin`