feat: new ui.Text:scroll() API for setting text to scroll horizontally or vertically (#2589)

Author: sxyazi

Cargo.lock

@@ -25,7 +25,7 @@ dirs                = "6.0.0"
 foldhash            = "0.1.5"
 futures             = "0.3.31"
 globset             = "0.4.16"
-indexmap            = { version = "2.8.0", features = [ "serde" ] }
+indexmap            = { version = "2.9.0", features = [ "serde" ] }
 libc                = "0.2.171"
 lru                 = "0.13.0"
 md-5                = "0.10.6"
@@ -39,7 +39,7 @@ scopeguard          = "1.2.0"
 serde               = { version = "1.0.219", features = [ "derive" ] }
 serde_json          = "1.0.140"
 syntect             = { version = "5.2.0", default-features = false, features = [ "parsing", "plist-load", "regex-onig" ] }
-tokio               = { version = "1.44.1", features = [ "full" ] }
+tokio               = { version = "1.44.2", features = [ "full" ] }
 tokio-stream        = "0.1.17"
 tokio-util          = "0.7.14"
 toml                = { version = "0.8.20" }

Cargo.toml

@@ -2,7 +2,16 @@ use std::{env, error::Error};
 
 fn main() -> Result<(), Box<dyn Error>> {
 	let dir = env::var("OUT_DIR").unwrap();
-	if dir.contains("\\target\\release\\build\\yazi-fm-") {
+
+	#[rustfmt::skip]
+	{
+		// cargo build
+		//   C:\Users\Ika\Desktop\yazi\target\release\build\yazi-fm-cfc94820f71daa30\out
+		// cargo install
+		//   C:\Users\Ika\AppData\Local\Temp\cargo-installTFU8cj\release\build\yazi-fm-45dffef2500eecd0\out
+	}
+
+	if dir.contains("\\release\\build\\yazi-fm-") {
 		panic!(
 			"Unwinding must be enabled for Windows. Please use `cargo build --profile release-windows --locked` instead to build Yazi."
 		);

yazi-fm/build.rs

@@ -23,9 +23,9 @@ pub struct Text {
 	pub area: Area,
 
 	// TODO: block
-	pub inner: ratatui::text::Text<'static>,
-	pub wrap:  u8,
-	// TODO: scroll
+	pub inner:  ratatui::text::Text<'static>,
+	pub wrap:   u8,
+	pub scroll: ratatui::layout::Position,
 }
 
 impl Text {
@@ -58,7 +58,7 @@ impl Text {
 		trans: impl Fn(yazi_config::popup::Position) -> ratatui::layout::Rect,
 	) {
 		let rect = self.area.transform(trans);
-		if self.wrap == WRAP_NO {
+		if self.wrap == WRAP_NO && self.scroll == Default::default() {
 			self.inner.render(rect, buf);
 		} else {
 			ratatui::widgets::Paragraph::from(self).render(rect, buf);
@@ -130,7 +130,7 @@ impl From<Text> for ratatui::widgets::Paragraph<'static> {
 		if value.wrap != WRAP_NO {
 			p = p.wrap(ratatui::widgets::Wrap { trim: value.wrap == WRAP_TRIM });
 		}
-		p
+		p.scroll((value.scroll.y, value.scroll.x))
 	}
 }
 
@@ -155,6 +155,10 @@ impl UserData for Text {
 			};
 			Ok(ud)
 		});
+		methods.add_function_mut("scroll", |_, (ud, x, y): (AnyUserData, u16, u16)| {
+			ud.borrow_mut::<Self>()?.scroll = ratatui::layout::Position { x, y };
+			Ok(ud)
+		});
 		methods.add_method("max_width", |_, me, ()| {
 			Ok(me.inner.lines.iter().take(me.area.size().height as usize).map(|l| l.width()).max())
 		});

yazi-plugin/src/elements/text.rs

@@ -52,6 +52,7 @@ impl Utils {
 				area,
 				inner,
 				wrap: if YAZI.preview.wrap == PreviewWrap::Yes { WRAP } else { WRAP_NO },
+				scroll: Default::default(),
 			})];
 
 			emit!(Call(Cmd::new("mgr:update_peeked").with_any("lock", lock)));