Add new line support for multi-line input box #509

WizardOhio24 · 2021-02-08T21:07:39Z

Adds multi-line support for multi-line input boxes, in particular the commit message box:

This is done with ALT+Enter, because SHIFT+Enter does not work in terminals and so does not work in crossterm.

The support is simple because it can sometimes be useful to add an extra line quickly and would be useful (and easier) to do in GitUI, but GitUI is not a text editor and so for large multi-line commit messages, a proper text editor should be used.

extrawurst · 2021-02-09T08:28:29Z

Can you make this showup in the commands section aswell then?

WizardOhio24 · 2021-02-18T19:48:01Z

Done, I'm unsure the alt symbol is that clear, but should be fixable with #516

extrawurst · 2021-02-23T17:33:13Z

I just checked and it unfortunately does not work with this key binding on a Mac. it just commits, no line break. I'd like to find a binding that works on all platforms out of the box

extrawurst · 2021-02-23T17:38:14Z

modifier keys+enter will not work reliably anyway (I think its a known limitation in crossterm)

terhechte · 2021-03-20T15:26:24Z

What about Enter inserts a newline and ^c (ctrl c or alt c) commits (just like ^a) amends?

extrawurst · 2021-03-20T16:46:58Z

What about Enter inserts a newline and ^c (ctrl c or alt c) commits (just like ^a) amends?

Thats a good idea!

WizardOhio24 · 2021-04-16T16:54:05Z

^c is to exit GitUI, so I'd be worried the user could try to exit and instead commit whatever was in the textbox so right now I've changed it to alt+c, but that seems awkward. With nano it would be ^x, would that be better? (The user can always change it to what they want in the config) Happy to go with whatever people want.

extrawurst · 2021-04-17T08:43:47Z

Option+c does not work either on a Mac..

at this point only something Ctrl + ... seems to be a workable option. lets start with Ctrl + m and gather some feedback (x with Ctrl breaks my wrist ^^)

edit: damn ctrl + m is a carriage return and cannot be differentiated in crossterm, so I settled on ctrl + o for now

extrawurst · 2021-04-17T09:14:36Z

@WizardOhio24 see #645

after playing around with this PR I realize we cannot merge this without also adding scrolling to the TextInputComponent otherwise after adding a couple of newlines the user cannot see the cursor anymore

fix command stack add to changelog

WizardOhio24 · 2021-04-29T20:48:56Z

Yeah, I mean, this was more for writing a commit message in a single line (i.e 50 chars) then adding a new line and putting some other detail (such as issues it was linked to). If the user wanted to put in a lot of text it would be better to use nano or vim (or micro), this is more intended for small commits where 2-3 lines are needed (I think, though could be expanded to have a scrollbar).

extrawurst · 2021-04-30T12:37:53Z

@WizardOhio24 thanks for updating this branch. still we can do better and add the scrollbar code we use all over the place already here aswell. this makes the cursor stay in view even when adding newlines.

WizardOhio24 · 2021-05-25T23:17:06Z

This now grows the commit box as new lines are added up to a limit, at which it stops growing and starts using a scrollbar, which seems better when typing out multiline commits.

extrawurst · 2021-05-26T07:24:00Z

typed around a bit:

