Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Filepicker Bubble #343

Merged
merged 6 commits into from
Mar 6, 2023
Merged

Filepicker Bubble #343

merged 6 commits into from
Mar 6, 2023

Conversation

maaslalani
Copy link
Contributor

Filepicker bubbles allows for selecting files or directories with customizable
key bindings and styling.

It emits a FileSelectedMsg to allow the parent model to react to a valid selection action.

@maaslalani
Copy link
Contributor Author

Screen.Recording.2023-03-03.at.12.47.21.PM.mov

@maaslalani maaslalani mentioned this pull request Mar 3, 2023
Merged
@maaslalani
Copy link
Contributor Author

Related PRs:

maaslalani
maaslalani commented Mar 3, 2023
View reviewed changes
filepicker/filepicker.go Outdated Show resolved Hide resolved
@maaslalani maaslalani mentioned this pull request Mar 3, 2023
Closed
@maaslalani maaslalani merged commit 3372cf1 into master Mar 6, 2023
@maaslalani maaslalani deleted the filepicker branch March 6, 2023 16:00
@maaslalani
Copy link
Contributor Author

I will update the README to include the file picker when we release the next version of Bubbles.

@picatz
Copy link

picatz commented Mar 7, 2023

FWIW, this is awesome! Cannot wait to use this. 📁

@KaiAragaki KaiAragaki mentioned this pull request May 2, 2023
Closed
@ManveerBhullar
Copy link

Great timing on adding this, just what I needed! 👍
fyi there isn't an example of this in the readme yet

@maaslalani
Copy link
Contributor Author

No problem @ManveerBhullar, let us know if you have any feedback / issues with it!

@ManveerBhullar
Copy link

@maaslalani I tried to use it today, but the released version of bubbles is from Jan and doesn't have this in it :(

@maaslalani
Copy link
Contributor Author

maaslalani commented May 12, 2023 •
edited
Loading

Hey @ManveerBhullar, we will do a release soon including the file picker but you can also run:

go get github.com/charmbracelet/bubbles@master

To use the version on master (which includes the file picker bubble), if you would like. Otherwise, we will do a release soon!

renovate bot referenced this pull request in sheldonhull/az-pr Jun 5, 2023
@renovate
chore(deps): update ⬆️ golang module github.com/charmbracelet/bubbles…
99ef476 
… to v0.16.1 (#18)

[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
|
[github.com/charmbracelet/bubbles](https://github.com/charmbracelet/bubbles)
| require | minor | `v0.15.0` -> `v0.16.1` |

copilot:all

---

### Release Notes

<details>
<summary>charmbracelet/bubbles</summary>

###
[`v0.16.1`](https://github.com/charmbracelet/bubbles/releases/tag/v0.16.1)

[Compare
Source](https://github.com/charmbracelet/bubbles/compare/v0.16.0...v0.16.1)

### File Picker Bubble  📁 🫧

This release introduces a brand new `filepicker` bubble, new features,
and a tonne of bugfixes.
Let us know what you think, ask questions, or just say hello in our
[Discord](https://charm.sh/chat).

<img src="https://vhs.charm.sh/vhs-yET2HNiJNEbyqaVfYuLnY.gif"
width="600" alt="File picker example">

For a quick start on how to use this bubble, take a look at the [Example
code](https://github.com/charmbracelet/bubbletea/tree/master/examples/file-picker/main.go).

##### Getting Started

Create a new file picker and add it to your Bubble Tea model.

```go
picker := filepicker.New()
picker.CurrentDirectory, err = os.UserHomeDir()
if err != nil {
    // ...
}

m := model{
    picker: picker,
    // ...
}
```

Initialize the file picker in your `Model`'s `Init` function.

```go
func (m model) Init() tea.Cmd {
    return tea.Batch(
        m.picker.Init(),
        // ...
    )
}
```

Update the filepicker as any other bubble in the `Update` function.
After the `picker.Update`, use the `DidSelectFile(msg tea.Msg)` function
to perform an action when the user selects a valid file.
You may allow only certain file types to be selected with the
`AllowedTypes` property and allow directories to be selected with the
`DirAllowed` property. To see the currently selected file/directory use
the `Path` property.

```go
var cmd tea.Cmd
m.picker, cmd = m.picker.Update(msg)

// Did the user select a file?
if didSelect, path := m.picker.DidSelectFile(msg); didSelect {
	// Get the path of the selected file.
	return m, tea.Println("You selected: " + selectedPath)
}

return m, cmd
```

For the full example on how to use this bubble, take a look at the
[Example
code](https://github.com/charmbracelet/bubbletea/tree/master/examples/file-picker/main.go).

#### New

- Filepicker: new bubble by
[@&#8203;maaslalani](https://github.com/maaslalani) in
[https://github.com/charmbracelet/bubbles/pull/343](https://github.com/charmbracelet/bubbles/pull/343)
- Textarea: max width/height configurable by
[@&#8203;knz](https://github.com/knz) in
[https://github.com/charmbracelet/bubbles/pull/370](https://github.com/charmbracelet/bubbles/pull/370)
- Spinner: periods of ellipsis by
[@&#8203;meowgorithm](https://github.com/meowgorithm) in
[https://github.com/charmbracelet/bubbles/pull/375](https://github.com/charmbracelet/bubbles/pull/375)
- List: infinite scrolling by
[@&#8203;jon4hz](https://github.com/jon4hz) in
[https://github.com/charmbracelet/bubbles/pull/316](https://github.com/charmbracelet/bubbles/pull/316)

#### Fixed

- app would crash if `deleteWordRight` was called at the end of line by
[@&#8203;infastin](https://github.com/infastin) in
[https://github.com/charmbracelet/bubbles/pull/313](https://github.com/charmbracelet/bubbles/pull/313)
- support pastes that end with a newline character by
[@&#8203;knz](https://github.com/knz) in
[https://github.com/charmbracelet/bubbles/pull/314](https://github.com/charmbracelet/bubbles/pull/314)
- data corruption after multi-line input by
[@&#8203;knz](https://github.com/knz) in
[https://github.com/charmbracelet/bubbles/pull/318](https://github.com/charmbracelet/bubbles/pull/318)
- Remove unused `BackgroundStyle` in TextInput by
[@&#8203;savannahostrowski](https://github.com/savannahostrowski) in
[https://github.com/charmbracelet/bubbles/pull/341](https://github.com/charmbracelet/bubbles/pull/341)
- add bounds checking to the `SelectedRow` by
[@&#8203;MikaelFangel](https://github.com/MikaelFangel) in
[https://github.com/charmbracelet/bubbles/pull/351](https://github.com/charmbracelet/bubbles/pull/351)
- fix(progress): last gradient color off by one by
[@&#8203;residualmind](https://github.com/residualmind) in
[https://github.com/charmbracelet/bubbles/pull/338](https://github.com/charmbracelet/bubbles/pull/338)
- deprecate `CursorStyle` in favour of `Cursor.Style` by
[@&#8203;maaslalani](https://github.com/maaslalani) in
[https://github.com/charmbracelet/bubbles/pull/365](https://github.com/charmbracelet/bubbles/pull/365)
- Reset blink only when `CursorBlink` by
[@&#8203;remiposo](https://github.com/remiposo) in
[https://github.com/charmbracelet/bubbles/pull/378](https://github.com/charmbracelet/bubbles/pull/378)

#### New Contributors

- [@&#8203;infastin](https://github.com/infastin) made their first
contribution in
[https://github.com/charmbracelet/bubbles/pull/313](https://github.com/charmbracelet/bubbles/pull/313)
- [@&#8203;gzipChrist](https://github.com/gzipChrist) made their first
contribution in
[https://github.com/charmbracelet/bubbles/pull/332](https://github.com/charmbracelet/bubbles/pull/332)
- [@&#8203;savannahostrowski](https://github.com/savannahostrowski)
made their first contribution in
[https://github.com/charmbracelet/bubbles/pull/341](https://github.com/charmbracelet/bubbles/pull/341)
- [@&#8203;MikaelFangel](https://github.com/MikaelFangel) made their
first contribution in
[https://github.com/charmbracelet/bubbles/pull/351](https://github.com/charmbracelet/bubbles/pull/351)
- [@&#8203;stefanbildl](https://github.com/stefanbildl) made their
first contribution in
[https://github.com/charmbracelet/bubbles/pull/339](https://github.com/charmbracelet/bubbles/pull/339)
- [@&#8203;residualmind](https://github.com/residualmind) made their
first contribution in
[https://github.com/charmbracelet/bubbles/pull/338](https://github.com/charmbracelet/bubbles/pull/338)
- [@&#8203;bashbunni](https://github.com/bashbunni) made their first
contribution in
[https://github.com/charmbracelet/bubbles/pull/359](https://github.com/charmbracelet/bubbles/pull/359)
- [@&#8203;squrki](https://github.com/squrki) made their first
contribution in
[https://github.com/charmbracelet/bubbles/pull/373](https://github.com/charmbracelet/bubbles/pull/373)
- [@&#8203;remiposo](https://github.com/remiposo) made their first
contribution in
[https://github.com/charmbracelet/bubbles/pull/378](https://github.com/charmbracelet/bubbles/pull/378)

**Full Changelog**:
charmbracelet/bubbles@v0.15.0...v0.16.0

***

<a href="https://charm.sh/"><img alt="The Charm logo"
src="https://stuff.charm.sh/charm-badge.jpg?1" width="400"></a>

Thoughts? Questions? We love hearing from you. Feel free to reach out on
[Twitter](https://twitter.com/charmcli), [The
Fediverse](https://mastodon.technology/@&#8203;charm), or on
[Discord](https://charm.sh/chat).

###
[`v0.16.0`](https://github.com/charmbracelet/bubbles/compare/v0.15.0...v0.16.0)

[Compare
Source](https://github.com/charmbracelet/bubbles/compare/v0.15.0...v0.16.0)

</details>

---

### Configuration

📅 **Schedule**: Branch creation - "before 4am on Monday" (UTC),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR is behind base branch, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://app.renovatebot.com/dashboard#github/sheldonhull/az-pr).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNS4xMTAuMCIsInVwZGF0ZWRJblZlciI6IjM1LjExMC4wIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
ReallyLiri pushed a commit to ReallyLiri/bubbles that referenced this pull request Jun 13, 2024
@maaslalani
Filepicker Bubble (charmbracelet#343)
d639073 
* feat: filepicker bubble

* fix: bump bubbles to 1.16

* fix: allow customization of empty state

* fix: change `Enter` to `Open`

* fix: lint gomnd

* fix: don't send msg, instead check if this update caused a selection
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@meowgorithm meowgorithm meowgorithm left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@maaslalani @picatz @ManveerBhullar @meowgorithm