Skip to content

[Shared UX] Markdown Component#142228

Merged
rshen91 merged 80 commits intoelastic:mainfrom
rshen91:markdown
Oct 18, 2022
Merged

[Shared UX] Markdown Component#142228
rshen91 merged 80 commits intoelastic:mainfrom
rshen91:markdown

Conversation

@rshen91
Copy link
Copy Markdown
Contributor

@rshen91 rshen91 commented Sep 29, 2022 •
edited
Loading

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 Platform AppEx-SharedUX (formerly Global Experience) t// label Sep 29, 2022
@rshen91 rshen91 self-assigned this Sep 29, 2022
kibanamachine and others added 24 commits September 29, 2022 15:10
@kibanamachine
[CI] Auto-commit changed files from 'node scripts/eslint --no-cache -…
7b9adee 
…-fix'
@rshen91
readonly markdown
623926b
@rshen91
Merge remote-tracking branch 'upstream/main' into markdown
738f16d
@kibanamachine
[CI] Auto-commit changed files from 'node scripts/eslint --no-cache -…
fd5bf5c 
…-fix'
@rshen91
refactor to include impl and types packages
cff592e
@rshen91
Merge remote-tracking branch 'origin/markdown' into markdown
01a3cf6
@kibanamachine
[CI] Auto-commit changed files from 'node scripts/precommit_hook.js -…
45ca78f 
…-ref HEAD~1..HEAD --fix'
@kibanamachine
[CI] Auto-commit changed files from 'node scripts/generate codeowners'
095e315
@rshen91
update
1feae32
@rshen91
Merge remote-tracking branch 'origin/markdown' into markdown
2658ba1
@kibanamachine
[CI] Auto-commit changed files from 'node scripts/eslint --no-cache -…
5868c56 
…-fix'
@rshen91
add render test
c52f9c3
@kibanamachine
[CI] Auto-commit changed files from 'node scripts/precommit_hook.js -…
5815a04 
…-ref HEAD~1..HEAD --fix'
@rshen91
update
24df4e2
@rshen91
Merge remote-tracking branch 'origin/markdown' into markdown
bae0552
@rshen91
Merge branch 'main' into markdown
173c53b
@rshen91
Merge branch 'main' into markdown
e347b0c
@rshen91
wip updating props and story mocks
08f6c0a
@rshen91
Merge remote-tracking branch 'origin/markdown' into markdown
865dcab
@rshen91
Merge remote-tracking branch 'upstream/main' into markdown
c3ab0f3
@rshen91
update
449903a
@kibanamachine
[CI] Auto-commit changed files from 'node scripts/eslint --no-cache -…
44e752b 
…-fix'
@rshen91
update mocks
7dc10d5
@rshen91
Merge remote-tracking branch 'upstream/main' into markdown
8a85478
@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
Copy Markdown
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
Copy Markdown

kibana-ci commented Oct 18, 2022

💚 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 PR does not require backporting labels Oct 18, 2022
@rshen91 rshen91 deleted the markdown branch October 18, 2022 21:06
@rshen91 rshen91 mentioned this pull request Oct 19, 2022
Open
15 tasks
kc13greiner pushed a commit to kc13greiner/kibana that referenced this pull request Oct 19, 2022
@rshen91 @kc13greiner
[Shared UX] Markdown Component (elastic#142228)
87e1e90
@rshen91 rshen91 mentioned this pull request Oct 20, 2022
Merged
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@sebelga sebelga sebelga approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@rshen91 rshen91

Labels

backport:skip This PR does not require backporting release_note:skip Skip the PR/issue when compiling release notes Team:SharedUX Platform AppEx-SharedUX (formerly Global Experience) t// v8.6.0

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@rshen91 @kibana-ci @sebelga @kibanamachine