mirror of
https://github.com/grafana/grafana.git
synced 2025-08-01 10:10:24 +08:00
6bc369629d
* trying out api-extractor. * works with our setup of build. * wip. * changed the packages so it works better with the api-extractor. * Changes to make the api-extractor to work. * cleaned up the api-extractor config files. * added some more documentation. * added tsdoc-metadata to gitignore. * removed the generated docs (will do that in another PR). * added execute permission to script for generating dosc. * added so we will push generated docs to branch. * will clean packages_api on abort. * Fixed failing tests. * fixed formatting issue with typedoc comment. * temporarily disabled tslint rules about namespace until https://github.com/microsoft/rushstack/issues/1029 is resolved * temporary enabled bable namespaces. * updated build script. * updated script. * updated script with some colors. * changed to camelCase. * removed spacing. * Starting to add documentation guidelines. * added examples headline. * added menu options. * added parameters and return values. * Fixed merge error. * Added first version of auto-generated docs. * changed so we use the eslint ignore syntax. * changed to correct eslint ingnore comment. * fixed some spelling errors reported by codespell. * added script to generate docs in current folder. * updated api docs. * lerna bootstrap. * added eror to the ingore words list. * removed file that should be ignored. * updated locKFILE. * referenced the code comments guidelines. * updated packages. * updated deps. * updated the autogenerated dosc. * adding missing new line.
40 lines
1.4 KiB
Markdown
40 lines
1.4 KiB
Markdown
+++
|
|
# -----------------------------------------------------------------------
|
|
# Do not edit this file. It is automatically generated by API Documenter.
|
|
# -----------------------------------------------------------------------
|
|
title = "SuggestionsPlugin"
|
|
keywords = ["grafana","documentation","sdk","@grafana/ui"]
|
|
type = "docs"
|
|
draft = true
|
|
+++
|
|
|
|
## 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) => Promise<TypeaheadOutput>;</code><br/><code> cleanText?: (text: string) => string;</code><br/><code> onWillApplySuggestion?: (suggestion: string, state: SuggestionsState) => string;</code><br/><code> portalOrigin: string;</code><br/><code>}</code> | |
|
|
|
|
<b>Returns:</b>
|
|
|
|
`SlatePlugin`
|
|
|