-
Notifications
You must be signed in to change notification settings - Fork 8.3k
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
Add help menu item to header #29664
Add help menu item to header #29664
Conversation
Pinging @elastic/kibana-design |
💔 Build Failed |
For the default content copy, I recommend: Get updates, information, and answers in our documentation. |
💔 Build Failed |
@cchaos Excellent work! Thanks for jumping on this such short notice 🙇 |
@cchaos Added APIs to feed the UI here, and also added info to the description on how to use those APIs. |
@spalger You are the best!!! 🥇 |
💚 Build Succeeded |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Adding some todo's of things I need help with. I'm hoping someone from the @elastic/kibana-app team can help.
src/ui/public/chrome/directives/header_global_nav/components/header_help_menu.tsx
Outdated
Show resolved
Hide resolved
src/ui/public/chrome/directives/header_global_nav/components/header_help_menu.tsx
Outdated
Show resolved
Hide resolved
src/ui/public/chrome/directives/header_global_nav/components/header_help_menu.tsx
Outdated
Show resolved
Hide resolved
src/ui/public/chrome/directives/header_global_nav/components/header_help_menu.tsx
Outdated
Show resolved
Hide resolved
src/ui/public/chrome/directives/header_global_nav/components/header_help_menu.tsx
Outdated
Show resolved
Hide resolved
💔 Build Failed |
2fe4bf8
to
2d680f3
Compare
💚 Build Succeeded |
💚 Build Succeeded |
Yasss @timroes !!! Thank you!! It's all dynamic now, just going through the last of the checklist items. |
💚 Build Succeeded |
💚 Build Succeeded |
Summary
This creates a help menu button in the Kibana header that allows for linking to documentation and/or other types of feedback opportunities.
It currently accepts three props:
useDefaultContent
: defaults to true and will show the default intro text and link to Kibana's docs sitedocumentationLink
: default's to kibana's docs sitecustomContent
: adds any custom content below the default contentAdditionally, this adds
core.chrome.setHelpExtension/getHelpExtension$
andchrome.helpExtension.set/get$
APIs to render a help extension in this popover.chrome.helpExtension.set()
(legacy platform) orcore.chrome.setHelpExtension()
(new platform) to provide the chrome with a render function that will be called with a DOM element, and should return a function to unmount the rendered componentundefined
tochrome.helpExtension.set()
orcore.chrome.setHelpExtension()
Example
Shows how to use the default content with additional custom content to show an extra link:
cc @formgeist and ref: #29247
@elastic/kibana-platform team (and specifically @spalger) This is ready to be hooked up. I basically dupped the app menu so it still contains (commented out) that
subscription
stuff in case that's need to be able to pass down some of those custom options.Thanks in advance!!!
Also, the default content copy could use some love from @gchaps or @schersh
Checklist
For maintainers