mirror of https://github.com/sayanarijit/xplr
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
622 lines
35 KiB
HTML
622 lines
35 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en" class="sidebar-visible no-js dark">
|
|
<head>
|
|
<!-- Book generated using mdBook -->
|
|
<meta charset="UTF-8">
|
|
<title>Layout - 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="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 -->
|
|
<!-- EthicalAds -->
|
|
<script async src="https://media.ethicalads.io/media/client/ethicalads.min.js"></script>
|
|
</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 ? "coal" : "dark";
|
|
</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('dark')
|
|
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"><strong aria-hidden="true">3.1.</strong> General</a></li><li class="chapter-item expanded "><a href="node_types.html"><strong aria-hidden="true">3.2.</strong> Node Types</a></li><li class="chapter-item expanded "><a href="layouts.html"><strong aria-hidden="true">3.3.</strong> Layouts</a></li><li class="chapter-item expanded "><a href="modes.html"><strong aria-hidden="true">3.4.</strong> Modes</a></li></ol></li><li class="chapter-item expanded "><a href="concept.html"><strong aria-hidden="true">4.</strong> Concept</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="sum-type.html"><strong aria-hidden="true">4.1.</strong> Sum Type</a></li><li class="chapter-item expanded "><a href="key-bindings.html"><strong aria-hidden="true">4.2.</strong> Key Bindings</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="configure-key-bindings.html"><strong aria-hidden="true">4.2.1.</strong> Configure Key Bindings</a></li><li class="chapter-item expanded "><a href="default-key-bindings.html"><strong aria-hidden="true">4.2.2.</strong> Default Key Bindings</a></li><li class="chapter-item expanded "><a href="debug-key-bindings.html"><strong aria-hidden="true">4.2.3.</strong> Debug Key Bindings</a></li></ol></li><li class="chapter-item expanded "><a href="node-type.html"><strong aria-hidden="true">4.3.</strong> Node Type</a></li><li class="chapter-item expanded "><a href="layout.html" class="active"><strong aria-hidden="true">4.4.</strong> Layout</a></li><li class="chapter-item expanded "><a href="mode.html"><strong aria-hidden="true">4.5.</strong> Mode</a></li><li class="chapter-item expanded "><a href="message.html"><strong aria-hidden="true">4.6.</strong> Message</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="messages.html"><strong aria-hidden="true">4.6.1.</strong> Full List of Messages</a></li><li class="chapter-item expanded "><a href="input-operation.html"><strong aria-hidden="true">4.6.2.</strong> Input Operation</a></li></ol></li><li class="chapter-item expanded "><a href="borders.html"><strong aria-hidden="true">4.7.</strong> Borders</a></li><li class="chapter-item expanded "><a href="style.html"><strong aria-hidden="true">4.8.</strong> Style</a></li><li class="chapter-item expanded "><a href="searching.html"><strong aria-hidden="true">4.9.</strong> Searching</a></li><li class="chapter-item expanded "><a href="sorting.html"><strong aria-hidden="true">4.10.</strong> Sorting</a></li><li class="chapter-item expanded "><a href="filtering.html"><strong aria-hidden="true">4.11.</strong> Filtering</a></li><li class="chapter-item expanded "><a href="column-renderer.html"><strong aria-hidden="true">4.12.</strong> Column Renderer</a></li><li class="chapter-item expanded "><a href="lua-function-calls.html"><strong aria-hidden="true">4.13.</strong> Lua Function Calls</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="xplr.util.html"><strong aria-hidden="true">4.13.1.</strong> xplr.util</a></li></ol></li><li class="chapter-item expanded "><a href="environment-variables-and-pipes.html"><strong aria-hidden="true">4.14.</strong> Environment Variables and Pipes</a></li></ol></li><li class="chapter-item expanded "><a href="awesome-hacks.html"><strong aria-hidden="true">5.</strong> Awesome Hacks</a></li><li class="chapter-item expanded "><a href="plugin.html"><strong aria-hidden="true">6.</strong> Plugin</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="installing-plugins.html"><strong aria-hidden="true">6.1.</strong> Installing Plugins</a></li><li class="chapter-item expanded "><a href="writing-plugins.html"><strong aria-hidden="true">6.2.</strong> Writing Plugins</a></li><li class="chapter-item expanded "><a href="awesome-plugins.html"><strong aria-hidden="true">6.3.</strong> Awesome Plugins</a></li></ol></li><li class="chapter-item expanded "><a href="integration.html"><strong aria-hidden="true">7.</strong> Integration</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="awesome-integrations.html"><strong aria-hidden="true">7.1.</strong> Awesome Integrations</a></li></ol></li><li class="chapter-item expanded "><a href="alternatives.html"><strong aria-hidden="true">8.</strong> Alternatives</a></li><li class="chapter-item expanded "><a href="upgrade-guide.html"><strong aria-hidden="true">9.</strong> Upgrade Guide</a></li></ol>
|
|
|
|
<!-- 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>
|
|
</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</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/layout.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="layout"><a class="header" href="#layout">Layout</a></h1>
|
|
<h4 id="example-defining-custom-layout"><a class="header" href="#example-defining-custom-layout">Example: Defining Custom Layout</a></h4>
|
|
<pre><code class="language-lua">xplr.config.layouts.builtin.default = {
|
|
Horizontal = {
|
|
config = {
|
|
margin = 1,
|
|
horizontal_margin = 1,
|
|
vertical_margin = 1,
|
|
constraints = {
|
|
{ Percentage = 50 },
|
|
{ Percentage = 50 },
|
|
}
|
|
},
|
|
splits = {
|
|
"Table",
|
|
"HelpMenu",
|
|
}
|
|
}
|
|
}
|
|
</code></pre>
|
|
<p>Result:</p>
|
|
<pre><code> ╭ /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 │
|
|
╰────────────────────╯╰────────────────────╯
|
|
</code></pre>
|
|
<p>A layout is a <a href="sum-type.html">sum type</a> can be one of the following:</p>
|
|
<ul>
|
|
<li><a href="#nothing">Nothing</a></li>
|
|
<li><a href="#table">Table</a></li>
|
|
<li><a href="#inputandlogs">InputAndLogs</a></li>
|
|
<li><a href="#selection">Selection</a></li>
|
|
<li><a href="#helpmenu">HelpMenu</a></li>
|
|
<li><a href="#sortandfilter">SortAndFilter</a></li>
|
|
<li><a href="#static">Static</a></li>
|
|
<li><a href="#dynamic">Dynamic</a></li>
|
|
<li><a href="#horizontal">Horizontal</a></li>
|
|
<li><a href="#vertical">Vertical</a></li>
|
|
<li>CustomContent (deprecated, use <code>Static</code> or <code>Dynamic</code>)</li>
|
|
</ul>
|
|
<h3 id="nothing"><a class="header" href="#nothing">Nothing</a></h3>
|
|
<p>This layout contains a blank panel.</p>
|
|
<p>Type: "Nothing"</p>
|
|
<h3 id="table"><a class="header" href="#table">Table</a></h3>
|
|
<p>This layout contains the table displaying the files and directories in the current
|
|
directory.</p>
|
|
<h3 id="inputandlogs"><a class="header" href="#inputandlogs">InputAndLogs</a></h3>
|
|
<p>This layout contains the panel displaying the input prompt and logs.</p>
|
|
<p>Type: "InputAndLogs"</p>
|
|
<h3 id="selection"><a class="header" href="#selection">Selection</a></h3>
|
|
<p>This layout contains the panel displaying the selected paths.</p>
|
|
<p>Type: "Selection"</p>
|
|
<h3 id="helpmenu"><a class="header" href="#helpmenu">HelpMenu</a></h3>
|
|
<p>This layout contains the panel displaying the help menu for the current mode in
|
|
real-time.</p>
|
|
<p>Type: "HelpMenu"</p>
|
|
<h3 id="sortandfilter"><a class="header" href="#sortandfilter">SortAndFilter</a></h3>
|
|
<p>This layout contains the panel displaying the pipeline of sorters and filters applied on
|
|
the list of paths being displayed.</p>
|
|
<p>Type: "SortAndFilter"</p>
|
|
<h3 id="static"><a class="header" href="#static">Static</a></h3>
|
|
<p>This is a custom layout to render static content.</p>
|
|
<p>Type: { Static = <a href="#custom-panel">Custom Panel</a> }</p>
|
|
<h3 id="dynamic"><a class="header" href="#dynamic">Dynamic</a></h3>
|
|
<p>This is a custom layout to render dynamic content using a function defined in
|
|
<a href="configuration.html#function">xplr.fn</a> that takes <a href="#content-renderer-argument">Content Renderer Argument</a> and returns <a href="#custom-panel">Custom Panel</a>.</p>
|
|
<p>Type: { Dynamic = "<a href="#content-renderer">Content Renderer</a>" }</p>
|
|
<h3 id="horizontal"><a class="header" href="#horizontal">Horizontal</a></h3>
|
|
<p>This is a special layout that splits the panel into two horizontal parts.</p>
|
|
<p>It contains the following information:</p>
|
|
<ul>
|
|
<li><a href="#layout-config">config</a></li>
|
|
<li><a href="#splits">splits</a></li>
|
|
</ul>
|
|
<p>Type: { Vertical = { config = <a href="#layout-config">Layout Config</a>, splits = { <a href="#splits">Layout</a>, ... } }</p>
|
|
<h3 id="vertical"><a class="header" href="#vertical">Vertical</a></h3>
|
|
<p>This is a special layout that splits the panel into two vertical parts.</p>
|
|
<p>It contains the following information:</p>
|
|
<ul>
|
|
<li><a href="#layout-config">config</a></li>
|
|
<li><a href="#splits">splits</a></li>
|
|
</ul>
|
|
<p>Type: { Vertical = { config = <a href="#layout-config">Layout Config</a>, splits = { <a href="#splits">Layout</a>, ... } }</p>
|
|
<h2 id="layout-config"><a class="header" href="#layout-config">Layout Config</a></h2>
|
|
<p>A layout config contains the following information:</p>
|
|
<ul>
|
|
<li><a href="#margin">margin</a></li>
|
|
<li><a href="#horizontal_margin">horizontal_margin</a></li>
|
|
<li><a href="#vertical_margin">vertical_margin</a></li>
|
|
<li><a href="#constraints">constraints</a></li>
|
|
</ul>
|
|
<h3 id="margin"><a class="header" href="#margin">margin</a></h3>
|
|
<p>Type: nullable integer</p>
|
|
<p>The width of the margin in all direction.</p>
|
|
<h3 id="horizontal_margin"><a class="header" href="#horizontal_margin">horizontal_Margin</a></h3>
|
|
<p>Type: nullable integer</p>
|
|
<p>The width of the horizontal margins. Overwrites the <a href="#margin">margin</a> value.</p>
|
|
<h3 id="vertical_margin"><a class="header" href="#vertical_margin">vertical_Margin</a></h3>
|
|
<p>Type: nullable integer</p>
|
|
<p>The width of the vertical margins. Overwrites the <a href="#margin">margin</a> value.</p>
|
|
<h3 id="constraints"><a class="header" href="#constraints">constraints</a></h3>
|
|
<p>Type: nullable list of <a href="#constraint">Constraint</a></p>
|
|
<p>The constraints applied on the layout.</p>
|
|
<h2 id="constraint"><a class="header" href="#constraint">Constraint</a></h2>
|
|
<p>A constraint is a <a href="sum-type.html">sum type</a> can be one of the following:</p>
|
|
<ul>
|
|
<li>{ Percentage = int }</li>
|
|
<li>{ Ratio = { int, int } }</li>
|
|
<li>{ Length = { int }</li>
|
|
<li>{ LengthLessThanScreenHeight = int }</li>
|
|
<li>{ LengthLessThanScreenWidth = int }</li>
|
|
<li>{ LengthLessThanLayoutHeight = int }</li>
|
|
<li>{ LengthLessThanLayoutWidth = int }</li>
|
|
<li>{ Max = int }</li>
|
|
<li>{ MaxLessThanScreenHeight = int }</li>
|
|
<li>{ MaxLessThanScreenWidth = int }</li>
|
|
<li>{ MaxLessThanLayoutHeight = int }</li>
|
|
<li>{ MaxLessThanLayoutWidth = int }</li>
|
|
<li>{ Min = int }</li>
|
|
<li>{ MinLessThanScreenHeight = int }</li>
|
|
<li>{ MinLessThanScreenWidth = int }</li>
|
|
<li>{ MinLessThanLayoutHeight = int }</li>
|
|
<li>{ MinLessThanLayoutWidth = int }</li>
|
|
</ul>
|
|
<h2 id="splits"><a class="header" href="#splits">splits</a></h2>
|
|
<p>Type: list of <a href="#layout">Layout</a></p>
|
|
<p>The list of child layouts to fit into the parent layout.</p>
|
|
<h2 id="custom-panel"><a class="header" href="#custom-panel">Custom Panel</a></h2>
|
|
<p>Custom panel is a <a href="sum-type.html">sum type</a> can be one of the following:</p>
|
|
<ul>
|
|
<li><a href="#customparagraph">CustomParagraph</a></li>
|
|
<li><a href="#customlist">CustomList</a></li>
|
|
<li><a href="#customtable">CustomTable</a></li>
|
|
<li><a href="#customlayout">CustomLayout</a></li>
|
|
</ul>
|
|
<h3 id="customparagraph"><a class="header" href="#customparagraph">CustomParagraph</a></h3>
|
|
<p>A paragraph to render. It contains the following fields:</p>
|
|
<ul>
|
|
<li><strong>ui</strong> (nullable <a href="#panel-ui-config">Panel UI Config</a>): Optional UI config for the panel.</li>
|
|
<li><strong>body</strong> (string): The string to render.</li>
|
|
</ul>
|
|
<h4 id="example-render-a-custom-static-paragraph"><a class="header" href="#example-render-a-custom-static-paragraph">Example: Render a custom static paragraph</a></h4>
|
|
<pre><code class="language-lua">xplr.config.layouts.builtin.default = {
|
|
Static = {
|
|
CustomParagraph = {
|
|
ui = { title = { format = " custom title " } },
|
|
body = "custom body",
|
|
},
|
|
},
|
|
}
|
|
</code></pre>
|
|
<p>Result:</p>
|
|
<pre><code>╭ custom title ────────╮
|
|
│custom body │
|
|
│ │
|
|
│ │
|
|
╰──────────────────────╯
|
|
</code></pre>
|
|
<h4 id="example-render-a-custom-dynamic-paragraph"><a class="header" href="#example-render-a-custom-dynamic-paragraph">Example: Render a custom dynamic paragraph</a></h4>
|
|
<pre><code class="language-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
|
|
</code></pre>
|
|
<p>Result:</p>
|
|
<pre><code>╭/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 │
|
|
╰────────────────────────────────────────────╯
|
|
</code></pre>
|
|
<h3 id="customlist"><a class="header" href="#customlist">CustomList</a></h3>
|
|
<p>A list to render. It contains the following fields:</p>
|
|
<ul>
|
|
<li><strong>ui</strong> (nullable <a href="#panel-ui-config">Panel UI Config</a>): Optional UI config for the panel.</li>
|
|
<li><strong>body</strong> (list of string): The list of strings to display.</li>
|
|
</ul>
|
|
<h4 id="example-render-a-custom-static-list"><a class="header" href="#example-render-a-custom-static-list">Example: Render a custom static list</a></h4>
|
|
<pre><code class="language-lua">xplr.config.layouts.builtin.default = {
|
|
Static = {
|
|
CustomList = {
|
|
ui = { title = { format = " custom title " } },
|
|
body = { "1", "2", "3" },
|
|
},
|
|
},
|
|
}
|
|
</code></pre>
|
|
<p>Result:</p>
|
|
<pre><code>╭ custom title ─────────────╮
|
|
│1 │
|
|
│2 │
|
|
│3 │
|
|
│ │
|
|
╰───────────────────────────╯
|
|
</code></pre>
|
|
<h4 id="example-render-a-custom-dynamic-list"><a class="header" href="#example-render-a-custom-dynamic-list">Example: Render a custom dynamic list</a></h4>
|
|
<pre><code class="language-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
|
|
</code></pre>
|
|
<p>Result:</p>
|
|
<pre><code>╭/home/sayanarijit──────────╮
|
|
│Desktop │
|
|
│0.21.2 │
|
|
│17336 │
|
|
│ │
|
|
│ │
|
|
╰───────────────────────────╯
|
|
</code></pre>
|
|
<h2 id="customtable"><a class="header" href="#customtable">CustomTable</a></h2>
|
|
<p>A custom table to render. It contains the following fields:</p>
|
|
<ul>
|
|
<li><strong>ui</strong> (nullable <a href="#panel-ui-config">Panel UI Config</a>): Optional UI config for the panel.</li>
|
|
<li><strong>widths</strong> (list of <a href="#constraint">Constraint</a>): Width of the columns.</li>
|
|
<li><strong>col_spacing</strong> (nullable int): Spacing between columns. Defaults to 1.</li>
|
|
<li><strong>body</strong> (list of list of string): The rows and columns to render.</li>
|
|
</ul>
|
|
<h4 id="example-render-a-custom-static-table"><a class="header" href="#example-render-a-custom-static-table">Example: Render a custom static table</a></h4>
|
|
<pre><code class="language-lua">xplr.config.layouts.builtin.default = {
|
|
Static = {
|
|
CustomTable = {
|
|
ui = { title = { format = " custom title " } },
|
|
widths = {
|
|
{ Percentage = 50 },
|
|
{ Percentage = 50 },
|
|
},
|
|
body = {
|
|
{ "a", "b" },
|
|
{ "c", "d" },
|
|
},
|
|
},
|
|
},
|
|
}
|
|
</code></pre>
|
|
<p>Result:</p>
|
|
<pre><code>╭ custom title ────────────────────╮
|
|
│a b │
|
|
│c d │
|
|
│ │
|
|
│ │
|
|
│ │
|
|
╰──────────────────────────────────╯
|
|
</code></pre>
|
|
<h4 id="example-render-a-custom-dynamic-table"><a class="header" href="#example-render-a-custom-dynamic-table">Example: Render a custom dynamic table</a></h4>
|
|
<pre><code class="language-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
|
|
</code></pre>
|
|
<p>Result:</p>
|
|
<pre><code>╭/home/sayanarijit───────────────────────────╮
|
|
│ │
|
|
│Layout height 12 │
|
|
│Layout width 46 │
|
|
│ │
|
|
│Screen height 12 │
|
|
│Screen width 46 │
|
|
│ │
|
|
│ │
|
|
│ │
|
|
│ │
|
|
╰────────────────────────────────────────────╯
|
|
</code></pre>
|
|
<h3 id="customlayout"><a class="header" href="#customlayout">CustomLayout</a></h3>
|
|
<p>A whole custom layout to render. It doesn't make sense to use it as a
|
|
<a href="#static">Static</a> layout, but can be very useful to render as a <a href="#dynamic">Dynamic</a> layout
|
|
for use cases where the structure of the layout needs to change without having
|
|
to switch modes.</p>
|
|
<blockquote>
|
|
<p>WARNING: Rendering the same dynamic custom layout recursively will result in
|
|
a ugly crash.</p>
|
|
</blockquote>
|
|
<h4 id="example-render-a-custom-dynamic-layout"><a class="header" href="#example-render-a-custom-dynamic-layout">Example: Render a custom dynamic layout</a></h4>
|
|
<pre><code class="language-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
|
|
</code></pre>
|
|
<p>Result:</p>
|
|
<pre><code>╭─────────────────────╮╭─────────────────────╮
|
|
│Try your luck... ││Press ctrl-r │
|
|
│ ││ │
|
|
│ ││ │
|
|
│ ││ │
|
|
│ ││ │
|
|
│ ││ │
|
|
│ ││ │
|
|
│ ││ │
|
|
│ ││ │
|
|
│ ││ │
|
|
╰─────────────────────╯╰─────────────────────╯
|
|
</code></pre>
|
|
<p>Or</p>
|
|
<pre><code>╭────────────────────────────────────────────╮
|
|
│Try your luck... │
|
|
│ │
|
|
│ │
|
|
│ │
|
|
╰────────────────────────────────────────────╯
|
|
╭────────────────────────────────────────────╮
|
|
│Press ctrl-r │
|
|
│ │
|
|
│ │
|
|
│ │
|
|
╰────────────────────────────────────────────╯
|
|
</code></pre>
|
|
<h2 id="panel-ui-config"><a class="header" href="#panel-ui-config">Panel UI Config</a></h2>
|
|
<p>It contains the following optional fields:</p>
|
|
<ul>
|
|
<li><strong>title</strong> ({ format = "string", style = <a href="style.html#style">Style</a> }): the title of the panel.</li>
|
|
<li><strong>style</strong> (<a href="style.html#style">Style</a>): The style of the panel body.</li>
|
|
<li><strong>borders</strong> (nullable list of <a href="borders.html#border">Border</a>): The shape of the borders.</li>
|
|
<li><strong>border_type</strong> (<a href="borders.html#border-type">Border Type</a>): The type of the borders.</li>
|
|
<li><strong>border_style</strong> (<a href="style.html#style">Style</a>): The style of the borders.</li>
|
|
</ul>
|
|
<h2 id="content-renderer"><a class="header" href="#content-renderer">Content Renderer</a></h2>
|
|
<p>It is a Lua function that receives <a href="#content-renderer-argument">a special argument</a> 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.</p>
|
|
<h2 id="content-renderer-argument"><a class="header" href="#content-renderer-argument">Content Renderer Argument</a></h2>
|
|
<p>It contains the following information:</p>
|
|
<ul>
|
|
<li><a href="#size">layout_size</a></li>
|
|
<li><a href="#size">screen_size</a></li>
|
|
<li><a href="#scrolltop">scrolltop</a></li>
|
|
<li><a href="#app">app</a></li>
|
|
</ul>
|
|
<h3 id="size"><a class="header" href="#size">Size</a></h3>
|
|
<p>It contains the following information:</p>
|
|
<ul>
|
|
<li>x</li>
|
|
<li>y</li>
|
|
<li>height</li>
|
|
<li>width</li>
|
|
</ul>
|
|
<p>Every field is of integer type.</p>
|
|
<h3 id="scrolltop"><a class="header" href="#scrolltop">scrolltop</a></h3>
|
|
<p>Type: integer</p>
|
|
<p>The start index of the visible nodes in the table.</p>
|
|
<h3 id="app"><a class="header" href="#app">app</a></h3>
|
|
<p>This is a lightweight version of the <a href="lua-function-calls.html#lua-context">Lua Context</a>. In this context, the
|
|
heavyweight fields like <a href="lua-function-calls.html#directory_buffer">directory_buffer</a> are omitted for performance
|
|
reasons.</p>
|
|
<p>Hence, only the following fields are available.</p>
|
|
<ul>
|
|
<li><a href="lua-function-calls.html#version">version</a></li>
|
|
<li><a href="lua-function-calls.html#pwd">pwd</a></li>
|
|
<li><a href="lua-function-calls.html#initial_pwd">initial_pwd</a></li>
|
|
<li><a href="lua-function-calls.html#vroot">vroot</a></li>
|
|
<li><a href="lua-function-calls.html#focused_node">focused_node</a></li>
|
|
<li><a href="lua-function-calls.html#selection">selection</a></li>
|
|
<li><a href="lua-function-calls.html#mode">mode</a></li>
|
|
<li><a href="lua-function-calls.html#layout">layout</a></li>
|
|
<li><a href="lua-function-calls.html#input_buffer">input_buffer</a></li>
|
|
<li><a href="lua-function-calls.html#pid">pid</a></li>
|
|
<li><a href="lua-function-calls.html#session_path">session_path</a></li>
|
|
<li><a href="lua-function-calls.html#explorer_config">explorer_config</a></li>
|
|
</ul>
|
|
<h2 id="also-see"><a class="header" href="#also-see">Also See:</a></h2>
|
|
<ul>
|
|
<li><a href="layouts.html">xplr.config.layouts</a></li>
|
|
</ul>
|
|
|
|
</main>
|
|
|
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
|
<!-- Mobile navigation buttons -->
|
|
<a rel="prev" href="node-type.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="mode.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="node-type.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="mode.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>
|