grafana/docs/sources/packages_api/ui/input.md

101 lines
2.3 KiB
Markdown
Raw Normal View History

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 17:03:53 +08:00
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "Input"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## Input class
<b>Signature</b>
```typescript
export declare class Input extends PureComponent<Props, State>
```
<b>Import</b>
```typescript
import { Input } from '@grafana/ui';
```
<b>Properties</b>
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [defaultProps](#defaultprops-property) | <code>static</code> | <code>{</code><br/><code> className: string;</code><br/><code> }</code> | |
| [isInvalid](#isinvalid-property) | | <code>boolean</code> | |
| [populateEventPropsWithStatus](#populateeventpropswithstatus-property) | | <code>(restProps: any, validationEvents: ValidationEvents &#124; undefined) =&gt; any</code> | |
| [state](#state-property) | | <code>State</code> | |
| [status](#status-property) | | <code>InputStatus</code> | |
| [validatorAsync](#validatorasync-property) | | <code>(validationRules: ValidationRule[]) =&gt; (evt: React.ChangeEvent&lt;HTMLInputElement&gt;) =&gt; void</code> | |
<b>Methods</b>
| Method | Modifiers | Description |
| --- | --- | --- |
| [render()](#render-method) | | |
### defaultProps property
<b>Signature</b>
```typescript
static defaultProps: {
className: string;
};
```
### isInvalid property
<b>Signature</b>
```typescript
get isInvalid(): boolean;
```
### populateEventPropsWithStatus property
<b>Signature</b>
```typescript
populateEventPropsWithStatus: (restProps: any, validationEvents: ValidationEvents | undefined) => any;
```
### state property
<b>Signature</b>
```typescript
state: State;
```
### status property
<b>Signature</b>
```typescript
get status(): InputStatus;
```
### validatorAsync property
<b>Signature</b>
```typescript
validatorAsync: (validationRules: ValidationRule[]) => (evt: React.ChangeEvent<HTMLInputElement>) => void;
```
### render method
<b>Signature</b>
```typescript
render(): JSX.Element;
```
<b>Returns:</b>
`JSX.Element`