feat(textarea) Add multiline placeholder

[mikelorant]

Add the capability to show a multiline placeholder. Some refactoring was required to improve readability and improve logic.

End of line buffer character was only shown when line numbers were displayed which requires some verification whether this is the intended outcome. This change resolves this issue.

[mikelorant]

@meowgorithm @maaslalani Can I get approval to run the workflow? Thanks.

[mikelorant]

Can I get someone from @charmbracelet to review this. Thanks.

[maaslalani]

Hey @mikelorant. Thank you so much for this PR.

I'm seeing a bug with how this PR is handling line numbers:

This is what the textarea should look like:

Here is what it looks like using this PR (rebased on main):

[maaslalani]

The testing code I'm using can be found here: https://github.com/charmbracelet/bubbletea/tree/master/examples/textarea

[mikelorant]

Just to clarify, line numbers only display if there is user input (or cursor) on that line?

[mikelorant]

Just did some basic investigation and it seems the aim is that it should look like Vim with line numbers enabled. Which means only lines with content get a number.

[maaslalani]

Just did some basic investigation and it seems the aim is that it should look like Vim with line numbers enabled. Which means only lines with content get a number.

Yep, that's correct! Similar to vim!

[mikelorant]

Have fixed the issue you have reported and here is the result using the code you linked:

Using a multiline placeholder shows like this:

I wish to make it clear that line numbers are only for lines that have a cursor or entered text. This is placeholder text, so only the first line will ever have a line number in this case. As soon as you start typing and adding new lines, none of this code is used.

I've had to extensively increase the unit tests because it was far too complex checking all the variations. As part of this process I needed a small helper function to strip ANSI and trailing white spaces to make comparison easier. I would have preferred to use golden files however I think this is a reasonable compromise. Unfortunately no other tests in textarea use testing tables so that will stand out as being different but as you can tell a requirement.

[mikelorant]

One more reference image with the cursor visible.

Check the test tables and let me know if that is the output you'd expect. I had to make some executive decisions and tried to base everything I could on how it was displayed in Vim.

[mikelorant]

@maaslalani Any chance you could do a review, if this is working correctly I'd like to get it merged otherwise if there are problems, lets me get started on fixing them.

[maaslalani]

Hey @mikelorant, thanks again for your work on this one!

One issue I'm seeing is the CursorLine (if it has a background color, bleeds over to the line number column)

Here's what it should look like:

[mikelorant]

The default prompt which is being used here is defined at:
https://github.com/charmbracelet/bubbles/blob/master/textarea/textarea.go#L258C3-L258C59

Code as follows:

Prompt:               lipgloss.ThickBorder().Left + " ",

This has me thinking that both versions are wrong. The background colour should start at position 3 for each line.

|X123 Once upon a time...
|X    ~
|X    ~

The X space is part of that prompt and whatever styling that is applied to it is independent of everything else.

Thoughts?

Additional notes:

Consider the following change:

Prompt:               lipgloss.ThickBorder().Right + " ",

This would put the changed background colour outside the left border which would be very wrong.

[mikelorant]

@maaslalani I'll quickly do the update to this pull request providing the original functionality, but I still believe both implementations have it wrong.

Using Vim as the reference, highlighted cursor line goes as far as the beginning of the line number or end of buffer character. It is hard to know what we should do if we put a border around it since we cant do that in Vim.

[mikelorant]

Here are the two possibilities in one image:

The top version is how it is currently implemented and the bottom version is how I think it should be. However as a lowly minion here to serve the wonderful Charm team 😄 I have pushed up the version that conforms with how it is also displayed when text is entered.

Thanks for helping make sure we catch all the little subtle things, very much appreciated @maaslalani.

[mikelorant]

Heres the example showing the line style for the cursor line leaking out of the prompt "border".

Prompt to use to see this case:

ti.Prompt = lipgloss.ThickBorder().Right + " "

[maaslalani]

@mikelorant Thanks for the care you're putting into this PR! Yes, I see what you mean by the border. However, when the cursor line is defined with a background color I think it looks more correct (but maybe we will change this later since you are actually right about the correctness technically)

Also when a text area has a multiline placeholder I believe the cursor line background should be applied to the entire placeholder. In your screenshots it only applies to the first line.

