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.
This commit is contained in:
Marcus Andersson
@@ -0,0 +1,189 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "JsonExplorer"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/ui"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## JsonExplorer class
|
||||
|
||||
JsonExplorer
|
||||
|
||||
JsonExplorer allows you to render JSON objects in HTML with a \*\*collapsible\*\* navigation.
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare class JsonExplorer
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { JsonExplorer } from '@grafana/ui';
|
||||
```
|
||||
<b>Constructors</b>
|
||||
|
||||
| Constructor | Modifiers | Description |
|
||||
| --- | --- | --- |
|
||||
| [constructor(json, open, config, key)](#constructor-jsonopenconfigkey) | | Constructs a new instance of the <code>JsonExplorer</code> class |
|
||||
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Modifiers | Type | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| [json](#json-property) | | <code>any</code> | |
|
||||
|
||||
<b>Methods</b>
|
||||
|
||||
| Method | Modifiers | Description |
|
||||
| --- | --- | --- |
|
||||
| [appendChildren(animated)](#appendchildren-method) | | Appends all the children to children element Animated option is used when user triggers this via a click |
|
||||
| [isNumberArray()](#isnumberarray-method) | | |
|
||||
| [openAtDepth(depth)](#openatdepth-method) | | Open all children up to a certain depth. Allows actions such as expand all/collapse all |
|
||||
| [removeChildren(animated)](#removechildren-method) | | Removes all the children from children element Animated option is used when user triggers this via a click |
|
||||
| [render(skipRoot)](#render-method) | | Renders an HTML element and installs event listeners |
|
||||
| [renderArray()](#renderarray-method) | | |
|
||||
| [toggleOpen()](#toggleopen-method) | | Toggles <code>isOpen</code> state |
|
||||
|
||||
### constructor(json, open, config, key)
|
||||
|
||||
Constructs a new instance of the `JsonExplorer` class
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
constructor(json: any, open?: number, config?: JsonExplorerConfig, key?: string | undefined);
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| json | <code>any</code> | |
|
||||
| open | <code>number</code> | |
|
||||
| config | <code>JsonExplorerConfig</code> | |
|
||||
| key | <code>string | undefined</code> | |
|
||||
|
||||
### json property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
json: any;
|
||||
```
|
||||
|
||||
### appendChildren method
|
||||
|
||||
Appends all the children to children element Animated option is used when user triggers this via a click
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
appendChildren(animated?: boolean): void;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| animated | <code>boolean</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`void`
|
||||
|
||||
### isNumberArray method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
isNumberArray(): boolean;
|
||||
```
|
||||
<b>Returns:</b>
|
||||
|
||||
`boolean`
|
||||
|
||||
### openAtDepth method
|
||||
|
||||
Open all children up to a certain depth. Allows actions such as expand all/collapse all
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
openAtDepth(depth?: number): void;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| depth | <code>number</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`void`
|
||||
|
||||
### removeChildren method
|
||||
|
||||
Removes all the children from children element Animated option is used when user triggers this via a click
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
removeChildren(animated?: boolean): void;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| animated | <code>boolean</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`void`
|
||||
|
||||
### render method
|
||||
|
||||
Renders an HTML element and installs event listeners
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
render(skipRoot?: boolean): HTMLDivElement;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| skipRoot | <code>boolean</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`HTMLDivElement`
|
||||
|
||||
{<!-- -->HTMLDivElement<!-- -->}
|
||||
|
||||
### renderArray method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
renderArray(): Element;
|
||||
```
|
||||
<b>Returns:</b>
|
||||
|
||||
`Element`
|
||||
|
||||
### toggleOpen method
|
||||
|
||||
Toggles `isOpen` state
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
toggleOpen(): void;
|
||||
```
|
||||
<b>Returns:</b>
|
||||
|
||||
`void`
|
||||
|
||||
Reference in New Issue
Block a user