mirror of
https://github.com/sayanarijit/xplr
synced 2024-11-04 18:00:14 +00:00
303 lines
18 KiB
HTML
303 lines
18 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en" class="sidebar-visible no-js light">
|
|
<head>
|
|
<!-- Book generated using mdBook -->
|
|
<meta charset="UTF-8">
|
|
<title>General Config - 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">
|
|
<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" class="active"><strong aria-hidden="true">3.1.</strong> General Config</a></li><li class="chapter-item expanded "><a href="modes.html"><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>
|
|
<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>
|
|
<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/general-config.md" title="Suggest an edit" aria-label="Suggest an edit">
|
|
<i id="git-edit-button" class="fa fa-edit"></i>
|
|
</a>
|
|
|
|
</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="general-config"><a class="header" href="#general-config">General Config</a></h1>
|
|
<p>This is configuration exposed via the <code>xplr.config.general</code> API. It contains
|
|
the following fields:</p>
|
|
<h2 id="enable_mouse"><a class="header" href="#enable_mouse">enable_mouse</a></h2>
|
|
<p>Type: boolean</p>
|
|
<p>Set it to <code>true</code> enable scrolling using mouse.</p>
|
|
<h2 id="show_hidden"><a class="header" href="#show_hidden">show_hidden</a></h2>
|
|
<p>Type: boolean</p>
|
|
<p>Set it to <code>true</code> to show hidden files.</p>
|
|
<h2 id="read_only"><a class="header" href="#read_only">read_only</a></h2>
|
|
<p>Type: boolean</p>
|
|
<p>Set it to <code>true</code> to use only a subset of selected operations that forbids
|
|
executing commands or performing write operations on the file-system.</p>
|
|
<h2 id="disable_recover_mode"><a class="header" href="#disable_recover_mode">disable_recover_mode</a></h2>
|
|
<p>Type: boolean</p>
|
|
<p>Set it to <code>true</code> when the special recover mode gets too annoying to appreciate
|
|
the good intentions. When enabled, typing the wrong keys won't result in any
|
|
action.</p>
|
|
<h2 id="cursorformat"><a class="header" href="#cursorformat">cursor.format</a></h2>
|
|
<p>Type: nullable string</p>
|
|
<p>This is the shape of the cursor visible when the input buffer contains some string.</p>
|
|
<h2 id="cursorstyle"><a class="header" href="#cursorstyle">cursor.style</a></h2>
|
|
<p>Type: <a href="style.html">Style</a></p>
|
|
<p>Style of the cursor.</p>
|
|
<h2 id="initial_layout"><a class="header" href="#initial_layout">initial_layout</a></h2>
|
|
<p>Type: string</p>
|
|
<p>The name of one of the <a href="layouts.html">layout</a> to use when xplr loads.</p>
|
|
<h2 id="initial_mode"><a class="header" href="#initial_mode">initial_mode</a></h2>
|
|
<p>Type: string</p>
|
|
<p>The name of one of the <a href="modes.html">mode</a> to use when xplr loads.</p>
|
|
<h2 id="initial_sorting"><a class="header" href="#initial_sorting">initial_sorting</a></h2>
|
|
<p>Type: list of <a href="sorting.html#node-sorter-applicable">Node Sorter Applicable</a></p>
|
|
<p>Initial group if sorters applied to the nodes list in the table.</p>
|
|
<h2 id="tablestyle"><a class="header" href="#tablestyle">table.style</a></h2>
|
|
<p>Type: <a href="style.html">Style</a></p>
|
|
<p>Default style of the table.</p>
|
|
<h2 id="tablecol_spacing"><a class="header" href="#tablecol_spacing">table.col_spacing</a></h2>
|
|
<p>Type: nullable integer</p>
|
|
<p>Default spacing of the columns in the table.</p>
|
|
<h2 id="tablecol_widths"><a class="header" href="#tablecol_widths">table.col_widths</a></h2>
|
|
<p>Type: nullable list of <a href="layouts.html#constraint">Constraint</a></p>
|
|
<p>Width of each column in the table.</p>
|
|
<h2 id="tableheaderheight"><a class="header" href="#tableheaderheight">table.header.height</a></h2>
|
|
<p>Type: nullable integer</p>
|
|
<p>Height of the table header.</p>
|
|
<h2 id="tableheaderstyle"><a class="header" href="#tableheaderstyle">table.header.style</a></h2>
|
|
<p>Type: <a href="style.html">Style</a></p>
|
|
<p>Style of table header.</p>
|
|
<h2 id="tableheadercols"><a class="header" href="#tableheadercols">table.header.cols</a></h2>
|
|
<p>Type: List of column configuration</p>
|
|
<p>Each column config contains <code>format</code> field (string) and <code>style</code> field
|
|
(<a href="style.html">Style</a>), that define the content and style of header.</p>
|
|
<h2 id="tablerowheight"><a class="header" href="#tablerowheight">table.row.height</a></h2>
|
|
<p>Type: nullable integer</p>
|
|
<p>Height of each row in the table.</p>
|
|
<h2 id="tablerowstyle"><a class="header" href="#tablerowstyle">table.row.style</a></h2>
|
|
<p>Type: <a href="style.html">Style</a></p>
|
|
<p>Style of table rows.</p>
|
|
<h2 id="tablerowcols"><a class="header" href="#tablerowcols">table.row.cols</a></h2>
|
|
<p>Type: List of column configuration</p>
|
|
<p>Each column config contains <code>format</code> field (string) and <code>style</code> field
|
|
(<a href="style.html">Style</a>).</p>
|
|
<p>However, unlike <a href="#tableheadercols">table.header.cols</a>, the <code>format</code> field here
|
|
points to a Lua function that receives a
|
|
<a href="https://docs.rs/xplr/latest/xplr/ui/struct.NodeUiMetadata.html">special argument</a>
|
|
as input and returns a string that will be displayed in the column.</p>
|
|
<p>TODO: Document the argument fields here.</p>
|
|
<p>xplr by default provides the following functions:</p>
|
|
<ul>
|
|
<li><code>xplr.fn.builtin.fmt_general_table_row_cols_0</code></li>
|
|
<li><code>xplr.fn.builtin.fmt_general_table_row_cols_1</code></li>
|
|
<li><code>xplr.fn.builtin.fmt_general_table_row_cols_2</code></li>
|
|
<li><code>xplr.fn.builtin.fmt_general_table_row_cols_3</code></li>
|
|
<li><code>xplr.fn.builtin.fmt_general_table_row_cols_4</code></li>
|
|
</ul>
|
|
<p>You can either overwrite these functions, or create new functions in
|
|
<code>xplr.fn.custom</code> and point to them.</p>
|
|
<p>Terminal colors are supported.</p>
|
|
<p>Example:</p>
|
|
<pre><code class="language-lua">xplr.fn.custom.fmt_simple_column = function(m)
|
|
return m.prefix .. m.relative_path .. m.suffix
|
|
end
|
|
|
|
xplr.config.general.table.header.cols = {
|
|
{ format = " path" }
|
|
}
|
|
|
|
xplr.config.general.table.row.cols = {
|
|
{ format = "custom.fmt_simple_column" }
|
|
}
|
|
|
|
xplr.config.general.table.col_widths = {
|
|
{ Percentage = 100 }
|
|
}
|
|
|
|
-- With this config, you should only see a single column displaying the
|
|
-- relative paths.
|
|
</code></pre>
|
|
<hr />
|
|
<p>TODO: Continue documentation</p>
|
|
|
|
</main>
|
|
|
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
|
<!-- Mobile navigation buttons -->
|
|
<a rel="prev" href="configuration.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="modes.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="configuration.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="modes.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>
|