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 > Layouts - 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" / >
2021-10-05 07:53:06 +00:00
< link rel = "icon" href = "favicon.svg" >
< link rel = "shortcut icon" href = "favicon.png" >
< link rel = "stylesheet" href = "css/variables.css" >
2021-06-23 10:02:10 +00:00
< link rel = "stylesheet" href = "css/general.css" >
< link rel = "stylesheet" href = "css/chrome.css" >
2021-10-05 07:53:06 +00:00
< link rel = "stylesheet" href = "css/print.css" media = "print" >
2021-06-23 10:02:10 +00:00
<!-- Fonts -->
< link rel = "stylesheet" href = "FontAwesome/css/font-awesome.css" >
2021-10-05 07:53:06 +00:00
< link rel = "stylesheet" href = "fonts/fonts.css" >
2021-06-23 10:02:10 +00:00
<!-- 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 -->
2021-10-05 07:53:06 +00:00
< / head >
2021-06-23 10:02:10 +00:00
< 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-11-05 08:29:48 +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 = "key-bindings.html" > < strong aria-hidden = "true" > 3.1.< / strong > Key Bindings< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "configure-key-bindings.html" > < strong aria-hidden = "true" > 3.1.1.< / strong > Configure Key Bindings< / a > < / li > < li class = "chapter-item expanded " > < a href = "default-key-bindings.html" > < strong aria-hidden = "true" > 3.1.2.< / strong > Default Key Bindings< / a > < / li > < li class = "chapter-item expanded " > < a href = "debug-key-bindings.html" > < strong aria-hidden = "true" > 3.1.3.< / strong > Debug Key Bindings< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "general-config.html" > < strong aria-hidden = "true" > 3.2.< / strong > General Config< / a > < / li > < li class = "chapter-item expanded " > < a href = "modes.html" > < strong aria-hidden = "true" > 3.3.< / strong > Modes< / a > < / li > < li class = "chapter-item expanded " > < a href = "message.html" > < strong aria-hidden = "true" > 3.4.< / strong > Message< / a > < / li > < li class = "chapter-item expanded " > < a href = "layouts.html" class = "active" > < strong aria-hidden = "true" > 3.5.< / strong > Layouts< / a > < / li > < li class = "chapter-item expanded " > < a href = "node_types.html" > < strong aria-hidden = "true" > 3.6.< / strong > Node Types< / a > < / li > < li class = "chapter-item expanded " > < a href = "style.html" > < strong aria-hidden = "true" > 3.7.< / strong > Style< / a > < / li > < li class = "chapter-item expanded " > < a href = "sorting.html" > < strong aria-hidden = "true" > 3.8.< / strong > Sorting< / a > < / li > < li class = "chapter-item expanded " > < a href = "filtering.html" > < strong aria-hidden = "true" > 3.9.< / strong > Filtering< / a > < / li > < li class = "chapter-item expanded " > < a href = "column-renderer.html" > < strong aria-hidden = "true" > 3.10.< / strong > Column Renderer< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "plugin.html" > < strong aria-hidden = "true" > 4.< / strong > Plugin< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "installing-plugins.html" > < strong aria-hidden = "true" > 4.1.< / strong > Installing Plugins< / a > < / li > < li class = "chapter-item expanded " > < a href = "writing-plugins.html" > < strong aria-hidden = "true" > 4.2.< / strong > Writing Plugins< / a > < / li > < li class = "chapter-item expanded " > < a href = "awesome-plugins.html" > < strong aria-hidden = "true" > 4.3.< / strong > Awesome Plugins< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "integration.html" > < strong aria-hidden = "true" > 5.< / strong > Integration< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "awesome-integrations.html" > < strong aria-hidden = "true" > 5.1.< / strong > Awesome Integrations< / 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 >
2021-10-05 07:53:06 +00:00
< / 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 >
2021-10-05 07:53:06 +00:00
< 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" >
2021-06-23 10:02:10 +00:00
< i class = "fa fa-search" > < / i >
< / button >
2021-10-05 07:53:06 +00:00
< / div >
2021-06-23 10:02:10 +00:00
< h1 class = "menu-title" > xplr book< / h1 >
< div class = "right-buttons" >
2021-10-05 07:53:06 +00:00
< a href = "print.html" title = "Print this book" aria-label = "Print this book" >
2021-06-23 10:02:10 +00:00
< i id = "print-button" class = "fa fa-print" > < / i >
< / a >
2021-10-05 07:53:06 +00:00
< a href = "https://github.com/sayanarijit/xplr" title = "Git repository" aria-label = "Git repository" >
2021-06-23 11:54:40 +00:00
< i id = "git-repository-button" class = "fa fa-github" > < / i >
< / a >
2021-10-05 07:53:06 +00:00
< a href = "https://github.com/sayanarijit/xplr/edit/main/docs/en/src/layouts.md" title = "Suggest an edit" aria-label = "Suggest an edit" >
2021-06-23 11:54:40 +00:00
< i id = "git-edit-button" class = "fa fa-edit" > < / i >
< / a >
2021-06-23 10:02:10 +00:00
< / div >
< / div >
2021-10-05 07:53:06 +00:00
< div id = "search-wrapper" class = "hidden" >
2021-06-23 10:02:10 +00:00
< 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 = "layouts" > < a class = "header" href = "#layouts" > Layouts< / a > < / h1 >
2021-10-05 07:53:06 +00:00
< h4 id = "example-defining-custom-layout" > < a class = "header" href = "#example-defining-custom-layout" > Example: Defining Custom Layout< / a > < / h4 >
< p > < a href = "https://gifyu.com/image/1X38" > < img src = "https://s6.gifyu.com/images/layout.png" alt = "layout.png" / > < / a > < / p >
< pre > < code class = "language-lua" > xplr.config.layouts.builtin.default = {
Horizontal = {
config = {
margin = 1,
horizontal_margin = 2,
vertical_margin = 3,
constraints = {
{ Percentage = 50 },
{ Percentage = 50 },
}
},
splits = {
" Table" ,
" HelpMenu" ,
}
}
}
< / code > < / pre >
2021-06-23 10:02:10 +00:00
< p > xplr layouts define the structure of the UI, i.e. how many panel we see,
placement and size of the panels, how they look etc.< / p >
< p > This is configuration exposed via the < code > xplr.config.layouts< / code > API. It contains
the following fields:< / p >
< ul >
< li > < a href = "#builtin" > builtin< / a > < / li >
< li > < a href = "#custom" > custom< / a > < / li >
< / ul >
< p > The users can switch between these layouts at run-time.< / p >
< h2 id = "builtin" > < a class = "header" href = "#builtin" > builtin< / a > < / h2 >
< p > Type: mapping of string and < a href = "#layout" > Layout< / a > < / p >
< p > This is exposed by the < code > xplr.config.layouts.builtin< / code > API.< / p >
< p > xplr by default provides the following builtin layouts:< / p >
< ul >
< li > < a href = "#default" > default< / a > < / li >
< li > < a href = "#no_help" > no_help< / a > < / li >
< li > < a href = "#no_selection" > no_selection< / a > < / li >
< li > < a href = "#no_help_no_selection" > no_help_no_selection< / a > < / li >
< / ul >
< h3 id = "default" > < a class = "header" href = "#default" > default< / a > < / h3 >
< p > Type: < a href = "#layout" > Layout< / a > < / p >
< p > This is the default layout we see when we run xplr.< / p >
< h3 id = "no_help" > < a class = "header" href = "#no_help" > no_help< / a > < / h3 >
< p > Type: < a href = "#layout" > Layout< / a > < / p >
< p > This layout hides the help menu.< / p >
< h3 id = "no_selection" > < a class = "header" href = "#no_selection" > no_selection< / a > < / h3 >
< p > Type: < a href = "#layout" > Layout< / a > < / p >
< p > This layout hides the selection panel.< / p >
< h3 id = "no_help_no_selection" > < a class = "header" href = "#no_help_no_selection" > no_help_no_selection< / a > < / h3 >
< p > Type: < a href = "#layout" > Layout< / a > < / p >
< p > This layout hides both the help menu and the selection panel.< / p >
< h2 id = "custom" > < a class = "header" href = "#custom" > custom< / a > < / h2 >
< p > Type: mapping of string and < a href = "#layout" > Layout< / a > < / p >
< p > This is exposed by the < code > xplr.config.layouts.custom< / code > API.< / p >
< p > It allows the users to define any custom layout.< / p >
< p > Example:< / p >
< pre > < code class = "language-lua" > xplr.config.layouts.custom.example = " Nothing"
xplr.config.general.initial_layout = " example"
-- when you load xplr, you should see a blank screen
< / code > < / pre >
< h2 id = "layout" > < a class = "header" href = "#layout" > Layout< / a > < / h2 >
< p > A layout 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 >
2021-10-05 07:53:06 +00:00
< li > { < a href = "#custom-content" > CustomContent< / a > = { < a href = "#title" > title< / a > , < a href = "#body" > body< / a > }< / li >
< li > { < a href = "#horizontal" > Horizontal< / a > = { < a href = "#layout-config" > config< / a > , < a href = "#splits" > splits< / a > }< / li >
< li > { < a href = "#vertical" > Vertical< / a > = { < a href = "#layout-config" > config< / a > , < a href = "#splits" > splits< / a > }< / li >
2021-06-23 10:02:10 +00:00
< / ul >
< h3 id = "nothing" > < a class = "header" href = "#nothing" > Nothing< / a > < / h3 >
< p > This layout contains a blank panel.< / 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 >
< h3 id = "selection" > < a class = "header" href = "#selection" > Selection< / a > < / h3 >
< p > This layout contains the panel displaying the selected paths.< / 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 >
< 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 of the list of paths being displayed.< / 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 >
< 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 >
< 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 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 >
2021-10-06 14:51:11 +00:00
< li > { MaxLessThanLayoutWidth = int }< / li >
2021-06-23 10:02:10 +00:00
< li > { Min = int }< / li >
< li > { MinLessThanScreenHeight = int }< / li >
< li > { MinLessThanScreenWidth = int }< / li >
< li > { MinLessThanLayoutHeight = int }< / li >
< li > { MinLessThanLayoutWidth = int }< / li >
< / ul >
< p > TODO: document each constraint.< / p >
< 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 >
2021-10-05 07:53:06 +00:00
< h2 id = "custom-content" > < a class = "header" href = "#custom-content" > Custom Content< / a > < / h2 >
< p > Custom content is a special layout to render something custom.
It contains the following information:< / p >
< ul >
< li > < a href = "#title" > title< / a > < / li >
< li > < a href = "#body" > body< / a > < / li >
< / ul >
< h3 id = "title" > < a class = "header" href = "#title" > title< / a > < / h3 >
< p > Type: nullable string< / p >
< p > The title of the panel.< / p >
< h3 id = "body" > < a class = "header" href = "#body" > body< / a > < / h3 >
< p > Type: < a href = "#content-body" > Content Body< / a > < / p >
< p > The body of the panel.< / p >
< h2 id = "content-body" > < a class = "header" href = "#content-body" > Content Body< / a > < / h2 >
< p > Content body can be one of the following:< / p >
< ul >
< li > < a href = "#static-paragraph" > StaticParagraph< / a > < / li >
< li > < a href = "#dynamic-paragraph" > DynamicParagraph< / a > < / li >
< li > < a href = "#static-list" > StaticList< / a > < / li >
< li > < a href = "#dynamic-list" > DynamicList< / a > < / li >
< li > < a href = "#static-table" > StaticTable< / a > < / li >
< li > < a href = "#dynamic-table" > DynamicTable< / a > < / li >
< / ul >
< h3 id = "static-paragraph" > < a class = "header" href = "#static-paragraph" > Static Paragraph< / a > < / h3 >
< p > A paragraph to render. It contains the following fields:< / p >
< ul >
< li > < strong > render< / 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 >
2021-06-23 10:02:10 +00:00
< pre > < code class = "language-lua" > xplr.config.layouts.builtin.default = {
2021-10-05 07:53:06 +00:00
CustomContent = {
title = " custom title" ,
body = {
StaticParagraph = { render = " custom body" },
2021-06-23 10:02:10 +00:00
},
2021-10-05 07:53:06 +00:00
},
}
< / code > < / pre >
< h3 id = "dynamic-paragraph" > < a class = "header" href = "#dynamic-paragraph" > Dynamic Paragraph< / a > < / h3 >
< p > A < a href = "#content-renderer" > Lua function< / a > to render a custom paragraph.
It contains the following fields:< / p >
< ul >
< li > < strong > render< / strong > (string): The < a href = "#content-renderer" > lua function< / a > that returns the paragraph to
render.< / li >
< / ul >
< 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 = {
CustomContent = {
title = " custom title" ,
2021-10-05 09:47:54 +00:00
body = { DynamicParagraph = { render = " custom.render_layout" } },
2021-10-05 07:53:06 +00:00
},
}
xplr.fn.custom.render_layout = function(ctx)
return ctx.app.pwd
end
< / code > < / pre >
< h3 id = "static-list" > < a class = "header" href = "#static-list" > Static List< / a > < / h3 >
< p > A list to render. It contains the following fields:< / p >
< ul >
< li > < strong > render< / strong > (list of string): The list to render.< / 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 = {
CustomContent = {
title = " custom title" ,
body = {
StaticList = { render = { " 1" , " 2" , " 3" } },
},
},
}
< / code > < / pre >
< h3 id = "dynamic-list" > < a class = "header" href = "#dynamic-list" > Dynamic List< / a > < / h3 >
< p > A < a href = "#content-renderer" > Lua function< / a > to render a custom list.
It contains the following fields:< / p >
< ul >
< li > < strong > render< / strong > (string): The < a href = "#content-renderer" > lua function< / a > that returns the list to render.< / li >
< / ul >
< 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 = {
CustomContent = {
title = " custom title" ,
body = { DynamicList = { render = " custom.render_layout" } },
},
}
xplr.fn.custom.render_layout = function(ctx)
2021-12-11 15:04:42 +00:00
return {
ctx.app.pwd,
ctx.app.version,
tostring(ctx.app.pid),
}
2021-10-05 07:53:06 +00:00
end
< / code > < / pre >
< h3 id = "static-table" > < a class = "header" href = "#static-table" > Static Table< / a > < / h3 >
< p > A table to render. It contains the following fields:< / p >
< ul >
< 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 > render< / 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 = {
CustomContent = {
title = " custom title" ,
body = {
StaticTable = {
widths = {
{ Percentage = 50 },
{ Percentage = 50 },
},
col_spacing = 1,
render = {
{ " a" , " b" },
{ " c" , " d" },
},
},
},
},
2021-06-23 10:02:10 +00:00
}
< / code > < / pre >
2021-10-05 07:53:06 +00:00
< h3 id = "dynamic-table" > < a class = "header" href = "#dynamic-table" > Dynamic Table< / a > < / h3 >
< p > A < a href = "#content-renderer" > Lua function< / a > to render a custom table.
It contains the following fields:< / p >
< ul >
< 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 > render< / strong > (string): The < a href = "#content-renderer" > lua function< / a > that returns the table to render.< / li >
< / ul >
< 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 = {
CustomContent = {
title = " custom title" ,
body = {
DynamicTable = {
widths = {
{ Percentage = 50 },
{ Percentage = 50 },
},
col_spacing = 1,
render = " custom.render_layout" ,
},
},
},
}
xplr.fn.custom.render_layout = function(ctx)
return {
{ " " , " " },
{ " 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 >
< 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 >
2021-12-11 14:08:09 +00:00
< li > < a href = "#app" > app< / a > < / li >
2021-10-05 07:53:06 +00:00
< / ul >
2021-12-11 14:08:09 +00:00
< h3 id = "size" > < a class = "header" href = "#size" > Size< / a > < / h3 >
2021-10-05 07:53:06 +00:00
< 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 >
2021-12-11 14:08:09 +00:00
< h3 id = "app" > < a class = "header" href = "#app" > app< / a > < / h3 >
< p > This is a lightweight version of the < a href = "message.html#lua-context" > Lua Context< / a > . In this context, the
heavyweight fields like < a href = "message.html#directory_buffer" > directory_buffer< / a > are omitted for performance
reasons.< / p >
< p > Hence, only the following fields are avilable.< / p >
< ul >
< li > < a href = "message.html#version" > version< / a > < / li >
< li > < a href = "message.html#pwd" > pwd< / a > < / li >
< li > < a href = "message.html#focused_node" > focused_node< / a > < / li >
< li > < a href = "message.html#selection" > selection< / a > < / li >
< li > < a href = "message.html#mode" > mode< / a > < / li >
< li > < a href = "message.html#layout" > layout< / a > < / li >
< li > < a href = "message.html#input_buffer" > input_buffer< / a > < / li >
< li > < a href = "message.html#pid" > pid< / a > < / li >
< li > < a href = "message.html#session_path" > session_path< / a > < / li >
< li > < a href = "message.html#explorer_config" > explorer_config< / a > < / li >
< / ul >
2021-06-23 10:02:10 +00:00
< / main >
< nav class = "nav-wrapper" aria-label = "Page navigation" >
<!-- Mobile navigation buttons -->
2021-10-05 07:53:06 +00:00
< a rel = "prev" href = "message.html" class = "mobile-nav-chapters previous" title = "Previous chapter" aria-label = "Previous chapter" aria-keyshortcuts = "Left" >
2021-06-23 10:02:10 +00:00
< i class = "fa fa-angle-left" > < / i >
< / a >
2021-10-05 07:53:06 +00:00
< a rel = "next" href = "node_types.html" class = "mobile-nav-chapters next" title = "Next chapter" aria-label = "Next chapter" aria-keyshortcuts = "Right" >
2021-06-23 10:02:10 +00:00
< 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" >
2021-10-05 07:53:06 +00:00
< a rel = "prev" href = "message.html" class = "nav-chapters previous" title = "Previous chapter" aria-label = "Previous chapter" aria-keyshortcuts = "Left" >
2021-06-23 10:02:10 +00:00
< i class = "fa fa-angle-left" > < / i >
< / a >
2021-10-05 07:53:06 +00:00
< a rel = "next" href = "node_types.html" class = "nav-chapters next" title = "Next chapter" aria-label = "Next chapter" aria-keyshortcuts = "Right" >
2021-06-23 10:02:10 +00:00
< i class = "fa fa-angle-right" > < / i >
< / a >
2021-10-05 07:53:06 +00:00
< / nav >
2021-06-23 10:02:10 +00:00
< / div >
2021-10-05 07:53:06 +00:00
< script type = "text/javascript" >
2021-06-23 10:02:10 +00:00
window.playground_copyable = true;
< / script >
2021-10-05 07:53:06 +00:00
< script src = "elasticlunr.min.js" type = "text/javascript" charset = "utf-8" > < / script >
2021-06-23 10:02:10 +00:00
< 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 >
