mirror of https://github.com/sayanarijit/xplr
Compare commits
No commits in common. 'main' and 'v0.16.2' have entirely different histories.
@ -1,6 +0,0 @@
|
||||
ratatui
|
||||
crate
|
||||
ser
|
||||
enque
|
||||
noice
|
||||
ans
|
||||
@ -1,23 +0,0 @@
|
||||
name: "Push Binary Cache for Nix"
|
||||
on:
|
||||
pull_request:
|
||||
push:
|
||||
jobs:
|
||||
build:
|
||||
strategy:
|
||||
matrix:
|
||||
os: [ubuntu-latest, macos-latest]
|
||||
runs-on: ${{ matrix.os }}
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
- uses: nixbuild/nix-quick-install-action@v19
|
||||
with:
|
||||
nix_conf: experimental-features = nix-command flakes
|
||||
- uses: cachix/cachix-action@v11
|
||||
with:
|
||||
name: xplr
|
||||
authtoken: "${{ secrets.CACHIX_AUTH_TOKEN }}"
|
||||
- run: nix profile install .
|
||||
- name: Run tests
|
||||
run: |
|
||||
xplr --version
|
||||
File diff suppressed because it is too large
Load Diff
@ -1,17 +1,7 @@
|
||||
# Build
|
||||
|
||||
See [install.md](./docs/en/src/install.md#build-from-source)
|
||||
|
||||
Note: xplr ships with vendored luajit. If the platform can't compile this,
|
||||
you need to compile using `--no-default-features` argument to avoid using
|
||||
vendored luajit, so that you can static link luajit yourself.
|
||||
|
||||
# Release
|
||||
|
||||
The final binary `target/release/xplr` can be shipped with the following assets
|
||||
|
||||
- [License](./LICENSE)
|
||||
- [Desktop Entry](./assets/desktop/xplr.desktop)
|
||||
- [Desktop Icons](./assets/icon/)
|
||||
- [Offline Docs](./docs/en/src)
|
||||
- [Lua Configuration Example](./src/init.lua)
|
||||
Process
|
||||
-------
|
||||
- [ ] Update `Cargo.toml` version.
|
||||
- [ ] Update `config.yml` version.
|
||||
- [ ] Update `Config::is_compatible()` and `Config::upgrade_notification()`.
|
||||
- [ ] Publish GitHub tag.
|
||||
- [ ] Update Wiki and docs.
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 6.9 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 5.6 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 12 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 6.9 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 80 KiB |
@ -1,10 +0,0 @@
|
||||
(import
|
||||
(
|
||||
let lock = builtins.fromJSON (builtins.readFile ./flake.lock); in
|
||||
fetchTarball {
|
||||
url = "https://github.com/edolstra/flake-compat/archive/${lock.nodes.flake-compat.locked.rev}.tar.gz";
|
||||
sha256 = lock.nodes.flake-compat.locked.narHash;
|
||||
}
|
||||
)
|
||||
{ src = ./.; }
|
||||
).defaultNix
|
||||
@ -1,16 +1,11 @@
|
||||
[book]
|
||||
authors = ['Arijit Basu <hi@arijitbasu.in>']
|
||||
title = 'xplr book'
|
||||
description = 'A hackable, minimal, fast TUI file explorer'
|
||||
src = 'src'
|
||||
language = 'en'
|
||||
authors = ["Arijit Basu <sayanarijit@gmail.com>"]
|
||||
title = "xplr book"
|
||||
description = "A hackable, minimal, fast TUI file explorer"
|
||||
src = "src"
|
||||
language = "en"
|
||||
|
||||
[output.html]
|
||||
site-url = '/xplr/en/'
|
||||
git-repository-url = 'https://github.com/sayanarijit/xplr'
|
||||
edit-url-template = 'https://github.com/sayanarijit/xplr/edit/main/docs/en/{path}'
|
||||
default-theme = 'dark'
|
||||
preferred-dark-theme = 'coal'
|
||||
|
||||
[output.linkcheck]
|
||||
optional = true
|
||||
site-url = "/xplr/en/"
|
||||
git-repository-url = "https://github.com/sayanarijit/xplr"
|
||||
edit-url-template = "https://github.com/sayanarijit/xplr/edit/main/docs/en/{path}"
|
||||
|
||||
@ -1,542 +0,0 @@
|
||||
# Awesome Hacks
|
||||
|
||||
Here's a list of cool xplr hacks, i.e. snippets of code that you can just copy
|
||||
and paste into your [configuration][1] or the appropriate file, that are
|
||||
too small or too niche for a full fledge [plugin][2].
|
||||
|
||||
Do you have something cool to share?
|
||||
|
||||
[Edit this file][3] or [share them here][4].
|
||||
|
||||
You can try these hacks by writing them to a file, say `hack.lua` and passing
|
||||
it to xplr with `--extra-config` or `-C`.
|
||||
|
||||
```bash
|
||||
xplr -C hack.lua
|
||||
```
|
||||
|
||||
### cd on quit
|
||||
|
||||
Change directory using xplr.
|
||||
|
||||
<details>
|
||||
<summary>Expand for details</summary>
|
||||
|
||||
- Author: [@sayanarijit][8]
|
||||
- Tested on: Linux
|
||||
|
||||
NOTE: This is a shell hack, rather than Lua config hack. Add this in
|
||||
`.bashrc` or `.profile` file in your home directory.
|
||||
|
||||
With this alias set, you can navigate directories using xplr by entering
|
||||
xcd command, and when you quit by pressing enter, you will enter the
|
||||
directory.
|
||||
|
||||
You can of course, quit with plain Quit (i.e. by pressing q) to
|
||||
gracefully cancel "cd on quit".
|
||||
|
||||
```bash
|
||||
alias xcd='cd "$(xplr --print-pwd-as-result)"'
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
### Spawn multiple sessions in different tabs (iTerm2)
|
||||
|
||||
Creating a new session that starts with iTerm2.
|
||||
|
||||
<details>
|
||||
<summary>Expand for details</summary>
|
||||
|
||||
- Author: [@lmburns][9]
|
||||
- Requires: iTerm2
|
||||
- Tested on: MacOS
|
||||
|
||||
```lua
|
||||
xplr.config.modes.builtin.default.key_bindings.on_key["ctrl-n"] = {
|
||||
help = "new session",
|
||||
messages = {
|
||||
{ BashExecSilently = [[
|
||||
osascript <<EOF
|
||||
tell application "iTerm2"
|
||||
tell current window
|
||||
create tab with default profile
|
||||
tell current session to write text "xplr"
|
||||
end tell
|
||||
end tell
|
||||
]]
|
||||
},
|
||||
},
|
||||
}
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
### Bookmark
|
||||
|
||||
Bookmark files using `m` and fuzzy search bookmarks using backtick.
|
||||
|
||||
<details>
|
||||
<summary>Expand for details</summary>
|
||||
|
||||
[![xplr-bookmark.gif][7]][6]
|
||||
|
||||
- Author: [@sayanarijit][8]
|
||||
- Requires: fzf
|
||||
- Tested on: Linux
|
||||
|
||||
```lua
|
||||
xplr.config.modes.builtin.default.key_bindings.on_key.m = {
|
||||
help = "bookmark",
|
||||
messages = {
|
||||
{
|
||||
BashExecSilently0 = [===[
|
||||
PTH="${XPLR_FOCUS_PATH:?}"
|
||||
PTH_ESC=$(printf %q "$PTH")
|
||||
if echo "${PTH:?}" >> "${XPLR_SESSION_PATH:?}/bookmarks"; then
|
||||
"$XPLR" -m 'LogSuccess: %q' "$PTH_ESC added to bookmarks"
|
||||
else
|
||||
"$XPLR" -m 'LogError: %q' "Failed to bookmark $PTH_ESC"
|
||||
fi
|
||||
]===],
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
xplr.config.modes.builtin.default.key_bindings.on_key["`"] = {
|
||||
help = "go to bookmark",
|
||||
messages = {
|
||||
{
|
||||
BashExec0 = [===[
|
||||
PTH=$(cat "${XPLR_SESSION_PATH:?}/bookmarks" | fzf --no-sort)
|
||||
PTH_ESC=$(printf %q "$PTH")
|
||||
if [ "$PTH" ]; then
|
||||
"$XPLR" -m 'FocusPath: %q' "$PTH"
|
||||
fi
|
||||
]===],
|
||||
},
|
||||
},
|
||||
}
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
### Persistent, multi-session bookmark
|
||||
|
||||
A bookmark mode that allows for a bookmark file to be used throughout multiples
|
||||
sessions. It is set to the environment variable `$XPLR_BOOKMARK_FILE`. A
|
||||
bookmark can be added, deleted, or jumped to.
|
||||
|
||||
<details>
|
||||
<summary>Expand for details</summary>
|
||||
|
||||
- Author: [@lmburns][9]
|
||||
- Requires: fzf, sd
|
||||
- Tested on: MacOS
|
||||
|
||||
```lua
|
||||
-- With `export XPLR_BOOKMARK_FILE="$HOME/bookmarks"`
|
||||
-- Bookmark: mode binding
|
||||
xplr.config.modes.builtin.default.key_bindings.on_key["b"] = {
|
||||
help = "bookmark mode",
|
||||
messages = {
|
||||
{ SwitchModeCustom = "bookmark" },
|
||||
},
|
||||
}
|
||||
xplr.config.modes.custom.bookmark = {
|
||||
name = "bookmark",
|
||||
key_bindings = {
|
||||
on_key = {
|
||||
m = {
|
||||
help = "bookmark dir",
|
||||
messages = {
|
||||
{
|
||||
BashExecSilently0 = [[
|
||||
PTH="${XPLR_FOCUS_PATH:?}"
|
||||
if [ -d "${PTH}" ]; then
|
||||
PTH="${PTH}"
|
||||
elif [ -f "${PTH}" ]; then
|
||||
PTH=$(dirname "${PTH}")
|
||||
fi
|
||||
PTH_ESC=$(printf %q "$PTH")
|
||||
if echo "${PTH:?}" >> "${XPLR_BOOKMARK_FILE:?}"; then
|
||||
"$XPLR" -m 'LogSuccess: %q' "$PTH_ESC added to bookmarks"
|
||||
else
|
||||
"$XPLR" -m 'LogError: %q' "Failed to bookmark $PTH_ESC"
|
||||
fi
|
||||
]],
|
||||
},
|
||||
"PopMode",
|
||||
},
|
||||
},
|
||||
g = {
|
||||
help = "go to bookmark",
|
||||
messages = {
|
||||
{
|
||||
BashExec0 = [===[
|
||||
PTH=$(cat "${XPLR_BOOKMARK_FILE:?}" | fzf --no-sort)
|
||||
if [ "$PTH" ]; then
|
||||
"$XPLR" -m 'FocusPath: %q' "$PTH"
|
||||
fi
|
||||
]===],
|
||||
},
|
||||
"PopMode",
|
||||
},
|
||||
},
|
||||
d = {
|
||||
help = "delete bookmark",
|
||||
messages = {
|
||||
{
|
||||
BashExec0 = [[
|
||||
PTH=$(cat "${XPLR_BOOKMARK_FILE:?}" | fzf --no-sort)
|
||||
sd "$PTH\n" "" "${XPLR_BOOKMARK_FILE:?}"
|
||||
]],
|
||||
},
|
||||
"PopMode",
|
||||
},
|
||||
},
|
||||
esc = {
|
||||
help = "cancel",
|
||||
messages = {
|
||||
"PopMode",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
### Another bookmark manager type thing, taken from [wfxr's zsh plugin][13].
|
||||
|
||||
Another bookmark manager type thing, taken from [wfxr's zsh plugin][13] which has colored output with fzf.
|
||||
|
||||
<details>
|
||||
<summary>Expand for details</summary>
|
||||
|
||||
- Author: [@lmburns][9]
|
||||
- Requires: fzf, exa
|
||||
- Tested on: MacOS
|
||||
|
||||
```lua
|
||||
xplr.config.modes.builtin.go_to.key_bindings.on_key.b = {
|
||||
help = "bookmark jump",
|
||||
messages = {
|
||||
"PopMode",
|
||||
{ BashExec0 = [===[
|
||||
field='\(\S\+\s*\)'
|
||||
esc=$(printf '\033')
|
||||
N="${esc}[0m"
|
||||
R="${esc}[31m"
|
||||
G="${esc}[32m"
|
||||
Y="${esc}[33m"
|
||||
B="${esc}[34m"
|
||||
pattern="s#^${field}${field}${field}${field}#$Y\1$R\2$N\3$B\4$N#"
|
||||
PTH=$(sed 's#: # -> #' "$PATHMARKS_FILE"| nl| column -t \
|
||||
| gsed "${pattern}" \
|
||||
| fzf --ansi \
|
||||
--height '40%' \
|
||||
--preview="echo {}|sed 's#.*-> ##'| xargs exa --color=always" \
|
||||
--preview-window="right:50%" \
|
||||
| sed 's#.*-> ##')
|
||||
if [ "$PTH" ]; then
|
||||
"$XPLR" -m 'ChangeDirectory: %q' "$PTH"
|
||||
fi
|
||||
]===]
|
||||
},
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
### Fuzzy search history
|
||||
|
||||
Fuzzy search the last visited directories.
|
||||
|
||||
<details>
|
||||
<summary>Expand for details</summary>
|
||||
|
||||
- Author: [@sayanarijit][8]
|
||||
- Requires: fzf
|
||||
- Tested on: Linux
|
||||
|
||||
```lua
|
||||
xplr.config.modes.builtin.go_to.key_bindings.on_key.h = {
|
||||
help = "history",
|
||||
messages = {
|
||||
"PopMode",
|
||||
{
|
||||
BashExec0 = [===[
|
||||
PTH=$(cat "${XPLR_PIPE_HISTORY_OUT:?}" | sort -z -u | fzf --read0)
|
||||
if [ "$PTH" ]; then
|
||||
"$XPLR" -m 'ChangeDirectory: %q' "$PTH"
|
||||
fi
|
||||
]===],
|
||||
},
|
||||
},
|
||||
}
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
### Batch rename
|
||||
|
||||
Batch rename the selected or visible files and directories in $PWD.
|
||||
|
||||
<details>
|
||||
<summary>Expand for details</summary>
|
||||
|
||||
[![xplr-rename.gif][11]][10]
|
||||
|
||||
- Author: [@sayanarijit][8]
|
||||
- Requires: [pipe-rename][12]
|
||||
- Tested on: Linux
|
||||
|
||||
```lua
|
||||
xplr.config.modes.builtin.default.key_bindings.on_key.R = {
|
||||
help = "batch rename",
|
||||
messages = {
|
||||
{
|
||||
BashExec = [===[
|
||||
SELECTION=$(cat "${XPLR_PIPE_SELECTION_OUT:?}")
|
||||
NODES=${SELECTION:-$(cat "${XPLR_PIPE_DIRECTORY_NODES_OUT:?}")}
|
||||
if [ "$NODES" ]; then
|
||||
echo -e "$NODES" | renamer
|
||||
"$XPLR" -m ExplorePwdAsync
|
||||
fi
|
||||
]===],
|
||||
},
|
||||
},
|
||||
}
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
### Serve $PWD
|
||||
|
||||
Serve $PWD using a static web server via LAN.
|
||||
|
||||
<details>
|
||||
<summary>Expand for details</summary>
|
||||
|
||||
- Author: [@sayanarijit][8]
|
||||
- Requires: [sfz][14], fzf
|
||||
- Tested on: Linux
|
||||
|
||||
```lua
|
||||
xplr.config.modes.builtin.default.key_bindings.on_key.S = {
|
||||
help = "serve $PWD",
|
||||
messages = {
|
||||
{
|
||||
BashExec0 = [===[
|
||||
IP=$(ip addr | grep -w inet | cut -d/ -f1 | grep -Eo '[0-9]{1,3}\.[0-9]{ 1,3}\.[0-9]{1,3}\.[0-9]{1,3}' | fzf --prompt 'Select IP > ')
|
||||
echo "IP: ${IP:?}"
|
||||
read -p "Port (default 5000): " PORT
|
||||
echo
|
||||
sfz --all --cors --no-ignore --bind ${IP:?} --port ${PORT:-5000} . &
|
||||
sleep 1 && read -p '[press enter to exit]'
|
||||
kill -9 %1
|
||||
]===],
|
||||
},
|
||||
},
|
||||
}
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
### Image viewer (imv)
|
||||
|
||||
Preview images using [imv][17].
|
||||
|
||||
<details>
|
||||
<summary>Expand for details</summary>
|
||||
|
||||
- Author: [@sayanarijit][8]
|
||||
- Requires: [imv][17], [xdotool][18]
|
||||
- Tested on: Linux, FreeBSD 13.1-RELEASE
|
||||
|
||||
```lua
|
||||
xplr.config.modes.builtin.default.key_bindings.on_key.P = {
|
||||
help = "preview",
|
||||
messages = {
|
||||
{
|
||||
BashExecSilently0 = [===[
|
||||
FIFO_PATH="/tmp/xplr.fifo"
|
||||
|
||||
if [ -e "$FIFO_PATH" ]; then
|
||||
"$XPLR" -m StopFifo
|
||||
rm -f -- "$FIFO_PATH"
|
||||
else
|
||||
mkfifo "$FIFO_PATH"
|
||||
"$HOME/.local/bin/imv-open.sh" "$FIFO_PATH" "$XPLR_FOCUS_PATH" &
|
||||
"$XPLR" -m 'StartFifo: %q' "$FIFO_PATH"
|
||||
fi
|
||||
]===],
|
||||
},
|
||||
},
|
||||
}
|
||||
```
|
||||
|
||||
$HOME/.local/bin/imv-open.sh
|
||||
|
||||
```bash
|
||||
#!/usr/bin/env bash
|
||||
|
||||
FIFO_PATH="$1"
|
||||
IMAGE="$2"
|
||||
MAINWINDOW="$(xdotool getactivewindow)"
|
||||
IMV_PID="$(pgrep imv)"
|
||||
|
||||
if [ ! "$IMV_PID" ]; then
|
||||
imv "$IMAGE" &
|
||||
IMV_PID=$!
|
||||
fi
|
||||
|
||||
sleep 0.5
|
||||
|
||||
xdotool windowactivate "$MAINWINDOW"
|
||||
|
||||
while read -r path; do
|
||||
imv-msg "$IMV_PID" close all
|
||||
imv-msg "$IMV_PID" open "$path"
|
||||
done < "$FIFO_PATH"
|
||||
|
||||
imv-msg "$IMV_PID" quit
|
||||
[ -e "$FIFO_PATH" ] && rm -f -- "$FIFO_PATH"
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
### Text preview pane
|
||||
|
||||
Preview text files in a native xplr pane (should be fast enough).
|
||||
|
||||
<details>
|
||||
<summary>Expand for details</summary>
|
||||
|
||||
- Author: [@sayanarijit][8]
|
||||
- Requires: none
|
||||
- Tested on: Linux, FreeBSD 13.1-RELEASE
|
||||
|
||||
```lua
|
||||
local function stat(node)
|
||||
return xplr.util.to_yaml(xplr.util.node(node.absolute_path))
|
||||
end
|
||||
|
||||
local function read(path, height)
|
||||
local p = io.open(path)
|
||||
|
||||
if p == nil then
|
||||
return nil
|
||||
end
|
||||
|
||||
local i = 0
|
||||
local res = ""
|
||||
for line in p:lines() do
|
||||
if line:match("[^ -~\n\t]") then
|
||||
p:close()
|
||||
return
|
||||
end
|
||||
|
||||
res = res .. line .. "\n"
|
||||
if i == height then
|
||||
break
|
||||
end
|
||||
i = i + 1
|
||||
end
|
||||
p:close()
|
||||
|
||||
return res
|
||||
end
|
||||
|
||||
xplr.fn.custom.preview_pane = {}
|
||||
xplr.fn.custom.preview_pane.render = function(ctx)
|
||||
local title = nil
|
||||
local body = ""
|
||||
local n = ctx.app.focused_node
|
||||
if n and n.canonical then
|
||||
n = n.canonical
|
||||
end
|
||||
|
||||
if n then
|
||||
title = { format = n.absolute_path, style = xplr.util.lscolor(n.absolute_path) }
|
||||
if n.is_file then
|
||||
body = read(n.absolute_path, ctx.layout_size.height) or stat(n)
|
||||
else
|
||||
body = stat(n)
|
||||
end
|
||||
end
|
||||
|
||||
return { CustomParagraph = { ui = { title = title }, body = body } }
|
||||
end
|
||||
|
||||
local preview_pane = { Dynamic = "custom.preview_pane.render" }
|
||||
local split_preview = {
|
||||
Horizontal = {
|
||||
config = {
|
||||
constraints = {
|
||||
{ Percentage = 60 },
|
||||
{ Percentage = 40 },
|
||||
},
|
||||
},
|
||||
splits = {
|
||||
"Table",
|
||||
preview_pane,
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
xplr.config.layouts.builtin.default =
|
||||
xplr.util.layout_replace(xplr.config.layouts.builtin.default, "Table", split_preview)
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
### Tere Navigation
|
||||
|
||||
Navigate using the [tere][19] file explorer (defaults to type-to-nav system).
|
||||
|
||||
<details>
|
||||
<summary>Expand for details</summary>
|
||||
|
||||
- Author: [@sayanarijit][8]
|
||||
- Requires: [tere][19]
|
||||
- Tested on: Linux
|
||||
|
||||
```lua
|
||||
xplr.config.modes.builtin.default.key_bindings.on_key.T = {
|
||||
help = "tere nav",
|
||||
messages = {
|
||||
{ BashExec0 = [["$XPLR" -m 'ChangeDirectory: %q' "$(tere)"]] },
|
||||
},
|
||||
}
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
## Also See:
|
||||
|
||||
- [Awesome Plugins][15]
|
||||
- [Awesome Integrations][16]
|
||||
|
||||
[1]: configuration.md
|
||||
[2]: plugin.md
|
||||
[3]: https://github.com/sayanarijit/xplr/edit/main/docs/en/src/awesome-hacks.md
|
||||
[4]: https://github.com/sayanarijit/xplr/discussions/categories/show-and-tell
|
||||
[6]: https://gifyu.com/image/rGSR
|
||||
[7]: https://s4.gifyu.com/images/xplr-bookmark.gif
|
||||
[8]: https://github.com/sayanarijit
|
||||
[9]: https://github.com/lmburns
|
||||
[10]: https://gifyu.com/image/rGbo
|
||||
[11]: https://s4.gifyu.com/images/xplr-rename.gif
|
||||
[12]: https://github.com/marcusbuffett/pipe-rename
|
||||
[13]: https://github.com/wfxr/formarks
|
||||
[14]: https://github.com/weihanglo/sfz
|
||||
[15]: awesome-plugins.md
|
||||
[16]: awesome-integrations.md
|
||||
[17]: https://sr.ht/~exec64/imv
|
||||
[18]: https://www.semicomplete.com/projects/xdotool
|
||||
[19]: https://github.com/mgunyho/tere
|
||||
@ -1,37 +0,0 @@
|
||||
# Borders
|
||||
|
||||
xplr allows customizing the shape and style of the borders.
|
||||
|
||||
### Border
|
||||
|
||||
A border is a [sum type][2] that can be one of the following:
|
||||
|
||||
- "Top"
|
||||
- "Right"
|
||||
- "Bottom"
|
||||
- "Left"
|
||||
|
||||
### Border Type
|
||||
|
||||
A border type is a [sum type][2] that can be one of the following:
|
||||
|
||||
- "Plain"
|
||||
- "Rounded"
|
||||
- "Double"
|
||||
- "Thick"
|
||||
|
||||
### Border Style
|
||||
|
||||
The [style][1] of the borders.
|
||||
|
||||
## Example
|
||||
|
||||
```lua
|
||||
xplr.config.general.panel_ui.default.borders = { "Top", "Right", "Bottom", "Left" }
|
||||
xplr.config.general.panel_ui.default.border_type = "Thick"
|
||||
xplr.config.general.panel_ui.default.border_style.fg = "Black"
|
||||
xplr.config.general.panel_ui.default.border_style.bg = "Gray"
|
||||
```
|
||||
|
||||
[1]: style.md#style
|
||||
[2]: sum-type.md
|
||||
@ -0,0 +1,12 @@
|
||||
# Community
|
||||
|
||||
Building an active community of awesome people and learning stuff together is
|
||||
one of my reasons to publish this tool and maintain it. Hence, please feel free
|
||||
to reach out via your preferred way.
|
||||
|
||||
- Real-time chat lovers can join our [**matrix room**][3] or [**discord channel**][1].
|
||||
- Forum discussion veterans can [**start a new GitHub discussion**][2].
|
||||
|
||||
[1]: https://discord.gg/JmasSPCcz3
|
||||
[2]: https://github.com/sayanarijit/xplr/discussions
|
||||
[3]: https://matrix.to/#/#xplr-pub:matrix.org
|
||||
@ -1,30 +0,0 @@
|
||||
# Concept
|
||||
|
||||
These are the concepts that make xplr probably the most hackable terminal file
|
||||
explorer.
|
||||
|
||||
- [Key Bindings][1]
|
||||
- [Node Type][2]
|
||||
- [Layout][3]
|
||||
- [Mode][4]
|
||||
- [Message][5]
|
||||
- [Borders][6]
|
||||
- [Style][7]
|
||||
- [Sorting][8]
|
||||
- [Filtering][9]
|
||||
- [Column Renderer][10]
|
||||
- [Lua Function Calls][11]
|
||||
- [Environment Variables and Pipes][12]
|
||||
|
||||
[1]: key-bindings.md
|
||||
[2]: node-type.md
|
||||
[3]: layout.md
|
||||
[4]: mode.md
|
||||
[5]: message.md
|
||||
[6]: borders.md
|
||||
[7]: style.md
|
||||
[8]: sorting.md
|
||||
[9]: filtering.md
|
||||
[10]: column-renderer.md
|
||||
[11]: lua-function-calls.md
|
||||
[12]: environment-variables-and-pipes.md
|
||||
@ -1,156 +1,41 @@
|
||||
# Configuration
|
||||
|
||||
xplr can be configured using [Lua][1] via a special file named `init.lua`,
|
||||
which can be placed in `~/.config/xplr/` (local to user) or `/etc/xplr/`
|
||||
(global) depending on the use case.
|
||||
xplr can be configured using [Lua][1] via a special file
|
||||
named `init.lua`
|
||||
([example][2]), which
|
||||
can be placed in `~/.config/xplr/` (user specific) or `/etc/xplr/` (global)
|
||||
depending on the use case.
|
||||
|
||||
When xplr loads, it first executes the [built-in init.lua][2] to set the
|
||||
default values, which is then overwritten by another config file, if found
|
||||
using the following lookup order:
|
||||
|
||||
1. `--config /path/to/init.lua`
|
||||
2. `~/.config/xplr/init.lua`
|
||||
3. `/etc/xplr/init.lua`
|
||||
|
||||
The first one found will be loaded by xplr and the lookup will stop.
|
||||
|
||||
The loaded config can be further extended using the `-C` or `--extra-config`
|
||||
command-line option.
|
||||
|
||||
[1]: https://www.lua.org
|
||||
[2]: https://github.com/sayanarijit/xplr/blob/main/src/init.lua
|
||||
[3]: https://xplr.dev/en/upgrade-guide
|
||||
|
||||
## Config
|
||||
|
||||
The xplr configuration, exposed via `xplr.config` Lua API contains the
|
||||
following sections.
|
||||
|
||||
See:
|
||||
|
||||
- [xplr.config.general](https://xplr.dev/en/general-config)
|
||||
- [xplr.config.node_types](https://xplr.dev/en/node_types)
|
||||
- [xplr.config.layouts](https://xplr.dev/en/layouts)
|
||||
- [xplr.config.modes](https://xplr.dev/en/modes)
|
||||
|
||||
## Function
|
||||
|
||||
While `xplr.config` defines all the static parts of the configuration,
|
||||
`xplr.fn` defines all the dynamic parts using functions.
|
||||
|
||||
See: [Lua Function Calls](https://xplr.dev/en/lua-function-calls)
|
||||
|
||||
As always, `xplr.fn.builtin` is where the built-in functions are defined
|
||||
that can be overwritten.
|
||||
|
||||
#### xplr.fn.builtin.try_complete_path
|
||||
|
||||
Tries to auto complete the path in the input buffer
|
||||
|
||||
#### xplr.fn.builtin.fmt_general_table_row_cols_0
|
||||
|
||||
Renders the first column in the table
|
||||
When a user specific configuration is available, the global configuration file
|
||||
will be ignored.
|
||||
|
||||
#### xplr.fn.builtin.fmt_general_table_row_cols_1
|
||||
However, it's also possible to place the file anywhere, with any name and use
|
||||
the command-line argument `-c` / `--config` to specify its path explicitely. In
|
||||
that case, both `~/.config/xplr/init.lua` and `/etc/xplr/init.lua` will be
|
||||
ignored.
|
||||
|
||||
Renders the second column in the table
|
||||
## How Config Is Loaded
|
||||
|
||||
#### xplr.fn.builtin.fmt_general_table_row_cols_2
|
||||
|
||||
Renders the third column in the table
|
||||
|
||||
#### xplr.fn.builtin.fmt_general_table_row_cols_3
|
||||
|
||||
Renders the fourth column in the table
|
||||
|
||||
#### xplr.fn.builtin.fmt_general_table_row_cols_4
|
||||
|
||||
Renders the fifth column in the table
|
||||
|
||||
#### xplr.fn.custom
|
||||
|
||||
This is where the custom functions can be added.
|
||||
|
||||
There is currently no restriction on what kind of functions can be defined
|
||||
in `xplr.fn.custom`.
|
||||
|
||||
You can also use nested tables such as
|
||||
`xplr.fn.custom.my_plugin.my_function` to define custom functions.
|
||||
|
||||
## Hooks
|
||||
|
||||
This section of the configuration cannot be overwritten by another config
|
||||
file or plugin, since this is an optional lua return statement specific to
|
||||
each config file. It can be used to define things that should be explicit
|
||||
for reasons like performance concerns, such as hooks.
|
||||
|
||||
Plugins should expose the hooks, and require users to subscribe to them
|
||||
explicitly.
|
||||
|
||||
Example:
|
||||
|
||||
```lua
|
||||
return {
|
||||
-- Add messages to send when the xplr loads.
|
||||
-- This is similar to the `--on-load` command-line option.
|
||||
--
|
||||
-- Type: list of [Message](https://xplr.dev/en/message#message)s
|
||||
on_load = {
|
||||
{ LogSuccess = "Configuration successfully loaded!" },
|
||||
{ CallLuaSilently = "custom.some_plugin_with_hooks.on_load" },
|
||||
},
|
||||
|
||||
-- Add messages to send when the directory changes.
|
||||
--
|
||||
-- Type: list of [Message](https://xplr.dev/en/message#message)s
|
||||
on_directory_change = {
|
||||
{ LogSuccess = "Changed directory" },
|
||||
{ CallLuaSilently = "custom.some_plugin_with_hooks.on_directory_change" },
|
||||
},
|
||||
|
||||
-- Add messages to send when the focus changes.
|
||||
--
|
||||
-- Type: list of [Message](https://xplr.dev/en/message#message)s
|
||||
on_focus_change = {
|
||||
{ LogSuccess = "Changed focus" },
|
||||
{ CallLuaSilently = "custom.some_plugin_with_hooks.on_focus_change" },
|
||||
}
|
||||
When xplr loads, it first executes the built-in
|
||||
[init.lua][2] to set
|
||||
the default values, which is then overwritten by another config file, if found
|
||||
using the following lookup order:
|
||||
|
||||
-- Add messages to send when the mode is switched.
|
||||
--
|
||||
-- Type: list of [Message](https://xplr.dev/en/message#message)s
|
||||
on_mode_switch = {
|
||||
{ LogSuccess = "Switched mode" },
|
||||
{ CallLuaSilently = "custom.some_plugin_with_hooks.on_mode_switch" },
|
||||
}
|
||||
**--config /path/to/init.lua** > **~/.config/xplr/init.lua** > **/etc/xplr/init.lua**
|
||||
|
||||
-- Add messages to send when the layout is switched
|
||||
--
|
||||
-- Type: list of [Message](https://xplr.dev/en/message#message)s
|
||||
on_layout_switch = {
|
||||
{ LogSuccess = "Switched layout" },
|
||||
{ CallLuaSilently = "custom.some_plugin_with_hooks.on_layout_switch" },
|
||||
}
|
||||
## config
|
||||
|
||||
-- Add messages to send when the selection changes
|
||||
--
|
||||
-- Type: list of [Message](https://xplr.dev/en/message#message)s
|
||||
on_selection_change = {
|
||||
{ LogSuccess = "Selection changed" },
|
||||
{ CallLuaSilently = "custom.some_plugin_with_hooks.on_selection_change" },
|
||||
}
|
||||
}
|
||||
```
|
||||
The xplr configuration, exposed as `xplr.config` Lua API contains the
|
||||
following fields:
|
||||
|
||||
---
|
||||
- [general][3]
|
||||
- [modes][4]
|
||||
- [layouts][5]
|
||||
- [node_types][6]
|
||||
|
||||
> Note:
|
||||
>
|
||||
> It's not recommended to copy the entire configuration, unless you want to
|
||||
> freeze it and miss out on useful updates to the defaults.
|
||||
>
|
||||
> Instead, you can use this as a reference to overwrite only the parts you
|
||||
> want to update.
|
||||
>
|
||||
> If you still want to copy the entire configuration, make sure to put your
|
||||
> customization before the return statement.
|
||||
[1]: https://www.lua.org/
|
||||
[2]: https://github.com/sayanarijit/xplr/blob/main/src/init.lua
|
||||
[3]: general-config.md
|
||||
[4]: modes.md
|
||||
[5]: layouts.md
|
||||
[6]: node_types.md
|
||||
|
||||
@ -0,0 +1,25 @@
|
||||
If you like xplr, and want to contribute, that would be really awesome.
|
||||
|
||||
You can contribute to this project in the following ways
|
||||
|
||||
- Contribute your time and expertise (read [CONTRIBUTING.md][1] for instructions).
|
||||
|
||||
- **Developers:** You can help me improve my code, fix things, implement features etc.
|
||||
- **Repository maintainers:** You can save the users from the pain of managing xplr in their system manually.
|
||||
- **Code Reviewers:** Teach me your ways of code.
|
||||
- **Designers:** You can make the logo even more awesome, donate stickers and blog post worthy pictures.
|
||||
- **Bloggers, YouTubers & broadcasters:** You can help spread the word.
|
||||
|
||||
- Contribute by donating.
|
||||
- You can [fuel me with coins of encouragement][2] or [buy me a coffee][3].
|
||||
|
||||
For further queries or concern related to `xplr`, [just ask us][4].
|
||||
|
||||
### Backers
|
||||
|
||||
<a href="https://opencollective.com/xplr#backer"><img src="https://opencollective.com/xplr/tiers/backer.svg?width=890" /></a>
|
||||
|
||||
[1]: https://github.com/sayanarijit/xplr/blob/main/CONTRIBUTING.md
|
||||
[2]: https://opencollective.com/xplr
|
||||
[3]: https://ko-fi.com/sayanarijit
|
||||
[4]: community.md
|
||||
@ -1,230 +0,0 @@
|
||||
# Environment Variables and Pipes
|
||||
|
||||
Alternative to `CallLua`, `CallLuaSilently` messages that call Lua functions,
|
||||
there are `Call0`, `CallSilently0`, `BashExec0`, `BashExecSilently0` messages
|
||||
that call shell commands.
|
||||
|
||||
### Example: Simple file opener using xdg-open and $XPLR_FOCUS_PATH
|
||||
|
||||
```lua
|
||||
xplr.config.modes.builtin.default.key_bindings.on_key["X"] = {
|
||||
help = "open",
|
||||
messages = {
|
||||
{
|
||||
BashExecSilently0 = [===[
|
||||
xdg-open "${XPLR_FOCUS_PATH:?}"
|
||||
]===],
|
||||
},
|
||||
},
|
||||
}
|
||||
```
|
||||
|
||||
However, unlike the Lua functions, these shell commands have to read the useful
|
||||
information and send messages via environment variables and temporary files
|
||||
called "pipe"s. These environment variables and files are only available when
|
||||
a command is being executed.
|
||||
|
||||
### Example: Using Environment Variables and Pipes
|
||||
|
||||
```lua
|
||||
xplr.config.modes.builtin.default.key_bindings.on_key["space"] = {
|
||||
help = "ask name and greet",
|
||||
messages = {
|
||||
{
|
||||
BashExec0 = [===[
|
||||
echo "What's your name?"
|
||||
|
||||
read name
|
||||
greeting="Hello $name!"
|
||||
message="$greeting You are inside $PWD"
|
||||
|
||||
"$XPLR" -m 'LogSuccess: %q' "$message"
|
||||
]===]
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
-- Now, when you press "space" in default mode, you will be prompted for your
|
||||
-- name. Enter your name to receive a nice greeting and to know your location.
|
||||
```
|
||||
|
||||
Visit the [**fzf integration tutorial**][19] for another example.
|
||||
|
||||
To see the environment variables and pipes, invoke the shell by typing `:!` in default
|
||||
mode and run the following command:
|
||||
|
||||
```
|
||||
env | grep ^XPLR
|
||||
```
|
||||
|
||||
You will see something like:
|
||||
|
||||
```
|
||||
XPLR=xplr
|
||||
XPLR_FOCUS_INDEX=0
|
||||
XPLR_MODE=action to
|
||||
XPLR_PIPE_SELECTION_OUT=/run/user/1000/xplr/session/122278/pipe/selection_out
|
||||
XPLR_INPUT_BUFFER=
|
||||
XPLR_PIPE_GLOBAL_HELP_MENU_OUT=/run/user/1000/xplr/session/122278/pipe/global_help_menu_out
|
||||
XPLR_PID=122278
|
||||
XPLR_PIPE_MSG_IN=/run/user/1000/xplr/session/122278/pipe/msg_in
|
||||
XPLR_PIPE_LOGS_OUT=/run/user/1000/xplr/session/122278/pipe/logs_out
|
||||
XPLR_PIPE_RESULT_OUT=/run/user/1000/xplr/session/122278/pipe/result_out
|
||||
XPLR_PIPE_HISTORY_OUT=/run/user/1000/xplr/session/122278/pipe/history_out
|
||||
XPLR_FOCUS_PATH=/home/sayanarijit/Documents/GitHub/xplr/docs/en/book
|
||||
XPLR_SESSION_PATH=/run/user/1000/xplr/session/122278
|
||||
XPLR_APP_VERSION=0.14.3
|
||||
XPLR_PIPE_DIRECTORY_NODES_OUT=/run/user/1000/xplr/session/122278/pipe/directory_nodes_out
|
||||
```
|
||||
|
||||
The environment variables starting with `XPLR_PIPE_` are the temporary files
|
||||
called ["pipe"s][18].
|
||||
|
||||
The other variables are single-line variables containing simple information:
|
||||
|
||||
- [XPLR][38]
|
||||
- [XPLR_APP_VERSION][30]
|
||||
- [XPLR_FOCUS_INDEX][31]
|
||||
- [XPLR_FOCUS_PATH][32]
|
||||
- [XPLR_INPUT_BUFFER][33]
|
||||
- [XPLR_INITIAL_PWD][40]
|
||||
- [XPLR_MODE][34]
|
||||
- [XPLR_PID][35]
|
||||
- [XPLR_SESSION_PATH][36]
|
||||
- [XPLR_VROOT][39]
|
||||
|
||||
### Environment variables
|
||||
|
||||
#### XPLR
|
||||
|
||||
The binary path of xplr command.
|
||||
|
||||
#### XPLR_APP_VERSION
|
||||
|
||||
Self-explanatory.
|
||||
|
||||
#### XPLR_FOCUS_INDEX
|
||||
|
||||
Contains the index of the currently focused item, as seen in
|
||||
[column-renderer/index][10].
|
||||
|
||||
#### XPLR_FOCUS_PATH
|
||||
|
||||
Contains the full path of the currently focused node.
|
||||
|
||||
#### XPLR_INITIAL_PWD
|
||||
|
||||
The $PWD then xplr started.
|
||||
|
||||
#### XPLR_INPUT_BUFFER
|
||||
|
||||
The line currently in displaying in the xplr input buffer. For e.g. the search
|
||||
input while searching. See [Reading Input][37].
|
||||
|
||||
#### XPLR_MODE
|
||||
|
||||
Contains the mode xplr is currently in, see [modes][11].
|
||||
|
||||
#### XPLR_PID
|
||||
|
||||
Contains the process ID of the current xplr process.
|
||||
|
||||
#### XPLR_SESSION_PATH
|
||||
|
||||
Contains the current session path, like /tmp/runtime-"$USER"/xplr/session/"$XPLR_PID"/,
|
||||
you can find temporary files here, such as pipes.
|
||||
|
||||
#### XPLR_VROOT
|
||||
|
||||
Contains the path of current virtual root, is set.
|
||||
|
||||
### Pipes
|
||||
|
||||
#### Input pipe
|
||||
|
||||
Currently there is only one input pipe.
|
||||
|
||||
- [XPLR_PIPE_MSG_IN][20]
|
||||
|
||||
#### Output pipes
|
||||
|
||||
`XPLR_PIPE_*_OUT` are the output pipes that contain data which cannot be
|
||||
exposed directly via environment variables, like multi-line strings.
|
||||
These pipes can be accessed as plain text files located in $XPLR_SESSION_PATH.
|
||||
|
||||
Depending on the message (e.g. `Call` or `Call0`), each line will be separated
|
||||
by newline or null character (`\n` or `\0`).
|
||||
|
||||
- [XPLR_PIPE_SELECTION_OUT][21]
|
||||
- [XPLR_PIPE_GLOBAL_HELP_MENU_OUT][22]
|
||||
- [XPLR_PIPE_LOGS_OUT][23]
|
||||
- [XPLR_PIPE_RESULT_OUT][24]
|
||||
- [XPLR_PIPE_HISTORY_OUT][25]
|
||||
- [XPLR_PIPE_DIRECTORY_NODES_OUT][26]
|
||||
|
||||
#### XPLR_PIPE_MSG_IN
|
||||
|
||||
Append new messages to this pipe in [YAML][27] (or [JSON][7]) syntax. These
|
||||
messages will be read and handled by xplr after the command execution.
|
||||
|
||||
Depending on the message (e.g. `Call` or `Call0`) you need to separate each
|
||||
message using newline or null character (`\n` or `\0`).
|
||||
|
||||
> **_NOTE:_** Since version `v0.20.0`, it's recommended to avoid writing
|
||||
> directly to this file, as safely escaping YAML strings is a lot of work. Use
|
||||
> `xplr -m` / `xplr --pipe-msg-in` to pass messages to xplr in a safer way.
|
||||
>
|
||||
> It uses [jf][41] syntax to safely convert an YAML template into a valid message.
|
||||
>
|
||||
> Example: `"$XPLR" -m 'ChangeDirectory: %q' "${HOME:?}"`
|
||||
|
||||
#### XPLR_PIPE_SELECTION_OUT
|
||||
|
||||
List of selected paths.
|
||||
|
||||
#### XPLR_PIPE_GLOBAL_HELP_MENU_OUT
|
||||
|
||||
The full help menu.
|
||||
|
||||
#### XPLR_PIPE_LOGS_OUT
|
||||
|
||||
List of logs.
|
||||
|
||||
#### XPLR_PIPE_RESULT_OUT
|
||||
|
||||
Result (selected paths if any, else the focused path)
|
||||
|
||||
#### XPLR_PIPE_HISTORY_OUT
|
||||
|
||||
List of last visited paths (similar to jump list in vim).
|
||||
|
||||
#### XPLR_PIPE_DIRECTORY_NODES_OUT
|
||||
|
||||
List of paths, filtered and sorted as displayed in the [files table][28].
|
||||
|
||||
[7]: https://www.json.org
|
||||
[10]: column-renderer.md#index
|
||||
[11]: modes.md#modes
|
||||
[18]: #pipes
|
||||
[19]: configure-key-bindings.md#tutorial-adding-a-new-mode
|
||||
[20]: #xplr_pipe_msg_in
|
||||
[21]: #xplr_pipe_selection_out
|
||||
[22]: #xplr_pipe_global_help_menu_out
|
||||
[23]: #xplr_pipe_logs_out
|
||||
[24]: #xplr_pipe_result_out
|
||||
[25]: #xplr_pipe_history_out
|
||||
[26]: #xplr_pipe_directory_nodes_out
|
||||
[27]: https://www.yaml.org
|
||||
[28]: layout.md#table
|
||||
[30]: #xplr_app_version
|
||||
[31]: #xplr_focus_index
|
||||
[32]: #xplr_focus_path
|
||||
[33]: #xplr_input_buffer
|
||||
[34]: #xplr_mode
|
||||
[35]: #xplr_pid
|
||||
[36]: #xplr_session_path
|
||||
[37]: messages.md#reading-input
|
||||
[38]: #xplr
|
||||
[39]: #xplr_vroot
|
||||
[40]: #xplr_initial_pwd
|
||||
[41]: https://github.com/sayanarijit/jf
|
||||
@ -1,628 +1,503 @@
|
||||
### General Configuration
|
||||
# General Config
|
||||
|
||||
The general configuration properties are grouped together in
|
||||
`xplr.config.general`.
|
||||
This configuration is exposed via the `xplr.config.general` API. It contains
|
||||
the following fields:
|
||||
|
||||
#### xplr.config.general.disable_debug_error_mode
|
||||
|
||||
Set it to `true` if you want to ignore the startup errors. You can still see
|
||||
the errors in the logs.
|
||||
## enable_mouse
|
||||
|
||||
Type: boolean
|
||||
|
||||
#### xplr.config.general.enable_mouse
|
||||
Set it to `true` enable scrolling using mouse.
|
||||
|
||||
Set it to `true` if you want to enable mouse scrolling.
|
||||
## show_hidden
|
||||
|
||||
Type: boolean
|
||||
|
||||
#### xplr.config.general.show_hidden
|
||||
Set it to `true` to show hidden files.
|
||||
|
||||
Set it to `true` to show hidden files by default.
|
||||
## read_only
|
||||
|
||||
Type: boolean
|
||||
|
||||
#### xplr.config.general.read_only
|
||||
|
||||
Set it to `true` to use only a subset of selected operations that forbids
|
||||
executing commands or performing write operations on the file-system.
|
||||
|
||||
Type: boolean
|
||||
|
||||
#### xplr.config.general.enable_recover_mode
|
||||
|
||||
Set it to `true` if you want to enable a safety feature that will save you
|
||||
from yourself when you type recklessly.
|
||||
## enable_recover_mode
|
||||
|
||||
Type: boolean
|
||||
|
||||
#### xplr.config.general.hide_remaps_in_help_menu
|
||||
Set it to `true` if you want to enable a safety feature that will save you from
|
||||
yourself when you type recklessly.
|
||||
|
||||
Set it to `true` if you want to hide all remaps in the help menu.
|
||||
## initial_layout
|
||||
|
||||
Type: boolean
|
||||
Type: string
|
||||
|
||||
#### xplr.config.general.paginated_scrolling
|
||||
The name of one of the [layout][2] to use when xplr loads.
|
||||
|
||||
Set it to `true` if you want paginated scrolling.
|
||||
## initial_mode
|
||||
|
||||
Type: boolean
|
||||
Type: string
|
||||
|
||||
#### xplr.config.general.scroll_padding
|
||||
The name of one of the [mode][3] to use when xplr loads.
|
||||
|
||||
Set the padding value to the scroll area.
|
||||
Only applicable when `xplr.config.general.paginated_scrolling = false`.
|
||||
## initial_sorting
|
||||
|
||||
Type: boolean
|
||||
Type: list of [Node Sorter Applicable][4]
|
||||
|
||||
#### xplr.config.general.enforce_bounded_index_navigation
|
||||
Initial group if sorters applied to the nodes list in the table.
|
||||
|
||||
Set it to `true` if you want the cursor to stay in the same position when
|
||||
the focus is on the first path and you navigate to the previous path
|
||||
(by pressing `up`/`k`), or when the focus is on the last path and you
|
||||
navigate to the next path (by pressing `down`/`j`).
|
||||
The default behavior is to rotate from the last/first path.
|
||||
## table.style
|
||||
|
||||
Type: boolean
|
||||
Type: [Style][1]
|
||||
|
||||
#### xplr.config.general.prompt.format
|
||||
Default style of the table.
|
||||
|
||||
This is the shape of the prompt for the input buffer.
|
||||
## table.col_spacing
|
||||
|
||||
Type: nullable string
|
||||
Type: nullable integer
|
||||
|
||||
#### xplr.config.general.prompt.style
|
||||
Default spacing of the columns in the table.
|
||||
|
||||
This is the style of the prompt for the input buffer.
|
||||
## table.col_widths
|
||||
|
||||
Type: [Style](https://xplr.dev/en/style)
|
||||
Type: nullable list of [Constraint][5]
|
||||
|
||||
#### xplr.config.general.logs.info.format
|
||||
Width of each column in the table.
|
||||
|
||||
The string to indicate an information in logs.
|
||||
## table.header.height
|
||||
|
||||
Type: nullable string
|
||||
|
||||
#### xplr.config.general.logs.info.style
|
||||
Type: nullable integer
|
||||
|
||||
The style for the information logs.
|
||||
Height of the table header.
|
||||
|
||||
Type: [Style](https://xplr.dev/en/style)
|
||||
## table.header.style
|
||||
|
||||
#### xplr.config.general.logs.success.format
|
||||
Type: [Style][1]
|
||||
|
||||
The string to indicate an success in logs.
|
||||
Style of table header.
|
||||
|
||||
Type: nullable string
|
||||
## table.header.cols
|
||||
|
||||
#### xplr.config.general.logs.success.style
|
||||
Type: list of column configuration
|
||||
|
||||
The style for the success logs.
|
||||
Each column config contains `format` field (string) and `style` field
|
||||
([Style][1]), that define the content and style of header.
|
||||
|
||||
Type: [Style](https://xplr.dev/en/style)
|
||||
## table.row.height
|
||||
|
||||
#### xplr.config.general.logs.warning.format
|
||||
Type: nullable integer
|
||||
|
||||
The string to indicate an warnings in logs.
|
||||
Height of each row in the table.
|
||||
|
||||
Type: nullable string
|
||||
## table.row.style
|
||||
|
||||
#### xplr.config.general.logs.warning.style
|
||||
Type: [Style][1]
|
||||
|
||||
The style for the warnings logs.
|
||||
Style of table rows.
|
||||
|
||||
Type: [Style](https://xplr.dev/en/style)
|
||||
## table.row.cols
|
||||
|
||||
#### xplr.config.general.logs.error.format
|
||||
Type: list of column configuration
|
||||
|
||||
The string to indicate an error in logs.
|
||||
Each column config contains `format` field (string) and `style` field
|
||||
([Style][1]).
|
||||
|
||||
Type: nullable string
|
||||
However, unlike [table.header.cols][6], the `format` field here
|
||||
points to a [column renderer function][7].
|
||||
|
||||
#### xplr.config.general.logs.error.style
|
||||
## table.tree
|
||||
|
||||
The style for the error logs.
|
||||
Type: list of tree configuration
|
||||
|
||||
Type: [Style](https://xplr.dev/en/style)
|
||||
It expects a list of three items. The first component of the tree, then the
|
||||
middle components, and finally the last component of the tree.
|
||||
|
||||
#### xplr.config.general.table.header.cols
|
||||
Each item requires the `format` field which is a string, and the `style` field,
|
||||
which is the [Style][1] object.
|
||||
|
||||
Columns to display in the table header.
|
||||
Example:
|
||||
|
||||
Type: nullable list of tables with the following fields:
|
||||
```lua
|
||||
xplr.config.general.table.tree = {
|
||||
{ format = "├─", style = { add_modifiers = { "Bold" }, bg = nil, fg = "Blue", sub_modifiers = nil } },
|
||||
{ format = "├─", style = { add_modifiers = { "Bold" }, bg = nil, fg = "Blue", sub_modifiers = nil } },
|
||||
{ format = "╰─", style = { add_modifiers = { "Bold" }, bg = nil, fg = "Blue", sub_modifiers = nil } },
|
||||
}
|
||||
```
|
||||
|
||||
- format: nullable string
|
||||
- style: [Style](https://xplr.dev/en/style)
|
||||
## start_fifo
|
||||
|
||||
#### xplr.config.general.table.header.style
|
||||
|
||||
Style of the table header.
|
||||
Type: nullable string
|
||||
|
||||
Type: [Style](https://xplr.dev/en/style)
|
||||
Start a FIFO file when xplr loads. It will track the absolute path of the file
|
||||
under focus.
|
||||
|
||||
#### xplr.config.general.table.header.height
|
||||
## prompt.format
|
||||
|
||||
Height of the table header.
|
||||
Type: string
|
||||
|
||||
Type: nullable integer
|
||||
This is the shape of the prompt for the input buffer.
|
||||
|
||||
#### xplr.config.general.table.row.cols
|
||||
## prompt.style
|
||||
|
||||
Columns to display in each row in the table.
|
||||
Type: [Style][1]
|
||||
|
||||
Type: nullable list of tables with the following fields:
|
||||
Style of the input prompt.
|
||||
|
||||
- format: nullable string
|
||||
- style: [Style](https://xplr.dev/en/style)
|
||||
## logs.error.format
|
||||
|
||||
#### xplr.config.general.table.row.style
|
||||
Type: string
|
||||
|
||||
Default style of the table.
|
||||
The string to indicate an error in logs.
|
||||
|
||||
Type: [Style](https://xplr.dev/en/style)
|
||||
## logs.error.style
|
||||
|
||||
#### xplr.config.general.table.row.height
|
||||
Type: [Style][1]
|
||||
|
||||
Height of the table rows.
|
||||
Style for errors shown in logs.
|
||||
|
||||
Type: nullable integer
|
||||
## logs.info.format
|
||||
|
||||
#### xplr.config.general.table.style
|
||||
Type: string
|
||||
|
||||
Default style of the table.
|
||||
The string to indicate an information in logs.
|
||||
|
||||
Type: [Style](https://xplr.dev/en/style)
|
||||
## logs.info.style
|
||||
|
||||
#### xplr.config.general.table.tree
|
||||
Type: [Style][1]
|
||||
|
||||
Tree to display in the table.
|
||||
Style for infos shown in logs.
|
||||
|
||||
Type: nullable list of tables with the following fields:
|
||||
## logs.success.format
|
||||
|
||||
- format: nullable string
|
||||
- style: [Style](https://xplr.dev/en/style)
|
||||
Type: string
|
||||
|
||||
#### xplr.config.general.table.col_spacing
|
||||
The string to indicate a successful operation in logs.
|
||||
|
||||
Spacing between the columns in the table.
|
||||
## logs.success.style
|
||||
|
||||
Type: nullable integer
|
||||
Type: [Style][1]
|
||||
|
||||
#### xplr.config.general.table.col_widths
|
||||
Style for successful operations in logs.
|
||||
|
||||
Constraint for the column widths.
|
||||
## logs.warning.format
|
||||
|
||||
Type: nullable list of [Constraint](https://xplr.dev/en/layouts#constraint)
|
||||
Type: string
|
||||
|
||||
#### xplr.config.general.selection.item.format
|
||||
The string that indicates a warning in logs.
|
||||
|
||||
Renderer for each item in the selection list.
|
||||
## logs.warning.style
|
||||
|
||||
Type: nullable string
|
||||
Type: [Style][1]
|
||||
|
||||
#### xplr.config.general.selection.item.style
|
||||
Style for warnings in logs.
|
||||
|
||||
Style for each item in the selection list.
|
||||
## default_ui.prefix
|
||||
|
||||
Type: [Style](https://xplr.dev/en/style)
|
||||
Type: nullable string
|
||||
|
||||
#### xplr.config.general.search.algorithm
|
||||
The content that is placed before the item name for each row.
|
||||
|
||||
The default search algorithm
|
||||
## default_ui.suffix
|
||||
|
||||
Type: [Search Algorithm](https://xplr.dev/en/searching#algorithm)
|
||||
Type: nullable string
|
||||
|
||||
#### xplr.config.general.search.unordered
|
||||
The content which is appended to each item name for each row.
|
||||
|
||||
The default search ordering
|
||||
## default_ui.style
|
||||
|
||||
Type: boolean
|
||||
Type: [Style][1]
|
||||
|
||||
#### xplr.config.general.default_ui.prefix
|
||||
Style for the default user interface.
|
||||
|
||||
The content that is placed before the item name for each row by default.
|
||||
## focus_ui.prefix
|
||||
|
||||
Type: nullable string
|
||||
|
||||
#### xplr.config.general.default_ui.suffix
|
||||
The string placed before the item name for a focused row.
|
||||
|
||||
The content which is appended to each item name for each row by default.
|
||||
## focus_ui.suffix
|
||||
|
||||
Type: nullable string
|
||||
|
||||
#### xplr.config.general.default_ui.style
|
||||
The string placed after the item name for a focused row.
|
||||
|
||||
The default style of each item for each row.
|
||||
## focus_ui.style
|
||||
|
||||
Type: [Style](https://xplr.dev/en/style)
|
||||
Type: [Style][1]
|
||||
|
||||
#### xplr.config.general.focus_ui.prefix
|
||||
Style for focused elements.
|
||||
|
||||
The string placed before the item name for a focused row.
|
||||
## selection_ui.prefix
|
||||
|
||||
Type: nullable string
|
||||
|
||||
#### xplr.config.general.focus_ui.suffix
|
||||
The string that is placed before the item name for a selected row.
|
||||
|
||||
The string placed after the item name for a focused row.
|
||||
## selection_ui.suffix
|
||||
|
||||
Type: nullable string
|
||||
|
||||
#### xplr.config.general.focus_ui.style
|
||||
|
||||
Style for focused item.
|
||||
Type: [Style](https://xplr.dev/en/style)
|
||||
|
||||
#### xplr.config.general.selection_ui.prefix
|
||||
|
||||
The string placed before the item name for a selected row.
|
||||
|
||||
Type: nullable string
|
||||
|
||||
#### xplr.config.general.selection_ui.suffix
|
||||
|
||||
The string placed after the item name for a selected row.
|
||||
|
||||
Type: nullable string
|
||||
## selection_ui.style
|
||||
|
||||
#### xplr.config.general.selection_ui.style
|
||||
Type: [Style][1]
|
||||
|
||||
Style for selected rows.
|
||||
|
||||
Type: [Style](https://xplr.dev/en/style)
|
||||
## focus_selection_ui.prefix
|
||||
|
||||
#### xplr.config.general.focus_selection_ui.prefix
|
||||
Type: nullable string
|
||||
|
||||
The string placed before item name for a selected row that gets the focus.
|
||||
|
||||
Type: nullable string
|
||||
## focus_selection_ui.suffix
|
||||
|
||||
#### xplr.config.general.focus_selection_ui.suffix
|
||||
Type: nullable string
|
||||
|
||||
The string placed after the item name for a selected row that gets the focus.
|
||||
|
||||
Type: nullable string
|
||||
## focus_selection_ui.style
|
||||
|
||||
#### xplr.config.general.focus_selection_ui.style
|
||||
Type: [Style][1]
|
||||
|
||||
Style for a selected row that gets the focus.
|
||||
|
||||
Type: [Style](https://xplr.dev/en/style)
|
||||
|
||||
#### xplr.config.general.sort_and_filter_ui.separator.format
|
||||
|
||||
The shape of the separator for the Sort & filter panel.
|
||||
## sort_and_filter_ui.separator.format
|
||||
|
||||
Type: nullable string
|
||||
|
||||
#### xplr.config.general.sort_and_filter_ui.separator.style
|
||||
The shape of the separator for the `Sort & filter` panel.
|
||||
|
||||
The style of the separator for the Sort & filter panel.
|
||||
## sort_and_filter_ui.separator.style
|
||||
|
||||
Type: [Style](https://xplr.dev/en/style)
|
||||
Type: [Style][1]
|
||||
|
||||
#### xplr.config.general.sort_and_filter_ui.default_identifier.format
|
||||
Style for `Sort & filter` panel separator.
|
||||
|
||||
The content of the default identifier in Sort & filter panel.
|
||||
## sort_and_filter_ui.default_identifier.format
|
||||
|
||||
Type: nullable string
|
||||
|
||||
#### xplr.config.general.sort_and_filter_ui.default_identifier.style
|
||||
The content of the default identifier in `Sort & filter` panel.
|
||||
|
||||
Style for the default identifier in Sort & filter panel.
|
||||
## sort_and_filter_ui.default_identifier.style
|
||||
|
||||
Type: [Style](https://xplr.dev/en/style)
|
||||
Type: [Style][1]
|
||||
|
||||
#### xplr.config.general.sort_and_filter_ui.sort_direction_identifiers.forward.format
|
||||
Style for the default identifier in `Sort & filter` panel.
|
||||
|
||||
The shape of the forward direction indicator for sort identifiers in Sort & filter panel.
|
||||
|
||||
Type: nullable string
|
||||
## sort_and_filter_ui.filter_identifiers
|
||||
|
||||
#### xplr.config.general.sort_and_filter_ui.sort_direction_identifiers.forward.style
|
||||
Type: Table with [filter name][8] as key
|
||||
|
||||
Style of forward direction indicator in Sort & filter panel.
|
||||
The value contains format field (string) and style field (Style), that define
|
||||
the content and style for the given filter.
|
||||
|
||||
Type: [Style](https://xplr.dev/en/style)
|
||||
Example:
|
||||
|
||||
#### xplr.config.general.sort_and_filter_ui.sort_direction_identifiers.reverse.format
|
||||
```lua
|
||||
xplr.config.general.sort_and_filter_ui.filter_identifiers.AbsolutePathDoesContain = {
|
||||
format = "abs=~",
|
||||
style = { add_modifiers = { "Bold" }, bg = nil, fg = nil, sub_modifiers = nil },
|
||||
}
|
||||
```
|
||||
|
||||
The shape of the reverse direction indicator for sort identifiers in Sort & filter panel.
|
||||
## sort_and_filter_ui.sort_direction_identifiers.forward.format
|
||||
|
||||
Type: nullable string
|
||||
|
||||
#### xplr.config.general.sort_and_filter_ui.sort_direction_identifiers.reverse.style
|
||||
|
||||
Style of reverse direction indicator in Sort & filter panel.
|
||||
|
||||
Type: [Style](https://xplr.dev/en/style)
|
||||
|
||||
#### xplr.config.general.sort_and_filter_ui.sorter_identifiers
|
||||
The shape of the forward direction indicator for sort identifiers in
|
||||
`Sort & filter` panel.
|
||||
|
||||
The identifiers used to denote applied sorters in the Sort & filter panel.
|
||||
## sort_and_filter_ui.sort_direction_identifiers.forward.style
|
||||
|
||||
Type: nullable mapping of the following key-value pairs:
|
||||
Type: [Style][1]
|
||||
|
||||
- key: [Sorter](https://xplr.dev/en/sorting#sorter)
|
||||
- value:
|
||||
- format: nullable string
|
||||
- style: [Style](https://xplr.dev/en/style)
|
||||
Style of forward direction indicator.
|
||||
|
||||
#### xplr.config.general.sort_and_filter_ui.filter_identifiers
|
||||
|
||||
The identifiers used to denote applied filters in the Sort & filter panel.
|
||||
|
||||
Type: nullable mapping of the following key-value pairs:
|
||||
|
||||
- key: [Filter](https://xplr.dev/en/filtering#filter)
|
||||
- value:
|
||||
- format: nullable string
|
||||
- style: [Style](https://xplr.dev/en/style)
|
||||
|
||||
#### xplr.config.general.sort_and_filter_ui.search_identifiers
|
||||
|
||||
The identifiers used to denote applied search input.
|
||||
|
||||
Type: { format = nullable string, style = [Style](https://xplr.dev/en/style) }
|
||||
|
||||
#### xplr.config.general.sort_and_filter_ui.search_direction_identifiers.ordered.format
|
||||
|
||||
The shape of ordered indicator for search ordering identifiers in Sort & filter panel.
|
||||
## sort_and_filter_ui.sort_direction_identifiers.reverse.format
|
||||
|
||||
Type: nullable string
|
||||
|
||||
#### xplr.config.general.sort_and_filter_ui.search_direction_identifiers.unordered.format
|
||||
The shape of the reverse direction indicator for sort identifiers in
|
||||
`Sort & filter` panel.
|
||||
|
||||
The shape of unordered indicator for search ordering identifiers in Sort & filter panel.
|
||||
## sort_and_filter_ui.sort_direction_identifiers.reverse.style
|
||||
|
||||
Type: nullable string
|
||||
|
||||
#### xplr.config.general.panel_ui.default.title.format
|
||||
|
||||
The content for panel title by default.
|
||||
|
||||
Type: nullable string
|
||||
|
||||
#### xplr.config.general.panel_ui.default.title.style
|
||||
Type: [Style][1]
|
||||
|
||||
The style for panel title by default.
|
||||
Style of reverse direction indicator.
|
||||
|
||||
Type: [Style](https://xplr.dev/en/style)
|
||||
## sort_and_filter_ui.sorter_identifiers
|
||||
|
||||
#### xplr.config.general.panel_ui.default.style
|
||||
Type: Table with [sorter name][9] as key
|
||||
|
||||
Style of the panels by default.
|
||||
The value contains format field (string) and style field (Style), that define
|
||||
the content and style for the given sorter.
|
||||
|
||||
Type: [Style](https://xplr.dev/en/style)
|
||||
Example:
|
||||
|
||||
#### xplr.config.general.panel_ui.default.borders
|
||||
```lua
|
||||
sort_and_filter_ui.sorter_identifiers.ByCanonicalAbsolutePath = {
|
||||
format = "[c]abs",
|
||||
style = { add_modifiers = nil, bg = nil, fg = "Yellow", sub_modifiers = nil },
|
||||
}
|
||||
```
|
||||
|
||||
Defines where to show borders for the panels by default.
|
||||
## panel_ui.default.borders
|
||||
|
||||
Type: nullable list of [Border](https://xplr.dev/en/borders#border)
|
||||
Type: nullable list of strings
|
||||
|
||||
#### xplr.config.general.panel_ui.default.border_type
|
||||
Defines where to show borders for the panels.
|
||||
|
||||
Type of the borders by default.
|
||||
The possible values are any combination of: "Top", "Bottom", "Left" and
|
||||
"Right".
|
||||
|
||||
Type: nullable [Border Type](https://xplr.dev/en/borders#border-type)
|
||||
Example:
|
||||
|
||||
#### xplr.config.general.panel_ui.default.border_style
|
||||
```lua
|
||||
-- Show Left and Right borders only
|
||||
xplr.config.general.panel_ui.default.borders = {
|
||||
"Right",
|
||||
"Left",
|
||||
}
|
||||
```
|
||||
|
||||
Style of the panel borders by default.
|
||||
## panel_ui.default.style
|
||||
|
||||
Type: [Style](https://xplr.dev/en/style)
|
||||
Type: [Style][1]
|
||||
|
||||
#### xplr.config.general.panel_ui.table.title.format
|
||||
Default style for panels.
|
||||
|
||||
The content for the table panel title.
|
||||
## panel_ui.default.title.format
|
||||
|
||||
Type: nullable string
|
||||
|
||||
#### xplr.config.general.panel_ui.table.title.style
|
||||
|
||||
Style of the table panel title.
|
||||
|
||||
Type: [Style](https://xplr.dev/en/style)
|
||||
The content for panel title.
|
||||
|
||||
#### xplr.config.general.panel_ui.table.style
|
||||
## panel_ui.default.title.style
|
||||
|
||||
Style of the table panel.
|
||||
Type: [Style][1]
|
||||
|
||||
Type: [Style](https://xplr.dev/en/style)
|
||||
Style for panel title.
|
||||
|
||||
#### xplr.config.general.panel_ui.table.borders
|
||||
## panel_ui.help_menu.borders
|
||||
|
||||
Defines where to show borders for the table panel.
|
||||
Type: nullable list of strings
|
||||
|
||||
Type: nullable list of [Border](https://xplr.dev/en/borders#border)
|
||||
Defines where to show borders for the `Help` panel.
|
||||
|
||||
#### xplr.config.general.panel_ui.table.border_type
|
||||
The possible values are any combination of: "Top", "Bottom", "Left" and
|
||||
"Right".
|
||||
|
||||
Type of the borders for table panel.
|
||||
## panel_ui.help_menu.style
|
||||
|
||||
Type: nullable [Border Type](https://xplr.dev/en/borders#border-type)
|
||||
Type: [Style][1]
|
||||
|
||||
#### xplr.config.general.panel_ui.table.border_style
|
||||
Style for `Help` panel.
|
||||
|
||||
Style of the table panel borders.
|
||||
|
||||
Type: [Style](https://xplr.dev/en/style)
|
||||
|
||||
#### xplr.config.general.panel_ui.help_menu.title.format
|
||||
|
||||
The content for the help menu panel title.
|
||||
## panel_ui.help_menu.title.format
|
||||
|
||||
Type: nullable string
|
||||
|
||||
#### xplr.config.general.panel_ui.help_menu.title.style
|
||||
|
||||
Style of the help menu panel title.
|
||||
|
||||
Type: [Style](https://xplr.dev/en/style)
|
||||
|
||||
#### xplr.config.general.panel_ui.help_menu.style
|
||||
|
||||
Style of the help menu panel.
|
||||
|
||||
Type: [Style](https://xplr.dev/en/style)
|
||||
The content for `Help` panel title.
|
||||
|
||||
#### xplr.config.general.panel_ui.help_menu.borders
|
||||
## panel_ui.help_menu.title.style
|
||||
|
||||
Defines where to show borders for the help menu panel.
|
||||
Type: [Style][1]
|
||||
|
||||
Type: nullable list of [Border](https://xplr.dev/en/borders#border)
|
||||
Style for `Help` panel title.
|
||||
|
||||
#### xplr.config.general.panel_ui.help_menu.border_type
|
||||
## panel_ui.input_and_logs.borders
|
||||
|
||||
Type of the borders for help menu panel.
|
||||
Type: nullable list of strings
|
||||
|
||||
Type: nullable [Border Type](https://xplr.dev/en/borders#border-type)
|
||||
Defines where to show borders for the `Input` & `Logs` panel.
|
||||
|
||||
#### xplr.config.general.panel_ui.help_menu.border_style
|
||||
The possible values are any combination of: "Top", "Bottom", "Left" and
|
||||
"Right".
|
||||
|
||||
Style of the help menu panel borders.
|
||||
## panel_ui.input_and_logs.style
|
||||
|
||||
Type: [Style](https://xplr.dev/en/style)
|
||||
Type: [Style][1]
|
||||
|
||||
#### xplr.config.general.panel_ui.input_and_logs.title.format
|
||||
Style for `Input` & `Logs` panel.
|
||||
|
||||
The content for the input & logs panel title.
|
||||
## panel_ui.input_and_logs.title.format
|
||||
|
||||
Type: nullable string
|
||||
|
||||
#### xplr.config.general.panel_ui.input_and_logs.title.style
|
||||
The content for the `Input` and `Logs` panel title.
|
||||
|
||||
Style of the input & logs panel title.
|
||||
## panel_ui.input_and_logs.title.style
|
||||
|
||||
Type: [Style](https://xplr.dev/en/style)
|
||||
Type: [Style][1]
|
||||
|
||||
#### xplr.config.general.panel_ui.input_and_logs.borders
|
||||
Style for `Input` & `Logs` panel title.
|
||||
|
||||
#### xplr.config.general.panel_ui.input_and_logs.style
|
||||
## panel_ui.selection.borders
|
||||
|
||||
Style of the input & logs panel.
|
||||
Type: nullable list of strings
|
||||
|
||||
Type: [Style](https://xplr.dev/en/style)
|
||||
Defines where to show borders for the input & logs panel.
|
||||
Defines where to show borders for the `Selection` panel.
|
||||
|
||||
Type: nullable list of [Border](https://xplr.dev/en/borders#border)
|
||||
The possible values are any combination of: "Top", "Bottom", "Left" and
|
||||
"Right".
|
||||
|
||||
#### xplr.config.general.panel_ui.input_and_logs.border_type
|
||||
## panel_ui.selection.style
|
||||
|
||||
Type of the borders for input & logs panel.
|
||||
Type: [Style][1]
|
||||
|
||||
Type: nullable [Border Type](https://xplr.dev/en/borders#border-type)
|
||||
Style for `Selection` panel.
|
||||
|
||||
#### xplr.config.general.panel_ui.input_and_logs.border_style
|
||||
|
||||
Style of the input & logs panel borders.
|
||||
|
||||
Type: [Style](https://xplr.dev/en/style)
|
||||
|
||||
#### xplr.config.general.panel_ui.selection.title.format
|
||||
|
||||
The content for the selection panel title.
|
||||
## panel_ui.selection.title.format
|
||||
|
||||
Type: nullable string
|
||||
|
||||
#### xplr.config.general.panel_ui.selection.title.style
|
||||
|
||||
Style of the selection panel title.
|
||||
|
||||
Type: [Style](https://xplr.dev/en/style)
|
||||
|
||||
#### xplr.config.general.panel_ui.selection.borders
|
||||
The content for `Selection` panel title.
|
||||
|
||||
#### xplr.config.general.panel_ui.selection.style
|
||||
## panel_ui.selection.title.style
|
||||
|
||||
Style of the selection panel.
|
||||
Type: [Style][1]
|
||||
|
||||
Type: [Style](https://xplr.dev/en/style)
|
||||
Defines where to show borders for the selection panel.
|
||||
Style for `Selection` panel title.
|
||||
|
||||
Type: nullable list of [Border](https://xplr.dev/en/borders#border)
|
||||
## panel_ui.sort_and_filter.borders
|
||||
|
||||
#### xplr.config.general.panel_ui.selection.border_type
|
||||
Type: nullable list of strings
|
||||
|
||||
Type of the borders for selection panel.
|
||||
Defines where to show borders for the `Sort & filter` panel.
|
||||
|
||||
Type: nullable [Border Type](https://xplr.dev/en/borders#border-type)
|
||||
The possible values are any combination of: "Top", "Bottom", "Left" and
|
||||
"Right".
|
||||
|
||||
#### xplr.config.general.panel_ui.selection.border_style
|
||||
## panel_ui.sort_and_filter.style
|
||||
|
||||
Style of the selection panel borders.
|
||||
Type: [Style][1]
|
||||
|
||||
Type: [Style](https://xplr.dev/en/style)
|
||||
Style for `Sort & filter` panel.
|
||||
|
||||
#### xplr.config.general.panel_ui.sort_and_filter.title.format
|
||||
|
||||
The content for the sort & filter panel title.
|
||||
|
||||
Type: nullable string
|
||||
|
||||
#### xplr.config.general.panel_ui.sort_and_filter.title.style
|
||||
|
||||
Style of the sort & filter panel title.
|
||||
|
||||
Type: [Style](https://xplr.dev/en/style)
|
||||
|
||||
#### xplr.config.general.panel_ui.sort_and_filter.style
|
||||
|
||||
Style of the sort & filter panel.
|
||||
|
||||
Type: [Style](https://xplr.dev/en/style)
|
||||
|
||||
#### xplr.config.general.panel_ui.sort_and_filter.borders
|
||||
|
||||
Defines where to show borders for the sort & filter panel.
|
||||
|
||||
Type: nullable list of [Border](https://xplr.dev/en/borders#border)
|
||||
|
||||
#### xplr.config.general.panel_ui.sort_and_filter.border_type
|
||||
|
||||
Type of the borders for sort & filter panel.
|
||||
|
||||
Type: nullable [Border Type](https://xplr.dev/en/borders#border-type)
|
||||
|
||||
#### xplr.config.general.panel_ui.sort_and_filter.border_style
|
||||
|
||||
Style of the sort & filter panel borders.
|
||||
|
||||
Type: [Style](https://xplr.dev/en/style)
|
||||
|
||||
#### xplr.config.general.initial_sorting
|
||||
|
||||
Initial group if sorters applied to the nodes list in the table.
|
||||
|
||||
Type: nullable list of [Node Sorter](https://xplr.dev/en/sorting#node-sorter-applicable)
|
||||
|
||||
#### xplr.config.general.initial_mode
|
||||
|
||||
The name of one of the modes to use when xplr loads.
|
||||
This isn't the default mode. To modify the default mode, overwrite
|
||||
[xplr.config.modes.builtin.default](https://xplr.dev/en/modes#xplrconfigmodesbuiltindefault).
|
||||
## panel_ui.sort_and_filter.title.format
|
||||
|
||||
Type: nullable string
|
||||
|
||||
#### xplr.config.general.initial_layout
|
||||
|
||||
The name of one of the layouts to use when xplr loads.
|
||||
This isn't the default layout. To modify the default layout, overwrite
|
||||
[xplr.config.layouts.builtin.default](https://xplr.dev/en/layouts#xplrconfiglayoutsbuiltindefault).
|
||||
|
||||
Type: nullable string
|
||||
The content for `Sort & filter` panel title.
|
||||
|
||||
#### xplr.config.general.start_fifo
|
||||
|
||||
Set it to a file path to start fifo when xplr loads.
|
||||
Generally it is used to integrate with external tools like previewers.
|
||||
|
||||
Type: nullable string
|
||||
## panel_ui.sort_and_filter.title.style
|
||||
|
||||
#### xplr.config.general.global_key_bindings
|
||||
Type: [Style][1]
|
||||
|
||||
Use it to define a set of key bindings that are available by default in
|
||||
every [mode](https://xplr.dev/en/mode). They can be overwritten.
|
||||
Style for `Sort & filter` panel title.
|
||||
|
||||
Type: [Key Bindings](https://xplr.dev/en/configure-key-bindings#key-bindings)
|
||||
[1]: style.md
|
||||
[2]: layouts.md
|
||||
[3]: modes.md
|
||||
[4]: sorting.md#node-sorter-applicable
|
||||
[5]: layouts.md#constraint
|
||||
[6]: #tableheadercols
|
||||
[7]: column-renderer.md
|
||||
[8]: filtering.md#filter
|
||||
[9]: sorting.md#sorter
|
||||
|
||||
@ -1,27 +0,0 @@
|
||||
# Input Operation
|
||||
|
||||
Cursor based input operation is a [sum type][3] can be one of the following:
|
||||
|
||||
- { SetCursor = int }
|
||||
- { InsertCharacter = str }
|
||||
- "GoToPreviousCharacter"
|
||||
- "GoToNextCharacter"
|
||||
- "GoToPreviousWord"
|
||||
- "GoToNextWord"
|
||||
- "GoToStart"
|
||||
- "GoToEnd"
|
||||
- "DeletePreviousCharacter"
|
||||
- "DeleteNextCharacter"
|
||||
- "DeletePreviousWord"
|
||||
- "DeleteNextWord"
|
||||
- "DeleteLine"
|
||||
- "DeleteTillEnd"
|
||||
|
||||
## Also See:
|
||||
|
||||
- [Message][1]
|
||||
- [Full List of Messages][2]
|
||||
|
||||
[1]: message.md
|
||||
[2]: messages.md
|
||||
[3]: sum-type.md
|
||||
@ -1,597 +0,0 @@
|
||||
# Layout
|
||||
|
||||
#### Example: Defining Custom Layout
|
||||
|
||||
```lua
|
||||
xplr.config.layouts.builtin.default = {
|
||||
Horizontal = {
|
||||
config = {
|
||||
margin = 1,
|
||||
horizontal_margin = 1,
|
||||
vertical_margin = 1,
|
||||
constraints = {
|
||||
{ Percentage = 50 },
|
||||
{ Percentage = 50 },
|
||||
}
|
||||
},
|
||||
splits = {
|
||||
"Table",
|
||||
"HelpMenu",
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Result:
|
||||
|
||||
```
|
||||
╭ /home ─────────────╮╭ Help [default] ────╮
|
||||
│ ╭─── path ││. show hidden │
|
||||
│ ├▸[ð Desktop/] ││/ search │
|
||||
│ ├ ð Documents/ ││: action │
|
||||
│ ├ ð Downloads/ ││? global help │
|
||||
│ ├ ð GitHub/ ││G go to bottom │
|
||||
│ ├ ð Music/ ││V select/unselect│
|
||||
│ ├ ð Pictures/ ││ctrl duplicate as │
|
||||
│ ├ ð Public/ ││ctrl next visit │
|
||||
╰────────────────────╯╰────────────────────╯
|
||||
```
|
||||
|
||||
A layout is a [sum type][56] can be one of the following:
|
||||
|
||||
- [Nothing][8]
|
||||
- [Table][9]
|
||||
- [InputAndLogs][10]
|
||||
- [Selection][11]
|
||||
- [HelpMenu][12]
|
||||
- [SortAndFilter][13]
|
||||
- [Static][25]
|
||||
- [Dynamic][26]
|
||||
- [Horizontal][14]
|
||||
- [Vertical][16]
|
||||
- CustomContent (deprecated, use `Static` or `Dynamic`)
|
||||
|
||||
### Nothing
|
||||
|
||||
This layout contains a blank panel.
|
||||
|
||||
Type: "Nothing"
|
||||
|
||||
### Table
|
||||
|
||||
This layout contains the table displaying the files and directories in the current
|
||||
directory.
|
||||
|
||||
### InputAndLogs
|
||||
|
||||
This layout contains the panel displaying the input prompt and logs.
|
||||
|
||||
Type: "InputAndLogs"
|
||||
|
||||
### Selection
|
||||
|
||||
This layout contains the panel displaying the selected paths.
|
||||
|
||||
Type: "Selection"
|
||||
|
||||
### HelpMenu
|
||||
|
||||
This layout contains the panel displaying the help menu for the current mode in
|
||||
real-time.
|
||||
|
||||
Type: "HelpMenu"
|
||||
|
||||
### SortAndFilter
|
||||
|
||||
This layout contains the panel displaying the pipeline of sorters and filters applied on
|
||||
the list of paths being displayed.
|
||||
|
||||
Type: "SortAndFilter"
|
||||
|
||||
### Static
|
||||
|
||||
This is a custom layout to render static content.
|
||||
|
||||
Type: { Static = [Custom Panel][27] }
|
||||
|
||||
### Dynamic
|
||||
|
||||
This is a custom layout to render dynamic content using a function defined in
|
||||
[xplr.fn][28] that takes [Content Renderer Argument][36] and returns [Custom Panel][27].
|
||||
|
||||
Type: { Dynamic = "[Content Renderer][35]" }
|
||||
|
||||
### Horizontal
|
||||
|
||||
This is a special layout that splits the panel into two horizontal parts.
|
||||
|
||||
It contains the following information:
|
||||
|
||||
- [config][15]
|
||||
- [splits][17]
|
||||
|
||||
Type: { Vertical = { config = [Layout Config][15], splits = { [Layout][17], ... } }
|
||||
|
||||
### Vertical
|
||||
|
||||
This is a special layout that splits the panel into two vertical parts.
|
||||
|
||||
It contains the following information:
|
||||
|
||||
- [config][15]
|
||||
- [splits][17]
|
||||
|
||||
Type: { Vertical = { config = [Layout Config][15], splits = { [Layout][17], ... } }
|
||||
|
||||
## Layout Config
|
||||
|
||||
A layout config contains the following information:
|
||||
|
||||
- [margin][18]
|
||||
- [horizontal_margin][19]
|
||||
- [vertical_margin][20]
|
||||
- [constraints][21]
|
||||
|
||||
### margin
|
||||
|
||||
Type: nullable integer
|
||||
|
||||
The width of the margin in all direction.
|
||||
|
||||
### horizontal_Margin
|
||||
|
||||
Type: nullable integer
|
||||
|
||||
The width of the horizontal margins. Overwrites the [margin][18] value.
|
||||
|
||||
### vertical_Margin
|
||||
|
||||
Type: nullable integer
|
||||
|
||||
The width of the vertical margins. Overwrites the [margin][18] value.
|
||||
|
||||
### constraints
|
||||
|
||||
Type: nullable list of [Constraint][22]
|
||||
|
||||
The constraints applied on the layout.
|
||||
|
||||
## Constraint
|
||||
|
||||
A constraint is a [sum type][56] can be one of the following:
|
||||
|
||||
- { Percentage = int }
|
||||
- { Ratio = { int, int } }
|
||||
- { Length = { int }
|
||||
- { LengthLessThanScreenHeight = int }
|
||||
- { LengthLessThanScreenWidth = int }
|
||||
- { LengthLessThanLayoutHeight = int }
|
||||
- { LengthLessThanLayoutWidth = int }
|
||||
- { Max = int }
|
||||
- { MaxLessThanScreenHeight = int }
|
||||
- { MaxLessThanScreenWidth = int }
|
||||
- { MaxLessThanLayoutHeight = int }
|
||||
- { MaxLessThanLayoutWidth = int }
|
||||
- { Min = int }
|
||||
- { MinLessThanScreenHeight = int }
|
||||
- { MinLessThanScreenWidth = int }
|
||||
- { MinLessThanLayoutHeight = int }
|
||||
- { MinLessThanLayoutWidth = int }
|
||||
|
||||
## splits
|
||||
|
||||
Type: list of [Layout][3]
|
||||
|
||||
The list of child layouts to fit into the parent layout.
|
||||
|
||||
## Custom Panel
|
||||
|
||||
Custom panel is a [sum type][56] can be one of the following:
|
||||
|
||||
- [CustomParagraph][29]
|
||||
- [CustomList][30]
|
||||
- [CustomTable][31]
|
||||
- [CustomLayout][55]
|
||||
|
||||
### CustomParagraph
|
||||
|
||||
A paragraph to render. It contains the following fields:
|
||||
|
||||
- **ui** (nullable [Panel UI Config][32]): Optional UI config for the panel.
|
||||
- **body** (string): The string to render.
|
||||
|
||||
#### Example: Render a custom static paragraph
|
||||
|
||||
```lua
|
||||
xplr.config.layouts.builtin.default = {
|
||||
Static = {
|
||||
CustomParagraph = {
|
||||
ui = { title = { format = " custom title " } },
|
||||
body = "custom body",
|
||||
},
|
||||
},
|
||||
}
|
||||
```
|
||||
|
||||
Result:
|
||||
|
||||
```
|
||||
╭ custom title ────────╮
|
||||
│custom body │
|
||||
│ │
|
||||
│ │
|
||||
╰──────────────────────╯
|
||||
```
|
||||
|
||||
#### Example: Render a custom dynamic paragraph
|
||||
|
||||
```lua
|
||||
xplr.config.layouts.builtin.default = { Dynamic = "custom.render_layout" }
|
||||
|
||||
xplr.fn.custom.render_layout = function(ctx)
|
||||
return {
|
||||
CustomParagraph = {
|
||||
ui = { title = { format = ctx.app.pwd } },
|
||||
body = xplr.util.to_yaml(ctx.app.focused_node),
|
||||
},
|
||||
}
|
||||
end
|
||||
```
|
||||
|
||||
Result:
|
||||
|
||||
```
|
||||
╭/home/sayanarijit───────────────────────────╮
|
||||
│mime_essence: inode/directory │
|
||||
│relative_path: Desktop │
|
||||
│is_symlink: false │
|
||||
│is_readonly: false │
|
||||
│parent: /home/sayanarijit │
|
||||
│absolute_path: /home/sayanarijit/Desktop │
|
||||
│is_broken: false │
|
||||
│created: 1668087850396758714 │
|
||||
│size: 4096 │
|
||||
│gid: 100 │
|
||||
╰────────────────────────────────────────────╯
|
||||
```
|
||||
|
||||
### CustomList
|
||||
|
||||
A list to render. It contains the following fields:
|
||||
|
||||
- **ui** (nullable [Panel UI Config][32]): Optional UI config for the panel.
|
||||
- **body** (list of string): The list of strings to display.
|
||||
|
||||
#### Example: Render a custom static list
|
||||
|
||||
```lua
|
||||
xplr.config.layouts.builtin.default = {
|
||||
Static = {
|
||||
CustomList = {
|
||||
ui = { title = { format = " custom title " } },
|
||||
body = { "1", "2", "3" },
|
||||
},
|
||||
},
|
||||
}
|
||||
```
|
||||
|
||||
Result:
|
||||
|
||||
```
|
||||
╭ custom title ─────────────╮
|
||||
│1 │
|
||||
│2 │
|
||||
│3 │
|
||||
│ │
|
||||
╰───────────────────────────╯
|
||||
```
|
||||
|
||||
#### Example: Render a custom dynamic list
|
||||
|
||||
```lua
|
||||
xplr.config.layouts.builtin.default = { Dynamic = "custom.render_layout" }
|
||||
|
||||
xplr.fn.custom.render_layout = function(ctx)
|
||||
return {
|
||||
CustomList = {
|
||||
ui = { title = { format = ctx.app.pwd } },
|
||||
body = {
|
||||
(ctx.app.focused_node or {}).relative_path or "",
|
||||
ctx.app.version,
|
||||
tostring(ctx.app.pid),
|
||||
},
|
||||
},
|
||||
}
|
||||
end
|
||||
```
|
||||
|
||||
Result:
|
||||
|
||||
```
|
||||
╭/home/sayanarijit──────────╮
|
||||
│Desktop │
|
||||
│0.21.2 │
|
||||
│17336 │
|
||||
│ │
|
||||
│ │
|
||||
╰───────────────────────────╯
|
||||
```
|
||||
|
||||
## CustomTable
|
||||
|
||||
A custom table to render. It contains the following fields:
|
||||
|
||||
- **ui** (nullable [Panel UI Config][32]): Optional UI config for the panel.
|
||||
- **widths** (list of [Constraint][22]): Width of the columns.
|
||||
- **col_spacing** (nullable int): Spacing between columns. Defaults to 1.
|
||||
- **body** (list of list of string): The rows and columns to render.
|
||||
|
||||
#### Example: Render a custom static table
|
||||
|
||||
```lua
|
||||
xplr.config.layouts.builtin.default = {
|
||||
Static = {
|
||||
CustomTable = {
|
||||
ui = { title = { format = " custom title " } },
|
||||
widths = {
|
||||
{ Percentage = 50 },
|
||||
{ Percentage = 50 },
|
||||
},
|
||||
body = {
|
||||
{ "a", "b" },
|
||||
{ "c", "d" },
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
```
|
||||
|
||||
Result:
|
||||
|
||||
```
|
||||
╭ custom title ────────────────────╮
|
||||
│a b │
|
||||
│c d │
|
||||
│ │
|
||||
│ │
|
||||
│ │
|
||||
╰──────────────────────────────────╯
|
||||
```
|
||||
|
||||
#### Example: Render a custom dynamic table
|
||||
|
||||
```lua
|
||||
xplr.config.layouts.builtin.default = {Dynamic = "custom.render_layout" }
|
||||
|
||||
xplr.fn.custom.render_layout = function(ctx)
|
||||
return {
|
||||
CustomTable = {
|
||||
ui = { title = { format = ctx.app.pwd } },
|
||||
widths = {
|
||||
{ Percentage = 50 },
|
||||
{ Percentage = 50 },
|
||||
},
|
||||
body = {
|
||||
{ "", "" },
|
||||
{ "Layout height", tostring(ctx.layout_size.height) },
|
||||
{ "Layout width", tostring(ctx.layout_size.width) },
|
||||
{ "", "" },
|
||||
{ "Screen height", tostring(ctx.screen_size.height) },
|
||||
{ "Screen width", tostring(ctx.screen_size.width) },
|
||||
},
|
||||
},
|
||||
}
|
||||
end
|
||||
```
|
||||
|
||||
Result:
|
||||
|
||||
```
|
||||
╭/home/sayanarijit───────────────────────────╮
|
||||
│ │
|
||||
│Layout height 12 │
|
||||
│Layout width 46 │
|
||||
│ │
|
||||
│Screen height 12 │
|
||||
│Screen width 46 │
|
||||
│ │
|
||||
│ │
|
||||
│ │
|
||||
│ │
|
||||
╰────────────────────────────────────────────╯
|
||||
```
|
||||
|
||||
### CustomLayout
|
||||
|
||||
A whole custom layout to render. It doesn't make sense to use it as a
|
||||
[Static][25] layout, but can be very useful to render as a [Dynamic][26] layout
|
||||
for use cases where the structure of the layout needs to change without having
|
||||
to switch modes.
|
||||
|
||||
> WARNING: Rendering the same dynamic custom layout recursively will result in
|
||||
> a ugly crash.
|
||||
|
||||
#### Example: Render a custom dynamic layout
|
||||
|
||||
```lua
|
||||
xplr.config.layouts.builtin.default = { Dynamic = "custom.render_layout" }
|
||||
|
||||
xplr.fn.custom.render_layout = function(ctx)
|
||||
local inner = {
|
||||
config = {
|
||||
constraints = {
|
||||
{ Percentage = 50 },
|
||||
{ Percentage = 50 },
|
||||
},
|
||||
},
|
||||
splits = {
|
||||
{ Static = { CustomParagraph = { body = "Try your luck..." } } },
|
||||
{ Static = { CustomParagraph = { body = "Press ctrl-r" } } },
|
||||
},
|
||||
}
|
||||
|
||||
local layout_type = "Vertical"
|
||||
if math.random(1, 2) == 1 then
|
||||
layout_type = "Horizontal"
|
||||
end
|
||||
|
||||
return { CustomLayout = { [layout_type] = inner } }
|
||||
end
|
||||
```
|
||||
|
||||
Result:
|
||||
|
||||
```
|
||||
╭─────────────────────╮╭─────────────────────╮
|
||||
│Try your luck... ││Press ctrl-r │
|
||||
│ ││ │
|
||||
│ ││ │
|
||||
│ ││ │
|
||||
│ ││ │
|
||||
│ ││ │
|
||||
│ ││ │
|
||||
│ ││ │
|
||||
│ ││ │
|
||||
│ ││ │
|
||||
╰─────────────────────╯╰─────────────────────╯
|
||||
```
|
||||
|
||||
Or
|
||||
|
||||
```
|
||||
╭────────────────────────────────────────────╮
|
||||
│Try your luck... │
|
||||
│ │
|
||||
│ │
|
||||
│ │
|
||||
╰────────────────────────────────────────────╯
|
||||
╭────────────────────────────────────────────╮
|
||||
│Press ctrl-r │
|
||||
│ │
|
||||
│ │
|
||||
│ │
|
||||
╰────────────────────────────────────────────╯
|
||||
```
|
||||
|
||||
## Panel UI Config
|
||||
|
||||
It contains the following optional fields:
|
||||
|
||||
- **title** ({ format = "string", style = [Style][33] }): the title of the panel.
|
||||
- **style** ([Style][33]): The style of the panel body.
|
||||
- **borders** (nullable list of [Border][34]): The shape of the borders.
|
||||
- **border_type** ([Border Type][54]): The type of the borders.
|
||||
- **border_style** ([Style][33]): The style of the borders.
|
||||
|
||||
## Content Renderer
|
||||
|
||||
It is a Lua function that receives [a special argument][36] as input and
|
||||
returns some output that can be rendered in the UI. It is used to render
|
||||
content body for the custom dynamic layouts.
|
||||
|
||||
## Content Renderer Argument
|
||||
|
||||
It contains the following information:
|
||||
|
||||
- [layout_size][37]
|
||||
- [screen_size][37]
|
||||
- [scrolltop][57]
|
||||
- [app][38]
|
||||
|
||||
### Size
|
||||
|
||||
It contains the following information:
|
||||
|
||||
- x
|
||||
- y
|
||||
- height
|
||||
- width
|
||||
|
||||
Every field is of integer type.
|
||||
|
||||
### scrolltop
|
||||
|
||||
Type: integer
|
||||
|
||||
The start index of the visible nodes in the table.
|
||||
|
||||
### app
|
||||
|
||||
This is a lightweight version of the [Lua Context][39]. In this context, the
|
||||
heavyweight fields like [directory_buffer][50] are omitted for performance
|
||||
reasons.
|
||||
|
||||
Hence, only the following fields are available.
|
||||
|
||||
- [version][40]
|
||||
- [pwd][41]
|
||||
- [initial_pwd][53]
|
||||
- [vroot][52]
|
||||
- [focused_node][42]
|
||||
- [selection][43]
|
||||
- [mode][44]
|
||||
- [layout][45]
|
||||
- [input_buffer][46]
|
||||
- [pid][47]
|
||||
- [session_path][48]
|
||||
- [explorer_config][49]
|
||||
|
||||
## Also See:
|
||||
|
||||
- [xplr.config.layouts][51]
|
||||
|
||||
[1]: #builtin
|
||||
[2]: #custom
|
||||
[3]: #layout
|
||||
[4]: #default
|
||||
[5]: #no_help
|
||||
[6]: #no_selection
|
||||
[7]: #no_help_no_selection
|
||||
[8]: #nothing
|
||||
[9]: #table
|
||||
[10]: #inputandlogs
|
||||
[11]: #selection
|
||||
[12]: #helpmenu
|
||||
[13]: #sortandfilter
|
||||
[14]: #horizontal
|
||||
[15]: #layout-config
|
||||
[16]: #vertical
|
||||
[17]: #splits
|
||||
[18]: #margin
|
||||
[19]: #horizontal_margin
|
||||
[20]: #vertical_margin
|
||||
[21]: #constraints
|
||||
[22]: #constraint
|
||||
[25]: #static
|
||||
[26]: #dynamic
|
||||
[27]: #custom-panel
|
||||
[28]: configuration.md#function
|
||||
[29]: #customparagraph
|
||||
[30]: #customlist
|
||||
[31]: #customtable
|
||||
[32]: #panel-ui-config
|
||||
[33]: style.md#style
|
||||
[34]: borders.md#border
|
||||
[35]: #content-renderer
|
||||
[36]: #content-renderer-argument
|
||||
[37]: #size
|
||||
[38]: #app
|
||||
[39]: lua-function-calls.md#lua-context
|
||||
[40]: lua-function-calls.md#version
|
||||
[41]: lua-function-calls.md#pwd
|
||||
[42]: lua-function-calls.md#focused_node
|
||||
[43]: lua-function-calls.md#selection
|
||||
[44]: lua-function-calls.md#mode
|
||||
[45]: lua-function-calls.md#layout
|
||||
[46]: lua-function-calls.md#input_buffer
|
||||
[47]: lua-function-calls.md#pid
|
||||
[48]: lua-function-calls.md#session_path
|
||||
[49]: lua-function-calls.md#explorer_config
|
||||
[50]: lua-function-calls.md#directory_buffer
|
||||
[51]: layouts.md
|
||||
[52]: lua-function-calls.md#vroot
|
||||
[53]: lua-function-calls.md#initial_pwd
|
||||
[54]: borders.md#border-type
|
||||
[55]: #customlayout
|
||||
[56]: sum-type.md
|
||||
[57]: #scrolltop
|
||||
@ -1,444 +0,0 @@
|
||||
# Lua Function Calls
|
||||
|
||||
xplr allows you to define lua functions using the `xplr.fn.custom` Lua API.
|
||||
|
||||
These functions can be called using messages like `CallLua`, `CallLuaSilently`.
|
||||
|
||||
When called the function receives a [special argument][14] that
|
||||
contains some useful information. The function can optionally return a list of
|
||||
messages which will be handled by xplr.
|
||||
|
||||
## Example: Using Lua Function Calls
|
||||
|
||||
```lua
|
||||
-- Define the function
|
||||
xplr.fn.custom.ask_name_and_greet = function(app)
|
||||
print("What's your name?")
|
||||
|
||||
local name = io.read()
|
||||
local greeting = "Hello " .. name .. "!"
|
||||
local message = greeting .. " You are inside " .. app.pwd
|
||||
|
||||
return {
|
||||
{ LogSuccess = message },
|
||||
}
|
||||
end
|
||||
|
||||
-- Map the function to a key (space)
|
||||
xplr.config.modes.builtin.default.key_bindings.on_key.space = {
|
||||
help = "ask name and greet",
|
||||
messages = {
|
||||
{ CallLua = "custom.ask_name_and_greet" }
|
||||
}
|
||||
}
|
||||
|
||||
-- Now, when you press "space" in default mode, you will be prompted for your
|
||||
-- name. Enter your name to receive a nice greeting and to know your location.
|
||||
```
|
||||
|
||||
Visit the [xplr.util][85] API docs for some useful utility / helper functions
|
||||
that you can use in your Lua function calls.
|
||||
|
||||
## Lua Context
|
||||
|
||||
This is a special argument passed to the lua functions when called using the
|
||||
`CallLua`, `CallLuaSilently` messages.
|
||||
|
||||
It contains the following information:
|
||||
|
||||
- [version][29]
|
||||
- [pwd][31]
|
||||
- [initial_pwd][76]
|
||||
- [vroot][75]
|
||||
- [focused_node][32]
|
||||
- [directory_buffer][33]
|
||||
- [selection][34]
|
||||
- [mode][35]
|
||||
- [layout][36]
|
||||
- [input_buffer][37]
|
||||
- [pid][38]
|
||||
- [session_path][39]
|
||||
- [explorer_config][40]
|
||||
- [history][41]
|
||||
- [last_modes][42]
|
||||
|
||||
### version
|
||||
|
||||
Type: string
|
||||
|
||||
xplr version. Can be used to test compatibility.
|
||||
|
||||
### pwd
|
||||
|
||||
Type: string
|
||||
|
||||
The present working directory.
|
||||
|
||||
### initial_pwd
|
||||
|
||||
Type: string
|
||||
|
||||
The initial working directory when xplr started.
|
||||
|
||||
### vroot
|
||||
|
||||
Type: nullable string
|
||||
|
||||
The current virtual root.
|
||||
|
||||
### focused_node
|
||||
|
||||
Type: nullable [Node][44]
|
||||
|
||||
The node under focus.
|
||||
|
||||
### directory_buffer
|
||||
|
||||
Type: nullable [Directory Buffer][62]
|
||||
|
||||
The directory buffer being rendered.
|
||||
|
||||
### selection
|
||||
|
||||
Type: list of selected [Node][44]s
|
||||
|
||||
The selected nodes.
|
||||
|
||||
### mode
|
||||
|
||||
Type: [Mode][8]
|
||||
|
||||
Current mode.
|
||||
|
||||
### layout
|
||||
|
||||
Type: [Layout][11]
|
||||
|
||||
Current layout.
|
||||
|
||||
### input_buffer
|
||||
|
||||
Type: nullable string
|
||||
|
||||
The input buffer.
|
||||
|
||||
### pid
|
||||
|
||||
Type: integer
|
||||
|
||||
The xplr session PID.
|
||||
|
||||
### session_path
|
||||
|
||||
Type: string
|
||||
|
||||
The session path.
|
||||
|
||||
### explorer_config
|
||||
|
||||
Type: [Explorer Config][66]
|
||||
|
||||
The configuration for exploring paths.
|
||||
|
||||
### history
|
||||
|
||||
Type: [History][70]
|
||||
|
||||
### last_modes
|
||||
|
||||
Type: list of [Mode][8]
|
||||
|
||||
Last modes, not popped yet.
|
||||
|
||||
## Node
|
||||
|
||||
A node contains the following fields:
|
||||
|
||||
- [parent][45]
|
||||
- [relative_path][46]
|
||||
- [absolute_path][47]
|
||||
- [extension][48]
|
||||
- [is_symlink][49]
|
||||
- [is_broken][50]
|
||||
- [is_dir][51]
|
||||
- [is_file][52]
|
||||
- [is_readonly][53]
|
||||
- [mime_essence][54]
|
||||
- [size][55]
|
||||
- [human_size][56]
|
||||
- [permissions][57]
|
||||
- [created][71]
|
||||
- [last_modified][72]
|
||||
- [uid][73]
|
||||
- [gid][74]
|
||||
- [canonical][58]
|
||||
- [symlink][59]
|
||||
|
||||
### parent
|
||||
|
||||
Type: string
|
||||
|
||||
The parent path of the node.
|
||||
|
||||
### relative_path
|
||||
|
||||
Type: string
|
||||
|
||||
The path relative to the parent, i.e. the file/directory name with extension.
|
||||
|
||||
### absolute_path
|
||||
|
||||
Type: string
|
||||
|
||||
The absolute path (without resolving symlinks) of the node.
|
||||
|
||||
### extension
|
||||
|
||||
Type: string
|
||||
|
||||
The extension of the node.
|
||||
|
||||
### is_symlink
|
||||
|
||||
Type: boolean
|
||||
|
||||
`true` if the node is a symlink.
|
||||
|
||||
### is_broken
|
||||
|
||||
Type: boolean
|
||||
|
||||
`true` if the node is a broken symlink.
|
||||
|
||||
### is_dir
|
||||
|
||||
Type: boolean
|
||||
|
||||
`true` if the node is a directory.
|
||||
|
||||
### is_file
|
||||
|
||||
Type: boolean
|
||||
|
||||
`true` if the node is a file.
|
||||
|
||||
### is_readonly
|
||||
|
||||
Type: boolean
|
||||
|
||||
`true` if the node is real-only.
|
||||
|
||||
### mime_essence
|
||||
|
||||
Type: string
|
||||
|
||||
The mime type of the node. For e.g. `text/csv`, `image/jpeg` etc.
|
||||
|
||||
### size
|
||||
|
||||
Type: integer
|
||||
|
||||
The size of the exact node. The size of a directory won't be calculated
|
||||
recursively.
|
||||
|
||||
### human_size
|
||||
|
||||
Type: string
|
||||
|
||||
Like size but in human readable format.
|
||||
|
||||
### permissions
|
||||
|
||||
Type: [Permission][60]
|
||||
|
||||
The [permissions][60] applied to the node.
|
||||
|
||||
### created
|
||||
|
||||
Type: nullable integer
|
||||
|
||||
Creation time in nanosecond since UNIX epoch.
|
||||
|
||||
### last_modified
|
||||
|
||||
Type: nullable integer
|
||||
|
||||
Last modification time in nanosecond since UNIX epoch.
|
||||
|
||||
### uid
|
||||
|
||||
Type: integer
|
||||
|
||||
User ID of the file owner.
|
||||
|
||||
### gid
|
||||
|
||||
Type: integer
|
||||
|
||||
Group ID of the file owner.
|
||||
|
||||
### canonical
|
||||
|
||||
Type: nullable [Resolved Node Metadata][61]
|
||||
|
||||
If the node is a symlink, it will hold information about the symlink resolved
|
||||
node. Else, it will hold information the actual node. It the symlink is broken,
|
||||
it will be null.
|
||||
|
||||
### symlink
|
||||
|
||||
Type: nullable [Resolved Node Metadata][61]
|
||||
|
||||
If the node is a symlink and is not broken, it will hold information about the
|
||||
symlink resolved node. However, it will never hold information about the actual
|
||||
node. It will instead be null.
|
||||
|
||||
## Directory Buffer
|
||||
|
||||
Directory buffer contains the following fields:
|
||||
|
||||
- [parent][45]
|
||||
- [nodes][63]
|
||||
- [total][64]
|
||||
- [focus][65]
|
||||
|
||||
### parent
|
||||
|
||||
Type: string
|
||||
|
||||
The parent path of the node.
|
||||
|
||||
### nodes
|
||||
|
||||
Type: list of [Node][44]s
|
||||
|
||||
A list of visible nodes.
|
||||
|
||||
### total
|
||||
|
||||
Type: int
|
||||
|
||||
The count of nodes being rendered.
|
||||
|
||||
### focus
|
||||
|
||||
Type: int
|
||||
|
||||
The index of the node under focus. It can be `0` even when there's no node to
|
||||
focus on.
|
||||
|
||||
## History
|
||||
|
||||
History contains the following fields:
|
||||
|
||||
- [loc][68]
|
||||
- [paths][69]
|
||||
|
||||
### loc
|
||||
|
||||
Type: int
|
||||
|
||||
Location of the current path in history.
|
||||
|
||||
### paths
|
||||
|
||||
Type: list of string
|
||||
|
||||
Visited paths.
|
||||
|
||||
## Explorer Config
|
||||
|
||||
Explorer config contains the following fields:
|
||||
|
||||
- [filters][77]
|
||||
- [sorters][78]
|
||||
- [searcher][79]
|
||||
|
||||
### filters
|
||||
|
||||
List of filters to apply.
|
||||
|
||||
Type: list of [Node Filter Applicable][80]
|
||||
|
||||
### sorters
|
||||
|
||||
Add list or sorters to the pipeline.
|
||||
|
||||
Type: list of [Node Sorter Applicable][81]
|
||||
|
||||
### searcher
|
||||
|
||||
The searcher to use (if any).
|
||||
|
||||
Type: nullable [Node Searcher Applicable][82]
|
||||
|
||||
## Also See:
|
||||
|
||||
- [xplr.util][85]
|
||||
|
||||
[7]: https://www.json.org
|
||||
[8]: modes.md#mode
|
||||
[9]: modes.md#builtin
|
||||
[10]: modes.md#custom
|
||||
[11]: layouts.md
|
||||
[12]: layouts.md#builtin
|
||||
[13]: layouts.md#custom
|
||||
[14]: #lua-context
|
||||
[15]: filtering.md#filter
|
||||
[16]: filtering.md
|
||||
[17]: sorting.md#sorter
|
||||
[29]: #version
|
||||
[30]: #config
|
||||
[31]: #pwd
|
||||
[32]: #focused_node
|
||||
[33]: #directory_buffer
|
||||
[34]: #selection
|
||||
[35]: #mode
|
||||
[36]: #layout
|
||||
[37]: #input_buffer
|
||||
[38]: #pid
|
||||
[39]: #session_path
|
||||
[40]: #explorer_config
|
||||
[41]: #history
|
||||
[42]: #last_modes
|
||||
[43]: configuration.md#config
|
||||
[44]: #node
|
||||
[45]: #parent
|
||||
[46]: #relative_path
|
||||
[47]: #absolute_path
|
||||
[48]: #extension
|
||||
[49]: #is_symlink
|
||||
[50]: #is_broken
|
||||
[51]: #is_dir
|
||||
[52]: #is_file
|
||||
[53]: #is_readonly
|
||||
[54]: #mime_essence
|
||||
[55]: #size
|
||||
[56]: #human_size
|
||||
[57]: #permissions
|
||||
[58]: #canonical
|
||||
[59]: #symlink
|
||||
[60]: column-renderer.md#permission
|
||||
[61]: column-renderer.md#resolved-node-metadata
|
||||
[62]: #directory-buffer
|
||||
[63]: #nodes
|
||||
[64]: #total
|
||||
[65]: #focus
|
||||
[66]: #explorer-config
|
||||
[67]: #history
|
||||
[68]: #loc
|
||||
[69]: #paths
|
||||
[70]: #history-1
|
||||
[71]: #created
|
||||
[72]: #last_modified
|
||||
[73]: #uid
|
||||
[74]: #gid
|
||||
[75]: #vroot
|
||||
[76]: #initial_pwd
|
||||
[77]: #filters
|
||||
[78]: #sorters
|
||||
[79]: #searcher
|
||||
[80]: filtering.md#node-filter-applicable
|
||||
[81]: sorting.md#node-sorter-applicable
|
||||
[82]: searching.md#node-searcher-applicable
|
||||
[85]: xplr.util.md
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -1,66 +0,0 @@
|
||||
# Mode
|
||||
|
||||
A mode contains the following information:
|
||||
|
||||
- [name][5]
|
||||
- [help][6]
|
||||
- [extra_help][7]
|
||||
- [key_bindings][9]
|
||||
- [layout][10]
|
||||
- [prompt][13]
|
||||
|
||||
### name
|
||||
|
||||
Type: string
|
||||
|
||||
This is the name of the mode visible in the help menu.
|
||||
|
||||
### help
|
||||
|
||||
Type: nullable string
|
||||
|
||||
If specified, the help menu will display this instead of the auto generated
|
||||
mappings.
|
||||
|
||||
### extra_help
|
||||
|
||||
Type: nullable string
|
||||
|
||||
If specified, the help menu will display this along-side the auto generated
|
||||
help menu.
|
||||
|
||||
### key_bindings
|
||||
|
||||
Type: [Key Bindings][8]
|
||||
|
||||
The key bindings available in that mode.
|
||||
|
||||
### layout
|
||||
|
||||
Type: nullable [Layout][11]
|
||||
|
||||
If specified, this layout will be used to render the UI.
|
||||
|
||||
### prompt
|
||||
|
||||
Type: nullable string
|
||||
|
||||
If set, this prompt will be displayed in the input buffer when in this mode.
|
||||
|
||||
## Also See:
|
||||
|
||||
- [xplr.config.modes][12]
|
||||
|
||||
[1]: #builtin
|
||||
[2]: #custom
|
||||
[3]: #mode
|
||||
[4]: default-key-bindings.md
|
||||
[5]: #name
|
||||
[6]: #help
|
||||
[7]: #extra_help
|
||||
[8]: configure-key-bindings.md#key-bindings
|
||||
[9]: #key_bindings
|
||||
[10]: #layout
|
||||
[11]: layout.md#layout
|
||||
[12]: modes.md
|
||||
[13]: #prompt
|
||||
@ -1,192 +1,128 @@
|
||||
### Modes
|
||||
# Modes
|
||||
|
||||
xplr is a modal file explorer. That means the users switch between different
|
||||
modes, each containing a different set of key bindings to avoid clashes.
|
||||
Users can switch between these modes at run-time.
|
||||
modes, each containing a different set of key bindings to avoid clashes. Users
|
||||
can switch between these modes at run-time.
|
||||
|
||||
The modes can be configured using the `xplr.config.modes` Lua API.
|
||||
|
||||
`xplr.config.modes.builtin` contain some built-in modes which can be
|
||||
overridden, but you can't add or remove modes in it.
|
||||
It contains the following fields:
|
||||
|
||||
#### xplr.config.modes.builtin.default
|
||||
- [builtin][1]
|
||||
- [custom][2]
|
||||
|
||||
The builtin default mode.
|
||||
Visit the [Default Key Bindings](https://xplr.dev/en/default-key-bindings)
|
||||
to see what each mode does.
|
||||
## builtin
|
||||
|
||||
Type: [Mode](https://xplr.dev/en/mode)
|
||||
Type: mapping of string and [Mode][3]
|
||||
|
||||
#### xplr.config.modes.builtin.debug_error
|
||||
This is exposed by the `xplr.config.modes.builtin` API.
|
||||
|
||||
The builtin debug error mode.
|
||||
xplr by default provides the following builtin modes:
|
||||
|
||||
Type: [Mode](https://xplr.dev/en/mode)
|
||||
- default
|
||||
- recover
|
||||
- selection_ops
|
||||
- create
|
||||
- create_directory
|
||||
- create_file
|
||||
- number
|
||||
- go_to
|
||||
- rename
|
||||
- delete
|
||||
- action
|
||||
- search
|
||||
- filter
|
||||
- relative_path_does_contain
|
||||
- relative_path_does_not_contain
|
||||
- sort
|
||||
- switch_layout
|
||||
- quit
|
||||
|
||||
#### xplr.config.modes.builtin.recover
|
||||
Visit the [Default Key Bindings][4] to see what each mode
|
||||
does.
|
||||
|
||||
The builtin recover mode.
|
||||
## custom
|
||||
|
||||
Type: [Mode](https://xplr.dev/en/mode)
|
||||
Type: mapping of string and [Mode][3]
|
||||
|
||||
#### xplr.config.modes.builtin.go_to_path
|
||||
This is exposed by the `xplr.config.modes.custom` API.
|
||||
|
||||
The builtin go to path mode.
|
||||
It allows the users to define custom modes.
|
||||
|
||||
Type: [Mode](https://xplr.dev/en/mode)
|
||||
|
||||
#### xplr.config.modes.builtin.move_to
|
||||
|
||||
The builtin move_to mode.
|
||||
|
||||
Type: [Mode](https://xplr.dev/en/mode)
|
||||
|
||||
#### xplr.config.modes.builtin.copy_to
|
||||
|
||||
The builtin copy_to mode.
|
||||
|
||||
Type: [Mode](https://xplr.dev/en/mode)
|
||||
|
||||
#### xplr.config.modes.builtin.selection_ops
|
||||
|
||||
The builtin selection ops mode.
|
||||
|
||||
Type: [Mode](https://xplr.dev/en/mode)
|
||||
|
||||
#### xplr.config.modes.builtin.create
|
||||
|
||||
The builtin create mode.
|
||||
|
||||
Type: [Mode](https://xplr.dev/en/mode)
|
||||
|
||||
#### xplr.config.modes.builtin.create_directory
|
||||
|
||||
The builtin create directory mode.
|
||||
|
||||
Type: [Mode](https://xplr.dev/en/mode)
|
||||
|
||||
#### xplr.config.modes.builtin.create_file
|
||||
|
||||
The builtin create file mode.
|
||||
|
||||
Type: [Mode](https://xplr.dev/en/mode)
|
||||
|
||||
#### xplr.config.modes.builtin.number
|
||||
|
||||
The builtin number mode.
|
||||
|
||||
Type: [Mode](https://xplr.dev/en/mode)
|
||||
|
||||
#### xplr.config.modes.builtin.go_to
|
||||
|
||||
The builtin go to mode.
|
||||
|
||||
Type: [Mode](https://xplr.dev/en/mode)
|
||||
|
||||
#### xplr.config.modes.builtin.rename
|
||||
|
||||
The builtin rename mode.
|
||||
|
||||
Type: [Mode](https://xplr.dev/en/mode)
|
||||
|
||||
#### xplr.config.modes.builtin.duplicate_as
|
||||
|
||||
The builtin duplicate as mode.
|
||||
|
||||
Type: [Mode](https://xplr.dev/en/mode)
|
||||
|
||||
#### xplr.config.modes.builtin.delete
|
||||
|
||||
The builtin delete mode.
|
||||
|
||||
Type: [Mode](https://xplr.dev/en/mode)
|
||||
|
||||
#### xplr.config.modes.builtin.action
|
||||
|
||||
The builtin action mode.
|
||||
|
||||
Type: [Mode](https://xplr.dev/en/mode)
|
||||
|
||||
#### xplr.config.modes.builtin.quit
|
||||
|
||||
The builtin quit mode.
|
||||
|
||||
Type: [Mode](https://xplr.dev/en/mode)
|
||||
|
||||
#### xplr.config.modes.builtin.search
|
||||
|
||||
The builtin search mode.
|
||||
|
||||
Type: [Mode](https://xplr.dev/en/mode)
|
||||
|
||||
#### xplr.config.modes.builtin.filter
|
||||
|
||||
The builtin filter mode.
|
||||
|
||||
Type: [Mode](https://xplr.dev/en/mode)
|
||||
|
||||
#### xplr.config.modes.builtin.relative_path_does_match_regex
|
||||
|
||||
The builtin relative_path_does_match_regex mode.
|
||||
|
||||
Type: [Mode](https://xplr.dev/en/mode)
|
||||
Example:
|
||||
|
||||
#### xplr.config.modes.builtin.relative_path_does_not_match_regex
|
||||
```lua
|
||||
xplr.config.modes.custom.example = {
|
||||
name = "example",
|
||||
key_bindings = {
|
||||
on_key = {
|
||||
enter = {
|
||||
help = "default mode",
|
||||
messages = {
|
||||
"PopMode",
|
||||
{ SwitchModeBuiltin = "default" }
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
The builtin relative_path_does_not_match_regex mode.
|
||||
xplr.config.general.initial_mode = "example"
|
||||
|
||||
Type: [Mode](https://xplr.dev/en/mode)
|
||||
-- when you load xplr, you should be in the "example" mode,
|
||||
-- pressing "enter" should take you to the "default" mode.
|
||||
```
|
||||
|
||||
#### xplr.config.modes.builtin.sort
|
||||
## Mode
|
||||
|
||||
The builtin sort mode.
|
||||
A mode contains the following information:
|
||||
|
||||
Type: [Mode](https://xplr.dev/en/mode)
|
||||
- [name][5]
|
||||
- [help][6]
|
||||
- [extra_help][7]
|
||||
- [key_bindings][8]
|
||||
- [layout][10]
|
||||
|
||||
#### xplr.config.modes.builtin.switch_layout
|
||||
### name
|
||||
|
||||
The builtin switch layout mode.
|
||||
Type: string
|
||||
|
||||
Type: [Mode](https://xplr.dev/en/mode)
|
||||
This is the name of the mode visible in the help menu.
|
||||
|
||||
#### xplr.config.modes.builtin.vroot
|
||||
### help
|
||||
|
||||
The builtin vroot mode.
|
||||
Type: nullable string
|
||||
|
||||
Type: [Mode](https://xplr.dev/en/mode)
|
||||
If specified, the help menu will display this instead of the auto generated
|
||||
mappings.
|
||||
|
||||
#### xplr.config.modes.builtin.edit_permissions
|
||||
### extra_help
|
||||
|
||||
The builtin edit permissions mode.
|
||||
Type: nullable string
|
||||
|
||||
Type: [Mode](https://xplr.dev/en/mode)
|
||||
If specified, the help menu will display this along-side the auto generated
|
||||
help menu.
|
||||
|
||||
#### xplr.config.modes.custom
|
||||
### key_bindings
|
||||
|
||||
This is where you define custom modes.
|
||||
Type: [Key Bindings][9]
|
||||
|
||||
Type: mapping of the following key-value pairs:
|
||||
The key bindings available in that mode.
|
||||
|
||||
- key: string
|
||||
- value: [Mode](https://xplr.dev/en/mode)
|
||||
### layout
|
||||
|
||||
Example:
|
||||
Type: nullable [Layout][11]
|
||||
|
||||
```lua
|
||||
xplr.config.modes.custom.example = {
|
||||
name = "example",
|
||||
key_bindings = {
|
||||
on_key = {
|
||||
enter = {
|
||||
help = "default mode",
|
||||
messages = {
|
||||
"PopMode",
|
||||
{ SwitchModeBuiltin = "default" },
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
If specified, this layout will be used to render the UI.
|
||||
|
||||
xplr.config.general.initial_mode = "example"
|
||||
```
|
||||
[1]: #builtin
|
||||
[2]: #custom
|
||||
[3]: #mode
|
||||
[4]: default-key-bindings.md
|
||||
[5]: #name
|
||||
[6]: #help
|
||||
[7]: #extra_help
|
||||
[8]: configure-key-bindings.md#key-bindings
|
||||
[9]: #key-bindings
|
||||
[10]: #layout
|
||||
[11]: layouts.md#Layout
|
||||
|
||||
@ -1,36 +0,0 @@
|
||||
# Node Type
|
||||
|
||||
A node-type contains the following fields:
|
||||
|
||||
- [meta][4]
|
||||
- [style][5]
|
||||
|
||||
### meta
|
||||
|
||||
Type: mapping of string and string
|
||||
|
||||
A meta field can contain custom metadata about a node. By default, the "icon"
|
||||
metadata is set for the [directory][1], [file][2], and
|
||||
[symlink][3] nodes.
|
||||
|
||||
Example:
|
||||
|
||||
```lua
|
||||
xplr.config.node_types.file = {
|
||||
meta = {
|
||||
icon = "f",
|
||||
foo = "bar",
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Also See:
|
||||
|
||||
- [xplr.config.node_types][6]
|
||||
|
||||
[1]: node_types.md#directory
|
||||
[2]: node_types.md#file
|
||||
[3]: node_types.md#symlink
|
||||
[4]: #meta
|
||||
[5]: style.md
|
||||
[6]: node_types.md
|
||||
@ -1,77 +0,0 @@
|
||||
# Searching
|
||||
|
||||
xplr supports searching paths using different algorithm. The search mechanism
|
||||
generally appears between filters and sorters in the `Sort & filter` panel.
|
||||
|
||||
Example:
|
||||
|
||||
```
|
||||
fzy:foo↓
|
||||
```
|
||||
|
||||
This line means that the nodes visible on the table are being filtered using the
|
||||
[fuzzy matching][1] algorithm on the input `foo`. The arrow means that ranking based
|
||||
ordering is being applied, i.e. [sorters][2] are being ignored.
|
||||
|
||||
## Node Searcher Applicable
|
||||
|
||||
Node Searcher contains the following fields:
|
||||
|
||||
- [pattern][3]
|
||||
- [recoverable_focus][4]
|
||||
- [algorithm][5]
|
||||
- [unordered][7]
|
||||
|
||||
### pattern
|
||||
|
||||
The patterns used to search.
|
||||
|
||||
Type: string
|
||||
|
||||
### recoverable_focus
|
||||
|
||||
Where to focus when search is cancelled.
|
||||
|
||||
Type: nullable string
|
||||
|
||||
### algorithm
|
||||
|
||||
Search algorithm to use. Defaults to the value set in
|
||||
[xplr.config.general.search.algorithm][8].
|
||||
|
||||
It can be one of the following:
|
||||
|
||||
- Fuzzy
|
||||
- Regex
|
||||
|
||||
### unordered
|
||||
|
||||
Whether to skip ordering the search result by algorithm based ranking. Defaults
|
||||
to the value set in [xplr.config.general.search.unordered][9].
|
||||
|
||||
Type: boolean
|
||||
|
||||
## Example:
|
||||
|
||||
```lua
|
||||
local searcher = {
|
||||
pattern = "pattern to search",
|
||||
recoverable_focus = "/path/to/focus/on/cancel",
|
||||
algorithm = "Fuzzy",
|
||||
unordered = false,
|
||||
}
|
||||
|
||||
xplr.util.explore({ searcher = searcher })
|
||||
```
|
||||
|
||||
See [xplr.util.explore][6].
|
||||
|
||||
[1]: https://en.wikipedia.org/wiki/Approximate_string_matching
|
||||
[2]: sorting.md
|
||||
[3]: #pattern
|
||||
[4]: #recoverable_focus
|
||||
[5]: #algorithm
|
||||
[6]: xplr.util.md#xplrutilexplore
|
||||
[7]: #unordered
|
||||
[8]: general-config.md#xplrconfiggeneralsearchalgorithm
|
||||
[9]: general-config.md#xplrconfiggeneralsearchunordered
|
||||
@ -1,96 +0,0 @@
|
||||
# Sum Type
|
||||
|
||||
> This section isn't specific to xplr. However, since xplr configuration makes
|
||||
> heavy use of this particular data type, even though it isn't available in
|
||||
> most of the mainstream programming languages (yet), making it a wild or
|
||||
> unfamiliar concept for many, it's worth doing a quick introduction here.
|
||||
>
|
||||
> If you're already familiar with [Sum Type / Tagged Union][1] (e.g. Rust's
|
||||
> enum), you can skip ahead.
|
||||
|
||||
While reading this doc, you'll come across some data types like [Layout][2],
|
||||
[Color][4], [Message][3] etc. that says something like "x is a sum type that
|
||||
can be any of the following", and then you'll see a list of strings and/or lua
|
||||
tables just below.
|
||||
|
||||
Yes, they are actually sum types, i.e. they can be any of the given set of
|
||||
tagged variants listed there.
|
||||
|
||||
Notice the word "be". Unlike classes or structs (aka product types), they can't
|
||||
"have" values, they can only "be" the value, or rather, be one of the possible
|
||||
set of values.
|
||||
|
||||
Also notice the word "tagged". Unlike the single variant `null`, or the dual
|
||||
variant `boolean` types, the variants of sum types are tagged (i.e. named), and
|
||||
may further have, or be, value or values of any data type.
|
||||
|
||||
A simple example of a sum type is an enum. Many programming languages have
|
||||
them, but only a few modern programming languages allow nesting other types
|
||||
into a sum type.
|
||||
|
||||
```rust
|
||||
enum Color {
|
||||
Red,
|
||||
Green,
|
||||
}
|
||||
```
|
||||
|
||||
Here, `Color` can be one of two possible set of values: `Red` and `Green`, just
|
||||
like `boolean`, but unlike `boolean`, being tagged allows `Color` to have more
|
||||
than two variants if required, by changing the definition.
|
||||
|
||||
e.g.
|
||||
|
||||
```rust
|
||||
enum Color {
|
||||
Red,
|
||||
Green,
|
||||
Blue,
|
||||
}
|
||||
```
|
||||
|
||||
We'd document it here as:
|
||||
|
||||
> Result is a sum type that can be one of the following:
|
||||
>
|
||||
> - "Red"
|
||||
> - "Green"
|
||||
> - "Blue"
|
||||
|
||||
But some languages (like Rust, Haskell, Elm etc.) go even further, allowing us
|
||||
to associate each branch of the enum with further nested types like:
|
||||
|
||||
```rust
|
||||
enum Layout {
|
||||
Table,
|
||||
HelpMenu,
|
||||
Horizontal {
|
||||
config: LayoutConfig, // A product type (similar to class/struct)
|
||||
splits: Vec<Layout> // A list of "Layout"s (i.e. list of sum types)
|
||||
},
|
||||
}
|
||||
```
|
||||
|
||||
Here, as we can see, unlike the first example, some of `Layout`'s possible
|
||||
variants can have further nested types associated with them. Note that
|
||||
`Horizontal` here can have a sum type (e.g. enum), or a product type (e.g.
|
||||
class/struct), or both (any number of them actually) nested in it. But the
|
||||
nested values will only exist when `Layout` is `Horizontal`.
|
||||
|
||||
We'd document it here as:
|
||||
|
||||
> Layout is a sum type that can be one of the following:
|
||||
>
|
||||
> - "Table"
|
||||
> - "HelpMenu"
|
||||
> - { Horizontal = { config = Layout Config, splits = { Layout, ... } }
|
||||
|
||||
And then we'd go on documenting whatever `Layout Config` is.
|
||||
|
||||
So, there you go. This is exactly what sum types are - glorified enums that can
|
||||
have nested types in each branch.
|
||||
|
||||
[1]: https://en.wikipedia.org/wiki/Tagged_union
|
||||
[2]: layout.md
|
||||
[3]: message.md
|
||||
[4]: style.md#color
|
||||
@ -0,0 +1,34 @@
|
||||
# TODO
|
||||
|
||||
- [x] Saner key bindings.
|
||||
- [x] Pipes.
|
||||
- [x] Native search & filter.
|
||||
- [x] Create, copy, move, delete files directly.
|
||||
- [x] logging support.
|
||||
- [x] Version compatibility instructions.
|
||||
- [x] Implement CLI arguments.
|
||||
- ~Add support for tabs and/or panes (non native)~ [hacked][1] | [discussion][2]
|
||||
- ~Implement bookmarks.~ [hacked][3]
|
||||
- [x] Add sorting support.
|
||||
- [x] Add filter support.
|
||||
- [x] File previews.
|
||||
- [x] Implement plugins support (or some way to easily share configuration).
|
||||
- [x] Bigger (and better) help menu.
|
||||
- [x] Offline docs.
|
||||
- [ ] Support for background services
|
||||
- [x] ~Customize~ switch UI at run-time.
|
||||
- [ ] More tests and benchmarks.
|
||||
- [ ] Measure code coverage.
|
||||
- [ ] Improve the [vim plugin][4].
|
||||
- [ ] Cleanup, refactor, optimize.
|
||||
|
||||
[add more][5]
|
||||
|
||||
Like this project so far? **[Please consider contributing][6].**
|
||||
|
||||
[1]: https://github.com/sayanarijit/xplr/wiki/Hacks#spawn-multiple-sessions-in-different-windows
|
||||
[2]: https://github.com/sayanarijit/xplr/discussions/15
|
||||
[3]: https://github.com/sayanarijit/xplr/wiki/Hacks#bookmark
|
||||
[4]: https://github.com/sayanarijit/xplr.vim
|
||||
[5]: https://github.com/sayanarijit/xplr/discussions/2
|
||||
[6]: contribute.md
|
||||
@ -1,528 +0,0 @@
|
||||
### xplr.util.version
|
||||
|
||||
Get the xplr version details.
|
||||
|
||||
Type: function() -> { major: number, minor: number, patch: number }
|
||||
|
||||
Example:
|
||||
|
||||
```lua
|
||||
xplr.util.version()
|
||||
-- { major = 0, minor = 0, patch = 0 }
|
||||
```
|
||||
|
||||
### xplr.util.debug
|
||||
|
||||
Print the given value to the console, and return it as a string.
|
||||
Useful for debugging.
|
||||
|
||||
Type: function( value ) -> string
|
||||
|
||||
Example:
|
||||
|
||||
```lua
|
||||
xplr.util.debug({ foo = "bar", bar = function() end })
|
||||
-- {
|
||||
-- ["bar"] = function: 0x55e5cebdeae0,
|
||||
-- ["foo"] = "bar",
|
||||
-- }
|
||||
```
|
||||
|
||||
### xplr.util.clone
|
||||
|
||||
Clone/deepcopy a Lua value. Doesn't work with functions.
|
||||
|
||||
Type: function( value ) -> value
|
||||
|
||||
Example:
|
||||
|
||||
```lua
|
||||
local val = { foo = "bar" }
|
||||
local val_clone = xplr.util.clone(val)
|
||||
val.foo = "baz"
|
||||
print(val_clone.foo)
|
||||
-- "bar"
|
||||
```
|
||||
|
||||
### xplr.util.exists
|
||||
|
||||
Check if the given path exists.
|
||||
|
||||
Type: function( path:string ) -> boolean
|
||||
|
||||
Example:
|
||||
|
||||
```lua
|
||||
xplr.util.exists("/foo/bar")
|
||||
-- true
|
||||
```
|
||||
|
||||
### xplr.util.is_dir
|
||||
|
||||
Check if the given path is a directory.
|
||||
|
||||
Type: function( path:string ) -> boolean
|
||||
|
||||
Example:
|
||||
|
||||
```lua
|
||||
xplr.util.is_dir("/foo/bar")
|
||||
-- true
|
||||
```
|
||||
|
||||
### xplr.util.is_file
|
||||
|
||||
Check if the given path is a file.
|
||||
|
||||
Type: function( path:string ) -> boolean
|
||||
|
||||
Example:
|
||||
|
||||
```lua
|
||||
xplr.util.is_file("/foo/bar")
|
||||
-- true
|
||||
```
|
||||
|
||||
### xplr.util.is_symlink
|
||||
|
||||
Check if the given path is a symlink.
|
||||
|
||||
Type: function( path:string ) -> boolean
|
||||
|
||||
Example:
|
||||
|
||||
```lua
|
||||
xplr.util.is_file("/foo/bar")
|
||||
-- true
|
||||
```
|
||||
|
||||
### xplr.util.is_absolute
|
||||
|
||||
Check if the given path is an absolute path.
|
||||
|
||||
Type: function( path:string ) -> boolean
|
||||
|
||||
Example:
|
||||
|
||||
```lua
|
||||
xplr.util.is_absolute("/foo/bar")
|
||||
-- true
|
||||
```
|
||||
|
||||
### xplr.util.path_split
|
||||
|
||||
Split a path into its components.
|
||||
|
||||
Type: function( path:string ) -> boolean
|
||||
|
||||
Example:
|
||||
|
||||
```lua
|
||||
xplr.util.path_split("/foo/bar")
|
||||
-- { "/", "foo", "bar" }
|
||||
|
||||
xplr.util.path_split(".././foo")
|
||||
-- { "..", "foo" }
|
||||
```
|
||||
|
||||
### xplr.util.node
|
||||
|
||||
Get [Node][5] information of a given path.
|
||||
Doesn't check if the path exists.
|
||||
Returns nil if the path is "/".
|
||||
Errors out if absolute path can't be obtained.
|
||||
|
||||
Type: function( path:string ) -> [Node][5]|nil
|
||||
|
||||
Example:
|
||||
|
||||
```lua
|
||||
xplr.util.node("./bar")
|
||||
-- { parent = "/pwd", relative_path = "bar", absolute_path = "/pwd/bar", ... }
|
||||
|
||||
xplr.util.node("/")
|
||||
-- nil
|
||||
```
|
||||
|
||||
### xplr.util.node_type
|
||||
|
||||
Get the configured [Node Type][6] of a given [Node][5].
|
||||
|
||||
Type: function( [Node][5], [xplr.config.node_types][7]|nil ) -> [Node Type][6]
|
||||
|
||||
If the second argument is missing, global config `xplr.config.node_types`
|
||||
will be used.
|
||||
|
||||
Example:
|
||||
|
||||
```lua
|
||||
xplr.util.node_type(app.focused_node)
|
||||
-- { style = { fg = "Red", ... }, meta = { icon = "", ... } ... }
|
||||
|
||||
xplr.util.node_type(xplr.util.node("/foo/bar"), xplr.config.node_types)
|
||||
-- { style = { fg = "Red", ... }, meta = { icon = "", ... } ... }
|
||||
```
|
||||
|
||||
### xplr.util.dirname
|
||||
|
||||
Get the directory name of a given path.
|
||||
|
||||
Type: function( path:string ) -> path:string|nil
|
||||
|
||||
Example:
|
||||
|
||||
```lua
|
||||
xplr.util.dirname("/foo/bar")
|
||||
-- "/foo"
|
||||
```
|
||||
|
||||
### xplr.util.basename
|
||||
|
||||
Get the base name of a given path.
|
||||
|
||||
Type: function( path:string ) -> path:string|nil
|
||||
|
||||
Example:
|
||||
|
||||
```lua
|
||||
xplr.util.basename("/foo/bar")
|
||||
-- "bar"
|
||||
```
|
||||
|
||||
### xplr.util.absolute
|
||||
|
||||
Get the absolute path of the given path by prepending $PWD.
|
||||
It doesn't check if the path exists.
|
||||
|
||||
Type: function( path:string ) -> path:string
|
||||
|
||||
Example:
|
||||
|
||||
```lua
|
||||
xplr.util.absolute("foo/bar")
|
||||
-- "/tmp/foo/bar"
|
||||
```
|
||||
|
||||
### xplr.util.relative_to
|
||||
|
||||
Get the relative path based on the given base path or current working dir.
|
||||
Will error if it fails to determine a relative path.
|
||||
|
||||
Type: function( path:string, options:table|nil ) -> path:string
|
||||
|
||||
Options type: { base:string|nil, with_prefix_dots:bookean|nil, without_suffix_dots:boolean|nil }
|
||||
|
||||
- If `base` path is given, the path will be relative to it.
|
||||
- If `with_prefix_dots` is true, the path will always start with dots `..` / `.`
|
||||
- If `without_suffix_dots` is true, the name will be visible instead of dots `..` / `.`
|
||||
|
||||
Example:
|
||||
|
||||
```lua
|
||||
xplr.util.relative_to("/present/working/directory")
|
||||
-- "."
|
||||
|
||||
xplr.util.relative_to("/present/working/directory/foo")
|
||||
-- "foo"
|
||||
|
||||
xplr.util.relative_to("/present/working/directory/foo", { with_prefix_dots = true })
|
||||
-- "./foo"
|
||||
|
||||
xplr.util.relative_to("/present/working/directory", { without_suffix_dots = true })
|
||||
-- "../directory"
|
||||
|
||||
xplr.util.relative_to("/present/working")
|
||||
-- ".."
|
||||
|
||||
xplr.util.relative_to("/present/working", { without_suffix_dots = true })
|
||||
-- "../../working"
|
||||
|
||||
xplr.util.relative_to("/present/working/directory", { base = "/present/foo/bar" })
|
||||
-- "../../working/directory"
|
||||
```
|
||||
|
||||
### xplr.util.shorten
|
||||
|
||||
Shorten the given absolute path using the following rules:
|
||||
|
||||
- either relative to your home dir if it makes sense
|
||||
- or relative to the current working directory
|
||||
- or absolute path if it makes the most sense
|
||||
|
||||
Type: Similar to `xplr.util.relative_to`
|
||||
|
||||
Example:
|
||||
|
||||
```lua
|
||||
xplr.util.shorten("/home/username/.config")
|
||||
-- "~/.config"
|
||||
|
||||
xplr.util.shorten("/present/working/directory")
|
||||
-- "."
|
||||
|
||||
xplr.util.shorten("/present/working/directory/foo")
|
||||
-- "foo"
|
||||
|
||||
xplr.util.shorten("/present/working/directory/foo", { with_prefix_dots = true })
|
||||
-- "./foo"
|
||||
|
||||
xplr.util.shorten("/present/working/directory", { without_suffix_dots = true })
|
||||
-- "../directory"
|
||||
|
||||
xplr.util.shorten("/present/working/directory", { base = "/present/foo/bar" })
|
||||
-- "../../working/directory"
|
||||
|
||||
xplr.util.shorten("/tmp")
|
||||
-- "/tmp"
|
||||
```
|
||||
|
||||
### xplr.util.explore
|
||||
|
||||
Explore directories with the given explorer config.
|
||||
|
||||
Type: function( path:string, [ExplorerConfig][1]|nil ) -> { [Node][2], ... }
|
||||
|
||||
Example:
|
||||
|
||||
```lua
|
||||
|
||||
xplr.util.explore("/tmp")
|
||||
-- { { absolute_path = "/tmp/a", ... }, ... }
|
||||
|
||||
xplr.util.explore("/tmp", app.explorer_config)
|
||||
-- { { absolute_path = "/tmp/a", ... }, ... }
|
||||
```
|
||||
|
||||
### xplr.util.shell_execute
|
||||
|
||||
Execute shell commands safely.
|
||||
|
||||
Type: function( program:string, args:{ string, ... }|nil ) -> { stdout = string, stderr = string, returncode = number|nil }
|
||||
|
||||
Example:
|
||||
|
||||
```lua
|
||||
xplr.util.shell_execute("pwd")
|
||||
-- { stdout = "/present/working/directory", stderr = "", returncode = 0 }
|
||||
|
||||
xplr.util.shell_execute("bash", {"-c", "xplr --help"})
|
||||
-- { stdout = "xplr...", stderr = "", returncode = 0 }
|
||||
```
|
||||
|
||||
### xplr.util.shell_quote
|
||||
|
||||
Quote commands and paths safely.
|
||||
|
||||
Type: function( string ) -> string
|
||||
|
||||
Example:
|
||||
|
||||
```lua
|
||||
xplr.util.shell_quote("a'b\"c")
|
||||
-- 'a'"'"'b"c'
|
||||
```
|
||||
|
||||
### xplr.util.shell_escape
|
||||
|
||||
Escape commands and paths safely.
|
||||
|
||||
Type: function( string ) -> string
|
||||
|
||||
Example:
|
||||
|
||||
```lua
|
||||
xplr.util.shell_escape("a'b\"c")
|
||||
-- "\"a'b\\\"c\""
|
||||
```
|
||||
|
||||
### xplr.util.from_json
|
||||
|
||||
Load JSON string into Lua value.
|
||||
|
||||
Type: function( string ) -> any
|
||||
|
||||
Example:
|
||||
|
||||
```lua
|
||||
xplr.util.from_json([[{"foo": "bar"}]])
|
||||
-- { foo = "bar" }
|
||||
```
|
||||
|
||||
### xplr.util.to_json
|
||||
|
||||
Dump Lua value into JSON (i.e. also YAML) string.
|
||||
|
||||
Type: function( value ) -> string
|
||||
|
||||
Example:
|
||||
|
||||
```lua
|
||||
xplr.util.to_json({ foo = "bar" })
|
||||
-- [[{ "foo": "bar" }]]
|
||||
|
||||
xplr.util.to_json({ foo = "bar" }, { pretty = true })
|
||||
-- [[{
|
||||
-- "foo": "bar"
|
||||
-- }]]
|
||||
```
|
||||
|
||||
### xplr.util.from_yaml
|
||||
|
||||
Load YAML (i.e. also JSON) string into Lua value.
|
||||
|
||||
Type: function( string ) -> value
|
||||
|
||||
Example:
|
||||
|
||||
```lua
|
||||
xplr.util.from_yaml([[{foo: bar}]])
|
||||
-- { foo = "bar" }
|
||||
```
|
||||
|
||||
### xplr.util.to_yaml
|
||||
|
||||
Dump Lua value into YAML string.
|
||||
|
||||
Type: function( value ) -> string
|
||||
|
||||
Example:
|
||||
|
||||
```lua
|
||||
xplr.util.to_yaml({ foo = "bar" })
|
||||
-- "foo: bar"
|
||||
```
|
||||
|
||||
### xplr.util.lscolor
|
||||
|
||||
Get a [Style][3] object for the given path based on the LS_COLORS
|
||||
environment variable.
|
||||
|
||||
Type: function( path:string ) -> [Style][3]
|
||||
|
||||
Example:
|
||||
|
||||
```lua
|
||||
xplr.util.lscolor("Desktop")
|
||||
-- { fg = "Red", bg = nil, add_modifiers = {}, sub_modifiers = {} }
|
||||
```
|
||||
|
||||
### xplr.util.paint
|
||||
|
||||
Apply style (escape sequence) to string using a given [Style][3] object.
|
||||
|
||||
Type: function( string, [Style][3]|nil ) -> string
|
||||
|
||||
Example:
|
||||
|
||||
```lua
|
||||
xplr.util.paint("Desktop", { fg = "Red", bg = nil, add_modifiers = {}, sub_modifiers = {} })
|
||||
-- "\u001b[31mDesktop\u001b[0m"
|
||||
```
|
||||
|
||||
### xplr.util.style_mix
|
||||
|
||||
Mix multiple [Style][3] objects into one.
|
||||
|
||||
Type: function( { [Style][3], [Style][3], ... } ) -> [Style][3]
|
||||
|
||||
Example:
|
||||
|
||||
```lua
|
||||
xplr.util.style_mix({{ fg = "Red" }, { bg = "Blue" }, { add_modifiers = {"Bold"} }})
|
||||
-- { fg = "Red", bg = "Blue", add_modifiers = { "Bold" }, sub_modifiers = {} }
|
||||
```
|
||||
|
||||
### xplr.util.textwrap
|
||||
|
||||
Wrap the given text to fit the specified width.
|
||||
It will try to not split words when possible.
|
||||
|
||||
Type: function( string, options:number|table ) -> { string, ...}
|
||||
|
||||
Options type: { width = number, initial_indent = string|nil, subsequent_indent = string|nil, break_words = boolean|nil }
|
||||
|
||||
Example:
|
||||
|
||||
```lua
|
||||
xplr.util.textwrap("this will be cut off", 11)
|
||||
-- { "this will', 'be cut off" }
|
||||
|
||||
xplr.util.textwrap(
|
||||
"this will be cut off",
|
||||
{ width = 12, initial_indent = "", subsequent_indent = " ", break_words = false }
|
||||
)
|
||||
-- { "this will be", " cut off" }
|
||||
```
|
||||
|
||||
### xplr.util.layout_replace
|
||||
|
||||
Find the target layout in the given layout and replace it with the replacement layout,
|
||||
returning a new layout.
|
||||
|
||||
Type: function( layout:[Layout][4], target:[Layout][4], replacement:[Layout][4] ) -> layout:[Layout][4]
|
||||
|
||||
Example:
|
||||
|
||||
```lua
|
||||
local layout = {
|
||||
Horizontal = {
|
||||
splits = {
|
||||
"Table", -- Target
|
||||
"HelpMenu",
|
||||
},
|
||||
config = ...,
|
||||
}
|
||||
}
|
||||
|
||||
xplr.util.layout_replace(layout, "Table", "Selection")
|
||||
-- {
|
||||
-- Horizontal = {
|
||||
-- splits = {
|
||||
-- "Selection", -- Replacement
|
||||
-- "HelpMenu",
|
||||
-- },
|
||||
-- config = ...
|
||||
-- }
|
||||
-- }
|
||||
```
|
||||
|
||||
### xplr.util.permissions_rwx
|
||||
|
||||
Convert [Permission][8] to rwxrwxrwx representation with special bits.
|
||||
|
||||
Type: function( [Permission][8] ) -> string
|
||||
|
||||
Example:
|
||||
|
||||
```lua
|
||||
xplr.util.permissions_rwx({ user_read = true })
|
||||
-- "r--------"
|
||||
|
||||
xplr.util.permissions_rwx(app.focused_node.permission)
|
||||
-- "rwxrwsrwT"
|
||||
```
|
||||
|
||||
### xplr.util.permissions_octal
|
||||
|
||||
Convert [Permission][8] to octal representation.
|
||||
|
||||
Type: function( [Permission][8] ) -> { number, number, number, number }
|
||||
|
||||
Example:
|
||||
|
||||
```lua
|
||||
xplr.util.permissions_octal({ user_read = true })
|
||||
-- { 0, 4, 0, 0 }
|
||||
|
||||
xplr.util.permissions_octal(app.focused_node.permission)
|
||||
-- { 0, 7, 5, 4 }
|
||||
```
|
||||
|
||||
[1]: https://xplr.dev/en/lua-function-calls#explorer-config
|
||||
[2]: https://xplr.dev/en/lua-function-calls#node
|
||||
[3]: https://xplr.dev/en/style
|
||||
[4]: https://xplr.dev/en/layout
|
||||
[5]: https://xplr.dev/en/lua-function-calls#node
|
||||
[6]: https://xplr.dev/en/node-type
|
||||
[7]: https://xplr.dev/en/node_types
|
||||
[8]: https://xplr.dev/en/column-renderer#permission
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 789 B |
@ -1,357 +0,0 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="{{ language }}" class="{{ default_theme }}" dir="{{ text_direction }}">
|
||||
<head>
|
||||
<!-- Book generated using mdBook -->
|
||||
<meta charset="UTF-8">
|
||||
<title>{{ title }}</title>
|
||||
{{#if is_print }}
|
||||
<meta name="robots" content="noindex">
|
||||
{{/if}}
|
||||
{{#if base_url}}
|
||||
<base href="{{ base_url }}">
|
||||
{{/if}}
|
||||
|
||||
|
||||
<!-- Custom HTML head -->
|
||||
{{> head}}
|
||||
|
||||
<meta name="description" content="{{ description }}">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta name="theme-color" content="#ffffff">
|
||||
|
||||
{{#if favicon_svg}}
|
||||
<link rel="icon" href="{{ path_to_root }}favicon.svg">
|
||||
{{/if}}
|
||||
{{#if favicon_png}}
|
||||
<link rel="shortcut icon" href="{{ path_to_root }}favicon.png">
|
||||
{{/if}}
|
||||
<link rel="stylesheet" href="{{ path_to_root }}css/variables.css">
|
||||
<link rel="stylesheet" href="{{ path_to_root }}css/general.css">
|
||||
<link rel="stylesheet" href="{{ path_to_root }}css/chrome.css">
|
||||
{{#if print_enable}}
|
||||
<link rel="stylesheet" href="{{ path_to_root }}css/print.css" media="print">
|
||||
{{/if}}
|
||||
|
||||
<!-- Fonts -->
|
||||
<link rel="stylesheet" href="{{ path_to_root }}FontAwesome/css/font-awesome.css">
|
||||
{{#if copy_fonts}}
|
||||
<link rel="stylesheet" href="{{ path_to_root }}fonts/fonts.css">
|
||||
{{/if}}
|
||||
|
||||
<!-- Highlight.js Stylesheets -->
|
||||
<link rel="stylesheet" href="{{ path_to_root }}highlight.css">
|
||||
<link rel="stylesheet" href="{{ path_to_root }}tomorrow-night.css">
|
||||
<link rel="stylesheet" href="{{ path_to_root }}ayu-highlight.css">
|
||||
|
||||
<!-- Custom theme stylesheets -->
|
||||
{{#each additional_css}}
|
||||
<link rel="stylesheet" href="{{ ../path_to_root }}{{ this }}">
|
||||
{{/each}}
|
||||
|
||||
{{#if mathjax_support}}
|
||||
<!-- MathJax -->
|
||||
<script async src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
{{/if}}
|
||||
|
||||
<!-- EthicalAds -->
|
||||
<script async src="https://media.ethicalads.io/media/client/ethicalads.min.js"></script>
|
||||
</head>
|
||||
<body class="sidebar-visible no-js">
|
||||
<div id="body-container">
|
||||
<!-- Provide site root to javascript -->
|
||||
<script>
|
||||
var path_to_root = "{{ path_to_root }}";
|
||||
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "{{ preferred_dark_theme }}" : "{{ default_theme }}";
|
||||
</script>
|
||||
|
||||
<!-- Work around some values being stored in localStorage wrapped in quotes -->
|
||||
<script>
|
||||
try {
|
||||
var theme = localStorage.getItem('mdbook-theme');
|
||||
var sidebar = localStorage.getItem('mdbook-sidebar');
|
||||
|
||||
if (theme.startsWith('"') && theme.endsWith('"')) {
|
||||
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
|
||||
}
|
||||
|
||||
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
|
||||
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
|
||||
}
|
||||
} catch (e) { }
|
||||
</script>
|
||||
|
||||
<!-- Set the theme before any content is loaded, prevents flash -->
|
||||
<script>
|
||||
var theme;
|
||||
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
|
||||
if (theme === null || theme === undefined) { theme = default_theme; }
|
||||
var html = document.querySelector('html');
|
||||
html.classList.remove('{{ default_theme }}')
|
||||
html.classList.add(theme);
|
||||
var body = document.querySelector('body');
|
||||
body.classList.remove('no-js')
|
||||
body.classList.add('js');
|
||||
</script>
|
||||
|
||||
<input type="checkbox" id="sidebar-toggle-anchor" class="hidden">
|
||||
|
||||
<!-- Hide / unhide sidebar before it is displayed -->
|
||||
<script>
|
||||
var body = document.querySelector('body');
|
||||
var sidebar = null;
|
||||
var sidebar_toggle = document.getElementById("sidebar-toggle-anchor");
|
||||
if (document.body.clientWidth >= 1080) {
|
||||
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
|
||||
sidebar = sidebar || 'visible';
|
||||
} else {
|
||||
sidebar = 'hidden';
|
||||
}
|
||||
sidebar_toggle.checked = sidebar === 'visible';
|
||||
body.classList.remove('sidebar-visible');
|
||||
body.classList.add("sidebar-" + sidebar);
|
||||
</script>
|
||||
|
||||
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
|
||||
<div class="sidebar-scrollbox">
|
||||
{{#toc}}{{/toc}}
|
||||
|
||||
<!-- EthicalAds -->
|
||||
<div
|
||||
id="docs-sidebar-bottom"
|
||||
class="dark flat"
|
||||
data-ea-publisher="xplrdev"
|
||||
data-ea-type="image"
|
||||
></div>
|
||||
</div>
|
||||
<div id="sidebar-resize-handle" class="sidebar-resize-handle">
|
||||
<div class="sidebar-resize-indicator"></div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<!-- Track and set sidebar scroll position -->
|
||||
<script>
|
||||
var sidebarScrollbox = document.querySelector('#sidebar .sidebar-scrollbox');
|
||||
sidebarScrollbox.addEventListener('click', function(e) {
|
||||
if (e.target.tagName === 'A') {
|
||||
sessionStorage.setItem('sidebar-scroll', sidebarScrollbox.scrollTop);
|
||||
}
|
||||
}, { passive: true });
|
||||
var sidebarScrollTop = sessionStorage.getItem('sidebar-scroll');
|
||||
sessionStorage.removeItem('sidebar-scroll');
|
||||
if (sidebarScrollTop) {
|
||||
// preserve sidebar scroll position when navigating via links within sidebar
|
||||
sidebarScrollbox.scrollTop = sidebarScrollTop;
|
||||
} else {
|
||||
// scroll sidebar to current active section when navigating via "next/previous chapter" buttons
|
||||
var activeSection = document.querySelector('#sidebar .active');
|
||||
if (activeSection) {
|
||||
activeSection.scrollIntoView({ block: 'center' });
|
||||
}
|
||||
}
|
||||
</script>
|
||||
|
||||
<div id="page-wrapper" class="page-wrapper">
|
||||
|
||||
<div class="page">
|
||||
{{> header}}
|
||||
<div id="menu-bar-hover-placeholder"></div>
|
||||
<div id="menu-bar" class="menu-bar sticky">
|
||||
<div class="left-buttons">
|
||||
<label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
|
||||
<i class="fa fa-bars"></i>
|
||||
</label>
|
||||
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
|
||||
<i class="fa fa-paint-brush"></i>
|
||||
</button>
|
||||
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
|
||||
<li role="none"><button role="menuitem" class="theme" id="light">Light</button></li>
|
||||
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
|
||||
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
|
||||
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
|
||||
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
|
||||
</ul>
|
||||
{{#if search_enabled}}
|
||||
<button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
|
||||
<i class="fa fa-search"></i>
|
||||
</button>
|
||||
{{/if}}
|
||||
</div>
|
||||
|
||||
<h1 class="menu-title">{{ book_title }}</h1>
|
||||
|
||||
<div class="right-buttons">
|
||||
{{#if print_enable}}
|
||||
<a href="{{ path_to_root }}print.html" title="Print this book" aria-label="Print this book">
|
||||
<i id="print-button" class="fa fa-print"></i>
|
||||
</a>
|
||||
{{/if}}
|
||||
{{#if git_repository_url}}
|
||||
<a href="{{git_repository_url}}" title="Git repository" aria-label="Git repository">
|
||||
<i id="git-repository-button" class="fa {{git_repository_icon}}"></i>
|
||||
</a>
|
||||
{{/if}}
|
||||
{{#if git_repository_edit_url}}
|
||||
<a href="{{git_repository_edit_url}}" title="Suggest an edit" aria-label="Suggest an edit">
|
||||
<i id="git-edit-button" class="fa fa-edit"></i>
|
||||
</a>
|
||||
{{/if}}
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
{{#if search_enabled}}
|
||||
<div id="search-wrapper" class="hidden">
|
||||
<form id="searchbar-outer" class="searchbar-outer">
|
||||
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
|
||||
</form>
|
||||
<div id="searchresults-outer" class="searchresults-outer hidden">
|
||||
<div id="searchresults-header" class="searchresults-header"></div>
|
||||
<ul id="searchresults">
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
{{/if}}
|
||||
|
||||
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
|
||||
<script>
|
||||
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
|
||||
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
|
||||
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
|
||||
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
|
||||
});
|
||||
</script>
|
||||
|
||||
<div id="content" class="content">
|
||||
<main>
|
||||
{{{ content }}}
|
||||
</main>
|
||||
|
||||
<nav class="nav-wrapper" aria-label="Page navigation">
|
||||
<!-- Mobile navigation buttons -->
|
||||
{{#previous}}
|
||||
<a rel="prev" href="{{ path_to_root }}{{link}}" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
||||
<i class="fa fa-angle-left"></i>
|
||||
</a>
|
||||
{{/previous}}
|
||||
|
||||
{{#next}}
|
||||
<a rel="next prefetch" href="{{ path_to_root }}{{link}}" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
||||
<i class="fa fa-angle-right"></i>
|
||||
</a>
|
||||
{{/next}}
|
||||
|
||||
<div style="clear: both"></div>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<nav class="nav-wide-wrapper" aria-label="Page navigation">
|
||||
{{#previous}}
|
||||
<a rel="prev" href="{{ path_to_root }}{{link}}" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
||||
<i class="fa fa-angle-left"></i>
|
||||
</a>
|
||||
{{/previous}}
|
||||
|
||||
{{#next}}
|
||||
<a rel="next prefetch" href="{{ path_to_root }}{{link}}" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
||||
<i class="fa fa-angle-right"></i>
|
||||
</a>
|
||||
{{/next}}
|
||||
</nav>
|
||||
|
||||
</div>
|
||||
|
||||
{{#if live_reload_endpoint}}
|
||||
<!-- Livereload script (if served using the cli tool) -->
|
||||
<script>
|
||||
const wsProtocol = location.protocol === 'https:' ? 'wss:' : 'ws:';
|
||||
const wsAddress = wsProtocol + "//" + location.host + "/" + "{{{live_reload_endpoint}}}";
|
||||
const socket = new WebSocket(wsAddress);
|
||||
socket.onmessage = function (event) {
|
||||
if (event.data === "reload") {
|
||||
socket.close();
|
||||
location.reload();
|
||||
}
|
||||
};
|
||||
|
||||
window.onbeforeunload = function() {
|
||||
socket.close();
|
||||
}
|
||||
</script>
|
||||
{{/if}}
|
||||
|
||||
{{#if google_analytics}}
|
||||
<!-- Google Analytics Tag -->
|
||||
<script>
|
||||
var localAddrs = ["localhost", "127.0.0.1", ""];
|
||||
|
||||
// make sure we don't activate google analytics if the developer is
|
||||
// inspecting the book locally...
|
||||
if (localAddrs.indexOf(document.location.hostname) === -1) {
|
||||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||||
|
||||
ga('create', '{{google_analytics}}', 'auto');
|
||||
ga('send', 'pageview');
|
||||
}
|
||||
</script>
|
||||
{{/if}}
|
||||
|
||||
{{#if playground_line_numbers}}
|
||||
<script>
|
||||
window.playground_line_numbers = true;
|
||||
</script>
|
||||
{{/if}}
|
||||
|
||||
{{#if playground_copyable}}
|
||||
<script>
|
||||
window.playground_copyable = true;
|
||||
</script>
|
||||
{{/if}}
|
||||
|
||||
{{#if playground_js}}
|
||||
<script src="{{ path_to_root }}ace.js"></script>
|
||||
<script src="{{ path_to_root }}editor.js"></script>
|
||||
<script src="{{ path_to_root }}mode-rust.js"></script>
|
||||
<script src="{{ path_to_root }}theme-dawn.js"></script>
|
||||
<script src="{{ path_to_root }}theme-tomorrow_night.js"></script>
|
||||
{{/if}}
|
||||
|
||||
{{#if search_js}}
|
||||
<script src="{{ path_to_root }}elasticlunr.min.js"></script>
|
||||
<script src="{{ path_to_root }}mark.min.js"></script>
|
||||
<script src="{{ path_to_root }}searcher.js"></script>
|
||||
{{/if}}
|
||||
|
||||
<script src="{{ path_to_root }}clipboard.min.js"></script>
|
||||
<script src="{{ path_to_root }}highlight.js"></script>
|
||||
<script src="{{ path_to_root }}book.js"></script>
|
||||
|
||||
<!-- Custom JS scripts -->
|
||||
{{#each additional_js}}
|
||||
<script src="{{ ../path_to_root }}{{this}}"></script>
|
||||
{{/each}}
|
||||
|
||||
{{#if is_print}}
|
||||
{{#if mathjax_support}}
|
||||
<script>
|
||||
window.addEventListener('load', function() {
|
||||
MathJax.Hub.Register.StartupHook('End', function() {
|
||||
window.setTimeout(window.print, 100);
|
||||
});
|
||||
});
|
||||
</script>
|
||||
{{else}}
|
||||
<script>
|
||||
window.addEventListener('load', function() {
|
||||
window.setTimeout(window.print, 100);
|
||||
});
|
||||
</script>
|
||||
{{/if}}
|
||||
{{/if}}
|
||||
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,114 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8" />
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<link rel="icon" href="/assets/icon/xplr64.png" />
|
||||
<link rel="stylesheet" href="style.css" />
|
||||
<title>xplr</title>
|
||||
<!-- ------------- SEO TAGS --------------------->
|
||||
<meta name="title" content="xplr" />
|
||||
<meta
|
||||
name="description"
|
||||
content="A hackable, minimal, fast TUI file explorer"
|
||||
/>
|
||||
|
||||
<meta name="twitter:card" content="summary_large_image" />
|
||||
<meta name="twitter:url" content="https://xplr.dev/" />
|
||||
<meta name="twitter:title" content="xplr" />
|
||||
<meta
|
||||
name="twitter:description"
|
||||
content="A hackable, minimal, fast TUI file explorer"
|
||||
/>
|
||||
<meta
|
||||
name="twitter:image"
|
||||
content="https://s3.gifyu.com/images/imaged284d8b830767ac4.png"
|
||||
/>
|
||||
<meta name="twitter:site" content="https://xplr.dev" />
|
||||
|
||||
<meta property="og:type" content="website" />
|
||||
<meta property="og:url" content="https://xplr.dev" />
|
||||
<meta property="og:title" content="xplr" />
|
||||
<meta
|
||||
property="og:description"
|
||||
content="A hackable, minimal, fast TUI file explorer"
|
||||
/>
|
||||
<meta
|
||||
property="og:image"
|
||||
content="https://s3.gifyu.com/images/imaged284d8b830767ac4.png"
|
||||
/>
|
||||
<meta
|
||||
property="og:image:alt"
|
||||
content="A hackable, minimal, fast TUI file explorer"
|
||||
/>
|
||||
|
||||
<meta itemprop="name" content="xplr" />
|
||||
<meta
|
||||
itemprop="description"
|
||||
content="A hackable, minimal, fast TUI file explorer"
|
||||
/>
|
||||
|
||||
<link
|
||||
rel="icon"
|
||||
type="image/png"
|
||||
href="https://s3.gifyu.com/images/icon2194563908b29554.png"
|
||||
/>
|
||||
<meta name="theme-color" content="#ffffff" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<div class="main-page">
|
||||
<div class="para">
|
||||
<h1>xplr</h1>
|
||||
<p>
|
||||
<span style="font-size: 4rem">A</span> hackable, minimal, fast TUI
|
||||
file explorer
|
||||
</p>
|
||||
<br />
|
||||
<p><a href="/en/install.html">Try or Install</a></p>
|
||||
</div>
|
||||
<div class="main-video">
|
||||
<img
|
||||
src="https://s3.gifyu.com/images/xplr-0.5.0.gif"
|
||||
alt=""
|
||||
width="100%"
|
||||
/>
|
||||
</div>
|
||||
</div>
|
||||
<div class="links">
|
||||
<a href="/en/">
|
||||
<div class="linkCad mrgL">
|
||||
<img
|
||||
src="/assets/homepage_icons/document_logo.png"
|
||||
alt=""
|
||||
width="35%"
|
||||
/>
|
||||
<p>Documentation</p>
|
||||
</div>
|
||||
</a>
|
||||
<a href="https://github.com/sayanarijit/xplr">
|
||||
<div class="linkCad mrgR">
|
||||
<img src="/assets/homepage_icons/pr_logo.png" alt="" width="40%" />
|
||||
<p>Source Code</p>
|
||||
</div>
|
||||
</a>
|
||||
<a href="https://github.com/sayanarijit/xplr/releases">
|
||||
<div class="linkCad mrgL">
|
||||
<img
|
||||
src="/assets/homepage_icons/release_logo.png"
|
||||
alt=""
|
||||
width="35%"
|
||||
/>
|
||||
<p>Releases</p>
|
||||
</div>
|
||||
</a>
|
||||
<a href="https://discord.com/invite/JmasSPCcz3">
|
||||
<div class="linkCad mrgR">
|
||||
<img src="/assets/homepage_icons/disc_logo.png" alt="" width="40%" />
|
||||
<p>Discord</p>
|
||||
</div>
|
||||
</a>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@ -1 +0,0 @@
|
||||
../../assets
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -1,235 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Required meta tags -->
|
||||
<meta charset="utf-8" />
|
||||
<meta
|
||||
name="viewport"
|
||||
content="width=device-width, initial-scale=1, shrink-to-fit=no"
|
||||
/>
|
||||
<title>xplr - A hackable, minimal, fast TUI file explorer</title>
|
||||
<meta
|
||||
name="description"
|
||||
content="xplr is a hackable, minimal, fast TUI file explorer "
|
||||
/>
|
||||
|
||||
<!--Inter UI font-->
|
||||
<link href="https://rsms.me/inter/inter.css" rel="stylesheet" />
|
||||
|
||||
<!--vendors styles-->
|
||||
<link
|
||||
rel="stylesheet"
|
||||
href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css"
|
||||
/>
|
||||
<link
|
||||
rel="stylesheet"
|
||||
href="https://cdnjs.cloudflare.com/ajax/libs/slick-carousel/1.8.1/slick.min.css"
|
||||
/>
|
||||
<link
|
||||
rel="stylesheet"
|
||||
href="https://cdnjs.cloudflare.com/ajax/libs/slick-carousel/1.8.1/slick-theme.min.css"
|
||||
/>
|
||||
|
||||
<!-- Icons -->
|
||||
<link
|
||||
rel="icon"
|
||||
type="image/png"
|
||||
sizes="126x128"
|
||||
href="/assets/icon/xplr128.png"
|
||||
/>
|
||||
<link
|
||||
rel="icon"
|
||||
type="image/png"
|
||||
sizes="64x64"
|
||||
href="/assets/icon/xplr64.png"
|
||||
/>
|
||||
<link
|
||||
rel="icon"
|
||||
type="image/png"
|
||||
sizes="32x32"
|
||||
href="/assets/icon/xplr32.png"
|
||||
/>
|
||||
<link
|
||||
rel="icon"
|
||||
type="image/png"
|
||||
sizes="16x16"
|
||||
href="/assets/icon/xplr16.png"
|
||||
/>
|
||||
|
||||
<!-- Bootstrap CSS / Color Scheme -->
|
||||
<link rel="stylesheet" href="css/default.css" id="theme-color" />
|
||||
|
||||
<!-- ------------- SEO TAGS --------------------->
|
||||
<meta name="title" content="xplr" />
|
||||
<meta
|
||||
name="description"
|
||||
content="A hackable, minimal, fast TUI file explorer"
|
||||
/>
|
||||
|
||||
<meta name="twitter:title" content="xplr" />
|
||||
<meta
|
||||
name="twitter:description"
|
||||
content="A hackable, minimal, fast TUI file explorer"
|
||||
/>
|
||||
<meta
|
||||
name="twitter:image"
|
||||
content="https://s8.gifyu.com/images/xplr-0.17.6.jpg"
|
||||
/>
|
||||
<meta name="twitter:card" content="summary_large_image" />
|
||||
<meta name="twitter:url" content="https://xplr.dev" />
|
||||
|
||||
<meta property="og:title" content="xplr" />
|
||||
<meta property="og:type" content="object" />
|
||||
<meta property="og:url" content="https://xplr.dev" />
|
||||
<meta
|
||||
property="og:image"
|
||||
content="https://s8.gifyu.com/images/xplr-0.17.6.jpg"
|
||||
/>
|
||||
|
||||
<meta itemprop="name" content="xplr" />
|
||||
<meta
|
||||
itemprop="description"
|
||||
content="A hackable, minimal, fast TUI file explorer"
|
||||
/>
|
||||
|
||||
<!-- Youtube Embed -->
|
||||
|
||||
<link
|
||||
rel="stylesheet"
|
||||
href="https://cdn.jsdelivr.net/gh/paulirish/lite-youtube-embed@master/src/lite-yt-embed.min.css"
|
||||
/>
|
||||
|
||||
<script
|
||||
defer="defer"
|
||||
src="https://cdn.jsdelivr.net/gh/paulirish/lite-youtube-embed@master/src/lite-yt-embed.min.js"
|
||||
></script>
|
||||
|
||||
<!-- EthicalAds by "Read The Docs" folks -->
|
||||
<script
|
||||
async
|
||||
src="https://media.ethicalads.io/media/client/ethicalads.min.js"
|
||||
></script>
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<!--navigation-->
|
||||
<section>
|
||||
<div class="container">
|
||||
<nav class="navbar navbar-expand-md navbar-dark">
|
||||
<a class="navbar-brand heading-black" href="/">
|
||||
<img src="/assets/icon/xplr32.png" alt="xplr" />
|
||||
</a>
|
||||
<button
|
||||
class="navbar-toggler navbar-toggler-right border-0"
|
||||
type="button"
|
||||
data-toggle="collapse"
|
||||
data-target="#navbarCollapse"
|
||||
aria-controls="navbarCollapse"
|
||||
aria-expanded="false"
|
||||
aria-label="Toggle navigation"
|
||||
>
|
||||
<span data-feather="grid"></span>
|
||||
</button>
|
||||
<div class="collapse navbar-collapse" id="navbarCollapse">
|
||||
<ul class="navbar-nav ml-auto">
|
||||
<li class="nav-item">
|
||||
<a
|
||||
class="nav-link page-scroll"
|
||||
href="/en/introduction.html#features"
|
||||
>
|
||||
Features
|
||||
</a>
|
||||
</li>
|
||||
<li class="nav-item">
|
||||
<a class="nav-link page-scroll" href="/en">Documentation</a>
|
||||
</li>
|
||||
<li class="nav-item">
|
||||
<a class="nav-link page-scroll" href="/en/community.html">
|
||||
Community
|
||||
</a>
|
||||
</li>
|
||||
<li class="nav-item">
|
||||
<a
|
||||
class="nav-link page-scroll"
|
||||
href="https://blog.xplr.dev"
|
||||
target="_blank"
|
||||
rel="noreferrer noopener"
|
||||
>
|
||||
Blog
|
||||
</a>
|
||||
</li>
|
||||
<li class="nav-item">
|
||||
<a
|
||||
class="nav-link page-scroll"
|
||||
href="https://github.com/sayanarijit/xplr"
|
||||
target="_blank"
|
||||
rel="noreferrer noopener"
|
||||
>
|
||||
GitHub
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<hr />
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<section>
|
||||
<div class="container">
|
||||
<div
|
||||
id="landing-under-navbar"
|
||||
class="dark flat"
|
||||
data-ea-publisher="xplrdev"
|
||||
data-ea-type="text"
|
||||
></div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<!--hero header-->
|
||||
<section id="home">
|
||||
<div class="container">
|
||||
<div class="row">
|
||||
<div class="col-md-8 col-sm-10 col-12 mx-auto my-auto text-center">
|
||||
<h1 class="heading-black">xplr</h1>
|
||||
<p class="lead">A hackable, minimal, fast TUI file explorer</p>
|
||||
|
||||
<div id="QJaEMeVo9Uw" class="eleventy-plugin-youtube-embed pb-3">
|
||||
<lite-youtube
|
||||
videoid="QJaEMeVo9Uw"
|
||||
style="
|
||||
background-image: url('https://s8.gifyu.com/images/xplr-0.17.6.jpg');
|
||||
"
|
||||
>
|
||||
<div class="lty-playbtn"></div>
|
||||
</lite-youtube>
|
||||
</div>
|
||||
|
||||
<a
|
||||
class="btn btn-primary d-inline-flex flex-row align-items-center py-3"
|
||||
href="/en/install.html"
|
||||
class="mb-3"
|
||||
>
|
||||
Try or Install
|
||||
<em class="ml-2" data-feather="arrow-right"></em>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<!--scroll to top-->
|
||||
<div class="scroll-top">
|
||||
<i class="fa fa-angle-up" aria-hidden="true"></i>
|
||||
</div>
|
||||
|
||||
<!-- jQuery first, then Popper.js, then Bootstrap JS -->
|
||||
<script src="https://code.jquery.com/jquery-3.2.1.min.js"></script>
|
||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.12.9/umd/popper.min.js"></script>
|
||||
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0/js/bootstrap.min.js"></script>
|
||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/feather-icons/4.7.3/feather.min.js"></script>
|
||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/slick-carousel/1.8.1/slick.min.js"></script>
|
||||
<script src="js/scripts.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@ -1,73 +0,0 @@
|
||||
$(function () {
|
||||
|
||||
// init feather icons
|
||||
feather.replace();
|
||||
|
||||
// init tooltip & popovers
|
||||
$('[data-toggle="tooltip"]').tooltip();
|
||||
$('[data-toggle="popover"]').popover();
|
||||
|
||||
//page scroll
|
||||
$('a.page-scroll').bind('click', function (event) {
|
||||
var $anchor = $(this);
|
||||
$('html, body').stop().animate({
|
||||
scrollTop: $($anchor.attr('href')).offset().top - 20
|
||||
}, 1000);
|
||||
event.preventDefault();
|
||||
});
|
||||
|
||||
// slick slider
|
||||
$('.slick-about').slick({
|
||||
slidesToShow: 1,
|
||||
slidesToScroll: 1,
|
||||
autoplay: true,
|
||||
autoplaySpeed: 3000,
|
||||
dots: true,
|
||||
arrows: false
|
||||
});
|
||||
|
||||
//toggle scroll menu
|
||||
var scrollTop = 0;
|
||||
$(window).scroll(function () {
|
||||
var scroll = $(window).scrollTop();
|
||||
//adjust menu background
|
||||
if (scroll > 80) {
|
||||
if (scroll > scrollTop) {
|
||||
$('.smart-scroll').addClass('scrolling').removeClass('up');
|
||||
} else {
|
||||
$('.smart-scroll').addClass('up');
|
||||
}
|
||||
} else {
|
||||
// remove if scroll = scrollTop
|
||||
$('.smart-scroll').removeClass('scrolling').removeClass('up');
|
||||
}
|
||||
|
||||
scrollTop = scroll;
|
||||
|
||||
// adjust scroll to top
|
||||
if (scroll >= 600) {
|
||||
$('.scroll-top').addClass('active');
|
||||
} else {
|
||||
$('.scroll-top').removeClass('active');
|
||||
}
|
||||
return false;
|
||||
});
|
||||
|
||||
// scroll top top
|
||||
$('.scroll-top').click(function () {
|
||||
$('html, body').stop().animate({
|
||||
scrollTop: 0
|
||||
}, 1000);
|
||||
});
|
||||
|
||||
/**Theme switcher - DEMO PURPOSE ONLY */
|
||||
$('.switcher-trigger').click(function () {
|
||||
$('.switcher-wrap').toggleClass('active');
|
||||
});
|
||||
$('.color-switcher ul li').click(function () {
|
||||
var color = $(this).attr('data-color');
|
||||
$('#theme-color').attr("href", "css/" + color + ".css");
|
||||
$('.color-switcher ul li').removeClass('active');
|
||||
$(this).addClass('active');
|
||||
});
|
||||
});
|
||||
@ -1,561 +0,0 @@
|
||||
/*!
|
||||
* Created by Kroplet (https://www.kroplet.com)
|
||||
* The easiest way to create Bootstrap 4 themes.
|
||||
*/
|
||||
|
||||
/*****************
|
||||
Custom CSS
|
||||
*****************/
|
||||
body {
|
||||
border-color: $black;
|
||||
}
|
||||
.small-xl {
|
||||
font-size: 90%;
|
||||
}
|
||||
|
||||
.img-faded {
|
||||
opacity: 0.5;
|
||||
}
|
||||
.font-weight-medium {
|
||||
font-weight: 600;
|
||||
}
|
||||
.heading-black {
|
||||
font-weight: 800;
|
||||
}
|
||||
|
||||
/* Box shadow */
|
||||
.btn {
|
||||
text-transform: uppercase;
|
||||
font-size: 15px;
|
||||
|
||||
@each $color, $value in $theme-colors {
|
||||
&.btn-#{$color} {
|
||||
box-shadow: 0 8px 16px rgba($value, 0.3);
|
||||
transition: all 0.2s ease-out;
|
||||
&:hover {
|
||||
box-shadow: 0 8px 20px rgba($value, 0.35);
|
||||
}
|
||||
&:active {
|
||||
box-shadow: none !important;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/*Navbar*/
|
||||
.navbar {
|
||||
&.navbar-transparent {
|
||||
opacity: 0.98;
|
||||
}
|
||||
|
||||
@media (max-width: 992px) {
|
||||
&.navbar-transparent {
|
||||
background-color: rgba($black, 0.4);
|
||||
}
|
||||
}
|
||||
|
||||
.navbar-brand {
|
||||
font-size: 1.5rem;
|
||||
font-weight: 900;
|
||||
color: $primary;
|
||||
text-transform: uppercase;
|
||||
}
|
||||
|
||||
.navbar-nav .nav-item {
|
||||
margin: 0 0.7rem;
|
||||
|
||||
.nav-link {
|
||||
font-weight: 600;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
.section-angle {
|
||||
position: relative;
|
||||
border-color: inherit;
|
||||
background: $black;
|
||||
|
||||
&:before,
|
||||
&:after {
|
||||
width: 0;
|
||||
height: 0;
|
||||
position: absolute;
|
||||
content: '';
|
||||
left: 0;
|
||||
border: 0 solid transparent;
|
||||
z-index: 3;
|
||||
}
|
||||
|
||||
&.top-left:before,
|
||||
&.top-right:before {
|
||||
top: 0;
|
||||
border-left-width: 100vw;
|
||||
}
|
||||
|
||||
&.bottom-left:after,
|
||||
&.bottom-right:after {
|
||||
bottom: 0;
|
||||
border-right-width: 100vw;
|
||||
}
|
||||
|
||||
&.bottom-left:after {
|
||||
border-right-color: inherit;
|
||||
}
|
||||
|
||||
&.bottom-right:after {
|
||||
border-bottom-color: inherit;
|
||||
}
|
||||
|
||||
&.top-left:before {
|
||||
border-top-color: inherit;
|
||||
}
|
||||
|
||||
&.top-right:before {
|
||||
border-left-color: inherit;
|
||||
}
|
||||
|
||||
@include media-breakpoint-up('lg') {
|
||||
&.bottom-right:after,
|
||||
&.top-right:before {
|
||||
border-bottom-width: 2rem;
|
||||
}
|
||||
&.bottom-left:after,
|
||||
&.top-left:before {
|
||||
border-top-width: 2rem;
|
||||
}
|
||||
}
|
||||
|
||||
@include media-breakpoint-down('sm') {
|
||||
&.bottom-right:after,
|
||||
&.top-right:before {
|
||||
border-bottom-width: 1rem;
|
||||
}
|
||||
&.bottom-left:after,
|
||||
&.top-left:before {
|
||||
border-top-width: 1rem;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/*smart scrolling*/
|
||||
.smart-scroll {
|
||||
position: fixed;
|
||||
top: 0;
|
||||
z-index: 1020;
|
||||
width: 100%;
|
||||
transition: all 0.3s ease-out;
|
||||
|
||||
&.scrolling {
|
||||
transform: translateY(-100%);
|
||||
|
||||
&.up {
|
||||
background-color: rgba($black, 0.9);
|
||||
transform: translateY(0);
|
||||
transition: all 0.3s ease-out;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**dividers */
|
||||
.divider {
|
||||
position: relative;
|
||||
|
||||
&.top-divider:before {
|
||||
content: '';
|
||||
position: absolute;
|
||||
top: 0;
|
||||
left: 0;
|
||||
width: 100%;
|
||||
display: block;
|
||||
height: 1px;
|
||||
background: $gray-900;
|
||||
background: linear-gradient(
|
||||
to right,
|
||||
rgba($primary, 0.1) 0,
|
||||
$gray-900 50%,
|
||||
rgba($primary, 0.1) 100%
|
||||
);
|
||||
}
|
||||
|
||||
&.bottom-divider:after {
|
||||
content: '';
|
||||
position: absolute;
|
||||
bottom: 0;
|
||||
left: 0;
|
||||
width: 100%;
|
||||
display: block;
|
||||
height: 1px;
|
||||
background: $gray-900;
|
||||
background: linear-gradient(
|
||||
to right,
|
||||
rgba($primary, 0.24) 0,
|
||||
$gray-900 50%,
|
||||
rgba($primary, 0.24) 100%
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
/*vertical heights */
|
||||
.vh-100 {
|
||||
height: 100vh;
|
||||
}
|
||||
|
||||
@media (min-width: 576px) {
|
||||
.vh-sm-100 {
|
||||
height: 100vh;
|
||||
}
|
||||
}
|
||||
|
||||
@media (min-width: 768px) {
|
||||
.vh-md-100 {
|
||||
height: 100vh;
|
||||
}
|
||||
}
|
||||
|
||||
.bg-hero {
|
||||
background-color: $black;
|
||||
background-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='100%25' height='100%25' viewBox='0 0 800 800'%3E%3Cg %3E%3Ccircle fill='#{$black}' cx='400' cy='400' r='600'/%3E%3Ccircle fill='#{darken($primary,40%)}' cx='400' cy='400' r='500'/%3E%3Ccircle fill='#{darken($primary,30%)}' cx='400' cy='400' r='400'/%3E%3Ccircle fill='#{darken($primary,20%)}' cx='400' cy='400' r='300'/%3E%3Ccircle fill='#{darken($primary,10%)}' cx='400' cy='400' r='200'/%3E%3Ccircle fill='#{$primary}' cx='400' cy='400' r='100'/%3E%3C/g%3E%3C/svg%3E");
|
||||
/* background by SVGBackgrounds.com */
|
||||
background-attachment: fixed;
|
||||
background-size: cover;
|
||||
position: relative;
|
||||
|
||||
&:before {
|
||||
position: absolute;
|
||||
z-index: 1;
|
||||
width: 100%;
|
||||
height: 100%;
|
||||
display: block;
|
||||
left: 0;
|
||||
top: 0;
|
||||
content: '';
|
||||
background-color: rgba($black, 0.7);
|
||||
}
|
||||
|
||||
.container {
|
||||
z-index: 2;
|
||||
position: relative;
|
||||
}
|
||||
}
|
||||
|
||||
/*features boxes*/
|
||||
.feature-boxes {
|
||||
text-align: center;
|
||||
|
||||
.box {
|
||||
padding: 3rem;
|
||||
}
|
||||
}
|
||||
|
||||
/*features-list */
|
||||
.features-list {
|
||||
list-style: none;
|
||||
|
||||
li {
|
||||
float: left;
|
||||
width: 50%;
|
||||
margin-top: 0;
|
||||
margin-bottom: 1.75rem;
|
||||
font-size: 1.05rem;
|
||||
padding-left: 1.75rem;
|
||||
font-weight: 500;
|
||||
|
||||
&:before {
|
||||
position: relative;
|
||||
font-family: FontAwesome;
|
||||
font-size: 14px;
|
||||
content: '\f10c';
|
||||
color: $primary;
|
||||
margin: 0 0.75rem 0 0;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/*Pricing tables*/
|
||||
.pricing-table {
|
||||
.pricing-list {
|
||||
margin-bottom: 3rem;
|
||||
margin-top: 2rem;
|
||||
li {
|
||||
margin-bottom: 1rem;
|
||||
font-size: 1.05rem;
|
||||
font-weight: 500;
|
||||
}
|
||||
}
|
||||
|
||||
.card {
|
||||
transition: all 0.25s ease-out;
|
||||
text-align: center;
|
||||
|
||||
.card-body {
|
||||
padding: 2.25rem 2rem;
|
||||
}
|
||||
|
||||
&.active {
|
||||
color: white;
|
||||
background-color: transparent;
|
||||
|
||||
h2,
|
||||
h3 {
|
||||
color: $white;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**slick slider */
|
||||
.slick-dots {
|
||||
top: -4rem;
|
||||
|
||||
li {
|
||||
button::before {
|
||||
font-size: 0.75rem !important;
|
||||
line-height: 3.5rem !important;
|
||||
}
|
||||
|
||||
button::before,
|
||||
&.slick-active button:before {
|
||||
color: $primary !important;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
.slick-next:before,
|
||||
.slick-prev:before {
|
||||
color: rgba($primary, 0.2);
|
||||
}
|
||||
|
||||
.slick-next:hover:before,
|
||||
.slick-prev:hover:before {
|
||||
color: $primary;
|
||||
}
|
||||
|
||||
/*footer*/
|
||||
footer {
|
||||
ul > li {
|
||||
padding: 0.5rem 0;
|
||||
}
|
||||
|
||||
a {
|
||||
color: rgba($white, 0.7);
|
||||
text-decoration: none;
|
||||
font-weight: 500;
|
||||
transition: all 0.25s ease-out;
|
||||
|
||||
&:hover {
|
||||
color: rgba($white, 0.9);
|
||||
text-decoration: underline;
|
||||
}
|
||||
}
|
||||
|
||||
h5 {
|
||||
font-size: 1rem;
|
||||
text-transform: uppercase;
|
||||
}
|
||||
}
|
||||
|
||||
/*social icons*/
|
||||
.social {
|
||||
a {
|
||||
width: 45px;
|
||||
height: 45px;
|
||||
background: transparent;
|
||||
display: block;
|
||||
text-align: center;
|
||||
color: gray-100;
|
||||
border-radius: 4px;
|
||||
font-size: 18px;
|
||||
line-height: 45px;
|
||||
|
||||
&:hover {
|
||||
background: $primary;
|
||||
color: $black;
|
||||
transition: all 0.4s ease-in-out;
|
||||
}
|
||||
}
|
||||
|
||||
&.social-sm a {
|
||||
width: 35px;
|
||||
height: 35px;
|
||||
font-size: 16px;
|
||||
line-height: 35px;
|
||||
}
|
||||
|
||||
&.social-rounded a {
|
||||
border-radius: 50%;
|
||||
}
|
||||
}
|
||||
|
||||
/*scroll to top */
|
||||
.scroll-top {
|
||||
bottom: 20px;
|
||||
font-size: 20px;
|
||||
height: 40px;
|
||||
position: fixed;
|
||||
text-align: center;
|
||||
width: 40px;
|
||||
z-index: 10;
|
||||
cursor: pointer;
|
||||
transition: 0.3s;
|
||||
border-radius: 50%;
|
||||
line-height: 40px;
|
||||
right: -100px;
|
||||
color: $white;
|
||||
background-color: rgba($primary, 0.5);
|
||||
|
||||
&:hover {
|
||||
background-color: rgba($primary, 1);
|
||||
transition: all 0.4s ease-in-out;
|
||||
}
|
||||
|
||||
&.active {
|
||||
right: 20px;
|
||||
}
|
||||
}
|
||||
|
||||
/* Icon Boxes */
|
||||
.icon-box {
|
||||
position: relative;
|
||||
border-radius: 50%;
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
background-color: $white;
|
||||
margin: 1rem;
|
||||
|
||||
@each $color, $value in $theme-colors {
|
||||
&.box-#{$color} {
|
||||
color: $value;
|
||||
background-color: rgba($value, 0.1);
|
||||
}
|
||||
}
|
||||
|
||||
.icon-box-inner {
|
||||
display: flex;
|
||||
flex-direction: row;
|
||||
align-items: center;
|
||||
padding: 1.5rem;
|
||||
|
||||
&.small {
|
||||
padding: 1.25rem;
|
||||
}
|
||||
|
||||
&.small-xs {
|
||||
padding: 1rem;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/*all themes colors*/
|
||||
.bg-black {
|
||||
background-color: $black;
|
||||
}
|
||||
.bg-blue {
|
||||
background-color: $blue;
|
||||
}
|
||||
.bg-indigo {
|
||||
background-color: $indigo;
|
||||
}
|
||||
.bg-purple {
|
||||
background-color: $purple;
|
||||
}
|
||||
.bg-pink {
|
||||
background-color: $pink;
|
||||
}
|
||||
.bg-red {
|
||||
background-color: $red;
|
||||
}
|
||||
.bg-orange {
|
||||
background-color: $orange;
|
||||
}
|
||||
.bg-yellow {
|
||||
background-color: $yellow;
|
||||
}
|
||||
.bg-green {
|
||||
background-color: $green;
|
||||
}
|
||||
.bg-teal {
|
||||
background-color: $teal;
|
||||
}
|
||||
.bg-cyan {
|
||||
background-color: $cyan;
|
||||
}
|
||||
|
||||
/*theme switcher*/
|
||||
.switcher-wrap {
|
||||
position: fixed;
|
||||
top: 250px;
|
||||
width: 250px;
|
||||
background: $gray-900;
|
||||
color: $body-color;
|
||||
z-index: 100;
|
||||
padding: 20px;
|
||||
left: -250px;
|
||||
transition: 0.3s;
|
||||
|
||||
&.active {
|
||||
left: 0;
|
||||
}
|
||||
|
||||
ul {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
list-style: none;
|
||||
|
||||
li {
|
||||
margin-bottom: 0.5rem;
|
||||
|
||||
a {
|
||||
color: $body-color;
|
||||
|
||||
&:hover {
|
||||
color: $primary;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
.color-switcher ul li {
|
||||
width: 28px;
|
||||
height: 28px;
|
||||
float: left;
|
||||
margin: 3px;
|
||||
margin-bottom: 10px;
|
||||
cursor: pointer;
|
||||
transition: 0.3s;
|
||||
|
||||
&.active {
|
||||
border: 3px solid $gray-800;
|
||||
}
|
||||
}
|
||||
|
||||
.switcher-trigger {
|
||||
position: absolute;
|
||||
left: 100%;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
background: $gray-900;
|
||||
top: 0;
|
||||
font-size: 20px;
|
||||
text-align: center;
|
||||
color: rgba($primary, 0.5);
|
||||
cursor: pointer;
|
||||
display: flex;
|
||||
align-items: center;
|
||||
justify-content: center;
|
||||
border-radius: 0 2px 2px 0;
|
||||
|
||||
&:hover {
|
||||
color: $primary;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@media screen and (max-width: 768px) {
|
||||
.switcher-wrap {
|
||||
display: none;
|
||||
}
|
||||
}
|
||||
|
||||
.ea-text {
|
||||
text-align: center;
|
||||
}
|
||||
@ -1,11 +0,0 @@
|
||||
v="0.4.40"
|
||||
|
||||
curl -L https://github.com/rust-lang/mdBook/releases/download/v$v/mdbook-v$v-x86_64-unknown-linux-gnu.tar.gz -o mdbook.tgz \
|
||||
&& tar xzvf mdbook.tgz \
|
||||
&& ./mdbook build docs/en \
|
||||
&& mkdir dist \
|
||||
&& mv -v docs/en/book/html dist/en \
|
||||
&& mv -v assets dist \
|
||||
&& mv -v docs/landing/index.html docs/landing/css docs/landing/js dist \
|
||||
&& rm -v mdbook \
|
||||
&& rm -v mdbook.tgz
|
||||
@ -1,279 +0,0 @@
|
||||
"""Generate docs from comments."""
|
||||
|
||||
import os
|
||||
from dataclasses import dataclass
|
||||
from typing import List
|
||||
|
||||
# Messages --------------------------------------------------------------------
|
||||
|
||||
MESSAGES_DOC_TEMPLATE = """
|
||||
# Full List of Messages
|
||||
|
||||
xplr [messages][1] categorized based on their purpose.
|
||||
|
||||
## Categories
|
||||
|
||||
{categories}
|
||||
|
||||
{msgs}
|
||||
|
||||
## Also See:
|
||||
|
||||
- [Message][1]
|
||||
|
||||
[1]: message.md
|
||||
""".strip()
|
||||
|
||||
CONFIGURATION_DOC_TEMPLATE = """
|
||||
# Configuration
|
||||
|
||||
{doc}
|
||||
|
||||
""".strip()
|
||||
|
||||
|
||||
@dataclass
|
||||
class MsgSection:
|
||||
title: str
|
||||
body: List[str]
|
||||
|
||||
|
||||
@dataclass
|
||||
class MsgCategory:
|
||||
title: str
|
||||
sections: List[MsgSection]
|
||||
|
||||
|
||||
@dataclass
|
||||
class MsgResult:
|
||||
categories: List[MsgCategory]
|
||||
msgs: List[str]
|
||||
|
||||
|
||||
def gen_messages():
|
||||
"""Generate messages.md"""
|
||||
|
||||
path = "./src/msg/in_/external.rs"
|
||||
res = []
|
||||
reading = False
|
||||
|
||||
with open(path) as f:
|
||||
lines = iter(f.read().splitlines())
|
||||
|
||||
for line in lines:
|
||||
line = line.strip()
|
||||
|
||||
if line.startswith("pub enum ExternalMsg {"):
|
||||
reading = True
|
||||
continue
|
||||
|
||||
if not reading:
|
||||
continue
|
||||
|
||||
if line == "}":
|
||||
break
|
||||
|
||||
if line.startswith("/// ### "):
|
||||
line = line.lstrip("/// ### ").rstrip("-").strip()
|
||||
sec = MsgSection(title=None, body=[])
|
||||
cat = MsgCategory(title=line, sections=[sec])
|
||||
res.append(cat)
|
||||
continue
|
||||
|
||||
if line.startswith("/// "):
|
||||
line = line.lstrip("/// ").strip()
|
||||
res[-1].sections[-1].body.append(line)
|
||||
continue
|
||||
|
||||
if not line or line == "///":
|
||||
res[-1].sections[-1].body.append("")
|
||||
continue
|
||||
|
||||
if line.endswith(","):
|
||||
line = line.split(",")[0].split("(")[0]
|
||||
res[-1].sections[-1].title = line
|
||||
|
||||
sec = MsgSection(title=None, body=[])
|
||||
res[-1].sections.append(sec)
|
||||
continue
|
||||
|
||||
result = MsgResult(categories=[], msgs=[])
|
||||
|
||||
for cat in res:
|
||||
slug = cat.title.lower().replace(" ", "-")
|
||||
result.categories.append(f"- [{cat.title}](#{slug})")
|
||||
result.msgs.append(f"### {cat.title}")
|
||||
result.msgs.append("")
|
||||
|
||||
for sec in cat.sections:
|
||||
if not sec.title:
|
||||
continue
|
||||
|
||||
result.msgs.append(f"#### {sec.title}")
|
||||
result.msgs.append("")
|
||||
for line in sec.body:
|
||||
result.msgs.append(f"{line}")
|
||||
result.msgs.append("")
|
||||
|
||||
messages = MESSAGES_DOC_TEMPLATE.format(
|
||||
categories="\n".join(result.categories), msgs="\n".join(result.msgs)
|
||||
)
|
||||
|
||||
print(messages)
|
||||
with open("./docs/en/src/messages.md", "w") as f:
|
||||
print(messages, file=f)
|
||||
|
||||
|
||||
# Configuration ---------------------------------------------------------------
|
||||
|
||||
|
||||
def gen_configuration():
|
||||
"""Generate the following docs.
|
||||
|
||||
- configuration.md
|
||||
- general-config.md
|
||||
- node_types.md
|
||||
- layouts.md
|
||||
- modes.md
|
||||
- modes.md
|
||||
"""
|
||||
|
||||
path = "./src/init.lua"
|
||||
|
||||
configuration = [[]]
|
||||
general = [[]]
|
||||
node_types = [[]]
|
||||
layouts = [[]]
|
||||
modes = [[]]
|
||||
|
||||
with open(path) as f:
|
||||
lines = iter(f.read().splitlines())
|
||||
|
||||
reading = None
|
||||
|
||||
for line in lines:
|
||||
if line.startswith("---"):
|
||||
continue
|
||||
|
||||
if (
|
||||
line.startswith("-- # Configuration ")
|
||||
or line.startswith("-- ## Config ")
|
||||
or line.startswith("-- ## Function ")
|
||||
or line.startswith("-- ## On Load ")
|
||||
):
|
||||
reading = configuration
|
||||
|
||||
if line.startswith("-- ### General Configuration "):
|
||||
reading = general
|
||||
|
||||
if line.startswith("-- ### Node Types "):
|
||||
reading = node_types
|
||||
|
||||
if line.startswith("-- ### Layouts "):
|
||||
reading = layouts
|
||||
|
||||
if line.startswith("-- ### Modes "):
|
||||
reading = modes
|
||||
|
||||
if not reading:
|
||||
continue
|
||||
|
||||
if line.startswith("-- ") or line == "--":
|
||||
if line.startswith("-- #") and line.endswith("--"):
|
||||
line = "\n{0}\n".format(line.rstrip("-"))
|
||||
|
||||
reading[-1].append(line[3:])
|
||||
continue
|
||||
|
||||
if line.startswith("xplr.") and reading[-1]:
|
||||
reading[-1].insert(0, "\n#### {0}\n".format(line.split()[0]))
|
||||
continue
|
||||
|
||||
if not line.strip() and reading[-1]:
|
||||
reading.append([])
|
||||
continue
|
||||
|
||||
with open("./docs/en/src/configuration.md", "w") as f:
|
||||
doc = "\n".join(["\n".join(c) for c in configuration])
|
||||
print(doc)
|
||||
print(doc, file=f)
|
||||
|
||||
with open("./docs/en/src/general-config.md", "w") as f:
|
||||
doc = "\n".join(["\n".join(c) for c in general])
|
||||
print(doc)
|
||||
print(doc, file=f)
|
||||
|
||||
with open("./docs/en/src/node_types.md", "w") as f:
|
||||
doc = "\n".join(["\n".join(c) for c in node_types])
|
||||
print(doc)
|
||||
print(doc, file=f)
|
||||
|
||||
with open("./docs/en/src/layouts.md", "w") as f:
|
||||
doc = "\n".join(["\n".join(c) for c in layouts])
|
||||
print(doc)
|
||||
print(doc, file=f)
|
||||
|
||||
with open("./docs/en/src/modes.md", "w") as f:
|
||||
doc = "\n".join(["\n".join(c) for c in modes])
|
||||
print(doc)
|
||||
print(doc, file=f)
|
||||
|
||||
|
||||
# xplr.util -------------------------------------------------------------------
|
||||
|
||||
|
||||
@dataclass
|
||||
class Function:
|
||||
doc: List[str]
|
||||
name: str
|
||||
|
||||
|
||||
def gen_xplr_util():
|
||||
|
||||
path = "./src/lua/util.rs"
|
||||
|
||||
functions: List[Function] = []
|
||||
|
||||
with open(path) as f:
|
||||
lines = iter(f.read().splitlines())
|
||||
|
||||
reading = None
|
||||
|
||||
for line in lines:
|
||||
if line.startswith("///"):
|
||||
if reading:
|
||||
reading.doc.append(line[4:])
|
||||
else:
|
||||
reading = Function(doc=[line[4:]], name="")
|
||||
|
||||
if line.startswith("pub fn") and reading:
|
||||
reading.name = "\n### xplr.util." + line.split("<")[0].split()[-1] + "\n"
|
||||
functions.append(reading)
|
||||
reading = None
|
||||
continue
|
||||
|
||||
with open("./docs/en/src/xplr.util.md", "w") as f:
|
||||
for function in functions:
|
||||
print(function.name)
|
||||
print(function.name, file=f)
|
||||
|
||||
print("\n".join(function.doc))
|
||||
print("\n".join(function.doc), file=f)
|
||||
|
||||
if reading:
|
||||
print("\n".join(reading.doc), file=f)
|
||||
|
||||
|
||||
def format_docs():
|
||||
os.system("prettier --write docs/en/src")
|
||||
|
||||
|
||||
def main():
|
||||
gen_messages()
|
||||
gen_configuration()
|
||||
gen_xplr_util()
|
||||
format_docs()
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
@ -0,0 +1,151 @@
|
||||
@import url('https://fonts.googleapis.com/css2?family=Share+Tech+Mono&display=swap');
|
||||
* {
|
||||
padding: 0;
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
body {
|
||||
color: #2d3436;
|
||||
}
|
||||
|
||||
h1 {
|
||||
padding-left: 5px;
|
||||
font-family: 'Share Tech Mono', monospace;
|
||||
font-size: 5rem;
|
||||
padding-top: 2vh;
|
||||
text-align: center;
|
||||
transform: translateY(-50px);
|
||||
}
|
||||
|
||||
.main-page {
|
||||
display: grid;
|
||||
grid-template-columns: repeat(2, 1fr);
|
||||
background-color: #dfe6e9;
|
||||
min-height: 100vh;
|
||||
}
|
||||
|
||||
.para {
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
font-family: Arial, Helvetica, sans-serif;
|
||||
font-size: 2rem;
|
||||
color: rgba(0, 0, 0, 0.9);
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
.para .more a {
|
||||
font-size: 1.5rem;
|
||||
color: #636e72;
|
||||
}
|
||||
|
||||
.main-video {
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
}
|
||||
|
||||
.main-video img {
|
||||
margin-right: 0rem;
|
||||
}
|
||||
|
||||
.links {
|
||||
display: grid;
|
||||
grid-template-columns: repeat(2, 1fr);
|
||||
grid-gap: 2rem;
|
||||
margin: 5rem 0;
|
||||
}
|
||||
|
||||
.links .linkCad {
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
height: 40vh;
|
||||
box-shadow: 0px 2px 10px rgba(0, 0, 0, 0.15);
|
||||
color: #2d3436;
|
||||
font-family: sans-serif;
|
||||
cursor: pointer;
|
||||
}
|
||||
|
||||
.links .linkCad:hover {
|
||||
box-shadow: 0px 2px 15px rgba(0, 0, 0, 0.2);
|
||||
}
|
||||
|
||||
.links a {
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
.links .linkCad p {
|
||||
padding-top: 2rem;
|
||||
font-weight: 600;
|
||||
}
|
||||
|
||||
.mrgL {
|
||||
margin-left: 60%;
|
||||
}
|
||||
|
||||
.mrgR {
|
||||
margin-right: 60%;
|
||||
}
|
||||
|
||||
@media (max-width: 1300px) {
|
||||
.mrgL {
|
||||
margin-left: 50%;
|
||||
}
|
||||
.mrgR {
|
||||
margin-right: 50%;
|
||||
}
|
||||
}
|
||||
|
||||
@media (max-width: 1050px) {
|
||||
.mrgL {
|
||||
margin-left: 40%;
|
||||
}
|
||||
.mrgR {
|
||||
margin-right: 40%;
|
||||
}
|
||||
.main-page {
|
||||
display: block;
|
||||
}
|
||||
.para {
|
||||
padding: 5rem 0;
|
||||
}
|
||||
}
|
||||
|
||||
@media (max-width: 850px) {
|
||||
.mrgL {
|
||||
margin-left: 30%;
|
||||
}
|
||||
.mrgR {
|
||||
margin-right: 30%;
|
||||
}
|
||||
}
|
||||
|
||||
@media (max-width: 700px) {
|
||||
.mrgL {
|
||||
margin-left: 15%;
|
||||
}
|
||||
.mrgR {
|
||||
margin-right: 15%;
|
||||
}
|
||||
}
|
||||
|
||||
@media (max-width: 550px) {
|
||||
.mrgL {
|
||||
margin-left: 0%;
|
||||
}
|
||||
.mrgR {
|
||||
margin-right: 0%;
|
||||
}
|
||||
.links {
|
||||
display: block;
|
||||
}
|
||||
.links {
|
||||
margin-top: 0rem;
|
||||
}
|
||||
.linkCad {
|
||||
margin-bottom: 4rem;
|
||||
}
|
||||
}
|
||||
@ -1,26 +0,0 @@
|
||||
{
|
||||
"nodes": {
|
||||
"nixpkgs": {
|
||||
"locked": {
|
||||
"lastModified": 1704262187,
|
||||
"narHash": "sha256-N4j9qghlp/Eb3Z11WF7Cb9U91AXwpascUbLH7YKMcLc=",
|
||||
"owner": "nixos",
|
||||
"repo": "nixpkgs",
|
||||
"rev": "65f0d241783c94a08e4c9a3870736fc8854dd520",
|
||||
"type": "github"
|
||||
},
|
||||
"original": {
|
||||
"owner": "nixos",
|
||||
"repo": "nixpkgs",
|
||||
"type": "github"
|
||||
}
|
||||
},
|
||||
"root": {
|
||||
"inputs": {
|
||||
"nixpkgs": "nixpkgs"
|
||||
}
|
||||
}
|
||||
},
|
||||
"root": "root",
|
||||
"version": 7
|
||||
}
|
||||
@ -1,70 +0,0 @@
|
||||
{
|
||||
description = "xplr - A hackable, minimal, fast TUI file explorer";
|
||||
|
||||
inputs = {
|
||||
nixpkgs.url = "github:nixos/nixpkgs";
|
||||
};
|
||||
|
||||
outputs = inputs@{ self, nixpkgs, ... }:
|
||||
let
|
||||
lib = nixpkgs.lib;
|
||||
|
||||
darwin = [ "x86_64-darwin" "aarch64-darwin" ];
|
||||
linux = [ "x86_64-linux" "x86_64-linux-musl" "aarch64-linux" "aarch64-linux-android" "i86_64-linux" ];
|
||||
allSystems = darwin ++ linux;
|
||||
|
||||
forEachSystem = systems: f: lib.genAttrs systems (system: f system);
|
||||
forAllSystems = forEachSystem allSystems;
|
||||
in
|
||||
{
|
||||
packages = forAllSystems (system:
|
||||
let
|
||||
pkgs = import nixpkgs { inherit system; };
|
||||
in
|
||||
rec {
|
||||
# e.g. nix build .#xplr
|
||||
xplr = pkgs.rustPlatform.buildRustPackage rec {
|
||||
name = "xplr";
|
||||
src = ./.;
|
||||
cargoLock = {
|
||||
lockFile = ./Cargo.lock;
|
||||
};
|
||||
};
|
||||
|
||||
# e.g. nix build .#cross.x86_64-linux-musl.xplr --impure
|
||||
cross = forEachSystem (lib.filter (sys: sys != system) allSystems) (targetSystem:
|
||||
let
|
||||
crossPkgs = import nixpkgs { localSystem = system; crossSystem = targetSystem; };
|
||||
in
|
||||
{ inherit (crossPkgs) xplr; }
|
||||
);
|
||||
}
|
||||
);
|
||||
defaultPackage = forAllSystems (system: self.packages.${system}.xplr);
|
||||
devShells = forAllSystems (system:
|
||||
let
|
||||
pkgs = import nixpkgs { inherit system; };
|
||||
devRequirements = with pkgs; [
|
||||
gcc
|
||||
gnumake
|
||||
clippy
|
||||
rustc
|
||||
cargo
|
||||
rustfmt
|
||||
rust-analyzer
|
||||
];
|
||||
in
|
||||
{
|
||||
default = pkgs.mkShell {
|
||||
RUST_BACKTRACE = 1;
|
||||
|
||||
# For cross compilation
|
||||
NIXPKGS_ALLOW_UNSUPPORTED_SYSTEM = 1;
|
||||
|
||||
buildInputs = devRequirements;
|
||||
packages = devRequirements;
|
||||
};
|
||||
}
|
||||
);
|
||||
};
|
||||
}
|
||||
@ -1,4 +1,4 @@
|
||||
edition = "2021"
|
||||
max_width = 89
|
||||
max_width = 80
|
||||
tab_spaces = 4
|
||||
use_field_init_shorthand = true
|
||||
|
||||
@ -1,26 +0,0 @@
|
||||
name: xplr
|
||||
version: git
|
||||
summary: A hackable, minimal, fast TUI file explorer
|
||||
description: |
|
||||
xplr is a terminal UI based file explorer
|
||||
that aims to increase our terminal productivity by being a flexible,
|
||||
interactive orchestrator for the ever growing awesome command-line
|
||||
utilities that work with the file-system.
|
||||
source-code: https://github.com/sayanarijit/xplr
|
||||
issues: https://github.com/sayanarijit/xplr/issues
|
||||
website: https://xplr.dev/
|
||||
|
||||
base: core20
|
||||
grade: devel # must be 'stable' to release into candidate/stable channels
|
||||
confinement: devmode # use 'strict' once you have the right plugs and slots
|
||||
|
||||
|
||||
parts:
|
||||
xplr:
|
||||
plugin: rust
|
||||
source: .
|
||||
|
||||
apps:
|
||||
xplr:
|
||||
command: bin/xplr
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@ -1,224 +0,0 @@
|
||||
// Things of the past, mostly bad decisions, which cannot erased, stays in this
|
||||
// haunted module.
|
||||
|
||||
use crate::app;
|
||||
use crate::lua;
|
||||
use crate::ui::block;
|
||||
use crate::ui::string_to_text;
|
||||
use crate::ui::Constraint;
|
||||
use crate::ui::ContentRendererArg;
|
||||
use crate::ui::UI;
|
||||
use serde::{Deserialize, Serialize};
|
||||
use tui::layout::Constraint as TuiConstraint;
|
||||
use tui::layout::Rect as TuiRect;
|
||||
use tui::widgets::Cell;
|
||||
use tui::widgets::List;
|
||||
use tui::widgets::ListItem;
|
||||
use tui::widgets::Paragraph;
|
||||
use tui::widgets::Row;
|
||||
use tui::widgets::Table;
|
||||
use tui::Frame;
|
||||
|
||||
/// A cursed enum from crate::ui.
|
||||
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
|
||||
#[serde(deny_unknown_fields)]
|
||||
pub enum ContentBody {
|
||||
/// A paragraph to render
|
||||
StaticParagraph { render: String },
|
||||
|
||||
/// A Lua function that returns a paragraph to render
|
||||
DynamicParagraph { render: String },
|
||||
|
||||
/// List to render
|
||||
StaticList { render: Vec<String> },
|
||||
|
||||
/// A Lua function that returns lines to render
|
||||
DynamicList { render: String },
|
||||
|
||||
/// A table to render
|
||||
StaticTable {
|
||||
widths: Vec<Constraint>,
|
||||
col_spacing: Option<u16>,
|
||||
render: Vec<Vec<String>>,
|
||||
},
|
||||
|
||||
/// A Lua function that returns a table to render
|
||||
DynamicTable {
|
||||
widths: Vec<Constraint>,
|
||||
col_spacing: Option<u16>,
|
||||
render: String,
|
||||
},
|
||||
}
|
||||
|
||||
/// A cursed struct from crate::ui.
|
||||
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
|
||||
#[serde(deny_unknown_fields)]
|
||||
pub struct CustomContent {
|
||||
pub title: Option<String>,
|
||||
pub body: ContentBody,
|
||||
}
|
||||
|
||||
/// A cursed function from crate::ui.
|
||||
pub fn draw_custom_content(
|
||||
ui: &mut UI,
|
||||
f: &mut Frame,
|
||||
layout_size: TuiRect,
|
||||
app: &app::App,
|
||||
content: CustomContent,
|
||||
) {
|
||||
let config = app.config.general.panel_ui.default.clone();
|
||||
let title = content.title;
|
||||
let body = content.body;
|
||||
|
||||
match body {
|
||||
ContentBody::StaticParagraph { render } => {
|
||||
let render = string_to_text(render);
|
||||
let content = Paragraph::new(render).block(block(
|
||||
config,
|
||||
title.map(|t| format!(" {t} ")).unwrap_or_default(),
|
||||
));
|
||||
f.render_widget(content, layout_size);
|
||||
}
|
||||
|
||||
ContentBody::DynamicParagraph { render } => {
|
||||
let ctx = ContentRendererArg {
|
||||
app: app.to_lua_ctx_light(),
|
||||
layout_size: layout_size.into(),
|
||||
screen_size: ui.screen_size.into(),
|
||||
scrolltop: ui.scrolltop as u16,
|
||||
};
|
||||
|
||||
let render = lua::serialize(ui.lua, &ctx)
|
||||
.map(|arg| {
|
||||
lua::call(ui.lua, &render, arg).unwrap_or_else(|e| format!("{e:?}"))
|
||||
})
|
||||
.unwrap_or_else(|e| e.to_string());
|
||||
|
||||
let render = string_to_text(render);
|
||||
|
||||
let content = Paragraph::new(render).block(block(
|
||||
config,
|
||||
title.map(|t| format!(" {t} ")).unwrap_or_default(),
|
||||
));
|
||||
f.render_widget(content, layout_size);
|
||||
}
|
||||
|
||||
ContentBody::StaticList { render } => {
|
||||
let items = render
|
||||
.into_iter()
|
||||
.map(string_to_text)
|
||||
.map(ListItem::new)
|
||||
.collect::<Vec<ListItem>>();
|
||||
|
||||
let content = List::new(items).block(block(
|
||||
config,
|
||||
title.map(|t| format!(" {t} ")).unwrap_or_default(),
|
||||
));
|
||||
f.render_widget(content, layout_size);
|
||||
}
|
||||
|
||||
ContentBody::DynamicList { render } => {
|
||||
let ctx = ContentRendererArg {
|
||||
app: app.to_lua_ctx_light(),
|
||||
layout_size: layout_size.into(),
|
||||
screen_size: ui.screen_size.into(),
|
||||
scrolltop: ui.scrolltop as u16,
|
||||
};
|
||||
|
||||
let items = lua::serialize(ui.lua, &ctx)
|
||||
.map(|arg| {
|
||||
lua::call(ui.lua, &render, arg)
|
||||
.unwrap_or_else(|e| vec![format!("{e:?}")])
|
||||
})
|
||||
.unwrap_or_else(|e| vec![e.to_string()])
|
||||
.into_iter()
|
||||
.map(string_to_text)
|
||||
.map(ListItem::new)
|
||||
.collect::<Vec<ListItem>>();
|
||||
|
||||
let content = List::new(items).block(block(
|
||||
config,
|
||||
title.map(|t| format!(" {t} ")).unwrap_or_default(),
|
||||
));
|
||||
f.render_widget(content, layout_size);
|
||||
}
|
||||
|
||||
ContentBody::StaticTable {
|
||||
widths,
|
||||
col_spacing,
|
||||
render,
|
||||
} => {
|
||||
let rows = render
|
||||
.into_iter()
|
||||
.map(|cols| {
|
||||
Row::new(
|
||||
cols.into_iter()
|
||||
.map(string_to_text)
|
||||
.map(Cell::from)
|
||||
.collect::<Vec<Cell>>(),
|
||||
)
|
||||
})
|
||||
.collect::<Vec<Row>>();
|
||||
|
||||
let widths = widths
|
||||
.into_iter()
|
||||
.map(|w| w.to_tui(ui.screen_size, layout_size))
|
||||
.collect::<Vec<TuiConstraint>>();
|
||||
|
||||
let content = Table::new(rows, widths)
|
||||
.column_spacing(col_spacing.unwrap_or(1))
|
||||
.block(block(
|
||||
config,
|
||||
title.map(|t| format!(" {t} ")).unwrap_or_default(),
|
||||
));
|
||||
|
||||
f.render_widget(content, layout_size);
|
||||
}
|
||||
|
||||
ContentBody::DynamicTable {
|
||||
widths,
|
||||
col_spacing,
|
||||
render,
|
||||
} => {
|
||||
let ctx = ContentRendererArg {
|
||||
app: app.to_lua_ctx_light(),
|
||||
layout_size: layout_size.into(),
|
||||
screen_size: ui.screen_size.into(),
|
||||
scrolltop: ui.scrolltop as u16,
|
||||
};
|
||||
|
||||
let rows = lua::serialize(ui.lua, &ctx)
|
||||
.map(|arg| {
|
||||
lua::call(ui.lua, &render, arg)
|
||||
.unwrap_or_else(|e| vec![vec![format!("{e:?}")]])
|
||||
})
|
||||
.unwrap_or_else(|e| vec![vec![e.to_string()]])
|
||||
.into_iter()
|
||||
.map(|cols| {
|
||||
Row::new(
|
||||
cols.into_iter()
|
||||
.map(string_to_text)
|
||||
.map(Cell::from)
|
||||
.collect::<Vec<Cell>>(),
|
||||
)
|
||||
})
|
||||
.collect::<Vec<Row>>();
|
||||
|
||||
let widths = widths
|
||||
.into_iter()
|
||||
.map(|w| w.to_tui(ui.screen_size, layout_size))
|
||||
.collect::<Vec<TuiConstraint>>();
|
||||
|
||||
let mut content = Table::new(rows, &widths).block(block(
|
||||
config,
|
||||
title.map(|t| format!(" {t} ")).unwrap_or_default(),
|
||||
));
|
||||
|
||||
if let Some(col_spacing) = col_spacing {
|
||||
content = content.column_spacing(col_spacing);
|
||||
};
|
||||
|
||||
f.render_widget(content, layout_size);
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -1,37 +0,0 @@
|
||||
use crate::node::Node;
|
||||
use serde::{Deserialize, Serialize};
|
||||
use time::OffsetDateTime;
|
||||
|
||||
#[derive(Debug, Clone, Eq, PartialEq, Serialize, Deserialize)]
|
||||
pub struct DirectoryBuffer {
|
||||
pub parent: String,
|
||||
pub nodes: Vec<Node>,
|
||||
pub total: usize,
|
||||
pub focus: usize,
|
||||
|
||||
#[serde(skip, default = "now")]
|
||||
pub explored_at: OffsetDateTime,
|
||||
}
|
||||
|
||||
impl DirectoryBuffer {
|
||||
pub fn new(parent: String, nodes: Vec<Node>, focus: usize) -> Self {
|
||||
let total = nodes.len();
|
||||
Self {
|
||||
parent,
|
||||
nodes,
|
||||
total,
|
||||
focus,
|
||||
explored_at: now(),
|
||||
}
|
||||
}
|
||||
|
||||
pub fn focused_node(&self) -> Option<&Node> {
|
||||
self.nodes.get(self.focus)
|
||||
}
|
||||
}
|
||||
|
||||
fn now() -> OffsetDateTime {
|
||||
OffsetDateTime::now_local()
|
||||
.ok()
|
||||
.unwrap_or_else(OffsetDateTime::now_utc)
|
||||
}
|
||||
@ -1,26 +0,0 @@
|
||||
use std::{env, path::PathBuf};
|
||||
|
||||
use lazy_static::lazy_static;
|
||||
use xdg::BaseDirectories;
|
||||
|
||||
lazy_static! {
|
||||
pub static ref BASE_DIRS: Option<BaseDirectories> = BaseDirectories::new().ok();
|
||||
}
|
||||
|
||||
pub fn home_dir() -> Option<PathBuf> {
|
||||
home::home_dir()
|
||||
}
|
||||
|
||||
pub fn config_dir() -> Option<PathBuf> {
|
||||
BASE_DIRS.as_ref().map(|base| base.get_config_home())
|
||||
}
|
||||
|
||||
pub fn runtime_dir() -> PathBuf {
|
||||
let Some(dir) = BASE_DIRS
|
||||
.as_ref()
|
||||
.and_then(|base| base.get_runtime_directory().ok())
|
||||
else {
|
||||
return env::temp_dir();
|
||||
};
|
||||
dir.clone()
|
||||
}
|
||||
File diff suppressed because it is too large
Load Diff
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue