kibana/api_docs/kbn_react_kibana_context_common.devdocs.json

{
  "id": "@kbn/react-kibana-context-common",
  "client": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "server": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "common": {
    "classes": [],
    "functions": [
      {
        "parentPluginId": "@kbn/react-kibana-context-common",
        "id": "def-common.getColorMode",
        "type": "Function",
        "tags": [],
        "label": "getColorMode",
        "description": [
          "\nGiven a `KibanaTheme`, provide a color mode for use with EUI."
        ],
        "signature": [
          "(theme: ",
          {
            "pluginId": "@kbn/react-kibana-context-common",
            "scope": "common",
            "docId": "kibKbnReactKibanaContextCommonPluginApi",
            "section": "def-common.KibanaTheme",
            "text": "KibanaTheme"
          },
          ") => ",
          "EuiThemeColorModeStandard"
        ],
        "path": "packages/react/kibana_context/common/color_mode.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/react-kibana-context-common",
            "id": "def-common.getColorMode.$1",
            "type": "Object",
            "tags": [],
            "label": "theme",
            "description": [
              "KibanaTheme"
            ],
            "signature": [
              {
                "pluginId": "@kbn/react-kibana-context-common",
                "scope": "common",
                "docId": "kibKbnReactKibanaContextCommonPluginApi",
                "section": "def-common.KibanaTheme",
                "text": "KibanaTheme"
              }
            ],
            "path": "packages/react/kibana_context/common/color_mode.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [
          "EuiThemeColorModeStandard"
        ],
        "initialIsOpen": false
      }
    ],
    "interfaces": [
      {
        "parentPluginId": "@kbn/react-kibana-context-common",
        "id": "def-common.KibanaTheme",
        "type": "Interface",
        "tags": [],
        "label": "KibanaTheme",
        "description": [
          "\nThe representation of the Kibana theme, (not to be confused with the EUI theme)."
        ],
        "path": "packages/react/kibana_context/common/types.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/react-kibana-context-common",
            "id": "def-common.KibanaTheme.darkMode",
            "type": "boolean",
            "tags": [],
            "label": "darkMode",
            "description": [
              "is dark mode enabled or not"
            ],
            "path": "packages/react/kibana_context/common/types.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/react-kibana-context-common",
        "id": "def-common.ThemeServiceStart",
        "type": "Interface",
        "tags": [],
        "label": "ThemeServiceStart",
        "description": [
          "\nThe `ThemeService` start contract, provided to plugins during the `start` lifecycle."
        ],
        "path": "packages/react/kibana_context/common/types.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/react-kibana-context-common",
            "id": "def-common.ThemeServiceStart.theme$",
            "type": "Object",
            "tags": [],
            "label": "theme$",
            "description": [],
            "signature": [
              "Observable",
              "<",
              {
                "pluginId": "@kbn/react-kibana-context-common",
                "scope": "common",
                "docId": "kibKbnReactKibanaContextCommonPluginApi",
                "section": "def-common.KibanaTheme",
                "text": "KibanaTheme"
              },
              ">"
            ],
            "path": "packages/react/kibana_context/common/types.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      }
    ],
    "enums": [],
    "misc": [],
    "objects": [
      {
        "parentPluginId": "@kbn/react-kibana-context-common",
        "id": "def-common.defaultTheme",
        "type": "Object",
        "tags": [],
        "label": "defaultTheme",
        "description": [
          "\nThe default `KibanaTheme` for use in Storybook, Jest, or initialization.  At\nruntime, the theme should always be provided by the `ThemeService`."
        ],
        "path": "packages/react/kibana_context/common/index.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/react-kibana-context-common",
            "id": "def-common.defaultTheme.darkMode",
            "type": "boolean",
            "tags": [],
            "label": "darkMode",
            "description": [],
            "signature": [
              "false"
            ],
            "path": "packages/react/kibana_context/common/index.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      }
    ]
  }
}