Skip to content

[EuiCodeBlock] Highlight line ranges#5207

Merged
thompsongl merged 11 commits intoelastic:masterfrom
thompsongl:highlight-lines
Sep 28, 2021
Merged

[EuiCodeBlock] Highlight line ranges#5207
thompsongl merged 11 commits intoelastic:masterfrom
thompsongl:highlight-lines

Conversation

@thompsongl
Copy link
Copy Markdown
Contributor

@thompsongl thompsongl commented Sep 21, 2021 •
edited
Loading

Summary

Adds the ability to visually highlight line ranges within EuiCodeBlock. Extends the lineNumbers prop to accept a comma-separated list of line number(s) or range(s) ({ highlight: '1, 5-10, 20-30, 40' }).

Amsterdam:
image

v7:
image

Also fixes a row height bug for virtualized blocks noticed during this work.

Checklist

  • Check against all themes for compatibility in both light and dark modes

- [ ] Checked in mobile

  • Checked in Chrome, Safari, Edge, and Firefox
  • Props have proper autodocs and playground toggles
  • Added documentation
  • Checked Code Sandbox works for any docs examples
  • Added or updated jest tests
  • Checked for breaking changes and labeled appropriately
  • Checked for accessibility including keyboard-only and screenreader modes
  • A changelog entry exists and is marked appropriately
  • Revert 2b9eee0

@kibanamachine
Copy link
Copy Markdown

kibanamachine commented Sep 21, 2021

Preview documentation changes for this PR: https://eui.elastic.co/pr_5207/

@thompsongl thompsongl marked this pull request as ready for review September 21, 2021 22:37
@kibanamachine
Copy link
Copy Markdown

kibanamachine commented Sep 21, 2021

Preview documentation changes for this PR: https://eui.elastic.co/pr_5207/

@cchaos cchaos requested a review from elizabetdev September 22, 2021 15:24
@elizabetdev
Copy link
Copy Markdown
Contributor

elizabetdev commented Sep 23, 2021

It's looking good @thompsongl,

I just found some small design issues. When the transparentBackground is set to true the numbers still have a background. We missed that on the PR that introduced the line numbers. For this scenario, we should remove the background.

Screenshot 2021-09-22 at 20 02 57

But if we remove this background the line number is highlighted and it doesn't pass the a11y contrast check (4.3). To solve this we can make the number with more contrast (maybe using the Sass function makeHighContrastColor) or we just remove the highlight for line numbers. What do you think?

Screenshot 2021-09-22 at 20 04 32

Then, on the following section we should also explain that we can also highlight the numbers.

Screenshot 2021-09-23 at 11 35 53

@thompsongl
Copy link
Copy Markdown
Contributor Author

thompsongl commented Sep 23, 2021

Good catch with transparentBackground; I didn't realize that was a prop that EuiCodeBlock accepted. Checking on options to resolve it.

cee-chen
cee-chen reviewed Sep 23, 2021
View reviewed changes
Copy link
Copy Markdown
Contributor

@cee-chen cee-chen left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Logic LGTM! I have some minor comments/suggestions but none of them are blockers. I didn't look too closely at the documentation/examples/design, since Elizabet is on it 🎉

@kibanamachine
Copy link
Copy Markdown

kibanamachine commented Sep 23, 2021

Preview documentation changes for this PR: https://eui.elastic.co/pr_5207/

@thompsongl
Copy link
Copy Markdown
Contributor Author

thompsongl commented Sep 27, 2021

Resolved all review comments, @miukimiu @constancecchen 🙇

@thompsongl thompsongl requested a review from cee-chen September 27, 2021 16:06
@kibanamachine
Copy link
Copy Markdown

kibanamachine commented Sep 27, 2021

Preview documentation changes for this PR: https://eui.elastic.co/pr_5207/

cee-chen
cee-chen approved these changes Sep 27, 2021
View reviewed changes
Copy link
Copy Markdown
Contributor

@cee-chen cee-chen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes for my feedback look great - thanks for the super thorough unit tests!! 🎉

elizabetdev
elizabetdev approved these changes Sep 28, 2021
View reviewed changes
Copy link
Copy Markdown
Contributor

@elizabetdev elizabetdev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, @thompsongl for making the changes. LGTM! 🎉

@snide
Copy link
Copy Markdown
Contributor

snide commented Sep 28, 2021

This PR is great! cc @goodroot as this is useful for document work. We'll probably want to add a more robust wrapper for the docs system at some point.

@thompsongl thompsongl merged commit 702f3c1 into elastic:master Sep 28, 2021
@thompsongl
Copy link
Copy Markdown
Contributor Author

thompsongl commented Sep 28, 2021

I forgot to revert 2b9eee0 🤦

@thompsongl thompsongl mentioned this pull request Sep 28, 2021
Merged
@goodroot
Copy link
Copy Markdown

goodroot commented Sep 28, 2021

OOh yeah this is real slick. Thanks for the awareness.

@jackamondo
Copy link
Copy Markdown

jackamondo commented Apr 1, 2022

Apologies for the necro on a merged topic, I'm using this component currently and I'm just wondering if anyone knows if it would be possible to dynamically highlight code? I have some json i'm displaying in the code block and ideally I want to highlight sections that match a certain syntax or result (i.e. only highlight objects with type "error"?) or is there any way to expose the API for prism? I'd massively appreciate if anyone could point me in the right direction!

@elizabetdev
Copy link
Copy Markdown
Contributor

elizabetdev commented Apr 1, 2022

Hi, @jackamondo I don't think is possible right now to dynamically highlight code that matches a certain syntax. Not sure @thompsongl can point out a workaround.

But there is a discussion with some feature requests for the EuiCodeBlock where you can comment there and propose the enhancements you would like to see: #5609.

@thompsongl
Copy link
Copy Markdown
Contributor Author

thompsongl commented Apr 1, 2022

I don't think is possible right now to dynamically highlight code that matches a certain syntax. Not sure @thompsongl can point out a workaround.

No workround at the moment unless you write a script that manipulates the DOM (not actually sure how this would work). I see you've added to the discussion, so that's best course right now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

2 more reviewers

@cee-chen cee-chen cee-chen approved these changes

@elizabetdev elizabetdev elizabetdev approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

@thompsongl @kibanamachine @elizabetdev @snide @goodroot @jackamondo @cee-chen