kibana/api_docs/search_homepage.devdocs.json

{
  "id": "searchHomepage",
  "client": {
    "classes": [],
    "functions": [],
    "interfaces": [
      {
        "parentPluginId": "searchHomepage",
        "id": "def-public.SearchHomepageAppInfo",
        "type": "Interface",
        "tags": [],
        "label": "SearchHomepageAppInfo",
        "description": [],
        "path": "x-pack/solutions/search/plugins/search_homepage/public/types.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "searchHomepage",
            "id": "def-public.SearchHomepageAppInfo.appRoute",
            "type": "string",
            "tags": [],
            "label": "appRoute",
            "description": [],
            "path": "x-pack/solutions/search/plugins/search_homepage/public/types.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "searchHomepage",
            "id": "def-public.SearchHomepageAppInfo.id",
            "type": "string",
            "tags": [],
            "label": "id",
            "description": [],
            "path": "x-pack/solutions/search/plugins/search_homepage/public/types.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "searchHomepage",
            "id": "def-public.SearchHomepageAppInfo.title",
            "type": "string",
            "tags": [],
            "label": "title",
            "description": [],
            "path": "x-pack/solutions/search/plugins/search_homepage/public/types.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      }
    ],
    "enums": [],
    "misc": [],
    "objects": [],
    "setup": {
      "parentPluginId": "searchHomepage",
      "id": "def-public.SearchHomepagePluginSetup",
      "type": "Interface",
      "tags": [],
      "label": "SearchHomepagePluginSetup",
      "description": [],
      "path": "x-pack/solutions/search/plugins/search_homepage/public/types.ts",
      "deprecated": false,
      "trackAdoption": false,
      "children": [
        {
          "parentPluginId": "searchHomepage",
          "id": "def-public.SearchHomepagePluginSetup.app",
          "type": "Object",
          "tags": [],
          "label": "app",
          "description": [
            "\nSearch Homepage shared information for the Kibana application.\nUsed to ensure the stack and serverless apps have the same route\nand deep links."
          ],
          "signature": [
            {
              "pluginId": "searchHomepage",
              "scope": "public",
              "docId": "kibSearchHomepagePluginApi",
              "section": "def-public.SearchHomepageAppInfo",
              "text": "SearchHomepageAppInfo"
            }
          ],
          "path": "x-pack/solutions/search/plugins/search_homepage/public/types.ts",
          "deprecated": false,
          "trackAdoption": false
        },
        {
          "parentPluginId": "searchHomepage",
          "id": "def-public.SearchHomepagePluginSetup.isHomepageFeatureEnabled",
          "type": "Function",
          "tags": [],
          "label": "isHomepageFeatureEnabled",
          "description": [
            "\nChecks if the Search Homepage feature flag is currently enabled."
          ],
          "signature": [
            "() => boolean"
          ],
          "path": "x-pack/solutions/search/plugins/search_homepage/public/types.ts",
          "deprecated": false,
          "trackAdoption": false,
          "children": [],
          "returnComment": [
            "true if Search Homepage feature is enabled"
          ]
        }
      ],
      "lifecycle": "setup",
      "initialIsOpen": true
    },
    "start": {
      "parentPluginId": "searchHomepage",
      "id": "def-public.SearchHomepagePluginStart",
      "type": "Interface",
      "tags": [],
      "label": "SearchHomepagePluginStart",
      "description": [],
      "path": "x-pack/solutions/search/plugins/search_homepage/public/types.ts",
      "deprecated": false,
      "trackAdoption": false,
      "children": [
        {
          "parentPluginId": "searchHomepage",
          "id": "def-public.SearchHomepagePluginStart.app",
          "type": "Object",
          "tags": [],
          "label": "app",
          "description": [
            "\nSearch Homepage shared information for the Kibana application.\nUsed to ensure the stack and serverless apps have the same route\nand deep links."
          ],
          "signature": [
            {
              "pluginId": "searchHomepage",
              "scope": "public",
              "docId": "kibSearchHomepagePluginApi",
              "section": "def-public.SearchHomepageAppInfo",
              "text": "SearchHomepageAppInfo"
            }
          ],
          "path": "x-pack/solutions/search/plugins/search_homepage/public/types.ts",
          "deprecated": false,
          "trackAdoption": false
        },
        {
          "parentPluginId": "searchHomepage",
          "id": "def-public.SearchHomepagePluginStart.isHomepageFeatureEnabled",
          "type": "Function",
          "tags": [],
          "label": "isHomepageFeatureEnabled",
          "description": [
            "\nChecks if the Search Homepage feature flag is currently enabled."
          ],
          "signature": [
            "() => boolean"
          ],
          "path": "x-pack/solutions/search/plugins/search_homepage/public/types.ts",
          "deprecated": false,
          "trackAdoption": false,
          "children": [],
          "returnComment": [
            "true if Search Homepage feature is enabled"
          ]
        },
        {
          "parentPluginId": "searchHomepage",
          "id": "def-public.SearchHomepagePluginStart.SearchHomepage",
          "type": "Function",
          "tags": [],
          "label": "SearchHomepage",
          "description": [
            "\nSearchHomepage shared component, used to render the search homepage in\nthe Stack search plugin"
          ],
          "signature": [
            "React.FunctionComponent<{}>"
          ],
          "path": "x-pack/solutions/search/plugins/search_homepage/public/types.ts",
          "deprecated": false,
          "trackAdoption": false,
          "returnComment": [],
          "children": [
            {
              "parentPluginId": "searchHomepage",
              "id": "def-public.SearchHomepagePluginStart.SearchHomepage.$1",
              "type": "Uncategorized",
              "tags": [],
              "label": "props",
              "description": [],
              "signature": [
                "P"
              ],
              "path": "node_modules/@types/react/ts5.0/index.d.ts",
              "deprecated": false,
              "trackAdoption": false
            },
            {
              "parentPluginId": "searchHomepage",
              "id": "def-public.SearchHomepagePluginStart.SearchHomepage.$2",
              "type": "Any",
              "tags": [],
              "label": "context",
              "description": [],
              "signature": [
                "any"
              ],
              "path": "node_modules/@types/react/ts5.0/index.d.ts",
              "deprecated": false,
              "trackAdoption": false
            }
          ]
        }
      ],
      "lifecycle": "start",
      "initialIsOpen": true
    }
  },
  "server": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": [],
    "setup": {
      "parentPluginId": "searchHomepage",
      "id": "def-server.SearchHomepagePluginSetup",
      "type": "Interface",
      "tags": [],
      "label": "SearchHomepagePluginSetup",
      "description": [],
      "path": "x-pack/solutions/search/plugins/search_homepage/server/types.ts",
      "deprecated": false,
      "trackAdoption": false,
      "children": [],
      "lifecycle": "setup",
      "initialIsOpen": true
    },
    "start": {
      "parentPluginId": "searchHomepage",
      "id": "def-server.SearchHomepagePluginStart",
      "type": "Interface",
      "tags": [],
      "label": "SearchHomepagePluginStart",
      "description": [],
      "path": "x-pack/solutions/search/plugins/search_homepage/server/types.ts",
      "deprecated": false,
      "trackAdoption": false,
      "children": [],
      "lifecycle": "start",
      "initialIsOpen": true
    }
  },
  "common": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [
      {
        "parentPluginId": "searchHomepage",
        "id": "def-common.HOMEPAGE_FEATURE_FLAG_ID",
        "type": "string",
        "tags": [],
        "label": "HOMEPAGE_FEATURE_FLAG_ID",
        "description": [
          "\nUI Setting id for the Search Homepage feature flag"
        ],
        "signature": [
          "\"searchHomepage:homepageEnabled\""
        ],
        "path": "x-pack/solutions/search/plugins/search_homepage/common/index.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "searchHomepage",
        "id": "def-common.PLUGIN_ID",
        "type": "string",
        "tags": [],
        "label": "PLUGIN_ID",
        "description": [],
        "signature": [
          "\"searchHomepage\""
        ],
        "path": "x-pack/solutions/search/plugins/search_homepage/common/index.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "searchHomepage",
        "id": "def-common.PLUGIN_NAME",
        "type": "string",
        "tags": [],
        "label": "PLUGIN_NAME",
        "description": [],
        "signature": [
          "\"searchHomepage\""
        ],
        "path": "x-pack/solutions/search/plugins/search_homepage/common/index.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      }
    ],
    "objects": []
  }
}