-
Notifications
You must be signed in to change notification settings - Fork 1.6k
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 code block copy button #5334
Merged
compulim
merged 37 commits into
microsoft:main
from
compulim:feat-code-block-copy-button
Oct 26, 2024
Merged
Add code block copy button #5334
compulim
merged 37 commits into
microsoft:main
from
compulim:feat-code-block-copy-button
Oct 26, 2024
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
OEvgeny
previously approved these changes
Oct 25, 2024
OEvgeny
reviewed
Oct 25, 2024
packages/component/src/providers/CustomElements/customElements/registerCodeBlockCopyButton.ts
Outdated
Show resolved
Hide resolved
OEvgeny
previously approved these changes
Oct 25, 2024
OEvgeny
previously approved these changes
Oct 25, 2024
OEvgeny
reviewed
Oct 26, 2024
packages/component/src/providers/CustomElements/customElements/registerCodeBlockCopyButton.ts
Outdated
Show resolved
Hide resolved
OEvgeny
reviewed
Oct 26, 2024
packages/component/src/providers/CustomElements/customElements/registerCodeBlockCopyButton.ts
Outdated
Show resolved
Hide resolved
OEvgeny
previously approved these changes
Oct 26, 2024
OEvgeny
reviewed
Oct 26, 2024
packages/component/src/providers/CustomElements/customElements/registerCodeBlockCopyButton.ts
Outdated
Show resolved
Hide resolved
OEvgeny
previously approved these changes
Oct 26, 2024
OEvgeny
approved these changes
Oct 26, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changelog Entry
Added
Description
For code blocks inside Markdown (via triple-backtick or
<pre>
), we will add a copy button on the top right corner of it.Design
We are introducing internal-use Web Components.
As we go through sanitization, DOM become string and it lose event handler. In other words, we cannot listen to "click" event on the button after sanitization.
Our solution is to use Web Components so we can preserve logic during sanitization.
Alternatively, we could have a catch-all click handler on Markdown, but it is not trivial as Adaptive Cards requires a HTML string instead of DOM too. That means, we will need to put a catch-all container in 2+ different places.
Specific Changes
CustomElementsProvider
to host internal-use hash-secured Web Components<webchat-xxxxx--code-block-copy-button>
wherexxxxx
is a random hashpackage.json
viatouch
so changes tocore
will trigger rebuild ofapi
, and so onCHANGELOG.md
I have updated documentationReview Checklist
Browser and platform compatibilities reviewedz-index
)Documents reviewed (docs, samples, live demo)Internationalization reviewed (strings, unit formatting)package.json
andpackage-lock.json
reviewed