Merge pull request #34 from koki-develop/custom-input-position

koki-develop · Apr 2, 2023 · 12ccf4b · 12ccf4b
2 parents 7f3feae + 4ba1017
commit 12ccf4b
Show file tree

Hide file tree

Showing 12 changed files with 279 additions and 67 deletions.
diff --git a/cmd/gofzf/main.go b/cmd/gofzf/main.go
@@ -34,7 +34,8 @@ var (
 	flagSelectedPrefix   string
 	flagUnselectedPrefix string
 
-	flagCountView bool
+	flagInputPosition string
+	flagCountView     bool
 
 	flagPromptFg            string
 	flagPromptBg            string
@@ -129,6 +130,8 @@ var rootCmd = &cobra.Command{
 			fzf.WithSelectedPrefix(flagSelectedPrefix),
 			fzf.WithUnselectedPrefix(flagUnselectedPrefix),
 
+			fzf.WithInputPosition(fzf.InputPosition(flagInputPosition)),
+
 			fzf.WithCountViewEnabled(flagCountView),
 
 			fzf.WithStyles(
@@ -340,6 +343,8 @@ func init() {
 	rootCmd.Flags().StringVar(&flagSelectedPrefix, "selected-prefix", "● ", "")
 	rootCmd.Flags().StringVar(&flagUnselectedPrefix, "unselected-prefix", "◯ ", "")
 
+	rootCmd.Flags().StringVar(&flagInputPosition, "input-position", string(fzf.InputPositionTop), "position of input (top|bottom)")
+
 	rootCmd.Flags().BoolVar(&flagCountView, "count-view", true, "")
 
 	rootCmd.Flags().StringVar(&flagPromptFg, "prompt-fg", "", "")

diff --git a/docs/cli/README.ja.md b/docs/cli/README.ja.md
@@ -54,6 +54,7 @@ $ go install github.com/koki-develop/go-fzf/cmd/gofzf@latest
 `gofzf` CLI はフラグを使用して様々な見た目のカスタマイズができます。
 
 - [プロンプト](#プロンプト)
+- [インプットの位置](#インプットの位置)
 - [インプットのプレースホルダ](#インプットのプレースホルダ)
 - [インプットのテキスト](#インプットのテキスト)
 - [カーソル](#カーソル)
@@ -75,6 +76,12 @@ $ go install github.com/koki-develop/go-fzf/cmd/gofzf@latest
 | `--prompt-underline` | `false`    | プロンプトに下線を引く。         |
 | `--prompt-faint`     | `false`    | プロンプトを薄く表示する。       |
 
+#### インプットの位置
+
+| フラグ             | デフォルト | 説明                                                    |
+| ------------------ | ---------- | ------------------------------------------------------- |
+| `--input-position` | `"top"`    | インプットの位置。 `top` もしくは `bottom` が有効です。 |
+
 #### インプットのプレースホルダ
 
 | フラグ                          | デフォルト    | 説明                                             |

diff --git a/docs/cli/README.md b/docs/cli/README.md
@@ -54,6 +54,7 @@ Setting the `--no-limit` flag allows unlimited item selection.
 The `gofzf` CLI allows for various visual customizations using flags.
 
 - [Prompt](#prompt)
+- [Position of input](#position-of-input)
 - [Placeholder for input](#placeholder-for-input)
 - [Input text](#input-text)
 - [Cursor](#cursor)
@@ -75,6 +76,12 @@ The `gofzf` CLI allows for various visual customizations using flags.
 | `--prompt-underline` | `false` | Underline prompt.           |
 | `--prompt-faint`     | `false` | Faint prompt.               |
 
+#### Position of input
+
+| Flag               | Default | Description                                           |
+| ------------------ | ------- | ----------------------------------------------------- |
+| `--input-position` | `"top"` | Position of input. Either `top` or `bottom` is valid. |
+
 #### Placeholder for input
 
 | Flag                            | Default       | Description                                |

diff --git a/docs/library/README.ja.md b/docs/library/README.ja.md
@@ -154,6 +154,7 @@ if err != nil {
 - [プロンプト](#プロンプト)
 - [カーソル](#カーソル)
 - [選択中 / 未選択アイテムの接頭辞](#選択中--未選択アイテムの接頭辞)
+- [インプットの位置](#インプットの位置)
 - [インプットのプレースホルダ](#インプットのプレースホルダ)
 - [カウントビュー](#カウントビュー)
 - [スタイル](#スタイル)
@@ -201,6 +202,21 @@ if err != nil {
 
 [Example](/examples/prefix/)
 
+#### インプットの位置
+
+`fzf.WithInputPosition()` を使用するとインプットの位置を設定できます。
+
+```go
+f, err := fzf.New(
+  fzf.WithInputPosition(fzf.InputPositionBottom),
+)
+if err != nil {
+  // ...
+}
+```
+
+[Example](/examples/input-position/)
+
 #### インプットのプレースホルダ
 
 `fzf.WithInputPlaceholder()` を使用するとインプットのプレースホルダを設定できます。

diff --git a/docs/library/README.md b/docs/library/README.md
@@ -155,6 +155,7 @@ if err != nil {
 - [Prompt](#prompt)
 - [Cursor](#cursor)
 - [Prefix of selected/unselected items](#prefix-of-selectedunselected-items)
+- [Position of input](#position-of-input)
 - [Placeholder for input](#placeholder-for-input)
 - [Count View](#count-view)
 - [Styles](#styles)
@@ -203,6 +204,21 @@ if err != nil {
 
 [Example](/examples/prefix/)
 
+#### Position of input
+
+`fzf.WithInputPosition()` can be used to set the position of input.
+
+```go
+f, err := fzf.New(
+  fzf.WithInputPosition(fzf.InputPositionBottom),
+)
+if err != nil {
+  // ...
+}
+```
+
+[Example](/examples/input-position/)
+
 #### Placeholder for input
 
 `fzf.WithCursor()` can be used to set the placeholder for input.

diff --git a/examples/input-position/README.md b/examples/input-position/README.md
@@ -0,0 +1 @@
+![](./demo.gif)
diff --git a/examples/input-position/demo.gif b/examples/input-position/demo.gif
diff --git a/examples/input-position/main.go b/examples/input-position/main.go
@@ -0,0 +1,28 @@
+package main
+
+import (
+	"fmt"
+	"log"
+
+	"github.com/koki-develop/go-fzf"
+)
+
+func main() {
+	items := []string{"hello", "world", "foo", "bar"}
+
+	f, err := fzf.New(
+		fzf.WithInputPosition(fzf.InputPositionBottom),
+	)
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	idxs, err := f.Find(items, func(i int) string { return items[i] })
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	for _, i := range idxs {
+		fmt.Println(items[i])
+	}
+}
diff --git a/fzf.go b/fzf.go
@@ -29,6 +29,10 @@ func New(opts ...Option) (*FZF, error) {
 		return nil, errors.New("limit must be at least 1")
 	}
 
+	if err := o.inputPosition.Valid(); err != nil {
+		return nil, err
+	}
+
 	m := newModel(&o)
 
 	return &FZF{