feat(viewport): horizontal scroll #240

tty2 · 2022-09-14T15:59:27Z

implement #235

meowgorithm · 2022-09-14T16:10:07Z

Thanks for the PR! One immediate things is jumping out here:

len() counts bytes and not runes, which are not always the same. Similarly, some runes occupy two cells. For example:

// 3 bytes, 3 cells
Hi!

// 7 bytes, 5 cells:
世界!

So, in short, keep in mind that horizontal scrolling will need to handle double-width runes. Here’s a more in-depth example that breaks it down further:

https://go.dev/play/p/7lPoU2SMjn5

tty2 · 2022-09-14T16:16:55Z

Thanks for the PR! One immediate things is jumping out here:

len() counts bytes and not runes, which are not always the same. Similarly, some runes occupy two cells. For example:
// 3 bytes, 3 cells
Hi!

// 7 bytes, 5 cells:
世界!
So, in short, keep in mind that horizontal scrolling will need to handle double-width runes. Here’s a more in-depth example that breaks it down further:

https://go.dev/play/p/7lPoU2SMjn5

It's a good point. I guess I have to use lipgloss.Width here.

tty2 · 2022-09-15T15:15:13Z

Waiting for this PR merge and tagging.
Will continue after that.

tty2 · 2022-09-20T15:16:04Z

Don't merge it yet, please.
I'm gonna write some simple tests later this evening.

tty2 · 2022-09-20T17:50:55Z

Done!
@meowgorithm could you check it, please?
I can suppose that last test case (list: with y offset: horizontal scroll) can be too complicated. But I'm not sure it it's better to change it.
WDYT?

meowgorithm · 2022-09-20T17:59:03Z

Thanks, @tty2. Before we get to this, do you mind adding some tests with double-width runes? That is going to be the number one thing we'll want to verify. In particular, cases where there's a mix of single and double width runes.

tty2 · 2022-09-20T18:15:56Z

These tests I've written inside go-runewidth library. For TruncateLeft function I use here.
But ok I'll write them here as well. I'll do it tomorrow.

tty2 · 2022-09-21T16:14:22Z

@meowgorithm
Done! Check the last test case.

tty2 · 2022-09-26T18:42:56Z

Hi, @meowgorithm
Should I change anything?

meowgorithm · 2022-09-26T19:55:51Z

Hey, @tty2! Thanks for all your work on this so far. It's going to be a little bit of time until we can give this a proper review, but I promise we'll get to it.

bobziuchkovski · 2023-09-17T16:16:00Z

We'd absolutely love this functionality as well!

However, I tested this branch and found a potential issue: the rune trimming also trims color codes. The below are a series of screens showing horizontal scroll of a terraform plan that includes colored text:

kalensk · 2024-05-24T00:30:48Z

It would be great to have this feature as well.

caarlos0

i think the only issue here is the truncation using rune width, ansi.Truncate should be a quick fix though!

caarlos0 · 2024-12-04T12:59:39Z

viewport/viewport.go

