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.
7.3 KiB
7.3 KiB
+++
-----------------------------------------------------------------------
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
Signature
export interface GrafanaThemeCommons
Import
import { GrafanaThemeCommons } from '@grafana/data';
Properties
| Property | Type | Description |
|---|---|---|
| border | { radius: { sm: string; md: string; lg: string; }; width: { sm: string; }; } |
|
| breakpoints | { xs: string; sm: string; md: string; lg: string; xl: string; } |
|
| height | { sm: string; md: string; lg: string; } |
|
| name | string |
|
| panelHeaderHeight | number |
|
| panelPadding | number |
|
| 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 | { 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 | { dropdown: string; navbarFixed: string; sidemenu: string; tooltip: string; modalBackdrop: string; modal: string; typeahead: string; } |
border property
Signature
border: {
radius: {
sm: string;
md: string;
lg: string;
};
width: {
sm: string;
};
};
breakpoints property
Signature
breakpoints: {
xs: string;
sm: string;
md: string;
lg: string;
xl: string;
};
height property
Signature
height: {
sm: string;
md: string;
lg: string;
};
name property
Signature
name: string;
panelHeaderHeight property
Signature
panelHeaderHeight: number;
panelPadding property
Signature
panelPadding: number;
spacing property
Signature
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
Signature
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
Signature
zIndex: {
dropdown: string;
navbarFixed: string;
sidemenu: string;
tooltip: string;
modalBackdrop: string;
modal: string;
typeahead: string;
};