OrgGo
/
termdash
mirror of https://github.com/mum4k/termdash.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Correcting documentation for the new options.

This commit is contained in:
Jakub Sobon 2020-11-23 22:42:29 -05:00
parent 0b94ed0f7c
commit e8565e739d
No known key found for this signature in database
GPG Key ID: F2451A77FB05D3B7
1 changed files with 10 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
container/options.go
View File

@ -842,13 +842,13 @@ func Bottom(opts ...Option) BottomOption {
// container when pressed. // container when pressed.
// //
// Containers are organized in a binary tree, when the focus moves to the next // Containers are organized in a binary tree, when the focus moves to the next
// container, it targets the next leaf container in a DFS traversal that // container, it targets the next leaf container in a DFS traversal.
// contains a widget. Non-leaf containers and containers without widgets are // Non-leaf containers are skipped. If the currently focused container is the
// skipped. If the currently focused container is the last container, the focus // last container, the focus moves back to the first container.
// moves back to the first container.
// //
// This option is global and applies to all created containers. // This option is global and applies to all created containers.
// If not specified, keyboard the focused container can only be changed by using the mouse. // If neither of (KeyFocusNext, KeyFocusPrevious) is specified, the keyboard
// focus can only be changed by using the mouse.
func KeyFocusNext(key keyboard.Key) Option { func KeyFocusNext(key keyboard.Key) Option {
return option(func(c *Container) error { return option(func(c *Container) error {
c.opts.global.keyFocusNext = &key c.opts.global.keyFocusNext = &key
@ -860,12 +860,13 @@ func KeyFocusNext(key keyboard.Key) Option {
// previous container when pressed. // previous container when pressed.
// //
// Containers are organized in a binary tree, when the focus moves to the previous // Containers are organized in a binary tree, when the focus moves to the previous
// container, it targets the previous leaf container in a DFS traversal that // container, it targets the previous leaf container in a DFS traversal.
// contains a widget. Non-leaf containers and containers without widgets are // Non-leaf containers are skipped. If the currently focused container is the
// skipped. If the currently focused container is the first container, the focus // first container, the focus moves back to the last container.
// moves back to the last container.
// //
// This option is global and applies to all created containers. // This option is global and applies to all created containers.
// If neither of (KeyFocusNext, KeyFocusPrevious) is specified, the keyboard
// focus can only be changed by using the mouse.
func KeyFocusPrevious(key keyboard.Key) Option { func KeyFocusPrevious(key keyboard.Key) Option {
return option(func(c *Container) error { return option(func(c *Container) error {
c.opts.global.keyFocusPrevious = &key c.opts.global.keyFocusPrevious = &key