feat: show help text #138
feat: show help text #138
Conversation
|
This pull request has been linked to Shortcut Story #237655: figure out help text in setup wizard. |
dbolson
force-pushed
the
sc-237655/help-text
branch
from
9e9bbb6
to
5f4abe5
Compare
dbolson
force-pushed
the
sc-237655/help-text
branch
from
5f4abe5
to
501875d
Compare
| @@ -22,6 +24,8 @@ const ( | |||
| ) | |||
|
|
|||
| type chooseSDKModel struct { | |||
| help help.Model | |||
| helpKeys keyMap | |||
There was a problem hiding this comment.
The pattern here is to have each model define the help keys it shows. These are separate from the keys we handle when they're pressed since we don't necessarily want to show, eg. tab in the help text of the toggle flag model.
internal/quickstart/create_flag.go
Outdated
| Back: key.NewBinding( | ||
| key.WithKeys("esc"), | ||
| key.WithHelp("esc", "back"), | ||
| ), |
There was a problem hiding this comment.
we can't go back on the input step here though - with the new success page we will be able to but is there a way to hide it when we should the textinput View?
There was a problem hiding this comment.
I removed "back" from the help text for create flag.
| @@ -75,5 +92,5 @@ func (m toggleFlagModel) View() string { | |||
| Padding(0, 1). | |||
| MarginRight(margin) | |||
|
|
|||
| return title + "\n\n" + toggleStyle.Render(toggle) + m.flagKey + furtherInstructions | |||
| return title + "\n\n" + toggleStyle.Render(toggle) + m.flagKey + furtherInstructions + "\n\n" + helpView | |||
There was a problem hiding this comment.
the help text jumps after the the flag is toggled for the first time. I don't think there's an easy way to pad this to make sure that doesn't happen though 😞
There was a problem hiding this comment.
I was able to add some padding to keep the help text on the same line, but I'm not sure if the additional space is better than the jump. Maybe we leave the jump to see if anybody comments on it?
Show help text for every step. We want to support going back for each step before merging this.
Also, we should try to fix the padding in the list of SDKs separate from this change.