mirror of
https://github.com/grafana/grafana.git
synced 2025-07-30 19:42:30 +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.
3.7 KiB
3.7 KiB
+++
-----------------------------------------------------------------------
Do not edit this file. It is automatically generated by API Documenter.
-----------------------------------------------------------------------
title = "Cascader" keywords = ["grafana","documentation","sdk","@grafana/ui"] type = "docs" draft = true +++
Cascader class
Signature
export declare class Cascader extends React.PureComponent<CascaderProps, CascaderState>
Import
import { Cascader } from '@grafana/ui';
Constructors
| Constructor | Modifiers | Description |
|---|---|---|
| constructor(props) | Constructs a new instance of the Cascader class |
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| flattenOptions | (options: CascaderOption[], optionPath?: CascaderOption[]) => SelectableValue<string[]>[] |
||
| onBlur | () => void |
||
| onBlurCascade | () => void |
||
| onChange | (value: string[], selectedOptions: CascaderOption[]) => void |
||
| onClick | () => void |
||
| onCreateOption | (value: string) => void |
||
| onInputKeyDown | (e: React.KeyboardEvent<HTMLInputElement>) => void |
||
| onSelect | (obj: SelectableValue<string[]>) => void |
Methods
| Method | Modifiers | Description |
|---|---|---|
| render() | ||
| setInitialValue(searchableOptions, initValue) |
constructor(props)
Constructs a new instance of the Cascader class
Signature
constructor(props: CascaderProps);
Parameters
| Parameter | Type | Description |
|---|---|---|
| props | CascaderProps |
flattenOptions property
Signature
flattenOptions: (options: CascaderOption[], optionPath?: CascaderOption[]) => SelectableValue<string[]>[];
onBlur property
Signature
onBlur: () => void;
onBlurCascade property
Signature
onBlurCascade: () => void;
onChange property
Signature
onChange: (value: string[], selectedOptions: CascaderOption[]) => void;
onClick property
Signature
onClick: () => void;
onCreateOption property
Signature
onCreateOption: (value: string) => void;
onInputKeyDown property
Signature
onInputKeyDown: (e: React.KeyboardEvent<HTMLInputElement>) => void;
onSelect property
Signature
onSelect: (obj: SelectableValue<string[]>) => void;
render method
Signature
render(): JSX.Element;
Returns:
JSX.Element
setInitialValue method
Signature
setInitialValue(searchableOptions: Array<SelectableValue<string[]>>, initValue?: string): {
rcValue: string[];
activeLabel: any;
};
Parameters
| Parameter | Type | Description |
|---|---|---|
| searchableOptions | Array<SelectableValue<string[]>> |
|
| initValue | string |
Returns:
{ rcValue: string[]; activeLabel: any; }