/* * 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 { Plugin, CoreSetup, AppMountParameters, AppNavLinkStatus } from '../../../src/core/public'; import { PHONE_TRIGGER, USER_TRIGGER, COUNTRY_TRIGGER, lookUpWeatherAction, viewInMapsAction, createEditUserAction, makePhoneCallAction, showcasePluggability, UserContext, CountryContext, PhoneContext, ACTION_EDIT_USER, ACTION_SHOWCASE_PLUGGABILITY, ACTION_CALL_PHONE_NUMBER, ACTION_TRAVEL_GUIDE, ACTION_VIEW_IN_MAPS, ACTION_TRIGGER_PHONE_USER, createTriggerPhoneTriggerAction, } from './actions/actions'; import image from './ui_actions.png'; import { UiActionsExplorerPluginSetup, UiActionsExplorerPluginStart, UiActionsExplorerStartDependencies, } from './types'; declare module '../../../src/plugins/ui_actions/public' { export interface TriggerContextMapping { [USER_TRIGGER]: UserContext; [COUNTRY_TRIGGER]: CountryContext; [PHONE_TRIGGER]: PhoneContext; } export interface ActionContextMapping { [ACTION_EDIT_USER]: UserContext; [ACTION_SHOWCASE_PLUGGABILITY]: {}; [ACTION_CALL_PHONE_NUMBER]: PhoneContext; [ACTION_TRAVEL_GUIDE]: CountryContext; [ACTION_VIEW_IN_MAPS]: CountryContext; [ACTION_TRIGGER_PHONE_USER]: UserContext; } } export class UiActionsExplorerPlugin implements Plugin { public setup( core: CoreSetup, deps: UiActionsExplorerPluginSetup ) { deps.uiActions.registerTrigger({ id: COUNTRY_TRIGGER, }); deps.uiActions.registerTrigger({ id: PHONE_TRIGGER, }); deps.uiActions.registerTrigger({ id: USER_TRIGGER, }); const startServices = core.getStartServices(); deps.uiActions.addTriggerAction( USER_TRIGGER, createTriggerPhoneTriggerAction(async () => (await startServices)[1].uiActions) ); deps.uiActions.addTriggerAction( USER_TRIGGER, createEditUserAction(async () => (await startServices)[0].overlays.openModal) ); deps.uiActions.addTriggerAction(COUNTRY_TRIGGER, viewInMapsAction); deps.uiActions.addTriggerAction(COUNTRY_TRIGGER, lookUpWeatherAction); deps.uiActions.addTriggerAction(COUNTRY_TRIGGER, showcasePluggability); deps.uiActions.addTriggerAction(PHONE_TRIGGER, makePhoneCallAction); deps.uiActions.addTriggerAction(PHONE_TRIGGER, showcasePluggability); deps.uiActions.addTriggerAction(USER_TRIGGER, showcasePluggability); core.application.register({ id: 'uiActionsExplorer', title: 'Ui Actions Explorer', navLinkStatus: AppNavLinkStatus.hidden, async mount(params: AppMountParameters) { const [coreStart, depsStart] = await core.getStartServices(); const { renderApp } = await import('./app'); return renderApp(coreStart, depsStart, params); }, }); deps.developerExamples.register({ appId: 'uiActionsExplorer', title: 'Ui Actions & Triggers', description: `Ui Actions can be used to make any part of your UI extensible. It has built in support for context menus, but you can also render all actions attached to a given trigger however you like, just how panel badges and panel notifications does.`, image, links: [ { label: 'README', href: 'https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/src/plugins/ui_actions/README.md', iconType: 'logoGithub', size: 's', target: '_blank', }, ], }); } public start() {} public stop() {} }