/* * SPDX-License-Identifier: Apache-2.0 * * The OpenSearch Contributors require contributions made to * this file be licensed under the Apache-2.0 license or a * compatible open source license. * * Any modifications Copyright OpenSearch Contributors. See * GitHub history for details. */ /* * Licensed to Elasticsearch B.V. under one or more contributor * license agreements. See the NOTICE file distributed with * this work for additional information regarding copyright * ownership. Elasticsearch B.V. licenses this file to you under * the Apache License, Version 2.0 (the "License"); you may * not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. */ import { EmbeddableExamplesStart } from 'examples/embeddable_examples/public/plugin'; import { Plugin, CoreSetup, AppMountParameters, AppNavLinkStatus } from '../../../src/core/public'; import { UiActionsService } from '../../../src/plugins/ui_actions/public'; import { EmbeddableStart } from '../../../src/plugins/embeddable/public'; import { Start as InspectorStart } from '../../../src/plugins/inspector/public'; import { DeveloperExamplesSetup } from '../../developer_examples/public'; import img from './embeddables.png'; interface StartDeps { uiActions: UiActionsService; embeddable: EmbeddableStart; inspector: InspectorStart; embeddableExamples: EmbeddableExamplesStart; } interface SetupDeps { developerExamples: DeveloperExamplesSetup; } export class EmbeddableExplorerPlugin implements Plugin { public setup(core: CoreSetup, { developerExamples }: SetupDeps) { core.application.register({ id: 'embeddableExplorer', title: 'Embeddable explorer', navLinkStatus: AppNavLinkStatus.hidden, async mount(params: AppMountParameters) { const [coreStart, depsStart] = await core.getStartServices(); const { renderApp } = await import('./app'); await depsStart.embeddableExamples.createSampleData(); return renderApp( { notifications: coreStart.notifications, inspector: depsStart.inspector, embeddableApi: depsStart.embeddable, uiActionsApi: depsStart.uiActions, basename: params.appBasePath, uiSettingsClient: coreStart.uiSettings, savedObject: coreStart.savedObjects, overlays: coreStart.overlays, navigateToApp: coreStart.application.navigateToApp, embeddableExamples: depsStart.embeddableExamples, }, params.element ); }, }); developerExamples.register({ appId: 'embeddableExplorer', title: 'Embeddables', description: `Multiple embeddable examples showcase how to build custom dashboard widgets, how to build your own custom "container" (like a dashboard but imagine you want to render the panels differently), and how to embed anything that can show up in a dashboard in your own UI and app, that comes pre-connected with actions built by other developers. `, links: [ { label: 'README', href: 'https://github.com/opensearch-project/OpenSearch-Dashboards/tree/main/src/plugins/embeddable/README.md', iconType: 'logoGithub', target: '_blank', size: 's', }, ], image: img, }); } public start() {} public stop() {} }