+	if m.indent > 0 {
+		cutLines := make([]string, len(lines))
+		for i := range lines {
+			cutLines[i] = runewidth.TruncateLeft(lines[i], m.indent, "")


should probably use ansi.Truncate so it doesn't trim escape codes as well...

https://pkg.go.dev/github.com/charmbracelet/x/ansi#Truncate

Created a patch that does that and renames indent to XOffset to match YOffset

tty2 · 2024-12-14T18:15:01Z

@Caden64
Hey
Thanks for your ping via email. Sorry I haven't looked at this PR for years.
Thanks for providing your patch, it helped a lot but I used TuncateLeft that was implemented after, cause it was exactly we need here. I believe @caarlos0 mentioned it for help.
Hopefully it is what we need now.
Could you review it please?

…ntal-scroll Feature/i236 viewport horizontal scroll

caarlos0 · 2024-12-19T01:51:29Z

thanks @tty2!

I'll look into glamour and what's needed there, just to make sure we're not missing anything here. :)

flavono123 · 2024-12-19T02:44:30Z

models in here should support this feature, such as table

tty2 · 2024-12-19T19:00:25Z

Hi @caarlos0
I fixed tests for viewport only yesterday.
I see you are going to look into other part of the lib.
Sorry, it's hard to recall everything after 2 years delay, but I'm sure that there was some flag before for the behavior you implemented here #240 (comment) .
And as I understand these changes break tests in table too.
I'm confused now.
In the initial issue #235 you can find that there was the way to prevent wrapping onto a new line (see screenshots).

flavono123 · 2024-12-20T01:18:31Z

this change is not breaking the other models in the lib, for instance table, i guess.

a proper keymap and update implements are required to do this feature for them and this could be in another PR

flavono123 · 2024-12-22T04:43:02Z

cannot wait this til next two years 😇 @meowgorithm @bashbunni are you mind to check this?

meowgorithm · 2024-12-22T22:45:47Z

I hear you @flavono123. We're all on holiday through the new year but we'll pick this up after then. We've done an initial review internally, made some changes, and we intend to merge this.

flavono123 · 2024-12-23T02:49:28Z

thanks got it. have a holy holiday

…oll API

meowgorithm · 2025-01-06T21:55:00Z

Alright, so I pushed a few changes to make the horizontal scroll API better match the rest of the API.

I think this is ready to go (the implementation is really good) although I'd love to figure out why it's breaking table tests first.

caarlos0 · 2025-01-06T22:22:13Z

Will take a look later

Signed-off-by: Carlos Alexandro Becker <[email protected]>

meowgorithm · 2025-01-10T12:54:56Z

Thanks for the PR, @tty2, and for the discourse, @flavono123. This was a long time coming.

We expect to release this soon.

rdalbuquerque · 2025-01-24T15:48:09Z

Hi Guys,
can we expect new features like this and #697 to be integrated with v2 alpha releases?

thank you all by all the amazing work btw!

meowgorithm · 2025-01-24T16:17:14Z

@rdalbuquerque Yep, absolutely. We regularly merge new stuff on master into v2-exp. We plan to tag another v2 prerelease soon.

tty2 mentioned this pull request Sep 16, 2022

trim prefix mattn/go-runewidth#65

Merged

muesli added the enhancement New feature or request label Oct 5, 2022

maaslalani mentioned this pull request Oct 7, 2022

Choose and filter don't work well with long lines. charmbracelet/gum#12

Open

Sojamann mentioned this pull request Sep 30, 2023

236 horizontal scroll #422

Closed

caarlos0 reviewed Dec 4, 2024

View reviewed changes

caarlos0 mentioned this pull request Dec 10, 2024

feat(ansi): TruncateLeft charmbracelet/x#301

Merged

tty2 and others added 6 commits December 14, 2024 18:29

horizontal scroll

98ba87b

rebase branch

fe8d41e

add tests

fd905df

add tests with 2 cells symbols

11c5170

trimLeft, move to charmbracelete/x/ansi lib

b718451

up ansi package

143ea43

tty2 force-pushed the feature/i236-viewport-horizontal-scroll branch from ba37376 to 143ea43 Compare December 14, 2024 18:03

tty2 requested review from meowgorithm and bashbunni as code owners December 14, 2024 18:03

tty2 requested review from Caden64 and caarlos0 December 14, 2024 18:09

tty2 added 4 commits December 18, 2024 21:25

fix tests

5dd53e5

Merge pull request #1 from charmbracelet/feature/i236-viewport-horizo…

51e92a1

…ntal-scroll Feature/i236 viewport horizontal scroll

fix viewport tests

f6b7762

add test for preventing right overscroll

9c0bc5c

meowgorithm added 2 commits January 6, 2025 16:30

chore(viewport): increase horizontal step to 6

c9d33f9

chore(viewport): make horizontal scroll API better match vertical scr…

4acc392

…oll API

caarlos0 added 6 commits January 7, 2025 11:30

fix: nolint

d1132a4

fix: use ansi.Cut

36a216e

perf: do not cut anything if not needed

fa32384

feat: expose HorizontalScrollPercent

fa28725

fix: do not scroll if width is 0

36be8b6

Signed-off-by: Carlos Alexandro Becker <[email protected]>

fix: visible lines take frame into account

4aff9da

caarlos0 mentioned this pull request Jan 7, 2025

feat(viewport): gutter column, soft wrap, search highlight #697

Open

caarlos0 merged commit 2d53a61 into charmbracelet:master Jan 10, 2025
26 checks passed

bashbunni mentioned this pull request Jan 13, 2025

feat(viewport): horizontal scroll #236

Closed

bashbunni linked an issue Jan 23, 2025 that may be closed by this pull request

viewport: horizontal scroll #145

Closed

caarlos0 mentioned this pull request Jan 24, 2025

viewport: horizontal scroll #145

Closed

bashbunni mentioned this pull request Jan 27, 2025

Pager should let you navigate sideways charmbracelet/gum#342

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(viewport): horizontal scroll #240

feat(viewport): horizontal scroll #240

tty2 commented Sep 14, 2022

meowgorithm commented Sep 14, 2022 •

edited

Loading

tty2 commented Sep 14, 2022

tty2 commented Sep 15, 2022 •

edited

Loading

tty2 commented Sep 20, 2022

tty2 commented Sep 20, 2022 •

edited

Loading

meowgorithm commented Sep 20, 2022

tty2 commented Sep 20, 2022 •

edited

Loading

tty2 commented Sep 21, 2022

tty2 commented Sep 26, 2022 •

edited

Loading

meowgorithm commented Sep 26, 2022 •

edited

Loading

bobziuchkovski commented Sep 17, 2023

kalensk commented May 24, 2024

caarlos0 left a comment

caarlos0 Dec 4, 2024

Caden64 Dec 5, 2024

tty2 commented Dec 14, 2024 •

edited

Loading

caarlos0 commented Dec 19, 2024

flavono123 commented Dec 19, 2024

tty2 commented Dec 19, 2024

flavono123 commented Dec 20, 2024

flavono123 commented Dec 22, 2024

meowgorithm commented Dec 22, 2024

flavono123 commented Dec 23, 2024

meowgorithm commented Jan 6, 2025

caarlos0 commented Jan 6, 2025

meowgorithm commented Jan 10, 2025

rdalbuquerque commented Jan 24, 2025

meowgorithm commented Jan 24, 2025

feat(viewport): horizontal scroll #240

feat(viewport): horizontal scroll #240

Conversation

tty2 commented Sep 14, 2022

meowgorithm commented Sep 14, 2022 • edited Loading

tty2 commented Sep 14, 2022

tty2 commented Sep 15, 2022 • edited Loading

tty2 commented Sep 20, 2022

tty2 commented Sep 20, 2022 • edited Loading

meowgorithm commented Sep 20, 2022

tty2 commented Sep 20, 2022 • edited Loading

tty2 commented Sep 21, 2022

tty2 commented Sep 26, 2022 • edited Loading

meowgorithm commented Sep 26, 2022 • edited Loading

bobziuchkovski commented Sep 17, 2023

kalensk commented May 24, 2024

caarlos0 left a comment

Choose a reason for hiding this comment

caarlos0 Dec 4, 2024

Choose a reason for hiding this comment

Caden64 Dec 5, 2024

Choose a reason for hiding this comment

tty2 commented Dec 14, 2024 • edited Loading

caarlos0 commented Dec 19, 2024

flavono123 commented Dec 19, 2024

tty2 commented Dec 19, 2024

flavono123 commented Dec 20, 2024

flavono123 commented Dec 22, 2024

meowgorithm commented Dec 22, 2024

flavono123 commented Dec 23, 2024

meowgorithm commented Jan 6, 2025

caarlos0 commented Jan 6, 2025

meowgorithm commented Jan 10, 2025

rdalbuquerque commented Jan 24, 2025

meowgorithm commented Jan 24, 2025

meowgorithm commented Sep 14, 2022 •

edited

Loading

tty2 commented Sep 15, 2022 •

edited

Loading

tty2 commented Sep 20, 2022 •

edited

Loading

tty2 commented Sep 20, 2022 •

edited

Loading

tty2 commented Sep 26, 2022 •

edited

Loading

meowgorithm commented Sep 26, 2022 •

edited

Loading

tty2 commented Dec 14, 2024 •

edited

Loading