[mikelorant]

Here is a comparison of the two:

I think it is very confusing to highlight more than the cursor line where there is a multiline placeholder. However, on the flip side it may help indicate that any typing will clear all that text away by keeping it "grouped".

How should I proceed?

[maaslalani]

In my opinion the second option is correct here as the entire line is highlighted with the cursor line and if the user types that exact placeholder then the same highlighting will occur.

[mikelorant]

@maaslalani Commit updated to highlight all lines of the placeholder.

[mikelorant]

@meowgorithm Not at all. This one is ready to go.

This has nothing to do with emojis or grapheme clusters.

[mikelorant]

@maaslalani Rebase completed and all unit tests are passing.

🤞 that there are no more issues.

[mikelorant]

@meowgorithm @maaslalani Can we please get this reviewed. Want to get this finalised so I can move off using my own fork.

[maaslalani]

@mikelorant Will take a look today

[maaslalani]

@mikelorant I'm still seeing the bug of long placeholders, let me know if I'm doing something incorrectly.

But, if I set the placeholder to:

	ti.Placeholder = "Once upon a time in a land far far away..."

Then the text is broken.

However if I add a new line it works as expected:

	ti.Placeholder = "Once upon a time in a land far far\naway..."

I wouldn't mind truncating the placeholder like we currently do if the user has not explicitly opted into the newline, if that easier.

[maaslalani]

I think we need to add a test where the CursorLine is styled like we see in the bubbletea example.

[mikelorant]

Lots more tests coming up.

[mikelorant]

I wouldn't mind truncating the placeholder like we currently do if the user has not explicitly opted into the newline, if that easier.

No truncating, will work out what is going on.

Just need lots more tests to find all these weird edge cases that keep popping up. Not sure why this feature has been so difficult to implement 😢

Thanks for finding these problems.

[mikelorant]

Found the bug and unfortunately it seems like we may have 2 bugs 😢

Firstly, my bug is quite simple, I was using m.MaxWidth to determine the width instead of m.width. Easy fix.

However, this has uncovered something new with all the tests we have added.

Looking into the function SetWidth, there is a lot of work done to make sure the width removes the prompt and line numbers. However the last check causing an edge case.

if m.MaxWidth > 0 {
    m.width = clamp(inputWidth, minWidth, m.MaxWidth)
} else {
    m.width = max(inputWidth, minWidth)
}

If the MaxWidth is smaller than inputWidth we pick MaxWidth. Cool? Cool. However, we never subtracted the prompt and line numbers from this. We need to pick whether we use inputWidth, minWidth or m.MaxWidth first and then subtract the prompt and line numbers.

Hoping my logic here is correct, will keep hacking away and see where this leads.

[mikelorant]

Going to add another problem, setting MaxWidth on the model does not call SetWidth() so updating of the model width is not being done.

I believe the order we need to follow is:

ta := textarea.New()
ta.MaxWidth = 25
ta.SetWidth(20)

This might be a case where MaxWidth should have been a function so it then it could call SetWidth() before it returns.

Definitely need some guidance on how this should work.

[mikelorant]

Sorted out all the problems, however this is now dependent on #496.

[maaslalani]

Thanks for debugging the SetWidth and improving it in #496, I can take a look at this one when it is ready to go!

[mikelorant]

Have fixed the conflicts and unit tests now pass.

Will run some manual tests to see if we have all the issues finally resolved 😄

[mikelorant]

@maaslalani Actually, everything looks OK from both unit tests and manual tests. Hopefully you see the same results.

[mikelorant]

@maaslalani Can we get another review of this one, I am hoping this one passes now that we have the SetWidth method fixed.

[mikelorant]

@maaslalani Can you please take another look at this? I have rebased it from master and made the fixes required to resolve the conflicts.

[maaslalani]

Thanks @mikelorant, I will take a look! Thanks for the reminder!

[maaslalani]

Thanks @mikelorant, tested things out in the example and worked well. Thank you so much for the extensive test suite also, it really makes these PRs easier to merge.

Really appreciate the patience and great work ❤️

[mikelorant]

Wahoo. Finally merged! Thank you so much for your efforts in making sure we keep the quality high.