feat: new ui.Align, ui.Wrap, and ui.Edge (sxyazi#2802)

sxyazi · xeysz · commit dd60042bed66 · 2025-06-27T15:15:58.000-07:00
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/yazi-plugin/preset/components/current.lua b/yazi-plugin/preset/components/current.lua
@@ -20,7 +20,7 @@ function Current:empty()
 	end
 
 	return {
-		ui.Line(s):area(self._area):align(ui.Line.CENTER),
+		ui.Line(s):area(self._area):align(ui.Align.CENTER),
 	}
 end
 
@@ -43,7 +43,7 @@ function Current:redraw()
 
 	return {
 		ui.List(left):area(self._area),
-		ui.Text(right):area(self._area):align(ui.Text.RIGHT),
+		ui.Text(right):area(self._area):align(ui.Align.RIGHT),
 	}
 end
 
diff --git a/yazi-plugin/preset/components/header.lua b/yazi-plugin/preset/components/header.lua
@@ -1,4 +1,5 @@
 Header = {
+	-- TODO: remove these two constants
 	LEFT = 0,
 	RIGHT = 1,
 
@@ -83,7 +84,7 @@ function Header:redraw()
 
 	return {
 		ui.Line(left):area(self._area),
-		ui.Line(right):area(self._area):align(ui.Line.RIGHT),
+		ui.Line(right):area(self._area):align(ui.Align.RIGHT),
 	}
 end
 
diff --git a/yazi-plugin/preset/components/marker.lua b/yazi-plugin/preset/components/marker.lua
@@ -29,7 +29,7 @@ function Marker:redraw()
 			w = 1,
 			h = math.min(1 + last[2] - last[1], self._area.y + self._area.h - y),
 		}
-		elements[#elements + 1] = ui.Bar(ui.Bar.LEFT):area(rect):style(last[3])
+		elements[#elements + 1] = ui.Bar(ui.Edge.LEFT):area(rect):style(last[3])
 	end
 
 	local last = { 0, 0, nil } -- start, end, style
diff --git a/yazi-plugin/preset/components/rail.lua b/yazi-plugin/preset/components/rail.lua
@@ -10,8 +10,8 @@ end
 
 function Rail:build()
 	self._base = {
-		ui.Bar(ui.Bar.RIGHT):area(self._chunks[1]):symbol(th.mgr.border_symbol):style(th.mgr.border_style),
-		ui.Bar(ui.Bar.LEFT):area(self._chunks[3]):symbol(th.mgr.border_symbol):style(th.mgr.border_style),
+		ui.Bar(ui.Edge.RIGHT):area(self._chunks[1]):symbol(th.mgr.border_symbol):style(th.mgr.border_style),
+		ui.Bar(ui.Edge.LEFT):area(self._chunks[3]):symbol(th.mgr.border_symbol):style(th.mgr.border_style),
 	}
 	self._children = {
 		Marker:new(self._chunks[1], self._tab.parent),
diff --git a/yazi-plugin/preset/components/status.lua b/yazi-plugin/preset/components/status.lua
@@ -1,4 +1,5 @@
 Status = {
+	-- TODO: remove these two constants
 	LEFT = 0,
 	RIGHT = 1,
 
@@ -141,7 +142,7 @@ function Status:redraw()
 	return {
 		ui.Text(""):area(self._area):style(th.status.overall),
 		ui.Line(left):area(self._area),
-		ui.Line(right):area(self._area):align(ui.Line.RIGHT),
+		ui.Line(right):area(self._area):align(ui.Align.RIGHT),
 		table.unpack(ui.redraw(Progress:new(self._area, right_width))),
 	}
 end
diff --git a/yazi-plugin/preset/plugins/archive.lua b/yazi-plugin/preset/plugins/archive.lua
@@ -45,7 +45,7 @@ function M:peek(job)
 	else
 		ya.preview_widget(job, {
 			ui.Text(left):area(job.area),
-			ui.Text(right):area(job.area):align(ui.Text.RIGHT),
+			ui.Text(right):area(job.area):align(ui.Align.RIGHT),
 		})
 	end
 end
diff --git a/yazi-plugin/preset/plugins/empty.lua b/yazi-plugin/preset/plugins/empty.lua
@@ -1,6 +1,6 @@
 local M = {}
 
-function M.msg(job, s) ya.preview_widget(job, ui.Text(ui.Line(s):reverse()):area(job.area):wrap(ui.Text.WRAP)) end
+function M.msg(job, s) ya.preview_widget(job, ui.Text(ui.Line(s):reverse()):area(job.area):wrap(ui.Wrap.YES)) end
 
 function M:peek(job)
 	local path = tostring(job.file.url)
diff --git a/yazi-plugin/preset/plugins/file.lua b/yazi-plugin/preset/plugins/file.lua
@@ -11,7 +11,7 @@ function M:peek(job)
 		text = ui.Text(string.format("Failed to start `%s`, error: %s", cmd, err))
 	end
 
-	ya.preview_widget(job, text:area(job.area):wrap(ui.Text.WRAP))
+	ya.preview_widget(job, text:area(job.area):wrap(ui.Wrap.YES))
 end
 
 function M:seek() end
diff --git a/yazi-plugin/preset/plugins/folder.lua b/yazi-plugin/preset/plugins/folder.lua
@@ -16,7 +16,7 @@ function M:peek(job)
 	if #folder.files == 0 then
 		local done, err = folder.stage()
 		local s = not done and "Loading..." or not err and "No items" or string.format("Error: %s", err)
-		return ya.preview_widget(job, ui.Line(s):area(job.area):align(ui.Line.CENTER))
+		return ya.preview_widget(job, ui.Line(s):area(job.area):align(ui.Align.CENTER))
 	end
 
 	local items = {}
diff --git a/yazi-plugin/preset/plugins/font.lua b/yazi-plugin/preset/plugins/font.lua
@@ -16,7 +16,7 @@ function M:peek(job)
 	ya.sleep(math.max(0, rt.preview.image_delay / 1000 + start - os.clock()))
 
 	local _, err = ya.image_show(cache, job.area)
-	ya.preview_widget(job, err and ui.Text(tostring(err)):area(job.area):wrap(ui.Text.WRAP))
+	ya.preview_widget(job, err and ui.Text(tostring(err)):area(job.area):wrap(ui.Wrap.YES))
 end
 
 function M:seek() end
diff --git a/yazi-plugin/preset/plugins/image.lua b/yazi-plugin/preset/plugins/image.lua
@@ -9,7 +9,7 @@ function M:peek(job)
 	ya.sleep(math.max(0, rt.preview.image_delay / 1000 + start - os.clock()))
 
 	local _, err = ya.image_show(url, job.area)
-	ya.preview_widget(job, err and ui.Text(tostring(err)):area(job.area):wrap(ui.Text.WRAP))
+	ya.preview_widget(job, err and ui.Text(tostring(err)):area(job.area):wrap(ui.Wrap.YES))
 end
 
 function M:seek() end
diff --git a/yazi-plugin/preset/plugins/json.lua b/yazi-plugin/preset/plugins/json.lua
@@ -34,7 +34,7 @@ function M:peek(job)
 		lines = lines:gsub("\t", string.rep(" ", rt.preview.tab_size))
 		ya.preview_widget(
 			job,
-			ui.Text.parse(lines):area(job.area):wrap(rt.preview.wrap == "yes" and ui.Text.WRAP or ui.Text.WRAP_NO)
+			ui.Text.parse(lines):area(job.area):wrap(rt.preview.wrap == "yes" and ui.Wrap.YES or ui.Wrap.NO)
 		)
 	end
 end
diff --git a/yazi-plugin/preset/plugins/magick.lua b/yazi-plugin/preset/plugins/magick.lua
@@ -14,7 +14,7 @@ function M:peek(job)
 	ya.sleep(math.max(0, rt.preview.image_delay / 1000 + start - os.clock()))
 
 	local _, err = ya.image_show(cache, job.area)
-	ya.preview_widget(job, err and ui.Text(tostring(err)):area(job.area):wrap(ui.Text.WRAP))
+	ya.preview_widget(job, err and ui.Text(tostring(err)):area(job.area):wrap(ui.Wrap.YES))
 end
 
 function M:seek() end
diff --git a/yazi-plugin/preset/plugins/pdf.lua b/yazi-plugin/preset/plugins/pdf.lua
@@ -14,7 +14,7 @@ function M:peek(job)
 	ya.sleep(math.max(0, rt.preview.image_delay / 1000 + start - os.clock()))
 
 	local _, err = ya.image_show(cache, job.area)
-	ya.preview_widget(job, err and ui.Text(tostring(err)):area(job.area):wrap(ui.Text.WRAP))
+	ya.preview_widget(job, err and ui.Text(tostring(err)):area(job.area):wrap(ui.Wrap.YES))
 end
 
 function M:seek(job)
diff --git a/yazi-plugin/preset/plugins/svg.lua b/yazi-plugin/preset/plugins/svg.lua
@@ -14,7 +14,7 @@ function M:peek(job)
 	ya.sleep(math.max(0, rt.preview.image_delay / 1000 + start - os.clock()))
 
 	local _, err = ya.image_show(cache, job.area)
-	ya.preview_widget(job, err and ui.Text(tostring(err)):area(job.area):wrap(ui.Text.WRAP))
+	ya.preview_widget(job, err and ui.Text(tostring(err)):area(job.area):wrap(ui.Wrap.YES))
 end
 
 function M:seek() end
diff --git a/yazi-plugin/preset/plugins/video.lua b/yazi-plugin/preset/plugins/video.lua
@@ -14,7 +14,7 @@ function M:peek(job)
 	ya.sleep(math.max(0, rt.preview.image_delay / 1000 + start - os.clock()))
 
 	local _, err = ya.image_show(cache, job.area)
-	ya.preview_widget(job, err and ui.Text(tostring(err)):area(job.area):wrap(ui.Text.WRAP))
+	ya.preview_widget(job, err and ui.Text(tostring(err)):area(job.area):wrap(ui.Wrap.YES))
 end
 
 function M:seek(job)
diff --git a/yazi-plugin/src/elements/align.rs b/yazi-plugin/src/elements/align.rs
@@ -0,0 +1,40 @@
+use std::ops::Deref;
+
+use mlua::{FromLua, IntoLua, Lua, Value};
+
+#[derive(Clone, Copy, Debug, Default, Eq, PartialEq)]
+pub struct Align(pub(super) ratatui::layout::Alignment);
+
+impl Deref for Align {
+	type Target = ratatui::layout::Alignment;
+
+	fn deref(&self) -> &Self::Target { &self.0 }
+}
+
+impl Align {
+	pub fn compose(lua: &Lua) -> mlua::Result<Value> {
+		lua.create_table_from([("LEFT", 0), ("CENTER", 1), ("RIGHT", 2)])?.into_lua(lua)
+	}
+}
+
+impl FromLua for Align {
+	fn from_lua(value: Value, _: &Lua) -> mlua::Result<Self> {
+		let Value::Integer(n) = value else {
+			return Err(mlua::Error::FromLuaConversionError {
+				from:    value.type_name(),
+				to:      "Align".to_string(),
+				message: Some("expected an integer representation of Align".to_string()),
+			});
+		};
+		Ok(Self(match n {
+			0 => ratatui::layout::Alignment::Left,
+			1 => ratatui::layout::Alignment::Center,
+			2 => ratatui::layout::Alignment::Right,
+			_ => Err(mlua::Error::FromLuaConversionError {
+				from:    value.type_name(),
+				to:      "Align".to_string(),
+				message: Some("invalid value for Align".to_string()),
+			})?,
+		}))
+	}
+}
diff --git a/yazi-plugin/src/elements/bar.rs b/yazi-plugin/src/elements/bar.rs
@@ -1,25 +1,24 @@
 use mlua::{AnyUserData, IntoLua, Lua, MetaMethod, Table, UserData, Value};
 use ratatui::widgets::Borders;
 
-use super::Area;
+use super::{Area, Edge};
 
 #[derive(Clone, Debug, Default)]
 pub struct Bar {
 	area: Area,
 
-	direction: ratatui::widgets::Borders,
-	symbol:    String,
-	style:     ratatui::style::Style,
+	edge:   Edge,
+	symbol: String,
+	style:  ratatui::style::Style,
 }
 
 impl Bar {
 	pub fn compose(lua: &Lua) -> mlua::Result<Value> {
-		let new = lua.create_function(|_, (_, direction): (Table, u8)| {
-			Ok(Self { direction: Borders::from_bits_truncate(direction), ..Default::default() })
-		})?;
+		let new =
+			lua.create_function(|_, (_, edge): (Table, Edge)| Ok(Self { edge, ..Default::default() }))?;
 
 		let bar = lua.create_table_from([
-			// Direction
+			// TODO: remove these constants
 			("NONE", Borders::NONE.bits()),
 			("TOP", Borders::TOP.bits()),
 			("RIGHT", Borders::RIGHT.bits()),
@@ -44,31 +43,31 @@ impl Bar {
 
 		let symbol = if !self.symbol.is_empty() {
 			&self.symbol
-		} else if self.direction.intersects(Borders::TOP | Borders::BOTTOM) {
+		} else if self.edge.intersects(Borders::TOP | Borders::BOTTOM) {
 			"─"
-		} else if self.direction.intersects(Borders::LEFT | Borders::RIGHT) {
+		} else if self.edge.intersects(Borders::LEFT | Borders::RIGHT) {
 			"│"
 		} else {
 			" "
 		};
 
-		if self.direction.contains(Borders::LEFT) {
+		if self.edge.contains(Borders::LEFT) {
 			for y in rect.top()..rect.bottom() {
 				buf[(rect.left(), y)].set_style(self.style).set_symbol(symbol);
 			}
 		}
-		if self.direction.contains(Borders::TOP) {
+		if self.edge.contains(Borders::TOP) {
 			for x in rect.left()..rect.right() {
 				buf[(x, rect.top())].set_style(self.style).set_symbol(symbol);
 			}
 		}
-		if self.direction.contains(Borders::RIGHT) {
+		if self.edge.contains(Borders::RIGHT) {
 			let x = rect.right() - 1;
 			for y in rect.top()..rect.bottom() {
 				buf[(x, y)].set_style(self.style).set_symbol(symbol);
 			}
 		}
-		if self.direction.contains(Borders::BOTTOM) {
+		if self.edge.contains(Borders::BOTTOM) {
 			let y = rect.bottom() - 1;
 			for x in rect.left()..rect.right() {
 				buf[(x, y)].set_style(self.style).set_symbol(symbol);
@@ -82,8 +81,8 @@ impl UserData for Bar {
 		crate::impl_area_method!(methods);
 		crate::impl_style_method!(methods, style);
 
-		methods.add_function_mut("direction", |_, (ud, symbol): (AnyUserData, u8)| {
-			ud.borrow_mut::<Self>()?.direction = Borders::from_bits_truncate(symbol);
+		methods.add_function_mut("edge", |_, (ud, edge): (AnyUserData, Edge)| {
+			ud.borrow_mut::<Self>()?.edge = edge;
 			Ok(ud)
 		});
 		methods.add_function_mut("symbol", |_, (ud, symbol): (AnyUserData, String)| {
diff --git a/yazi-plugin/src/elements/border.rs b/yazi-plugin/src/elements/border.rs
@@ -1,7 +1,7 @@
 use mlua::{AnyUserData, IntoLua, Lua, MetaMethod, Table, UserData, Value};
 use ratatui::widgets::{Borders, Widget};
 
-use super::Area;
+use super::{Area, Edge};
 use crate::elements::Line;
 
 // Type
@@ -16,24 +16,20 @@ const QUADRANT_OUTSIDE: u8 = 5;
 pub struct Border {
 	pub(crate) area: Area,
 
-	pub(crate) position: ratatui::widgets::Borders,
-	pub(crate) r#type:   ratatui::widgets::BorderType,
-	pub(crate) style:    ratatui::style::Style,
+	pub(crate) edge:   Edge,
+	pub(crate) r#type: ratatui::widgets::BorderType,
+	pub(crate) style:  ratatui::style::Style,
 
 	pub(crate) titles: Vec<(ratatui::widgets::block::Position, ratatui::text::Line<'static>)>,
 }
 
 impl Border {
 	pub fn compose(lua: &Lua) -> mlua::Result<Value> {
-		let new = lua.create_function(|_, (_, position): (Table, u8)| {
-			Ok(Border {
-				position: ratatui::widgets::Borders::from_bits_truncate(position),
-				..Default::default()
-			})
-		})?;
+		let new = lua
+			.create_function(|_, (_, edge): (Table, Edge)| Ok(Border { edge, ..Default::default() }))?;
 
 		let border = lua.create_table_from([
-			// Position
+			// TODO: remove these constants
 			("NONE", Borders::NONE.bits()),
 			("TOP", Borders::TOP.bits()),
 			("RIGHT", Borders::RIGHT.bits()),
@@ -59,7 +55,7 @@ impl Border {
 		trans: impl FnOnce(yazi_config::popup::Position) -> ratatui::layout::Rect,
 	) {
 		let mut block = ratatui::widgets::Block::default()
-			.borders(self.position)
+			.borders(self.edge.0)
 			.border_type(self.r#type)
 			.border_style(self.style);
 
@@ -103,8 +99,8 @@ impl UserData for Border {
 				Ok(ud)
 			},
 		);
-		methods.add_function_mut("position", |_, (ud, position): (AnyUserData, u8)| {
-			ud.borrow_mut::<Self>()?.position = ratatui::widgets::Borders::from_bits_truncate(position);
+		methods.add_function_mut("edge", |_, (ud, edge): (AnyUserData, Edge)| {
+			ud.borrow_mut::<Self>()?.edge = edge;
 			Ok(ud)
 		});
 	}
diff --git a/yazi-plugin/src/elements/edge.rs b/yazi-plugin/src/elements/edge.rs
diff --git a/yazi-plugin/src/elements/elements.rs b/yazi-plugin/src/elements/elements.rs
diff --git a/yazi-plugin/src/elements/line.rs b/yazi-plugin/src/elements/line.rs
diff --git a/yazi-plugin/src/elements/mod.rs b/yazi-plugin/src/elements/mod.rs
diff --git a/yazi-plugin/src/elements/text.rs b/yazi-plugin/src/elements/text.rs
diff --git a/yazi-plugin/src/elements/wrap.rs b/yazi-plugin/src/elements/wrap.rs
diff --git a/yazi-plugin/src/utils/preview.rs b/yazi-plugin/src/utils/preview.rs
diff --git a/yazi-plugin/src/utils/spot.rs b/yazi-plugin/src/utils/spot.rs

Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ function Current:empty()`
`20`	`20`	`end`
`21`	`21`
`22`	`22`	`return {`
`23`		`- ui.Line(s):area(self._area):align(ui.Line.CENTER),`
	`23`	`+ ui.Line(s):area(self._area):align(ui.Align.CENTER),`
`24`	`24`	`}`
`25`	`25`	`end`
`26`	`26`
`@@ -43,7 +43,7 @@ function Current:redraw()`
`43`	`43`
`44`	`44`	`return {`
`45`	`45`	`ui.List(left):area(self._area),`
`46`		`- ui.Text(right):area(self._area):align(ui.Text.RIGHT),`
	`46`	`+ ui.Text(right):area(self._area):align(ui.Align.RIGHT),`
`47`	`47`	`}`
`48`	`48`	`end`
`49`	`49`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ function Marker:redraw()`
`29`	`29`	`w = 1,`
`30`	`30`	`h = math.min(1 + last[2] - last[1], self._area.y + self._area.h - y),`
`31`	`31`	`}`
`32`		`- elements[#elements + 1] = ui.Bar(ui.Bar.LEFT):area(rect):style(last[3])`
	`32`	`+ elements[#elements + 1] = ui.Bar(ui.Edge.LEFT):area(rect):style(last[3])`
`33`	`33`	`end`
`34`	`34`
`35`	`35`	`local last = { 0, 0, nil } -- start, end, style`