opensource/grafana
1
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-08-03 04:22:13 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
grafana/docs/sources/packages_api/data/grafanatheme.md
Marcus Andersson 6bc369629d 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 10:03:53 +01:00

9.3 KiB
Raw Blame History

+++

-----------------------------------------------------------------------

Do not edit this file. It is automatically generated by API Documenter.

-----------------------------------------------------------------------

title = "GrafanaTheme" keywords = ["grafana","documentation","sdk","@grafana/data"] type = "docs" draft = true +++

GrafanaTheme interface

Signature

export interface GrafanaTheme extends GrafanaThemeCommons

Import

import { GrafanaTheme } from '@grafana/data';

Properties

Property Type Description
background {
dropdown: string;
scrollbar: string;
scrollbar2: string;
pageHeader: string;
}
colors {
black: string;
white: string;
dark1: string;
dark2: string;
dark3: string;
dark4: string;
dark5: string;
dark6: string;
dark7: string;
dark8: string;
dark9: string;
dark10: string;
gray1: string;
gray2: string;
gray3: string;
gray4: string;
gray5: string;
gray6: string;
gray7: string;
gray98: string;
gray95: string;
gray85: string;
gray70: string;
gray33: string;
gray25: string;
gray15: string;
gray10: string;
gray05: string;
blue95: string;
blue85: string;
blue77: string;
red88: string;
grayBlue: string;
inputBlack: string;
blue: string;
blueBase: string;
blueShade: string;
blueLight: string;
blueFaint: string;
redBase: string;
redShade: string;
greenBase: string;
greenShade: string;
red: string;
yellow: string;
purple: string;
variable: string;
orange: string;
orangeDark: string;
queryRed: string;
queryGreen: string;
queryPurple: string;
queryKeyword: string;
queryOrange: string;
brandPrimary: string;
brandSuccess: string;
brandWarning: string;
brandDanger: string;
online: string;
warn: string;
critical: string;
link: string;
linkDisabled: string;
linkHover: string;
linkExternal: string;
body: string;
text: string;
textStrong: string;
textWeak: string;
textFaint: string;
textEmphasis: string;
panelBg: string;
bodyBg: string;
pageBg: string;
headingColor: string;
pageHeaderBorder: string;
formLabel: string;
formDescription: string;
formLegend: string;
formInputBg: string;
formInputBgDisabled: string;
formInputBorder: string;
formInputBorderHover: string;
formInputBorderActive: string;
formInputBorderInvalid: string;
formFocusOutline: string;
formInputText: string;
formInputDisabledText: string;
formInputTextStrong: string;
formInputTextWhite: string;
formValidationMessageText: string;
formValidationMessageBg: string;
formSwitchBg: string;
formSwitchBgActive: string;
formSwitchBgActiveHover: string;
formSwitchBgHover: string;
formSwitchBgDisabled: string;
formSwitchDot: string;
formCheckboxBg: string;
formCheckboxBgChecked: string;
formCheckboxBgCheckedHover: string;
formCheckboxCheckmark: string;
}
isDark boolean
isLight boolean
shadow {
pageHeader: string;
}
type GrafanaThemeType

background property

Signature

background: {
        dropdown: string;
        scrollbar: string;
        scrollbar2: string;
        pageHeader: string;
    };

colors property

Signature

colors: {
        black: string;
        white: string;
        dark1: string;
        dark2: string;
        dark3: string;
        dark4: string;
        dark5: string;
        dark6: string;
        dark7: string;
        dark8: string;
        dark9: string;
        dark10: string;
        gray1: string;
        gray2: string;
        gray3: string;
        gray4: string;
        gray5: string;
        gray6: string;
        gray7: string;
        gray98: string;
        gray95: string;
        gray85: string;
        gray70: string;
        gray33: string;
        gray25: string;
        gray15: string;
        gray10: string;
        gray05: string;
        blue95: string;
        blue85: string;
        blue77: string;
        red88: string;
        grayBlue: string;
        inputBlack: string;
        blue: string;
        blueBase: string;
        blueShade: string;
        blueLight: string;
        blueFaint: string;
        redBase: string;
        redShade: string;
        greenBase: string;
        greenShade: string;
        red: string;
        yellow: string;
        purple: string;
        variable: string;
        orange: string;
        orangeDark: string;
        queryRed: string;
        queryGreen: string;
        queryPurple: string;
        queryKeyword: string;
        queryOrange: string;
        brandPrimary: string;
        brandSuccess: string;
        brandWarning: string;
        brandDanger: string;
        online: string;
        warn: string;
        critical: string;
        link: string;
        linkDisabled: string;
        linkHover: string;
        linkExternal: string;
        body: string;
        text: string;
        textStrong: string;
        textWeak: string;
        textFaint: string;
        textEmphasis: string;
        panelBg: string;
        bodyBg: string;
        pageBg: string;
        headingColor: string;
        pageHeaderBorder: string;
        formLabel: string;
        formDescription: string;
        formLegend: string;
        formInputBg: string;
        formInputBgDisabled: string;
        formInputBorder: string;
        formInputBorderHover: string;
        formInputBorderActive: string;
        formInputBorderInvalid: string;
        formFocusOutline: string;
        formInputText: string;
        formInputDisabledText: string;
        formInputTextStrong: string;
        formInputTextWhite: string;
        formValidationMessageText: string;
        formValidationMessageBg: string;
        formSwitchBg: string;
        formSwitchBgActive: string;
        formSwitchBgActiveHover: string;
        formSwitchBgHover: string;
        formSwitchBgDisabled: string;
        formSwitchDot: string;
        formCheckboxBg: string;
        formCheckboxBgChecked: string;
        formCheckboxBgCheckedHover: string;
        formCheckboxCheckmark: string;
    };

isDark property

Signature

isDark: boolean;

isLight property

Signature

isLight: boolean;

shadow property

Signature

shadow: {
        pageHeader: string;
    };

type property

Signature

type: GrafanaThemeType;