Marcus Andersson
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.
194 lines
7.3 KiB
Markdown
194 lines
7.3 KiB
Markdown
+++
|
|
# -----------------------------------------------------------------------
|
|
# Do not edit this file. It is automatically generated by API Documenter.
|
|
# -----------------------------------------------------------------------
|
|
title = "GrafanaThemeCommons"
|
|
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
|
type = "docs"
|
|
draft = true
|
|
+++
|
|
|
|
## GrafanaThemeCommons interface
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
export interface GrafanaThemeCommons
|
|
```
|
|
<b>Import</b>
|
|
|
|
```typescript
|
|
import { GrafanaThemeCommons } from '@grafana/data';
|
|
```
|
|
<b>Properties</b>
|
|
|
|
| Property | Type | Description |
|
|
| --- | --- | --- |
|
|
| [border](#border-property) | <code>{</code><br/><code> radius: {</code><br/><code> sm: string;</code><br/><code> md: string;</code><br/><code> lg: string;</code><br/><code> };</code><br/><code> width: {</code><br/><code> sm: string;</code><br/><code> };</code><br/><code> }</code> | |
|
|
| [breakpoints](#breakpoints-property) | <code>{</code><br/><code> xs: string;</code><br/><code> sm: string;</code><br/><code> md: string;</code><br/><code> lg: string;</code><br/><code> xl: string;</code><br/><code> }</code> | |
|
|
| [height](#height-property) | <code>{</code><br/><code> sm: string;</code><br/><code> md: string;</code><br/><code> lg: string;</code><br/><code> }</code> | |
|
|
| [name](#name-property) | <code>string</code> | |
|
|
| [panelHeaderHeight](#panelheaderheight-property) | <code>number</code> | |
|
|
| [panelPadding](#panelpadding-property) | <code>number</code> | |
|
|
| [spacing](#spacing-property) | <code>{</code><br/><code> insetSquishMd: string;</code><br/><code> d: string;</code><br/><code> xxs: string;</code><br/><code> xs: string;</code><br/><code> sm: string;</code><br/><code> md: string;</code><br/><code> lg: string;</code><br/><code> xl: string;</code><br/><code> gutter: string;</code><br/><code> formSpacingBase: number;</code><br/><code> formMargin: string;</code><br/><code> formFieldsetMargin: string;</code><br/><code> formLegendMargin: string;</code><br/><code> formInputHeight: string;</code><br/><code> formButtonHeight: number;</code><br/><code> formInputPaddingHorizontal: string;</code><br/><code> formInputAffixPaddingHorizontal: string;</code><br/><code> formInputMargin: string;</code><br/><code> formLabelPadding: string;</code><br/><code> formLabelMargin: string;</code><br/><code> formValidationMessagePadding: string;</code><br/><code> formValidationMessageMargin: string;</code><br/><code> }</code> | |
|
|
| [typography](#typography-property) | <code>{</code><br/><code> fontFamily: {</code><br/><code> sansSerif: string;</code><br/><code> monospace: string;</code><br/><code> };</code><br/><code> size: {</code><br/><code> base: string;</code><br/><code> xs: string;</code><br/><code> sm: string;</code><br/><code> md: string;</code><br/><code> lg: string;</code><br/><code> };</code><br/><code> weight: {</code><br/><code> light: number;</code><br/><code> regular: number;</code><br/><code> semibold: number;</code><br/><code> bold: number;</code><br/><code> };</code><br/><code> lineHeight: {</code><br/><code> xs: number;</code><br/><code> sm: number;</code><br/><code> md: number;</code><br/><code> lg: number;</code><br/><code> };</code><br/><code> heading: {</code><br/><code> h1: string;</code><br/><code> h2: string;</code><br/><code> h3: string;</code><br/><code> h4: string;</code><br/><code> h5: string;</code><br/><code> h6: string;</code><br/><code> };</code><br/><code> link: {</code><br/><code> decoration: string;</code><br/><code> hoverDecoration: string;</code><br/><code> };</code><br/><code> }</code> | |
|
|
| [zIndex](#zindex-property) | <code>{</code><br/><code> dropdown: string;</code><br/><code> navbarFixed: string;</code><br/><code> sidemenu: string;</code><br/><code> tooltip: string;</code><br/><code> modalBackdrop: string;</code><br/><code> modal: string;</code><br/><code> typeahead: string;</code><br/><code> }</code> | |
|
|
|
|
### border property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
border: {
|
|
radius: {
|
|
sm: string;
|
|
md: string;
|
|
lg: string;
|
|
};
|
|
width: {
|
|
sm: string;
|
|
};
|
|
};
|
|
```
|
|
|
|
### breakpoints property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
breakpoints: {
|
|
xs: string;
|
|
sm: string;
|
|
md: string;
|
|
lg: string;
|
|
xl: string;
|
|
};
|
|
```
|
|
|
|
### height property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
height: {
|
|
sm: string;
|
|
md: string;
|
|
lg: string;
|
|
};
|
|
```
|
|
|
|
### name property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
name: string;
|
|
```
|
|
|
|
### panelHeaderHeight property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
panelHeaderHeight: number;
|
|
```
|
|
|
|
### panelPadding property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
panelPadding: number;
|
|
```
|
|
|
|
### spacing property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
spacing: {
|
|
insetSquishMd: string;
|
|
d: string;
|
|
xxs: string;
|
|
xs: string;
|
|
sm: string;
|
|
md: string;
|
|
lg: string;
|
|
xl: string;
|
|
gutter: string;
|
|
formSpacingBase: number;
|
|
formMargin: string;
|
|
formFieldsetMargin: string;
|
|
formLegendMargin: string;
|
|
formInputHeight: string;
|
|
formButtonHeight: number;
|
|
formInputPaddingHorizontal: string;
|
|
formInputAffixPaddingHorizontal: string;
|
|
formInputMargin: string;
|
|
formLabelPadding: string;
|
|
formLabelMargin: string;
|
|
formValidationMessagePadding: string;
|
|
formValidationMessageMargin: string;
|
|
};
|
|
```
|
|
|
|
### typography property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
typography: {
|
|
fontFamily: {
|
|
sansSerif: string;
|
|
monospace: string;
|
|
};
|
|
size: {
|
|
base: string;
|
|
xs: string;
|
|
sm: string;
|
|
md: string;
|
|
lg: string;
|
|
};
|
|
weight: {
|
|
light: number;
|
|
regular: number;
|
|
semibold: number;
|
|
bold: number;
|
|
};
|
|
lineHeight: {
|
|
xs: number;
|
|
sm: number;
|
|
md: number;
|
|
lg: number;
|
|
};
|
|
heading: {
|
|
h1: string;
|
|
h2: string;
|
|
h3: string;
|
|
h4: string;
|
|
h5: string;
|
|
h6: string;
|
|
};
|
|
link: {
|
|
decoration: string;
|
|
hoverDecoration: string;
|
|
};
|
|
};
|
|
```
|
|
|
|
### zIndex property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
zIndex: {
|
|
dropdown: string;
|
|
navbarFixed: string;
|
|
sidemenu: string;
|
|
tooltip: string;
|
|
modalBackdrop: string;
|
|
modal: string;
|
|
typeahead: string;
|
|
};
|
|
```
|