Docs: enable packages reference docs for 7-beta (#23953)
* added packages reference menu item. * removed the draft flag. * Updated docs by running script.
This commit is contained in:
@@ -0,0 +1,35 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "@grafana/e2e-selectors"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/e2e-selectors"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## @grafana/e2e-selectors package
|
||||
|
||||
A library containing the different design components of the Grafana ecosystem.
|
||||
|
||||
## Interfaces
|
||||
|
||||
| Interface | Description |
|
||||
| --- | --- |
|
||||
| [Selectors](./selectors/) | |
|
||||
| [UrlSelector](./urlselector/) | |
|
||||
|
||||
## Variables
|
||||
|
||||
| Variable | Description |
|
||||
| --- | --- |
|
||||
| [selectors](./selectors/) | |
|
||||
|
||||
## Type Aliases
|
||||
|
||||
| Type Alias | Description |
|
||||
| --- | --- |
|
||||
| [CssSelector](./cssselector/) | |
|
||||
| [E2ESelectors](./e2eselectors/) | |
|
||||
| [FunctionSelector](./functionselector/) | |
|
||||
| [StringSelector](./stringselector/) | |
|
||||
|
||||
@@ -0,0 +1,23 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "CssSelector"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/e2e-selectors"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## CssSelector type
|
||||
|
||||
### CssSelector type
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare type CssSelector = () => string;
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { CssSelector } from '@grafana/e2e-selectors';
|
||||
```
|
||||
@@ -0,0 +1,25 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "E2ESelectors"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/e2e-selectors"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## E2ESelectors type
|
||||
|
||||
### E2ESelectors type
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare type E2ESelectors<S extends Selectors> = {
|
||||
[P in keyof S]: S[P];
|
||||
};
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { E2ESelectors } from '@grafana/e2e-selectors';
|
||||
```
|
||||
@@ -0,0 +1,23 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "FunctionSelector"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/e2e-selectors"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## FunctionSelector type
|
||||
|
||||
### FunctionSelector type
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare type FunctionSelector = (id: string) => string;
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { FunctionSelector } from '@grafana/e2e-selectors';
|
||||
```
|
||||
@@ -0,0 +1,26 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "selectors"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/e2e-selectors"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## selectors variable
|
||||
|
||||
### selectors variable
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
selectors: {
|
||||
pages: E2ESelectors<typeof Pages>;
|
||||
components: E2ESelectors<typeof Components>;
|
||||
}
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { selectors } from '@grafana/e2e-selectors';
|
||||
```
|
||||
@@ -0,0 +1,23 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "StringSelector"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/e2e-selectors"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## StringSelector type
|
||||
|
||||
### StringSelector type
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare type StringSelector = string;
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { StringSelector } from '@grafana/e2e-selectors';
|
||||
```
|
||||
@@ -0,0 +1,34 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "UrlSelector"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/e2e-selectors"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## UrlSelector interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface UrlSelector extends Selectors
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { UrlSelector } from '@grafana/e2e-selectors';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [url](#url-property) | <code>string | FunctionSelector</code> | |
|
||||
|
||||
### url property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
url: string | FunctionSelector;
|
||||
```
|
||||
Reference in New Issue
Block a user