github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-23 17:28:26 -04:00
Code Issues Projects Releases Packages Wiki Activity

[docs] Adds paragraphs on inter-app navigation with application service (#129421)

Browse source
This commit is contained in:
Christiane (Tina) Heiligers 2022-04-05 07:22:22 -07:00 • committed by GitHub
parent 735b4c936d
commit 3bb27f21fa
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 47 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

22
dev_docs/key_concepts/navigation.mdx
View file

@ -89,6 +89,10 @@ To navigate between different Kibana apps without a page reload there are APIs i
* [core.application.navigateToApp](https://github.com/elastic/kibana/blob/main/docs/development/core/public/kibana-plugin-core-public.applicationstart.navigatetoapp.md)
* [core.application.navigateToUrl](https://github.com/elastic/kibana/blob/main/docs/development/core/public/kibana-plugin-core-public.applicationstart.navigatetourl.md)
Both methods offer customization such as opening the target in a new page, with an `options` parameter. All the options are optional be default.
* [core.application.navigateToApp options](https://github.com/elastic/kibana/blob/main/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.md)
* [core.application.navigateToUrl options](https://github.com/elastic/kibana/blob/main/docs/development/core/public/kibana-plugin-core-public.navigatetourloptions.md)
*Rendering a link to a different app on its own would also cause a full page reload:*
```jsx
@ -124,6 +128,24 @@ const MyApp = () =>
</RedirectAppLinks>
```
NOTE: There may be cases where you need a full page reload. While rare and should be avoided, rather than implement your own navigation,
you can use the `navigateToUrl` `forceRedirect` option.
```tsx
const MyForcedPageReloadLink = () =>
<a
href={urlToSomeSpecialApp}
onClick={(e) => {
e.preventDefault();
core.application.navigateToUrl('someSpecialApp', { forceRedirect: true });
}}
>
Go to Some Special App
</a>;
```
If you also need to bypass the default onAppLeave behavior, you can set the `skipUnload` option to `true`. This option is also available in `navigateToApp`.
## Setting up internal app routing
It is very common for Kibana apps to use React and React Router.

25
docs/developer/best-practices/navigation.asciidoc
View file

@ -85,11 +85,15 @@ const urlToADashboard = core.http.basePath.prepend(`/dashboard/my-dashboard`);
window.location.href = urlToADashboard;
----
To navigate between different {kib} apps without a page reload there are APIs in `core`:
To navigate between different {kib} apps without a page reload (by default) there are APIs in `core`:
* {kib-repo}tree/{branch}/docs/development/core/public/kibana-plugin-core-public.applicationstart.navigatetoapp.md[core.application.navigateToApp]
* {kib-repo}tree/{branch}/docs/development/core/public/kibana-plugin-core-public.applicationstart.navigatetourl.md[core.application.navigateToUrl]
Both methods offer customization such as opening the target in a new page, with an `options` parameter. All the options are optional be default.
* {kib-repo}tree/{branch}/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.md[core.application.navigateToApp options]
* {kib-repo}tree/{branch}/docs/development/core/public/kibana-plugin-core-public.navigatetourloptions.md[core.application.navigateToUrl options]
*Rendering a link to a different {kib} app on its own would also cause a full page reload:*
[source,typescript jsx]
@ -128,6 +132,25 @@ const MyApp = () =>
</RedirectAppLinks>
----
NOTE: There may be cases where you need a full page reload. While rare and should be avoided, rather than implement your own navigation,
you can use the `navigateToUrl` `forceRedirect` option.
[source,typescript jsx]
----
const MyForcedPageReloadLink = () =>
<a
href={urlToSomeSpecialApp}
onClick={(e) => {
e.preventDefault();
core.application.navigateToUrl('someSpecialApp', { forceRedirect: true });
}}
>
Go to Some Special App
</a>;
----
If you also need to bypass the default onAppLeave behavior, you can set the `skipUnload` option to `true`. This option is also available in `navigateToApp`.
[[routing]]
=== Setting up internal app routing

1
src/core/public/application/types.ts
View file

@ -821,6 +821,7 @@ export interface ApplicationStart {
* ```
*
* @param url - an absolute URL, an absolute path or a relative path, to navigate to.
* @param options - navigation options
*/
navigateToUrl(url: string, options?: NavigateToUrlOptions): Promise<void>;
/**