kibana/api_docs/kbn_shared_ux_router.devdocs.json

{
  "id": "@kbn/shared-ux-router",
  "client": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "server": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "common": {
    "classes": [],
    "functions": [
      {
        "parentPluginId": "@kbn/shared-ux-router",
        "id": "def-common.BrowserRouter",
        "type": "Function",
        "tags": [],
        "label": "BrowserRouter",
        "description": [],
        "signature": [
          "({ children, ...props }: ",
          "BrowserRouterProps",
          ") => React.JSX.Element"
        ],
        "path": "src/platform/packages/shared/shared-ux/router/impl/router.tsx",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/shared-ux-router",
            "id": "def-common.BrowserRouter.$1",
            "type": "Object",
            "tags": [],
            "label": "{ children, ...props }",
            "description": [],
            "signature": [
              "BrowserRouterProps"
            ],
            "path": "src/platform/packages/shared/shared-ux/router/impl/router.tsx",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/shared-ux-router",
        "id": "def-common.HashRouter",
        "type": "Function",
        "tags": [],
        "label": "HashRouter",
        "description": [],
        "signature": [
          "({ children, ...props }: ",
          "HashRouterProps",
          ") => React.JSX.Element"
        ],
        "path": "src/platform/packages/shared/shared-ux/router/impl/router.tsx",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/shared-ux-router",
            "id": "def-common.HashRouter.$1",
            "type": "Object",
            "tags": [],
            "label": "{ children, ...props }",
            "description": [],
            "signature": [
              "HashRouterProps"
            ],
            "path": "src/platform/packages/shared/shared-ux/router/impl/router.tsx",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/shared-ux-router",
        "id": "def-common.MemoryRouter",
        "type": "Function",
        "tags": [],
        "label": "MemoryRouter",
        "description": [],
        "signature": [
          "({ children, ...props }: ",
          "MemoryRouterProps",
          ") => React.JSX.Element"
        ],
        "path": "src/platform/packages/shared/shared-ux/router/impl/router.tsx",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/shared-ux-router",
            "id": "def-common.MemoryRouter.$1",
            "type": "Object",
            "tags": [],
            "label": "{ children, ...props }",
            "description": [],
            "signature": [
              "MemoryRouterProps"
            ],
            "path": "src/platform/packages/shared/shared-ux/router/impl/router.tsx",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/shared-ux-router",
        "id": "def-common.Route",
        "type": "Function",
        "tags": [],
        "label": "Route",
        "description": [
          "\nThis is a wrapper around the react-router-dom Route component that inserts\nMatchPropagator in every application route. It helps track all route changes\nand send them to the execution context, later used to enrich APM\n'route-change' transactions."
        ],
        "signature": [
          "<T extends {}>({ children, component: Component, render, ...rest }: ",
          "RouteProps",
          "<string, { [K: string]: string; } & T>) => React.JSX.Element"
        ],
        "path": "src/platform/packages/shared/shared-ux/router/impl/route.tsx",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/shared-ux-router",
            "id": "def-common.Route.$1",
            "type": "Object",
            "tags": [],
            "label": "{\n  children,\n  component: Component,\n  render,\n  ...rest\n}",
            "description": [],
            "signature": [
              "RouteProps",
              "<string, { [K: string]: string; } & T>"
            ],
            "path": "src/platform/packages/shared/shared-ux/router/impl/route.tsx",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/shared-ux-router",
        "id": "def-common.Router",
        "type": "Function",
        "tags": [],
        "label": "Router",
        "description": [],
        "signature": [
          "({ children, ...props }: ",
          "RouterProps",
          ") => React.JSX.Element"
        ],
        "path": "src/platform/packages/shared/shared-ux/router/impl/router.tsx",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/shared-ux-router",
            "id": "def-common.Router.$1",
            "type": "Object",
            "tags": [],
            "label": "{ children, ...props }",
            "description": [],
            "signature": [
              "RouterProps"
            ],
            "path": "src/platform/packages/shared/shared-ux/router/impl/router.tsx",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/shared-ux-router",
        "id": "def-common.Routes",
        "type": "Function",
        "tags": [],
        "label": "Routes",
        "description": [],
        "signature": [
          "({ legacySwitch, enableExecutionContextTracking, children, }: { legacySwitch?: boolean | undefined; enableExecutionContextTracking?: boolean | undefined; children: React.ReactNode; }) => React.JSX.Element"
        ],
        "path": "src/platform/packages/shared/shared-ux/router/impl/routes.tsx",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/shared-ux-router",
            "id": "def-common.Routes.$1",
            "type": "Object",
            "tags": [],
            "label": "{\n  legacySwitch = true,\n  enableExecutionContextTracking = false,\n  children,\n}",
            "description": [],
            "path": "src/platform/packages/shared/shared-ux/router/impl/routes.tsx",
            "deprecated": false,
            "trackAdoption": false,
            "children": [
              {
                "parentPluginId": "@kbn/shared-ux-router",
                "id": "def-common.Routes.$1.legacySwitch",
                "type": "CompoundType",
                "tags": [],
                "label": "legacySwitch",
                "description": [],
                "signature": [
                  "boolean | undefined"
                ],
                "path": "src/platform/packages/shared/shared-ux/router/impl/routes.tsx",
                "deprecated": false,
                "trackAdoption": false
              },
              {
                "parentPluginId": "@kbn/shared-ux-router",
                "id": "def-common.Routes.$1.enableExecutionContextTracking",
                "type": "CompoundType",
                "tags": [],
                "label": "enableExecutionContextTracking",
                "description": [],
                "signature": [
                  "boolean | undefined"
                ],
                "path": "src/platform/packages/shared/shared-ux/router/impl/routes.tsx",
                "deprecated": false,
                "trackAdoption": false
              },
              {
                "parentPluginId": "@kbn/shared-ux-router",
                "id": "def-common.Routes.$1.children",
                "type": "CompoundType",
                "tags": [],
                "label": "children",
                "description": [],
                "signature": [
                  "string | number | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal | null | undefined"
                ],
                "path": "src/platform/packages/shared/shared-ux/router/impl/routes.tsx",
                "deprecated": false,
                "trackAdoption": false
              }
            ]
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      }
    ],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": [
      {
        "parentPluginId": "@kbn/shared-ux-router",
        "id": "def-common.SharedUXRouterContext",
        "type": "Object",
        "tags": [],
        "label": "SharedUXRouterContext",
        "description": [],
        "signature": [
          "React.Context<",
          "SharedUXRouterContextValue",
          "<Partial<",
          "SharedUXExecutionContextSetup",
          ">>>"
        ],
        "path": "src/platform/packages/shared/shared-ux/router/impl/services.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      }
    ]
  }
}