public/grafana
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Docs: updated packages reference docs for 7.1.0-beta1. (#25958)

Browse Source
This commit is contained in:
Marcus Andersson
2020-07-01 09:12:35 +02:00
committed by GitHub
parent e93640878d
commit 83df83fa42
97 changed files with 1369 additions and 206 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/sources/packages_api/ui/_index.md
+8 -1
View File
@@ -36,8 +36,10 @@ A library containing the different design components of the Grafana ecosystem.
| [PopoverController](./popovercontroller/) | |
| [Portal](./portal/) | |
| [QueryField](./queryfield/) | Renders an editor field. Pass initial value as initialQuery and listen to changes in props.onValueChanged. This component can only process strings. Internally it uses Slate Value. Implement props.onTypeahead to use suggestions, see PromQueryField.tsx as an example. |
| [SelectValueEditor](./selectvalueeditor/) | |
| [SetInterval](./setinterval/) | |
| [StatsPicker](./statspicker/) | |
| [StringArrayEditor](./stringarrayeditor/) | |
| [TableInputCSV](./tableinputcsv/) | Expects the container div to have size set and will fill it 100% |
| [TagsInput](./tagsinput/) | |
| [ToggleButtonGroup](./togglebuttongroup/) | |
@@ -73,6 +75,7 @@ A library containing the different design components of the Grafana ecosystem.
| [convertOldAngularValueMapping(panel)](./convertoldangularvaluemapping/) | Convert the angular single stat mapping to new react style |
| [FadeTransition(props)](./fadetransition/) | |
| [Form({ defaultValues, onSubmit, validateOnMount, validateFieldsOnMount, children, validateOn, maxWidth, })](./form/) | |
| [getScrollbarWidth()](./getscrollbarwidth/) | |
| [getTagColor(index)](./gettagcolor/) | |
| [getTagColorsFromName(name)](./gettagcolorsfromname/) | Returns tag badge background and border colors based on hashed tag name. |
| [IndentationPlugin()](./indentationplugin/) | |
@@ -89,7 +92,6 @@ A library containing the different design components of the Grafana ecosystem.
| [SegmentSelect({ value, options, onChange, onClickOutside, width, noOptionsMessage, allowCustomValue, })](./segmentselect/) | |
| [Select(props)](./select/) | |
| [SelectionShortcutsPlugin()](./selectionshortcutsplugin/) | |
| [SelectValueEditor({ value, onChange, item, })](./selectvalueeditor/) | |
| [sharedSingleStatMigrationHandler(panel)](./sharedsinglestatmigrationhandler/) | |
| [sharedSingleStatPanelChangedHandler(panel, prevPluginId, prevOptions)](./sharedsinglestatpanelchangedhandler/) | |
| [SlatePrism(optsParam)](./slateprism/) | A Slate plugin to highlight code syntax. |
@@ -120,6 +122,7 @@ A library containing the different design components of the Grafana ecosystem.
| [SingleStatBaseOptions](./singlestatbaseoptions/) | |
| [StyleProps](./styleprops/) | |
| [SuggestionsState](./suggestionsstate/) | |
| [TableSortByFieldState](./tablesortbyfieldstate/) | |
| [Themeable](./themeable/) | |
| [Token](./token/) | |
| [TypeaheadInput](./typeaheadinput/) | |
@@ -149,6 +152,7 @@ A library containing the different design components of the Grafana ecosystem.
| [CallToActionCard](./calltoactioncard/) | |
| [Chart](./chart/) | |
| [Checkbox](./checkbox/) | |
| [CodeEditor](./codeeditor/) | |
| [Collapse](./collapse/) | |
| [ColorPicker](./colorpicker/) | |
| [colors](./colors/) | |
@@ -171,6 +175,8 @@ A library containing the different design components of the Grafana ecosystem.
| [Field](./field/) | |
| [FieldConfigItemHeaderTitle](./fieldconfigitemheadertitle/) | |
| [fieldMatchersUI](./fieldmatchersui/) | |
| [FieldSet](./fieldset/) | |
| [FileUpload](./fileupload/) | |
| [FilterPill](./filterpill/) | |
| [FullWidthButtonContainer](./fullwidthbuttoncontainer/) | |
| [getAvailableIcons](./getavailableicons/) | |
@@ -244,6 +250,7 @@ A library containing the different design components of the Grafana ecosystem.
| [ThemeContext](./themecontext/) | |
| [TimeOfDayPicker](./timeofdaypicker/) | |
| [TimeRangePicker](./timerangepicker/) | |
| [TimeZonePicker](./timezonepicker/) | |
| [ToggleButton](./togglebutton/) | |
| [Tooltip](./tooltip/) | |
| [useStyles](./usestyles/) | Hook for using memoized styles with access to the theme. |
docs/sources/packages_api/ui/checkbox.md
+1 -1
View File
File diff suppressed because one or more lines are too long
docs/sources/packages_api/ui/clickoutsidewrapper.md
+11
View File
@@ -23,6 +23,7 @@ import { ClickOutsideWrapper } from '@grafana/ui';
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [defaultProps](#defaultprops-property) | <code>static</code> | <code>{</code><br/><code> includeButtonPress: boolean;</code><br/><code> }</code> | |
| [onOutsideClick](#onoutsideclick-property) | | <code>(event: any) =&gt; void</code> | |
| [state](#state-property) | | <code>{</code><br/><code> hasEventListener: boolean;</code><br/><code> }</code> | |
@@ -34,6 +35,16 @@ import { ClickOutsideWrapper } from '@grafana/ui';
| [componentWillUnmount()](#componentwillunmount-method) | | |
| [render()](#render-method) | | |
### defaultProps property
<b>Signature</b>
```typescript
static defaultProps: {
includeButtonPress: boolean;
};
```
### onOutsideClick property
<b>Signature</b>
docs/sources/packages_api/ui/codeeditor.md
+23
View File
@@ -0,0 +1,23 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "CodeEditor"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
+++
## CodeEditor variable
### CodeEditor variable
<b>Signature</b>
```typescript
CodeEditor: React.FC<CodeEditorProps>
```
<b>Import</b>
```typescript
import { CodeEditor } from '@grafana/ui';
```
docs/sources/packages_api/ui/colorpicker.md
+1 -1
View File
@@ -16,7 +16,7 @@ type = "docs"
```typescript
ColorPicker: React.FunctionComponent<Pick<import("./ColorPickerPopover").Props<import("./ColorPickerPopover").CustomPickersDescriptor> & {
children?: ColorPickerTriggerRenderer | undefined;
}, "onChange" | "color" | "children" | "onColorChange" | "enableNamedColors" | "customPickers" | "updatePopperPosition">>
}, "color" | "onChange" | "children" | "onColorChange" | "enableNamedColors" | "customPickers" | "updatePopperPosition">>
```
<b>Import</b>
docs/sources/packages_api/ui/customscrollbar.md
+4 -4
View File
@@ -32,10 +32,10 @@ import { CustomScrollbar } from '@grafana/ui';
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [defaultProps](#defaultprops-property) | <code>static</code> | <code>Partial&lt;Props&gt;</code> | |
| [renderThumb](#renderthumb-property) | | <code>(thumb: &quot;thumb-horizontal&quot; &#124; &quot;thumb-vertical&quot;, passedProps: any) =&gt; JSX.Element</code> | |
| [renderThumb](#renderthumb-property) | | <code>(thumb: 'thumb-horizontal' &#124; 'thumb-vertical', passedProps: any) =&gt; JSX.Element</code> | |
| [renderThumbHorizontal](#renderthumbhorizontal-property) | | <code>(passedProps: any) =&gt; JSX.Element</code> | |
| [renderThumbVertical](#renderthumbvertical-property) | | <code>(passedProps: any) =&gt; JSX.Element</code> | |
| [renderTrack](#rendertrack-property) | | <code>(track: &quot;track-vertical&quot; &#124; &quot;track-horizontal&quot;, hideTrack: boolean &#124; undefined, passedProps: any) =&gt; JSX.Element</code> | |
| [renderTrack](#rendertrack-property) | | <code>(track: 'track-vertical' &#124; 'track-horizontal', hideTrack: boolean &#124; undefined, passedProps: any) =&gt; JSX.Element</code> | |
| [renderTrackHorizontal](#rendertrackhorizontal-property) | | <code>(passedProps: any) =&gt; JSX.Element</code> | |
| [renderTrackVertical](#rendertrackvertical-property) | | <code>(passedProps: any) =&gt; JSX.Element</code> | |
| [renderView](#renderview-property) | | <code>(passedProps: any) =&gt; JSX.Element</code> | |
@@ -78,7 +78,7 @@ static defaultProps: Partial<Props>;
<b>Signature</b>
```typescript
renderThumb: (thumb: "thumb-horizontal" | "thumb-vertical", passedProps: any) => JSX.Element;
renderThumb: (thumb: 'thumb-horizontal' | 'thumb-vertical', passedProps: any) => JSX.Element;
```
### renderThumbHorizontal property
@@ -102,7 +102,7 @@ renderThumbVertical: (passedProps: any) => JSX.Element;
<b>Signature</b>
```typescript
renderTrack: (track: "track-vertical" | "track-horizontal", hideTrack: boolean | undefined, passedProps: any) => JSX.Element;
renderTrack: (track: 'track-vertical' | 'track-horizontal', hideTrack: boolean | undefined, passedProps: any) => JSX.Element;
```
### renderTrackHorizontal property
docs/sources/packages_api/ui/fieldset.md
+23
View File
@@ -0,0 +1,23 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "FieldSet"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
+++
## FieldSet variable
### FieldSet variable
<b>Signature</b>
```typescript
FieldSet: FC<Props>
```
<b>Import</b>
```typescript
import { FieldSet } from '@grafana/ui';
```
docs/sources/packages_api/ui/fileupload.md
+23
View File
@@ -0,0 +1,23 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "FileUpload"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
+++
## FileUpload variable
### FileUpload variable
<b>Signature</b>
```typescript
FileUpload: FC<Props>
```
<b>Import</b>
```typescript
import { FileUpload } from '@grafana/ui';
```
docs/sources/packages_api/ui/formapi.md
+1 -1
View File
@@ -14,7 +14,7 @@ type = "docs"
<b>Signature</b>
```typescript
export declare type FormAPI<T> = Pick<FormContextValues<T>, 'register' | 'errors' | 'control' | 'formState' | 'getValues'>;
export declare type FormAPI<T> = Pick<FormContextValues<T>, 'register' | 'errors' | 'control' | 'formState' | 'getValues' | 'watch'>;
```
<b>Import</b>
docs/sources/packages_api/ui/getscrollbarwidth.md
+27
View File
@@ -0,0 +1,27 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "getScrollbarWidth"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
+++
## getScrollbarWidth() function
### getScrollbarWidth() function
<b>Signature</b>
```typescript
export declare function getScrollbarWidth(): number;
```
<b>Import</b>
```typescript
import { getScrollbarWidth } from '@grafana/ui';
```
<b>Returns:</b>
`number`
docs/sources/packages_api/ui/getstandardfieldconfigs.md
+1 -1
View File
@@ -16,7 +16,7 @@ Returns collection of common field config properties definitions
<b>Signature</b>
```typescript
getStandardFieldConfigs: () => (FieldConfigPropertyItem<any, string, StringFieldConfigSettings> | FieldConfigPropertyItem<any, number, NumberFieldConfigSettings> | FieldConfigPropertyItem<any, ThresholdsConfig, ThresholdsFieldConfigSettings> | FieldConfigPropertyItem<any, ValueMapping[], ValueMappingFieldConfigSettings> | FieldConfigPropertyItem<any, DataLink[], StringFieldConfigSettings>)[]
getStandardFieldConfigs: () => (FieldConfigPropertyItem<any, string, StringFieldConfigSettings> | FieldConfigPropertyItem<any, number, NumberFieldConfigSettings> | FieldConfigPropertyItem<any, ThresholdsConfig, ThresholdsFieldConfigSettings> | FieldConfigPropertyItem<any, ValueMapping[], ValueMappingFieldConfigSettings> | FieldConfigPropertyItem<any, DataLink<any>[], StringFieldConfigSettings>)[]
```
<b>Import</b>
docs/sources/packages_api/ui/getstandardoptioneditors.md
+1 -1
View File
@@ -16,7 +16,7 @@ Returns collection of standard option editors definitions
<b>Signature</b>
```typescript
getStandardOptionEditors: () => (StandardEditorsRegistryItem<any, any> | StandardEditorsRegistryItem<string, any> | StandardEditorsRegistryItem<number, any> | StandardEditorsRegistryItem<boolean, any> | StandardEditorsRegistryItem<ValueMapping[], any> | StandardEditorsRegistryItem<ThresholdsConfig, any> | StandardEditorsRegistryItem<DataLink[], any> | StandardEditorsRegistryItem<string[], any>)[]
getStandardOptionEditors: () => (StandardEditorsRegistryItem<any, any> | StandardEditorsRegistryItem<string, any> | StandardEditorsRegistryItem<number, any> | StandardEditorsRegistryItem<boolean, any> | StandardEditorsRegistryItem<ValueMapping[], any> | StandardEditorsRegistryItem<ThresholdsConfig, any> | StandardEditorsRegistryItem<DataLink<any>[], any> | StandardEditorsRegistryItem<string[], any>)[]
```
<b>Import</b>
docs/sources/packages_api/ui/input.md
+1 -1
View File
File diff suppressed because one or more lines are too long
docs/sources/packages_api/ui/logrows.md
+1 -1
View File
@@ -14,7 +14,7 @@ type = "docs"
<b>Signature</b>
```typescript
LogRows: React.FunctionComponent<Pick<Props, "timeZone" | "getRowContext" | "onClickFilterLabel" | "onClickFilterOutLabel" | "getFieldLinks" | "highlighterExpressions" | "wrapLogMessage" | "showContextToggle" | "showLabels" | "showTime" | "allowDetails" | "logRows" | "deduplicatedRows" | "dedupStrategy" | "rowLimit" | "previewLimit">>
LogRows: React.FunctionComponent<Pick<Props, "timeZone" | "getRowContext" | "onClickFilterLabel" | "onClickFilterOutLabel" | "getFieldLinks" | "highlighterExpressions" | "wrapLogMessage" | "showContextToggle" | "showLabels" | "showTime" | "allowDetails" | "logRows" | "deduplicatedRows" | "dedupStrategy" | "rowLimit" | "previewLimit" | "disableCustomHorizontalScroll">>
```
<b>Import</b>
docs/sources/packages_api/ui/popovercontroller.md
+11 -39
View File
@@ -19,40 +19,19 @@ declare class PopoverController extends React.Component<Props, State>
```typescript
import { PopoverController } from '@grafana/ui';
```
<b>Constructors</b>
| Constructor | Modifiers | Description |
| --- | --- | --- |
| [constructor(props)](#constructor-props) | | Constructs a new instance of the <code>PopoverController</code> class |
<b>Properties</b>
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [hidePopper](#hidepopper-property) | | <code>() =&gt; void</code> | |
| [showPopper](#showpopper-property) | | <code>() =&gt; void</code> | |
| [state](#state-property) | | <code>{</code><br/><code> show: boolean;</code><br/><code> }</code> | |
<b>Methods</b>
| Method | Modifiers | Description |
| --- | --- | --- |
| [render()](#render-method) | | |
| [UNSAFE\_componentWillReceiveProps(nextProps)](#unsafe_componentwillreceiveprops-method) | | |
### constructor(props)
Constructs a new instance of the `PopoverController` class
<b>Signature</b>
```typescript
constructor(props: Props);
```
<b>Parameters</b>
| Parameter | Type | Description |
| --- | --- | --- |
| props | <code>Props</code> | |
### hidePopper property
@@ -70,6 +49,16 @@ hidePopper: () => void;
showPopper: () => void;
```
### state property
<b>Signature</b>
```typescript
state: {
show: boolean;
};
```
### render method
<b>Signature</b>
@@ -81,20 +70,3 @@ render(): JSX.Element;
`JSX.Element`
### UNSAFE\_componentWillReceiveProps method
<b>Signature</b>
```typescript
UNSAFE_componentWillReceiveProps(nextProps: Props): void;
```
<b>Parameters</b>
| Parameter | Type | Description |
| --- | --- | --- |
| nextProps | <code>Props</code> | |
<b>Returns:</b>
`void`
docs/sources/packages_api/ui/refreshpicker.md
+3 -9
View File
@@ -15,15 +15,9 @@ type = "docs"
```typescript
RefreshPicker: React.FunctionComponent<Pick<Props, "value" | "tooltip" | "intervals" | "onRefresh" | "onIntervalChanged" | "hasLiveOption" | "refreshButton" | "buttonSelectClassName">> & {
offOption: {
label: string;
value: string;
};
liveOption: {
label: string;
value: string;
};
isLive: (refreshInterval?: string | undefined) => boolean;
offOption: typeof RefreshPickerBase.offOption;
liveOption: typeof RefreshPickerBase.liveOption;
isLive: typeof RefreshPickerBase.isLive;
}
```
<b>Import</b>
docs/sources/packages_api/ui/selectvalueeditor.md
+63 -5
View File
@@ -7,27 +7,85 @@ keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
+++
## SelectValueEditor() function
### SelectValueEditor() function
## SelectValueEditor class
<b>Signature</b>
```typescript
export declare function SelectValueEditor<T>({ value, onChange, item, }: FieldConfigEditorProps<T, SelectFieldConfigSettings<T>>): JSX.Element;
export declare class SelectValueEditor<T> extends React.PureComponent<Props<T>, State<T>>
```
<b>Import</b>
```typescript
import { SelectValueEditor } from '@grafana/ui';
```
<b>Properties</b>
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [state](#state-property) | | <code>State&lt;T&gt;</code> | |
| [updateOptions](#updateoptions-property) | | <code>() =&gt; Promise&lt;void&gt;</code> | |
<b>Methods</b>
| Method | Modifiers | Description |
| --- | --- | --- |
| [componentDidMount()](#componentdidmount-method) | | |
| [componentDidUpdate(oldProps)](#componentdidupdate-method) | | |
| [render()](#render-method) | | |
### state property
<b>Signature</b>
```typescript
state: State<T>;
```
### updateOptions property
<b>Signature</b>
```typescript
updateOptions: () => Promise<void>;
```
### componentDidMount method
<b>Signature</b>
```typescript
componentDidMount(): void;
```
<b>Returns:</b>
`void`
### componentDidUpdate method
<b>Signature</b>
```typescript
componentDidUpdate(oldProps: Props<T>): void;
```
<b>Parameters</b>
| Parameter | Type | Description |
| --- | --- | --- |
| { value, onChange, item, } | <code>FieldConfigEditorProps&lt;T, SelectFieldConfigSettings&lt;T&gt;&gt;</code> | |
| oldProps | <code>Props&lt;T&gt;</code> | |
<b>Returns:</b>
`void`
### render method
<b>Signature</b>
```typescript
render(): JSX.Element;
```
<b>Returns:</b>
`JSX.Element`
docs/sources/packages_api/ui/seriescolorpicker.md
+1 -1
View File
@@ -16,7 +16,7 @@ type = "docs"
```typescript
SeriesColorPicker: React.FunctionComponent<Pick<import("./SeriesColorPickerPopover").SeriesColorPickerPopoverProps & {
children?: ColorPickerTriggerRenderer | undefined;
}, "onChange" | "color" | "children" | "onColorChange" | "enableNamedColors" | "updatePopperPosition" | "yaxis" | "onToggleAxis">>
}, "color" | "onChange" | "children" | "onColorChange" | "enableNamedColors" | "updatePopperPosition" | "yaxis" | "onToggleAxis">>
```
<b>Import</b>
docs/sources/packages_api/ui/seriescolorpickerpopoverwiththeme.md
+1 -1
View File
@@ -14,7 +14,7 @@ type = "docs"
<b>Signature</b>
```typescript
SeriesColorPickerPopoverWithTheme: React.FunctionComponent<Pick<SeriesColorPickerPopoverProps, "onChange" | "color" | "onColorChange" | "enableNamedColors" | "updatePopperPosition" | "yaxis" | "onToggleAxis">>
SeriesColorPickerPopoverWithTheme: React.FunctionComponent<Pick<SeriesColorPickerPopoverProps, "color" | "onChange" | "onColorChange" | "enableNamedColors" | "updatePopperPosition" | "yaxis" | "onToggleAxis">>
```
<b>Import</b>
docs/sources/packages_api/ui/stringarrayeditor.md
+72
View File
@@ -0,0 +1,72 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "StringArrayEditor"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
+++
## StringArrayEditor class
<b>Signature</b>
```typescript
export declare class StringArrayEditor extends React.PureComponent<Props, State>
```
<b>Import</b>
```typescript
import { StringArrayEditor } from '@grafana/ui';
```
<b>Properties</b>
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [onRemoveString](#onremovestring-property) | | <code>(index: number) =&gt; void</code> | |
| [onValueChange](#onvaluechange-property) | | <code>(e: React.SyntheticEvent, idx: number) =&gt; void</code> | |
| [state](#state-property) | | <code>{</code><br/><code> showAdd: boolean;</code><br/><code> }</code> | |
<b>Methods</b>
| Method | Modifiers | Description |
| --- | --- | --- |
| [render()](#render-method) | | |
### onRemoveString property
<b>Signature</b>
```typescript
onRemoveString: (index: number) => void;
```
### onValueChange property
<b>Signature</b>
```typescript
onValueChange: (e: React.SyntheticEvent, idx: number) => void;
```
### state property
<b>Signature</b>
```typescript
state: {
showAdd: boolean;
};
```
### render method
<b>Signature</b>
```typescript
render(): JSX.Element;
```
<b>Returns:</b>
`JSX.Element`
docs/sources/packages_api/ui/switch.md
+1 -1
View File
File diff suppressed because one or more lines are too long
docs/sources/packages_api/ui/tab.md
+1 -1
View File
File diff suppressed because one or more lines are too long
docs/sources/packages_api/ui/tablesortbyfieldstate.md
+43
View File
@@ -0,0 +1,43 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "TableSortByFieldState"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
+++
## TableSortByFieldState interface
<b>Signature</b>
```typescript
export interface TableSortByFieldState
```
<b>Import</b>
```typescript
import { TableSortByFieldState } from '@grafana/ui';
```
<b>Properties</b>
| Property | Type | Description |
| --- | --- | --- |
| [desc](#desc-property) | <code>boolean</code> | |
| [displayName](#displayname-property) | <code>string</code> | |
### desc property
<b>Signature</b>
```typescript
desc?: boolean;
```
### displayName property
<b>Signature</b>
```typescript
displayName: string;
```
docs/sources/packages_api/ui/tagsinput.md
+6 -6
View File
@@ -29,10 +29,10 @@ import { TagsInput } from '@grafana/ui';
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [onAdd](#onadd-property) | | <code>(event: React.MouseEvent&lt;Element, MouseEvent&gt;) =&gt; void</code> | |
| [onAdd](#onadd-property) | | <code>(event: React.MouseEvent) =&gt; void</code> | |
| [onChange](#onchange-property) | | <code>() =&gt; void</code> | |
| [onKeyboardAdd](#onkeyboardadd-property) | | <code>(event: React.KeyboardEvent&lt;Element&gt;) =&gt; void</code> | |
| [onNameChange](#onnamechange-property) | | <code>(event: React.ChangeEvent&lt;HTMLInputElement&gt;) =&gt; void</code> | |
| [onKeyboardAdd](#onkeyboardadd-property) | | <code>(event: KeyboardEvent) =&gt; void</code> | |
| [onNameChange](#onnamechange-property) | | <code>(event: ChangeEvent&lt;HTMLInputElement&gt;) =&gt; void</code> | |
| [onRemove](#onremove-property) | | <code>(tagToRemove: string) =&gt; void</code> | |
| [setNewTags](#setnewtags-property) | | <code>() =&gt; void</code> | |
@@ -62,7 +62,7 @@ constructor(props: Props);
<b>Signature</b>
```typescript
onAdd: (event: React.MouseEvent<Element, MouseEvent>) => void;
onAdd: (event: React.MouseEvent) => void;
```
### onChange property
@@ -78,7 +78,7 @@ onChange: () => void;
<b>Signature</b>
```typescript
onKeyboardAdd: (event: React.KeyboardEvent<Element>) => void;
onKeyboardAdd: (event: KeyboardEvent) => void;
```
### onNameChange property
@@ -86,7 +86,7 @@ onKeyboardAdd: (event: React.KeyboardEvent<Element>) => void;
<b>Signature</b>
```typescript
onNameChange: (event: React.ChangeEvent<HTMLInputElement>) => void;
onNameChange: (event: ChangeEvent<HTMLInputElement>) => void;
```
### onRemove property
docs/sources/packages_api/ui/textarea.md
+1 -1
View File
File diff suppressed because one or more lines are too long
docs/sources/packages_api/ui/timerangepicker.md
+1 -1
View File
@@ -14,7 +14,7 @@ type = "docs"
<b>Signature</b>
```typescript
TimeRangePicker: React.FunctionComponent<Pick<Props, "onChange" | "history" | "timeZone" | "value" | "hideText" | "timeSyncButton" | "isSynced" | "onMoveBackward" | "onMoveForward" | "onZoom">>
TimeRangePicker: React.FunctionComponent<Pick<Props, "timeZone" | "value" | "onChange" | "history" | "onChangeTimeZone" | "hideText" | "timeSyncButton" | "isSynced" | "onMoveBackward" | "onMoveForward" | "onZoom">>
```
<b>Import</b>
docs/sources/packages_api/ui/timezonepicker.md
+23
View File
@@ -0,0 +1,23 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "TimeZonePicker"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
+++
## TimeZonePicker variable
### TimeZonePicker variable
<b>Signature</b>
```typescript
TimeZonePicker: React.FC<Props>
```
<b>Import</b>
```typescript
import { TimeZonePicker } from '@grafana/ui';
```