07:17:06 [ERROR] panic: PanicInfo { payload: Any, message: Some(attempt to subtract with overflow), location: Location { file: "src/c
omponents/textinput.rs", line: 148, col: 13 } }
trace:
[...]
  11: gitui::components::textinput::TextInputComponent::decr_cursor_multiline
             at src/components/textinput.rs:148:13
  12: gitui::components::textinput::TextInputComponent::decr_cursor
             at src/components/textinput.rs:163:13
  13: gitui::components::textinput::TextInputComponent::backspace
             at src/components/textinput.rs:286:13

also up/down behaves weird when having empty lines in between:

the scrollbar is also not keeping the cursor in view.
instead of adding new features like auto growing lets focus on getting one thing working first please.

extrawurst · 2021-05-26T07:24:58Z

src/components/textinput.rs

+            && self.scroll_max >= 3
+        {
+            self.scroll_top = self.scroll_top.saturating_sub(1);
+            //self.cur_line = self.cur_line.saturating_sub(1);


remove commented code please

extrawurst · 2021-05-26T07:25:40Z

src/components/textinput.rs

+        let mut nearest_newline: usize = 0;
+        let mut prev_line_newline_loc = 0;
+        for (i, c) in self.msg.chars().enumerate() {
+            if c == '\n' {


how does this behave on windows where a newline is two chars wide?

A newline can be 2 chars? It's just '\n', right?

No, google ‚windows line endings‘

extrawurst · 2021-05-26T07:25:57Z

src/components/textinput.rs

+                    break;
+                }
+            }
+            // if !self.msg.is_char_boundary(i) {


commented code

I was trying to get the scrolling working with characters which occupy more than 1 byte, such as ö or é. This code should have worked, but it doesn't, nothing seems to.

src/components/textinput.rs

extrawurst · 2021-05-26T07:26:44Z

src/components/textinput.rs

-                        Size::new(10, 3),
+                        Size::new(
+                            10,
+                            min(


there is clamp for this

extrawurst · 2021-05-26T07:27:45Z

src/strings.rs

+                "New Line [{}]",
+                key_config.get_hint(key_config.enter),
+            ),
+            "make a new line in the commit message",


insert newline

src/components/textinput.rs

extrawurst · 2022-09-04T17:31:32Z

closing in favour of #1309

WizardOhio24 added 3 commits February 8, 2021 20:50

Add input multi-line support

2ccdf8f

Remove incorrect ;

0a0046e

Only allow inserting new line if input type is multiline

fb8bd52

WizardOhio24 marked this pull request as ready for review February 8, 2021 21:13

WizardOhio24 added 2 commits February 18, 2021 19:29

Add command for new line when commit box is open

3d4ae7e

Change to use defined ALT symbol

1a219a1

extrawurst marked this pull request as draft February 23, 2021 17:38

extrawurst force-pushed the master branch 2 times, most recently from 81a8849 to f84f6f4 Compare March 3, 2021 21:27

extrawurst mentioned this pull request Apr 12, 2021

Allow adding newlines in commit message with alt+enter #636

Closed

WizardOhio24 added 2 commits April 16, 2021 17:10

Merge branch 'master' into multi-line-commit

e464a67

Change commit key to alt c and newline to enter

de9eeaa

Stephan Dilly and others added 2 commits April 29, 2021 21:36

commit via ctrl+o

470f895

fix command stack add to changelog

Merge branch 'master' into multi-line-commit

6c8b6aa

WizardOhio24 added 2 commits April 29, 2021 21:55

Fix build use EventState

b012557

Fix build

424c4ce

extrawurst mentioned this pull request Apr 30, 2021

Warn when commit message is suspiciously long #478

Closed

extrawurst mentioned this pull request May 16, 2021

Add new line support for multi-line input box #711

Closed

Merge branch 'master' into multi-line-commit

6864122

WizardOhio24 added 10 commits May 25, 2021 22:25

Textbox resize to number of lines

135c8c5

Show scrollbar only if text area larger than frame

421d4d6

Scroll up when backspace over newline char

4b66809

Revert keys formatting

9925ea9

Remove else if input event consumed

a4dbd6e

Merge branch 'master' into multi-line-commit

aa7da1e

Make command for newline only show on multiline textboxes

be36c54

Add some comments and seperation between single and multiline

8d44559

Fix build

51d38e2

Fix clippy error

efb948d

WizardOhio24 added 2 commits May 26, 2021 00:37

Change ends in nl to add a span

aafd928

Fix moving down a line

424e865

extrawurst reviewed May 26, 2021

View reviewed changes

src/components/textinput.rs Outdated Show resolved Hide resolved

extrawurst reviewed May 26, 2021

View reviewed changes

src/components/textinput.rs

Size::new(10, 3),

Size::new(

10,

min(

Copy link

Collaborator

extrawurst May 26, 2021

Choose a reason for hiding this comment

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

there is clamp for this

extrawurst reviewed May 26, 2021

View reviewed changes

src/components/textinput.rs Show resolved Hide resolved

Some fixes

a51fb26

extrawurst force-pushed the master branch from 3bca9d4 to 8905fd2 Compare September 1, 2021 21:24

extrawurst mentioned this pull request Sep 9, 2021

Honor commit.verbose configuration variable #900

Closed

extrawurst mentioned this pull request Mar 21, 2022

Create multi-line commit messages #1171

Closed

extrawurst mentioned this pull request Aug 17, 2022

new line support for multi-line input box #1284

Closed

guzzit mentioned this pull request Sep 1, 2022

Add new line support for multi-line input box (follow up PR) #1309

Closed

4 tasks

extrawurst closed this Sep 4, 2022

extrawurst mentioned this pull request Feb 14, 2024

Replace textarea with tui-textarea #2045

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add new line support for multi-line input box #509

Add new line support for multi-line input box #509

WizardOhio24 commented Feb 8, 2021

extrawurst commented Feb 9, 2021

WizardOhio24 commented Feb 18, 2021 •

edited

Loading

extrawurst commented Feb 23, 2021

extrawurst commented Feb 23, 2021

terhechte commented Mar 20, 2021

extrawurst commented Mar 20, 2021

WizardOhio24 commented Apr 16, 2021

extrawurst commented Apr 17, 2021 •

edited

Loading

extrawurst commented Apr 17, 2021

WizardOhio24 commented Apr 29, 2021 •

edited

Loading

extrawurst commented Apr 30, 2021 •

edited

Loading

WizardOhio24 commented May 25, 2021

extrawurst commented May 26, 2021

extrawurst May 26, 2021

extrawurst May 26, 2021

WizardOhio24 May 27, 2021

extrawurst May 27, 2021

extrawurst May 26, 2021

WizardOhio24 May 27, 2021

extrawurst May 26, 2021

extrawurst May 26, 2021

extrawurst commented Sep 4, 2022

Add new line support for multi-line input box #509

Add new line support for multi-line input box #509

Conversation

WizardOhio24 commented Feb 8, 2021

extrawurst commented Feb 9, 2021

WizardOhio24 commented Feb 18, 2021 • edited Loading

extrawurst commented Feb 23, 2021

extrawurst commented Feb 23, 2021

terhechte commented Mar 20, 2021

extrawurst commented Mar 20, 2021

WizardOhio24 commented Apr 16, 2021

extrawurst commented Apr 17, 2021 • edited Loading

extrawurst commented Apr 17, 2021

WizardOhio24 commented Apr 29, 2021 • edited Loading

extrawurst commented Apr 30, 2021 • edited Loading

WizardOhio24 commented May 25, 2021

extrawurst commented May 26, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

extrawurst commented Sep 4, 2022

WizardOhio24 commented Feb 18, 2021 •

edited

Loading

extrawurst commented Apr 17, 2021 •

edited

Loading

WizardOhio24 commented Apr 29, 2021 •

edited

Loading

extrawurst commented Apr 30, 2021 •

edited

Loading