|
|
|
@ -535,7 +535,193 @@ which is the <a href="style.html">Style</a> object.</p>
|
|
|
|
|
{ format = "╰─", style = { add_modifiers = { "Bold" }, bg = nil, fg = "Blue", sub_modifiers = nil } },
|
|
|
|
|
}
|
|
|
|
|
</code></pre>
|
|
|
|
|
<p>TODO: Continue documentation.</p>
|
|
|
|
|
<h2 id="start_fifo"><a class="header" href="#start_fifo">start_fifo</a></h2>
|
|
|
|
|
<p>Type: nullable string</p>
|
|
|
|
|
<p><a href="https://docs.rs/xplr/0.15.0/xplr/config/struct.GeneralConfig.html#structfield.start_fifo">Description</a></p>
|
|
|
|
|
<h2 id="promptformat"><a class="header" href="#promptformat">prompt.format</a></h2>
|
|
|
|
|
<p>Type: string</p>
|
|
|
|
|
<p>This is the shape of the prompt for the input buffer.</p>
|
|
|
|
|
<h2 id="promptstyle"><a class="header" href="#promptstyle">prompt.style</a></h2>
|
|
|
|
|
<p>Type: <a href="style.html">Style</a></p>
|
|
|
|
|
<p>Style of the input prompt.</p>
|
|
|
|
|
<h2 id="logserrorformat"><a class="header" href="#logserrorformat">logs.error.format</a></h2>
|
|
|
|
|
<p>Type: string</p>
|
|
|
|
|
<p>The string to indicate an error in logs.</p>
|
|
|
|
|
<h2 id="logserrorstyle"><a class="header" href="#logserrorstyle">logs.error.style</a></h2>
|
|
|
|
|
<p>Type: <a href="style.html">Style</a></p>
|
|
|
|
|
<p>Style for errors shown in logs.</p>
|
|
|
|
|
<h2 id="logsinfoformat"><a class="header" href="#logsinfoformat">logs.info.format</a></h2>
|
|
|
|
|
<p>Type: string</p>
|
|
|
|
|
<p>The string to indicate an information in logs.</p>
|
|
|
|
|
<h2 id="logsinfostyle"><a class="header" href="#logsinfostyle">logs.info.style</a></h2>
|
|
|
|
|
<p>Type: <a href="style.html">Style</a></p>
|
|
|
|
|
<p>Style for infos shown in logs.</p>
|
|
|
|
|
<h2 id="logssuccessformat"><a class="header" href="#logssuccessformat">logs.success.format</a></h2>
|
|
|
|
|
<p>Type: string</p>
|
|
|
|
|
<p>The string to indicate a successful operation in logs.</p>
|
|
|
|
|
<h2 id="logssuccessstyle"><a class="header" href="#logssuccessstyle">logs.success.style</a></h2>
|
|
|
|
|
<p>Type: <a href="style.html">Style</a></p>
|
|
|
|
|
<p>Style for successful operations in logs.</p>
|
|
|
|
|
<h2 id="logswarningformat"><a class="header" href="#logswarningformat">logs.warning.format</a></h2>
|
|
|
|
|
<p>Type: string</p>
|
|
|
|
|
<p>The string that indicates a warning in logs.</p>
|
|
|
|
|
<h2 id="logswarningstyle"><a class="header" href="#logswarningstyle">logs.warning.style</a></h2>
|
|
|
|
|
<p>Type: <a href="style.html">Style</a></p>
|
|
|
|
|
<p>Style for warnings in logs.</p>
|
|
|
|
|
<h2 id="default_uiprefix"><a class="header" href="#default_uiprefix">default_ui.prefix</a></h2>
|
|
|
|
|
<p>Type: nullable string</p>
|
|
|
|
|
<p>The content that is placed before the item name for each row.</p>
|
|
|
|
|
<h2 id="default_uisuffix"><a class="header" href="#default_uisuffix">default_ui.suffix</a></h2>
|
|
|
|
|
<p>Type: nullable string</p>
|
|
|
|
|
<p>The content which is appended to each item name for each row.</p>
|
|
|
|
|
<h2 id="default_uistyle"><a class="header" href="#default_uistyle">default_ui.style</a></h2>
|
|
|
|
|
<p>Type: <a href="style.html">Style</a></p>
|
|
|
|
|
<p>Style for the default user interface.</p>
|
|
|
|
|
<h2 id="focus_uiprefix"><a class="header" href="#focus_uiprefix">focus_ui.prefix</a></h2>
|
|
|
|
|
<p>Type: nullable string</p>
|
|
|
|
|
<p>The string placed before the item name for a focused row.</p>
|
|
|
|
|
<h2 id="focus_uisuffix"><a class="header" href="#focus_uisuffix">focus_ui.suffix</a></h2>
|
|
|
|
|
<p>Type: nullable string</p>
|
|
|
|
|
<p>The string placed after the item name for a focused row.</p>
|
|
|
|
|
<h2 id="focus_uistyle"><a class="header" href="#focus_uistyle">focus_ui.style</a></h2>
|
|
|
|
|
<p>Type: <a href="style.html">Style</a></p>
|
|
|
|
|
<p>Style for focused elements.</p>
|
|
|
|
|
<h2 id="selection_uiprefix"><a class="header" href="#selection_uiprefix">selection_ui.prefix</a></h2>
|
|
|
|
|
<p>Type: nullable string</p>
|
|
|
|
|
<p>The string that is placed before the item name for a selected row.</p>
|
|
|
|
|
<h2 id="selection_uisuffix"><a class="header" href="#selection_uisuffix">selection_ui.suffix</a></h2>
|
|
|
|
|
<p>Type: nullable string</p>
|
|
|
|
|
<p>The string placed after the item name for a selected row.</p>
|
|
|
|
|
<h2 id="selection_uistyle"><a class="header" href="#selection_uistyle">selection_ui.style</a></h2>
|
|
|
|
|
<p>Type: <a href="style.html">Style</a></p>
|
|
|
|
|
<p>Style for selected rows.</p>
|
|
|
|
|
<h2 id="focus_selection_uiprefix"><a class="header" href="#focus_selection_uiprefix">focus_selection_ui.prefix</a></h2>
|
|
|
|
|
<p>Type: nullable string</p>
|
|
|
|
|
<p>The string placed before item name for a selected row that gets the focus.</p>
|
|
|
|
|
<h2 id="focus_selection_uisuffix"><a class="header" href="#focus_selection_uisuffix">focus_selection_ui.suffix</a></h2>
|
|
|
|
|
<p>Type: nullable string</p>
|
|
|
|
|
<p>The string placed after the item name for a selected row that gets the focus.</p>
|
|
|
|
|
<h2 id="focus_selection_uistyle"><a class="header" href="#focus_selection_uistyle">focus_selection_ui.style</a></h2>
|
|
|
|
|
<p>Type: <a href="style.html">Style</a></p>
|
|
|
|
|
<p>Style for a selected row that gets the focus.</p>
|
|
|
|
|
<h2 id="sort_and_filter_uiseparatorformat"><a class="header" href="#sort_and_filter_uiseparatorformat">sort_and_filter_ui.separator.format</a></h2>
|
|
|
|
|
<p>Type: nullable string</p>
|
|
|
|
|
<p>The shape of the separator for the <code>Sort & filter</code> panel.</p>
|
|
|
|
|
<h2 id="sort_and_filter_uiseparatorstyle"><a class="header" href="#sort_and_filter_uiseparatorstyle">sort_and_filter_ui.separator.style</a></h2>
|
|
|
|
|
<p>Type: <a href="style.html">Style</a></p>
|
|
|
|
|
<p>Style for <code>Sort & filter</code> panel separator.</p>
|
|
|
|
|
<h2 id="sort_and_filter_uidefault_identifierformat"><a class="header" href="#sort_and_filter_uidefault_identifierformat">sort_and_filter_ui.default_identifier.format</a></h2>
|
|
|
|
|
<p>Type: nullable string</p>
|
|
|
|
|
<p>The content of the default identifier in <code>Sort & filter</code> panel.</p>
|
|
|
|
|
<h2 id="sort_and_filter_uidefault_identifierstyle"><a class="header" href="#sort_and_filter_uidefault_identifierstyle">sort_and_filter_ui.default_identifier.style</a></h2>
|
|
|
|
|
<p>Type: <a href="style.html">Style</a></p>
|
|
|
|
|
<p>Style for the default identifier in <code>Sort & filter</code> panel.</p>
|
|
|
|
|
<h2 id="sort_and_filter_uifilter_identifiers"><a class="header" href="#sort_and_filter_uifilter_identifiers">sort_and_filter_ui.filter_identifiers</a></h2>
|
|
|
|
|
<p>Type: Table with <a href="filtering.html#filter">filter name</a> as key</p>
|
|
|
|
|
<p>The value contains format field (string) and style field (Style), that define the content and style for the given filter.</p>
|
|
|
|
|
<p>Example:</p>
|
|
|
|
|
<pre><code class="language-lua">xplr.config.general.sort_and_filter_ui.filter_identifiers = {
|
|
|
|
|
AbsolutePathDoesContain = {
|
|
|
|
|
format = "abs=~",
|
|
|
|
|
style = { add_modifiers = { "Bold" }, bg = nil, fg = nil, sub_modifiers = nil },
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
</code></pre>
|
|
|
|
|
<h2 id="sort_and_filter_uisort_direction_identifiersforwardformat"><a class="header" href="#sort_and_filter_uisort_direction_identifiersforwardformat">sort_and_filter_ui.sort_direction_identifiers.forward.format</a></h2>
|
|
|
|
|
<p>Type: nullable string</p>
|
|
|
|
|
<p>The shape of the forward direction indicator for sort identifiers in <code>Sort & filter</code> panel.</p>
|
|
|
|
|
<h2 id="sort_and_filter_uisort_direction_identifiersforwardstyle"><a class="header" href="#sort_and_filter_uisort_direction_identifiersforwardstyle">sort_and_filter_ui.sort_direction_identifiers.forward.style</a></h2>
|
|
|
|
|
<p>Type: <a href="style.html">Style</a></p>
|
|
|
|
|
<p>Style of forward direction indicator.</p>
|
|
|
|
|
<h2 id="sort_and_filter_uisort_direction_identifiersreverseformat"><a class="header" href="#sort_and_filter_uisort_direction_identifiersreverseformat">sort_and_filter_ui.sort_direction_identifiers.reverse.format</a></h2>
|
|
|
|
|
<p>Type: nullable string</p>
|
|
|
|
|
<p>The shape of the reverse direction indicator for sort identifiers in <code>Sort & filter</code> panel.</p>
|
|
|
|
|
<h2 id="sort_and_filter_uisort_direction_identifiersreversestyle"><a class="header" href="#sort_and_filter_uisort_direction_identifiersreversestyle">sort_and_filter_ui.sort_direction_identifiers.reverse.style</a></h2>
|
|
|
|
|
<p>Type: <a href="style.html">Style</a></p>
|
|
|
|
|
<p>Style of reverse direction indicator.</p>
|
|
|
|
|
<h2 id="sort_and_filter_uisorter_identifiers"><a class="header" href="#sort_and_filter_uisorter_identifiers">sort_and_filter_ui.sorter_identifiers</a></h2>
|
|
|
|
|
<p>Type: Table with <a href="sorting.html#sorter">sorter name</a> as key</p>
|
|
|
|
|
<p>The value contains format field (string) and style field (Style), that define the content and style for the given sorter.</p>
|
|
|
|
|
<p>Example:</p>
|
|
|
|
|
<pre><code class="language-lua">sort_and_filter_ui.sorter_identifiers = {
|
|
|
|
|
ByCanonicalAbsolutePath = {
|
|
|
|
|
format = "[c]abs",
|
|
|
|
|
style = { add_modifiers = nil, bg = nil, fg = "Yellow", sub_modifiers = nil },
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
</code></pre>
|
|
|
|
|
<h2 id="panel_uidefaultborders"><a class="header" href="#panel_uidefaultborders">panel_ui.default.borders</a></h2>
|
|
|
|
|
<p>Type: nullable List of strings</p>
|
|
|
|
|
<p>Defines where to show borders for the panels.</p>
|
|
|
|
|
<p>The possible values are any combination of: "Top", "Bottom", "Left" and "Right".</p>
|
|
|
|
|
<p>Example:</p>
|
|
|
|
|
<pre><code class="language-lua">-- Show Left and Right borders only
|
|
|
|
|
xplr.config.general.panel_ui.default.borders = {
|
|
|
|
|
"Right",
|
|
|
|
|
"Left",
|
|
|
|
|
}
|
|
|
|
|
</code></pre>
|
|
|
|
|
<h2 id="panel_uidefaultstyle"><a class="header" href="#panel_uidefaultstyle">panel_ui.default.style</a></h2>
|
|
|
|
|
<p>Type: <a href="style.html">Style</a></p>
|
|
|
|
|
<p>Default style for panels.</p>
|
|
|
|
|
<h2 id="panel_uidefaulttitleformat"><a class="header" href="#panel_uidefaulttitleformat">panel_ui.default.title.format</a></h2>
|
|
|
|
|
<p>Type: nullable string</p>
|
|
|
|
|
<p>The content for panel title.</p>
|
|
|
|
|
<h2 id="panel_uidefaulttitlestyle"><a class="header" href="#panel_uidefaulttitlestyle">panel_ui.default.title.style</a></h2>
|
|
|
|
|
<p>Type: <a href="style.html">Style</a></p>
|
|
|
|
|
<p>Style for panel title.</p>
|
|
|
|
|
<h2 id="panel_uihelp_menuborders"><a class="header" href="#panel_uihelp_menuborders">panel_ui.help_menu.borders</a></h2>
|
|
|
|
|
<p>Type: nullable List of strings</p>
|
|
|
|
|
<p>Defines where to show borders for the <code>Help</code> panel.</p>
|
|
|
|
|
<p>The possible values are any combination of: "Top", "Bottom", "Left" and "Right".</p>
|
|
|
|
|
<h2 id="panel_uihelp_menustyle"><a class="header" href="#panel_uihelp_menustyle">panel_ui.help_menu.style</a></h2>
|
|
|
|
|
<p>Type: <a href="style.html">Style</a></p>
|
|
|
|
|
<p>Style for <code>Help</code> panel.</p>
|
|
|
|
|
<h2 id="panel_uihelp_menutitleformat"><a class="header" href="#panel_uihelp_menutitleformat">panel_ui.help_menu.title.format</a></h2>
|
|
|
|
|
<p>Type: nullable string</p>
|
|
|
|
|
<p>The content for <code>Help</code> panel title.</p>
|
|
|
|
|
<h2 id="panel_uihelp_menutitlestyle"><a class="header" href="#panel_uihelp_menutitlestyle">panel_ui.help_menu.title.style</a></h2>
|
|
|
|
|
<p>Type: <a href="style.html">Style</a></p>
|
|
|
|
|
<p>Style for <code>Help</code> panel title.</p>
|
|
|
|
|
<h2 id="panel_uiinput_and_logsborders"><a class="header" href="#panel_uiinput_and_logsborders">panel_ui.input_and_logs.borders</a></h2>
|
|
|
|
|
<p>Type: nullable List of strings</p>
|
|
|
|
|
<p>Defines where to show borders for the <code>Input</code> & <code>Logs</code> panel.</p>
|
|
|
|
|
<p>The possible values are any combination of: "Top", "Bottom", "Left" and "Right".</p>
|
|
|
|
|
<h2 id="panel_uiinput_and_logsstyle"><a class="header" href="#panel_uiinput_and_logsstyle">panel_ui.input_and_logs.style</a></h2>
|
|
|
|
|
<p>Type: <a href="style.html">Style</a></p>
|
|
|
|
|
<p>Style for <code>Input</code> & <code>Logs</code> panel.</p>
|
|
|
|
|
<h2 id="panel_uiinput_and_logstitleformat"><a class="header" href="#panel_uiinput_and_logstitleformat">panel_ui.input_and_logs.title.format</a></h2>
|
|
|
|
|
<p>Type: nullable string</p>
|
|
|
|
|
<p>The content for the <code>Input</code> and <code>Logs</code> panel title.</p>
|
|
|
|
|
<h2 id="panel_uiinput_and_logstitlestyle"><a class="header" href="#panel_uiinput_and_logstitlestyle">panel_ui.input_and_logs.title.style</a></h2>
|
|
|
|
|
<p>Type: <a href="style.html">Style</a></p>
|
|
|
|
|
<p>Style for <code>Input</code> & <code>Logs</code> panel title.</p>
|
|
|
|
|
<h2 id="panel_uiselectionborders"><a class="header" href="#panel_uiselectionborders">panel_ui.selection.borders</a></h2>
|
|
|
|
|
<p>Type: nullable List of strings</p>
|
|
|
|
|
<p>Defines where to show borders for the <code>Selection</code> panel.</p>
|
|
|
|
|
<p>The possible values are any combination of: "Top", "Bottom", "Left" and "Right".</p>
|
|
|
|
|
<h2 id="panel_uiselectionstyle"><a class="header" href="#panel_uiselectionstyle">panel_ui.selection.style</a></h2>
|
|
|
|
|
<p>Type: <a href="style.html">Style</a></p>
|
|
|
|
|
<p>Style for <code>Selection</code> panel.</p>
|
|
|
|
|
<h2 id="panel_uiselectiontitleformat"><a class="header" href="#panel_uiselectiontitleformat">panel_ui.selection.title.format</a></h2>
|
|
|
|
|
<p>Type: nullable string</p>
|
|
|
|
|
<p>The content for <code>Selection</code> panel title.</p>
|
|
|
|
|
<h2 id="panel_uiselectiontitlestyle"><a class="header" href="#panel_uiselectiontitlestyle">panel_ui.selection.title.style</a></h2>
|
|
|
|
|
<p>Type: <a href="style.html">Style</a></p>
|
|
|
|
|
<p>Style for <code>Selection</code> panel title.</p>
|
|
|
|
|
<h2 id="panel_uisort_and_filterborders"><a class="header" href="#panel_uisort_and_filterborders">panel_ui.sort_and_filter.borders</a></h2>
|
|
|
|
|
<p>Type: nullable list of strings</p>
|
|
|
|
|
<p>Defines where to show borders for the <code>Sort & filter</code> panel.</p>
|
|
|
|
|
<p>The possible values are any combination of: "Top", "Bottom", "Left" and "Right".</p>
|
|
|
|
|
<h2 id="panel_uisort_and_filterstyle"><a class="header" href="#panel_uisort_and_filterstyle">panel_ui.sort_and_filter.style</a></h2>
|
|
|
|
|
<p>Type: <a href="style.html">Style</a></p>
|
|
|
|
|
<p>Style for <code>Sort & filter</code> panel.</p>
|
|
|
|
|
<h2 id="panel_uisort_and_filtertitleformat"><a class="header" href="#panel_uisort_and_filtertitleformat">panel_ui.sort_and_filter.title.format</a></h2>
|
|
|
|
|
<p>Type: nullable string</p>
|
|
|
|
|
<p>The content for <code>Sort & filter</code> panel title.</p>
|
|
|
|
|
<h2 id="panel_uisort_and_filtertitlestyle"><a class="header" href="#panel_uisort_and_filtertitlestyle">panel_ui.sort_and_filter.title.style</a></h2>
|
|
|
|
|
<p>Type: <a href="style.html">Style</a></p>
|
|
|
|
|
<p>Style for <code>Sort & filter</code> panel title.</p>
|
|
|
|
|
<div style="break-before: page; page-break-before: always;"></div><h1 id="modes"><a class="header" href="#modes">Modes</a></h1>
|
|
|
|
|
<p>xplr is a modal file explorer. That means the users switch between different
|
|
|
|
|
modes, each containing a different set of key bindings to avoid clashes. Users
|
|
|
|
|