IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2024-11-29 20:24:18 -06:00
Code Issues Packages Projects Releases Wiki Activity
b7fee71049
grafana/docs/sources/packages_api/ui/suggestionsplugin.md
Marcus Andersson cc3fc18076
Docs: enable packages reference docs for 7-beta (#23953) 
* added packages reference menu item.

* removed the draft flag.

* Updated docs by running script.
2020-04-28 09:53:58 +02:00

1.4 KiB
Raw Blame History

+++

-----------------------------------------------------------------------

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

Signature

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;

Import

import { SuggestionsPlugin } from '@grafana/ui';

Parameters

Parameter Type Description
{ onTypeahead, cleanText, onWillApplySuggestion, portalOrigin, } {
onTypeahead?: (typeahead: TypeaheadInput) => Promise<TypeaheadOutput>;
cleanText?: (text: string) => string;
onWillApplySuggestion?: (suggestion: string, state: SuggestionsState) => string;
portalOrigin: string;
}

Returns:

SlatePlugin