mirror of
https://github.com/grafana/grafana.git
synced 2025-08-01 23:23:12 +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.
163 lines
3.7 KiB
Markdown
163 lines
3.7 KiB
Markdown
+++
|
|
# -----------------------------------------------------------------------
|
|
# 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
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
export declare class Cascader extends React.PureComponent<CascaderProps, CascaderState>
|
|
```
|
|
<b>Import</b>
|
|
|
|
```typescript
|
|
import { Cascader } from '@grafana/ui';
|
|
```
|
|
<b>Constructors</b>
|
|
|
|
| Constructor | Modifiers | Description |
|
|
| --- | --- | --- |
|
|
| [constructor(props)](#constructor-props) | | Constructs a new instance of the <code>Cascader</code> class |
|
|
|
|
<b>Properties</b>
|
|
|
|
| Property | Modifiers | Type | Description |
|
|
| --- | --- | --- | --- |
|
|
| [flattenOptions](#flattenoptions-property) | | <code>(options: CascaderOption[], optionPath?: CascaderOption[]) => SelectableValue<string[]>[]</code> | |
|
|
| [onBlur](#onblur-property) | | <code>() => void</code> | |
|
|
| [onBlurCascade](#onblurcascade-property) | | <code>() => void</code> | |
|
|
| [onChange](#onchange-property) | | <code>(value: string[], selectedOptions: CascaderOption[]) => void</code> | |
|
|
| [onClick](#onclick-property) | | <code>() => void</code> | |
|
|
| [onCreateOption](#oncreateoption-property) | | <code>(value: string) => void</code> | |
|
|
| [onInputKeyDown](#oninputkeydown-property) | | <code>(e: React.KeyboardEvent<HTMLInputElement>) => void</code> | |
|
|
| [onSelect](#onselect-property) | | <code>(obj: SelectableValue<string[]>) => void</code> | |
|
|
|
|
<b>Methods</b>
|
|
|
|
| Method | Modifiers | Description |
|
|
| --- | --- | --- |
|
|
| [render()](#render-method) | | |
|
|
| [setInitialValue(searchableOptions, initValue)](#setinitialvalue-method) | | |
|
|
|
|
### constructor(props)
|
|
|
|
Constructs a new instance of the `Cascader` class
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
constructor(props: CascaderProps);
|
|
```
|
|
<b>Parameters</b>
|
|
|
|
| Parameter | Type | Description |
|
|
| --- | --- | --- |
|
|
| props | <code>CascaderProps</code> | |
|
|
|
|
### flattenOptions property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
flattenOptions: (options: CascaderOption[], optionPath?: CascaderOption[]) => SelectableValue<string[]>[];
|
|
```
|
|
|
|
### onBlur property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
onBlur: () => void;
|
|
```
|
|
|
|
### onBlurCascade property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
onBlurCascade: () => void;
|
|
```
|
|
|
|
### onChange property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
onChange: (value: string[], selectedOptions: CascaderOption[]) => void;
|
|
```
|
|
|
|
### onClick property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
onClick: () => void;
|
|
```
|
|
|
|
### onCreateOption property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
onCreateOption: (value: string) => void;
|
|
```
|
|
|
|
### onInputKeyDown property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
onInputKeyDown: (e: React.KeyboardEvent<HTMLInputElement>) => void;
|
|
```
|
|
|
|
### onSelect property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
onSelect: (obj: SelectableValue<string[]>) => void;
|
|
```
|
|
|
|
### render method
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
render(): JSX.Element;
|
|
```
|
|
<b>Returns:</b>
|
|
|
|
`JSX.Element`
|
|
|
|
### setInitialValue method
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
setInitialValue(searchableOptions: Array<SelectableValue<string[]>>, initValue?: string): {
|
|
rcValue: string[];
|
|
activeLabel: any;
|
|
};
|
|
```
|
|
<b>Parameters</b>
|
|
|
|
| Parameter | Type | Description |
|
|
| --- | --- | --- |
|
|
| searchableOptions | <code>Array<SelectableValue<string[]>></code> | |
|
|
| initValue | <code>string</code> | |
|
|
|
|
<b>Returns:</b>
|
|
|
|
`{
|
|
rcValue: string[];
|
|
activeLabel: any;
|
|
}`
|
|
|