mirror of
https://github.com/elastic/kibana.git
synced 2025-06-27 18:51:07 -04:00
## Summary Fixes: https://github.com/elastic/kibana/issues/149347 This PR replaces deprecated `uiSettings` client with `settings.client` in `useUiSetting` hook. As a result, all consumers of the hook need to provide `settings` service to Kibana context. The majority of this PR is providing the `settings` as a dependency to affected plugins. It would be great if sometime in the future we could get rid of `uiSettings` entirely. `CodeEditor` is one of the components relying on this hook, which caused a lot of the changes in this PR. If you have been tagged for review it means your code is using `useUiSetting` hook directly, or is consuming `CodeEditor` component. I have been focused on updating plugins that had failing functional tests, but would appreciate a manual pass on this as well. xoxo ### Checklist Delete any items that are not applicable to this PR. ~ [ ] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)~ ~- [ ] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials~ - [X] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios ~- [ ] Any UI touched in this PR is usable by keyboard only (learn more about [keyboard accessibility](https://webaim.org/techniques/keyboard/))~ ~- [ ] Any UI touched in this PR does not create any new axe failures (run axe in browser: [FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/), [Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US))~ ~- [ ] If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the [docker list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)~ ~- [ ] This renders correctly on smaller devices using a responsive layout. (You can test this [in your browser](https://www.browserstack.com/guide/responsive-testing-on-local-server))~ ~- [ ] This was checked for [cross-browser compatibility](https://www.elastic.co/support/matrix#matrix_browsers)~ ### For maintainers - [ ] This was checked for breaking API changes and was [labeled appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: Maja Grubic <maja.grubic@elastic.co> Co-authored-by: Patryk Kopyciński <contact@patrykkopycinski.com>
86 lines
3.2 KiB
TypeScript
86 lines
3.2 KiB
TypeScript
/*
|
|
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
|
|
* or more contributor license agreements. Licensed under the Elastic License
|
|
* 2.0 and the Server Side Public License, v 1; you may not use this file except
|
|
* in compliance with, at your election, the Elastic License 2.0 or the Server
|
|
* Side Public License, v 1.
|
|
*/
|
|
|
|
import { Plugin, CoreSetup, AppMountParameters, AppNavLinkStatus } from '@kbn/core/public';
|
|
import { DeveloperExamplesSetup } from '@kbn/developer-examples-plugin/public';
|
|
import { ExpressionsSetup, ExpressionsStart } from '@kbn/expressions-plugin/public';
|
|
import { Setup as InspectorSetup, Start as InspectorStart } from '@kbn/inspector-plugin/public';
|
|
import { UiActionsStart, UiActionsSetup } from '@kbn/ui-actions-plugin/public';
|
|
import { getExpressionsInspectorViewDescription } from './inspector';
|
|
import { NAVIGATE_TRIGGER_ID, navigateTrigger } from './actions/navigate_trigger';
|
|
import { ACTION_NAVIGATE, createNavigateAction } from './actions/navigate_action';
|
|
import { buttonRenderer } from './renderers/button';
|
|
import { buttonFn } from './functions/button';
|
|
|
|
interface StartDeps {
|
|
expressions: ExpressionsStart;
|
|
inspector: InspectorStart;
|
|
uiActions: UiActionsStart;
|
|
}
|
|
|
|
interface SetupDeps {
|
|
uiActions: UiActionsSetup;
|
|
expressions: ExpressionsSetup;
|
|
inspector: InspectorSetup;
|
|
developerExamples: DeveloperExamplesSetup;
|
|
}
|
|
|
|
export class ExpressionsExplorerPlugin implements Plugin<void, void, SetupDeps, StartDeps> {
|
|
public setup(core: CoreSetup<StartDeps>, deps: SetupDeps) {
|
|
// register custom inspector adapter & view
|
|
deps.inspector.registerView(getExpressionsInspectorViewDescription());
|
|
|
|
// register custom actions
|
|
deps.uiActions.registerTrigger(navigateTrigger);
|
|
deps.uiActions.registerAction(createNavigateAction());
|
|
deps.uiActions.attachAction(NAVIGATE_TRIGGER_ID, ACTION_NAVIGATE);
|
|
|
|
// register custom functions and renderers
|
|
deps.expressions.registerRenderer(buttonRenderer);
|
|
deps.expressions.registerFunction(buttonFn);
|
|
|
|
core.application.register({
|
|
id: 'expressionsExplorer',
|
|
title: 'Expressions Explorer',
|
|
navLinkStatus: AppNavLinkStatus.hidden,
|
|
async mount(params: AppMountParameters) {
|
|
const [, depsStart] = await core.getStartServices();
|
|
const { renderApp } = await import('./app');
|
|
return renderApp(
|
|
{
|
|
expressions: depsStart.expressions,
|
|
inspector: depsStart.inspector,
|
|
actions: depsStart.uiActions,
|
|
uiSettings: core.uiSettings,
|
|
settings: core.settings,
|
|
},
|
|
params
|
|
);
|
|
},
|
|
});
|
|
|
|
deps.developerExamples.register({
|
|
appId: 'expressionsExplorer',
|
|
title: 'Expressions',
|
|
description: `Expressions is a plugin that allows to execute Kibana expressions and render content using expression renderers. This example plugin showcases various usage scenarios.`,
|
|
links: [
|
|
{
|
|
label: 'README',
|
|
href: 'https://github.com/elastic/kibana/blob/main/src/plugins/expressions/README.asciidoc',
|
|
iconType: 'logoGithub',
|
|
size: 's',
|
|
target: '_blank',
|
|
},
|
|
],
|
|
});
|
|
}
|
|
|
|
public start() {}
|
|
|
|
public stop() {}
|
|
}
|