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

[Shared UX] Markdown Component #142228

Merged
merged 80 commits into from
Oct 18, 2022
Merged

[Shared UX] Markdown Component #142228

merged 80 commits into from
Oct 18, 2022

Conversation

rshen91
Copy link
Contributor

@rshen91 rshen91 commented Sep 29, 2022

Summary

Relating to #141166 taking considerations from instances of markdown etc in Kibana for this Shared UX Markdown component using EuiMarkdownEditor and EuiMarkdownFormat.

For places that previously used MarkdownSimple both implementations are supported:

    toastNotifications.addWarning({
      title: warnTitle,
      text: toMountPoint(<Markdown readOnly markdownContent={warnDescription} />),
    });

which was previously:

 toastNotifications.addWarning({
      title: warnTitle,
      text: toMountPoint(<MarkdownSimple readOnly>{warnDescription}</MarkdownSimple>),
  });

If readOnly is not passed, then the Markdown component will be passed as EuiMarkdownEditor.

openLinksInNewTab is removed due to lack of support in Github Flavored Markdown but workaround from @chandlerprall implemented in commit 66ed116

Checklist

Delete any items that are not applicable to this PR.

@rshen91 rshen91 added the Team:SharedUX Team label for AppEx-SharedUX (formerly Global Experience) label Sep 29, 2022
@rshen91 rshen91 self-assigned this Sep 29, 2022
kibanamachine and others added 24 commits September 29, 2022 15:10
@rshen91 rshen91 removed the request for review from majagrubic October 18, 2022 14:19
@rshen91 rshen91 enabled auto-merge (squash) October 18, 2022 16:37
@rshen91 rshen91 disabled auto-merge October 18, 2022 16:59
@rshen91
Copy link
Contributor Author

rshen91 commented Oct 18, 2022

Adding openInNewTab support based on Chandler's work in https://codesandbox.io/s/relaxed-yalow-hy69r4?file=/demo.js in commit 66ed116

@rshen91 rshen91 enabled auto-merge (squash) October 18, 2022 17:11
@rshen91 rshen91 disabled auto-merge October 18, 2022 17:16
@rshen91 rshen91 enabled auto-merge (squash) October 18, 2022 17:35
@kibana-ci
Copy link
Collaborator

💚 Build Succeeded

Metrics [docs]

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id before after diff
@kbn/shared-ux-markdown - 2 +2
@kbn/shared-ux-markdown-mocks - 31 +31
total +33

Public APIs missing exports

Total count of every type that is part of your API that should be exported but is not. This will cause broken links in the API documentation system. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats exports for more detailed information.

id before after diff
@kbn/shared-ux-markdown - 1 +1
@kbn/shared-ux-markdown-types - 1 +1
total +2
Unknown metric groups

API count

id before after diff
@kbn/shared-ux-markdown - 2 +2
@kbn/shared-ux-markdown-mocks - 32 +32
total +34

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

cc @rshen91

@rshen91 rshen91 merged commit 4e3461a into elastic:main Oct 18, 2022
@kibanamachine kibanamachine added v8.6.0 backport:skip This commit does not require backporting labels Oct 18, 2022
@rshen91 rshen91 deleted the markdown branch October 18, 2022 21:06
kc13greiner pushed a commit to kc13greiner/kibana that referenced this pull request Oct 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:skip This commit does not require backporting release_note:skip Skip the PR/issue when compiling release notes Team:SharedUX Team label for AppEx-SharedUX (formerly Global Experience) v8.6.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants