xplr allows customizing the shape and style of the borders.
A border can be one of the following:
A border is a sum type that can be one of the following:
A border type is a sum type that can be one of the following:
The style of the borders.
Default action to perform in case if a keyboard input not mapped via any of the on_* fields mentioned above.
on_*
A key can be one of the following:
A key is a sum type can be one of the following:
xyz
A filter can be one of the following:
A filter is a sum type that can be one of the following:
Cursor based input operation can be one of the following:
Cursor based input operation is a sum type can be one of the following:
A layout can be one of the following:
A layout is a sum type can be one of the following:
Type: nullable list of Constraint
The constraints applied on the layout.
A constraint can be one of the following:
A constraint is a sum type can be one of the following:
Type: list of Layout
The list of child layouts to fit into the parent layout.
Custom panel can be one of the following:
Custom panel is a sum type can be one of the following:
You can think of xplr as a server. Just like web servers listen to HTTP -requests, xplr listens to messages.
A message is a sum type that can have these possible values.
You can send these messages to an xplr session in the following ways:
--on-load
+This section isn't specific to xplr. However, since xplr configuration makes +heavy use of this particular data type, even though it isn't available in +most of the mainstream programming languages (yet), making it a wild or +unfamilier concept for many, it's worth doing a quick introduction here. +If you're already familiar with Sum Type / Tagged Union (e.g. Rust's +enum), you can skip ahead. +
This section isn't specific to xplr. However, since xplr configuration makes +heavy use of this particular data type, even though it isn't available in +most of the mainstream programming languages (yet), making it a wild or +unfamilier concept for many, it's worth doing a quick introduction here.
If you're already familiar with Sum Type / Tagged Union (e.g. Rust's +enum), you can skip ahead.
While reading this doc, you'll come across some data types like Layout, +Color, Message etc. that says something like "x can be any of the +following", and then you'll see a list of strings and/or lua tables just below.
Yes, they are actually sum types, i.e. they can be any of the finite set of +values listed there.
Note the word "finite". Many conventional programming languages have only two +kinds of data types with finite set of values:
null
bool
true
false
Other types like integer, float, string etc. can have infinite number of +possible values (ideally).
integer
float
string
Many popular programming languages come with the concept of enum, which lets +us define a type with finite set of possible values like:
enum
+#![allow(unused)] +fn main() { +enum Result { + Ok, + Err, +} +} +
Here, Result has only two possible values (just like bool): Ok and Err.
Result
Ok
Err
We'd document it here as:
+Result is a sum type that can be one of the following: + +"Ok" +"Err" + +
Result is a sum type that can be one of the following:
But some languages (like Rust, Haskell, Elm etc.) go even further, allowing us +to associate each branch of the enum with further nested types like:
+#![allow(unused)] +fn main() { +enum Result { + Ok(bool), + Err(String), +} +} +
+Result is a sum type that can be one of the following: + +{ Ok = bool } +{ Err = "string" } + +
Here, Result still has only two possibilities, but unlike bool, each +possibility here has further finite or infinite set of possible values.
And there you go. This is exactly what sum types are - glorified enums that can +have nested types in each branch.
Key bindings define how each keyboard input will be handled while in a specific mode.
Type: nullable list of Modifier
Modifiers to remove.
Color can be one of the following:
Color is a sum type that can be one of the following:
Modifier can be one of the following:
Modifier is a sum type that can be one of the following:
A sorter can be one of the following:
A sorter is a sum type that can be one of the following: