Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Dev Docs entry: ui/public & angular cleanup 7.6 #43511

Closed
lukeelmers opened this issue Aug 19, 2019 · 3 comments
Closed

Dev Docs entry: ui/public & angular cleanup 7.6 #43511

lukeelmers opened this issue Aug 19, 2019 · 3 comments
Labels
Feature:NP Migration release_note:plugin_api_changes Contains a Plugin API changes section for the breaking plugin API changes section. Team:Visualizations Visualization editors, elastic-charts and infrastructure v7.6.0

Comments

@lukeelmers
Copy link
Member

lukeelmers commented Aug 19, 2019

This issue is just there to create a single dev docs entry in the API changes blog post, for any of the ui/public directory removals, so not every removal PR pops up as it's own section in the blog post.

Dev Docs

ui/public cleanup

Removed / moved modules

In preparation for Kibana's upcoming new platform, we are in the process of migrating away from the ui/public directory. Over time, the contents of this directory will be either deprecated or housed inside a parent plugin. If your plugin imports the listed items from the following ui/public modules, you will need to either update your import statements as indicated below, so that you are pulling these modules from their new locations, or copy the relevant code into your plugin.

ui/state_management #51835, #52172, #52280, #53582

The hashUrl and unhashUrl functions no longer rely on states being provided as an argument, therefore getUnhashableStates/getUnhashableStatesProvider have been removed.

// old
import {
  hashUrl,
  unhashUrl,
  getUnhashableStatesProvider, // deprecated
} from 'ui/state_management/state_hashing';
const getUnhashableStates = Private(getUnhashableStatesProvider);
unhashUrl(window.location.href, getUnhashableStates());
hashUrl([new AppState(), globalState], myRedirectUrl);

// new
import { hashUrl, unhashUrl } from '../../plugins/kibana_utils/public'
hashUrl(window.location.href);
unhashUrl(myRedirectUrl);

HashedItemStore was also moved to the kibana_utils plugin.

// old
import { HashedItemStoreSingleton } from 'ui/state_management/state_storage'

// new
import { hashedItemStore } from '../../plugins/kibana_utils/public'
New state syncing utilities (AppState & GlobalState replacement in NP)

Created new state syncing utilities for syncing state between state containers and different type of state storage (e.g. query params in URL or session storage).

Example app: examples/state_containers_examples

This should become a replacement for AppState and GlobalState in NP.

ui/public/utils cleanup

@lukeelmers lukeelmers added release_note:plugin_api_changes Contains a Plugin API changes section for the breaking plugin API changes section. Team:Visualizations Visualization editors, elastic-charts and infrastructure Team:AppArch v7.5.0 Feature:NP Migration labels Aug 19, 2019
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-app

@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-app-arch

@lukeelmers
Copy link
Member Author

lukeelmers commented Aug 19, 2019

Immediately closing this so the dev tools script can pick up docs changes for 7.6

Please update the issue description with any ui/public cleanup items for 7.6 that come up as we are working on NP migration (but only use this issue for changes that will make it into the release)

@lukeelmers lukeelmers added v7.6.0 and removed release_note:plugin_api_changes Contains a Plugin API changes section for the breaking plugin API changes section. v7.5.0 labels Nov 21, 2019
@lukeelmers lukeelmers changed the title Dev Docs entry: ui/public cleanup 7.5 Dev Docs entry: ui/public cleanup 7.6 Nov 21, 2019
@lukeelmers lukeelmers changed the title Dev Docs entry: ui/public cleanup 7.6 Dev Docs entry: ui/public & angular cleanup 7.6 Nov 21, 2019
@lukeelmers lukeelmers added the release_note:plugin_api_changes Contains a Plugin API changes section for the breaking plugin API changes section. label Dec 11, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature:NP Migration release_note:plugin_api_changes Contains a Plugin API changes section for the breaking plugin API changes section. Team:Visualizations Visualization editors, elastic-charts and infrastructure v7.6.0
Projects
None yet
Development

No branches or pull requests

2 participants