2021-06-23 10:02:10 +00:00
<!DOCTYPE HTML>
< html lang = "en" class = "sidebar-visible no-js light" >
< head >
<!-- Book generated using mdBook -->
< meta charset = "UTF-8" >
< title > Modes - xplr book< / title >
<!-- Custom HTML head -->
< meta content = "text/html; charset=utf-8" http-equiv = "Content-Type" >
< meta name = "description" content = "A hackable, minimal, fast TUI file explorer" >
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
< meta name = "theme-color" content = "#ffffff" / >
< link rel = "icon" href = "favicon.svg" >
< link rel = "shortcut icon" href = "favicon.png" >
< link rel = "stylesheet" href = "css/variables.css" >
< link rel = "stylesheet" href = "css/general.css" >
< link rel = "stylesheet" href = "css/chrome.css" >
< link rel = "stylesheet" href = "css/print.css" media = "print" >
<!-- Fonts -->
< link rel = "stylesheet" href = "FontAwesome/css/font-awesome.css" >
< link rel = "stylesheet" href = "fonts/fonts.css" >
<!-- Highlight.js Stylesheets -->
< link rel = "stylesheet" href = "highlight.css" >
< link rel = "stylesheet" href = "tomorrow-night.css" >
< link rel = "stylesheet" href = "ayu-highlight.css" >
<!-- Custom theme stylesheets -->
< / head >
< body >
<!-- Provide site root to javascript -->
< script type = "text/javascript" >
var path_to_root = "";
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
< / script >
<!-- Work around some values being stored in localStorage wrapped in quotes -->
< script type = "text/javascript" >
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 type = "text/javascript" >
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('no-js')
html.classList.remove('light')
html.classList.add(theme);
html.classList.add('js');
< / script >
<!-- Hide / unhide sidebar before it is displayed -->
< script type = "text/javascript" >
var html = document.querySelector('html');
var sidebar = 'hidden';
if (document.body.clientWidth >= 1080) {
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
sidebar = sidebar || 'visible';
}
html.classList.remove('sidebar-visible');
html.classList.add("sidebar-" + sidebar);
< / script >
< nav id = "sidebar" class = "sidebar" aria-label = "Table of contents" >
< div class = "sidebar-scrollbox" >
2021-06-24 11:35:20 +00:00
< ol class = "chapter" > < li class = "chapter-item expanded " > < a href = "introduction.html" > < strong aria-hidden = "true" > 1.< / strong > Introduction< / a > < / li > < li class = "chapter-item expanded " > < a href = "quickstart.html" > < strong aria-hidden = "true" > 2.< / strong > Quickstart< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "install.html" > < strong aria-hidden = "true" > 2.1.< / strong > Install< / a > < / li > < li class = "chapter-item expanded " > < a href = "post-install.html" > < strong aria-hidden = "true" > 2.2.< / strong > Post Install< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "configuration.html" > < strong aria-hidden = "true" > 3.< / strong > Configuration< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "general-config.html" > < strong aria-hidden = "true" > 3.1.< / strong > General Config< / a > < / li > < li class = "chapter-item expanded " > < a href = "modes.html" class = "active" > < strong aria-hidden = "true" > 3.2.< / strong > Modes< / a > < / li > < li class = "chapter-item expanded " > < a href = "message.html" > < strong aria-hidden = "true" > 3.3.< / strong > Message< / a > < / li > < li class = "chapter-item expanded " > < a href = "layouts.html" > < strong aria-hidden = "true" > 3.4.< / strong > Layouts< / a > < / li > < li class = "chapter-item expanded " > < a href = "node_types.html" > < strong aria-hidden = "true" > 3.5.< / strong > Node Types< / a > < / li > < li class = "chapter-item expanded " > < a href = "style.html" > < strong aria-hidden = "true" > 3.6.< / strong > Style< / a > < / li > < li class = "chapter-item expanded " > < a href = "sorting.html" > < strong aria-hidden = "true" > 3.7.< / strong > Sorting< / a > < / li > < li class = "chapter-item expanded " > < a href = "filtering.html" > < strong aria-hidden = "true" > 3.8.< / strong > Filtering< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "default-key-bindings.html" > < strong aria-hidden = "true" > 4.< / strong > Default Key Bindings< / a > < / li > < li class = "chapter-item expanded " > < a href = "plugin.html" > < strong aria-hidden = "true" > 5.< / strong > Plugin< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "installing-plugins.html" > < strong aria-hidden = "true" > 5.1.< / strong > Installing Plugins< / a > < / li > < li class = "chapter-item expanded " > < a href = "writing-plugins.html" > < strong aria-hidden = "true" > 5.2.< / strong > Writing Plugins< / a > < / li > < li class = "chapter-item expanded " > < a href = "awesome-plugins.html" > < strong aria-hidden = "true" > 5.3.< / strong > Awesome Plugins< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "todo.html" > < strong aria-hidden = "true" > 6.< / strong > TODO< / a > < / li > < li class = "chapter-item expanded " > < a href = "alternatives.html" > < strong aria-hidden = "true" > 7.< / strong > Alternatives< / a > < / li > < li class = "chapter-item expanded " > < a href = "upgrade-guide.html" > < strong aria-hidden = "true" > 8.< / strong > Upgrade Guide< / a > < / li > < li class = "chapter-item expanded " > < a href = "community.html" > < strong aria-hidden = "true" > 9.< / strong > Community< / a > < / li > < li class = "chapter-item expanded " > < a href = "contribute.html" > < strong aria-hidden = "true" > 10.< / strong > Contribute< / a > < / li > < / ol > < / div >
2021-06-23 10:02:10 +00:00
< div id = "sidebar-resize-handle" class = "sidebar-resize-handle" > < / div >
< / nav >
< div id = "page-wrapper" class = "page-wrapper" >
< div class = "page" >
< div id = "menu-bar-hover-placeholder" > < / div >
< div id = "menu-bar" class = "menu-bar sticky bordered" >
< div class = "left-buttons" >
< button id = "sidebar-toggle" class = "icon-button" type = "button" title = "Toggle Table of Contents" aria-label = "Toggle Table of Contents" aria-controls = "sidebar" >
< i class = "fa fa-bars" > < / i >
< / button >
< 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 (default)< / 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 >
< 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 >
< / div >
< h1 class = "menu-title" > xplr book< / h1 >
< div class = "right-buttons" >
< a href = "print.html" title = "Print this book" aria-label = "Print this book" >
< i id = "print-button" class = "fa fa-print" > < / i >
< / a >
2021-06-23 11:54:40 +00:00
< a href = "https://github.com/sayanarijit/xplr" title = "Git repository" aria-label = "Git repository" >
< i id = "git-repository-button" class = "fa fa-github" > < / i >
< / a >
< a href = "https://github.com/sayanarijit/xplr/edit/main/docs/en/src/modes.md" title = "Suggest an edit" aria-label = "Suggest an edit" >
< i id = "git-edit-button" class = "fa fa-edit" > < / i >
< / a >
2021-06-23 10:02:10 +00:00
< / div >
< / div >
< 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 >
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
< script type = "text/javascript" >
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 >
< h1 id = "modes" > < a class = "header" href = "#modes" > Modes< / a > < / h1 >
2021-06-23 11:54:40 +00:00
< p > xplr is a modal file explorer. That means the users switch between different
2021-06-24 04:43:26 +00:00
modes, each containing a different set of key bindings to avoid clashes. Users
2021-06-23 11:54:40 +00:00
can switch between these modes at run-time.< / p >
< p > The modes can be configured using the < code > xplr.config.modes< / code > Lua API.< / p >
< p > It contains the following fields:< / p >
2021-06-23 10:02:10 +00:00
< ul >
< li > < a href = "#builtin" > builtin< / a > < / li >
< li > < a href = "#custom" > custom< / a > < / li >
< / ul >
< h2 id = "builtin" > < a class = "header" href = "#builtin" > builtin< / a > < / h2 >
< p > Type: mapping of string and < a href = "#mode" > Mode< / a > < / p >
< p > This is exposed by the < code > xplr.config.modes.builtin< / code > API.< / p >
< p > xplr by default provides the following builtin modes:< / p >
< ul >
< li > default< / li >
< li > recover< / li >
< li > selection_ops< / li >
< li > create< / li >
< li > create_directory< / li >
< li > create_file< / li >
< li > number< / li >
< li > go_to< / li >
< li > rename< / li >
< li > delete< / li >
< li > action< / li >
< li > search< / li >
< li > filter< / li >
< li > relative_path_does_contain< / li >
< li > relative_path_does_not_contain< / li >
< li > sort< / li >
< li > switch_layout< / li >
< li > quit< / li >
< / ul >
< p > Visit the < a href = "default-key-bindings.html" > Default Key Bindings< / a > to see what each mode
does.< / p >
< h2 id = "custom" > < a class = "header" href = "#custom" > custom< / a > < / h2 >
< p > Type: mapping of string and < a href = "#mode" > Mode< / a > < / p >
< p > This is exposed by the < code > xplr.config.layouts.custom< / code > API.< / p >
2021-06-23 11:54:40 +00:00
< p > It allows the users to define custom modes.< / p >
2021-06-23 10:02:10 +00:00
< p > Example:< / p >
< pre > < code class = "language-lua" > xplr.config.modes.custom.example = {
name = " example" ,
key_bindings = {
on_key = {
enter = {
help = " default mode" ,
messages = {
" PopMode" ,
{ SwitchModeBuiltin = " default" }
}
}
}
}
}
xplr.config.general.initial_mode = " example"
-- when you load xplr, you should be in the " example" mode,
-- pressing " enter" should take you to the " default" mode.
< / code > < / pre >
< h2 id = "mode" > < a class = "header" href = "#mode" > Mode< / a > < / h2 >
< p > A mode contains the following information:< / p >
< ul >
< li > < a href = "#name" > name< / a > < / li >
< li > < a href = "#help" > help< / a > < / li >
< li > < a href = "#extra_help" > extra_help< / a > < / li >
< li > < a href = "#key_bindings" > key_bindings< / a > < / li >
< / ul >
< h3 id = "name" > < a class = "header" href = "#name" > name< / a > < / h3 >
< p > Type: string< / p >
< p > This is the name of the mode visible in the help menu.< / p >
< h3 id = "help" > < a class = "header" href = "#help" > help< / a > < / h3 >
< p > Type: nullable string< / p >
< p > If specified, the help menu will display this instead of the auto generated
mappings.< / p >
< h3 id = "extra_help" > < a class = "header" href = "#extra_help" > extra_help< / a > < / h3 >
< p > Type: nullable string< / p >
< p > If specified, the help menu will display this along-side the auto generated
help menu.< / p >
< h3 id = "key_bindings" > < a class = "header" href = "#key_bindings" > key_bindings< / a > < / h3 >
< p > Type: < a href = "#key-bindings" > Key Bindings< / a > < / p >
< p > The key bindings available in that mode.< / p >
< h2 id = "key-bindings" > < a class = "header" href = "#key-bindings" > Key Bindings< / a > < / h2 >
< p > Key bindings define how each keyboard input will be handled in a specific mode.< / p >
< p > See the < a href = "default-key-bindings.html" > default key bindings< / a > for example.< / p >
< p > Key bindings contains the following information:< / p >
< ul >
< li > < a href = "#on_key" > on_key< / a > < / li >
< li > < a href = "#on_alphabet" > on_alphabet< / a > < / li >
< li > < a href = "#on_number" > on_number< / a > < / li >
< li > < a href = "#on_special_character" > on_special_character< / a > < / li >
< li > < a href = "#default" > default< / a > < / li >
< / ul >
< h3 id = "on_key" > < a class = "header" href = "#on_key" > on_key< / a > < / h3 >
< p > Type: mapping of < a href = "#key" > Key< / a > to nullable < a href = "#action" > Action< / a > < / p >
< p > Defines what to do when a specific key is pressed.< / p >
< h3 id = "on_alphabet" > < a class = "header" href = "#on_alphabet" > on_alphabet< / a > < / h3 >
< p > Type: nullable < a href = "#action" > Action< / a > < / p >
< p > An action to perform if the keyboard input is an alphabet and is not mapped via
the < a href = "#on_key" > on_key< / a > field.< / p >
< h3 id = "on_number" > < a class = "header" href = "#on_number" > on_number< / a > < / h3 >
< p > Type: nullable < a href = "#action" > Action< / a > < / p >
< p > An action to perform if the keyboard input is a number and is not mapped via
the < a href = "#on_key" > on_key< / a > field.< / p >
< h3 id = "on_special_character" > < a class = "header" href = "#on_special_character" > on_special_character< / a > < / h3 >
< p > Type: nullable < a href = "#action" > Action< / a > < / p >
< p > An action to perform if the keyboard input is a special character and is not
mapped via the < a href = "#on_key" > on_key< / a > field.< / p >
< h3 id = "default" > < a class = "header" href = "#default" > default< / a > < / h3 >
< p > Type: nullable < a href = "#action" > Action< / a > < / p >
< p > Default action to perform in case of a keyboard input not mapped via any of the
< a href = "#on_key" > on_key< / a > , < a href = "#on_alphabet" > on_alphabet< / a > , < a href = "#on_number" > on_number< / a > or
< a href = "#on_special_character" > on_special_character< / a > field.< / p >
< h2 id = "action" > < a class = "header" href = "#action" > Action< / a > < / h2 >
< p > An action contains the following information:< / p >
< ul >
< li > help< / li >
< li > < a href = "#messages" > messages< / a > < / li >
< / ul >
< h3 id = "help-1" > < a class = "header" href = "#help-1" > help< / a > < / h3 >
< p > Type: nullable string< / p >
< p > Description of what it does. If unspecified, it will be excluded from the help
menu.< / p >
< h3 id = "messages" > < a class = "header" href = "#messages" > messages< / a > < / h3 >
< p > Type: A list of < a href = "message.html" > Message< / a > to send.< / p >
< p > The list of messages to send when a key is pressed.< / p >
< h2 id = "tutorial-adding-a-new-mode" > < a class = "header" href = "#tutorial-adding-a-new-mode" > Tutorial: Adding a New Mode< / a > < / h2 >
< p > Assuming xplr is < a href = "install.html" > installed< / a > and < a href = "post-install.html" > setup< / a > , let's
add our own mode to integrate xplr with < a href = "https://github.com/junegunn/fzf" > fzf< / a > .< / p >
< p > We'll call it < code > fzxplr< / code > mode.< / p >
< p > First, let's add a custom mode called < code > fzxplr< / code > , and map the key < code > F< / code > to an
action that will call < code > fzf< / code > to search and focus on a file or enter into a
directory.< / p >
< pre > < code class = "language-lua" > xplr.config.modes.custom.fzxplr = {
name = " fzxplr" ,
key_bindings = {
on_key = {
F = {
help = " search" ,
messages = {
{
BashExec = [===[
PTH=$(cat " ${XPLR_PIPE_DIRECTORY_NODES_OUT:?}" | awk -F/ '{print $NF}' | fzf)
if [ -d " $PTH" ]; then
echo ChangeDirectory: " '" ${PWD:?}/${PTH:?}" '" > > " ${XPLR_PIPE_MSG_IN:?}"
else
echo FocusPath: " '" ${PWD:?}/${PTH:?}" '" > > " ${XPLR_PIPE_MSG_IN:?}"
fi
]===]
},
" PopMode" ,
},
},
},
default = {
messages = {
" PopMode" ,
},
},
},
}
< / code > < / pre >
< p > As you can see, the key < code > F< / code > in mode < code > fzxplr< / code > (the name can be anything)
executes a script in < code > bash< / code > .< / p >
< p > < code > BashExec< / code > , < code > PopMode< / code > , < code > SwitchModeBuiltin< / code > , < code > ChangeDirectory< / code > and < code > FocusPath< / code >
are < a href = "message.html" > messages< / a > , < code > $XPLR_PIPE_MSG_IN< / code > ,
< code > $XPLR_PIPE_DIRECTORY_NODES_OUT< / code > are
< a href = "message.html#environment-variables" > environment variables< / a > exported by < code > xplr< / code >
before executing the command. They contain the path to the
< a href = "message.html#input-pipe" > input< / a > and < a href = "message.html#output-pipes" > output< / a > pipes that
allows external tools to interact with < code > xplr< / code > .< / p >
< p > Now that we have our new mode ready, let's add an entry point to this mode via
the < code > default< / code > mode.< / p >
< pre > < code class = "language-lua" > xplr.config.modes.builtin.default.key_bindings.on_key[" F" ] = {
help = " fzf mode" ,
messages = {
{ SwitchModeCustom = " fzxplr" },
},
}
< / code > < / pre >
< p > Now let's try out the new < code > xplr< / code > -< code > fzf< / code > integration.< / p >
< p > < a href = "https://gifyu.com/image/tW86" > < img src = "https://s3.gifyu.com/images/xplr-fzf.gif" alt = "xplr-fzf.gif" / > < / a > < / p >
2021-06-24 04:43:26 +00:00
< hr / >
< p > Visit < a href = "awesome-plugins.html" > Awesome Plugins< / a > for more < a href = "awesome-plugins.html#integration" > integration< / a > options.< / p >
2021-06-23 10:02:10 +00:00
< / main >
< nav class = "nav-wrapper" aria-label = "Page navigation" >
<!-- Mobile navigation buttons -->
< a rel = "prev" href = "general-config.html" class = "mobile-nav-chapters previous" title = "Previous chapter" aria-label = "Previous chapter" aria-keyshortcuts = "Left" >
< i class = "fa fa-angle-left" > < / i >
< / a >
< a rel = "next" href = "message.html" class = "mobile-nav-chapters next" title = "Next chapter" aria-label = "Next chapter" aria-keyshortcuts = "Right" >
< i class = "fa fa-angle-right" > < / i >
< / a >
< div style = "clear: both" > < / div >
< / nav >
< / div >
< / div >
< nav class = "nav-wide-wrapper" aria-label = "Page navigation" >
< a rel = "prev" href = "general-config.html" class = "nav-chapters previous" title = "Previous chapter" aria-label = "Previous chapter" aria-keyshortcuts = "Left" >
< i class = "fa fa-angle-left" > < / i >
< / a >
< a rel = "next" href = "message.html" class = "nav-chapters next" title = "Next chapter" aria-label = "Next chapter" aria-keyshortcuts = "Right" >
< i class = "fa fa-angle-right" > < / i >
< / a >
< / nav >
< / div >
< script type = "text/javascript" >
window.playground_copyable = true;
< / script >
< script src = "elasticlunr.min.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "mark.min.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "searcher.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "clipboard.min.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "highlight.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "book.js" type = "text/javascript" charset = "utf-8" > < / script >
<!-- Custom JS scripts -->
< / body >
< / html >
