https://github.com/mihaigalos/skim-navi

🏛 A friendlier skim façade.
https://github.com/mihaigalos/skim-navi

Last synced: 3 days ago
JSON representation

🏛 A friendlier skim façade.

• Host: GitHub
• URL: https://github.com/mihaigalos/skim-navi
• Owner: mihaigalos
• License: mit
• Created: 2022-08-02T18:45:07.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-05T11:15:48.000Z (6 months ago)
• Last Synced: 2024-10-10T16:26:43.827Z (about 1 month ago)
• Language: Rust
• Homepage:
• Size: 30.3 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# skim-navi

[![CD-auto](https://github.com/mihaigalos/skim-navi/actions/workflows/cd-auto.yaml/badge.svg)](https://github.com/mihaigalos/skim-navi/actions/workflows/cd-auto.yaml)

[![crates.io](https://img.shields.io/crates/d/skim-navi.svg)](https://crates.io/crates/skim-navi)

[![LoC](https://tokei.rs/b1/github/mihaigalos/skim-navi)](https://github.com/mihaigalos/skim-navi)

A friendlier skim façade.

## Why?

[`skim`](https://github.com/lotabout/skim) is fiddly to use when i.e. navigating a tree hierarchy.

`skim-navi` addresses that.

## Usage

Implement the following async function and call `skim-navi::Navi::run()` with it:

```rust

pub async fn get_links(input: String) -> Result, Error>

```

This represents the handler that gets called on each navigation update (i.e.: changing folders), and can even talk to a remote backend.

You can find a further examples in the [`examples`](https://github.com/mihaigalos/skim-navi/tree/main/examples) folder.