Files
grafana/docs/sources/packages_api/ui/completionitemgroup.md
Marcus Andersson 6bc369629d Docs: adding first version of the auto-generated packages API docs. (#22107)
* 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.
2020-02-26 10:03:53 +01:00

1.8 KiB

+++

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

Do not edit this file. It is automatically generated by API Documenter.

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

title = "CompletionItemGroup" keywords = ["grafana","documentation","sdk","@grafana/ui"] type = "docs" draft = true +++

CompletionItemGroup interface

Signature

export interface CompletionItemGroup 

Import

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

Properties

Property Type Description
items CompletionItem[] List of suggestions of this group.
label string Label that will be displayed for all entries of this group.
prefixMatch boolean If true, match only by prefix (and not mid-word).
skipFilter boolean If true, do not filter items in this group based on the search.
skipSort boolean If true, do not sort items.

items property

List of suggestions of this group.

Signature

items: CompletionItem[];

label property

Label that will be displayed for all entries of this group.

Signature

label: string;

prefixMatch property

If true, match only by prefix (and not mid-word).

Signature

prefixMatch?: boolean;

skipFilter property

If true, do not filter items in this group based on the search.

Signature

skipFilter?: boolean;

skipSort property

If true, do not sort items.

Signature

skipSort?: boolean;