use iced::advanced::layout::{self, Layout};
use iced::advanced::renderer;
use iced::advanced::widget::tree::{self, Tree};
use iced::advanced::widget::Widget;
use iced::advanced::{Clipboard, Shell};
use iced::mouse;
use iced::{Background, Color, Element, Event, Length, Rectangle, Size};
use crate::chrome::{Corner, SCROLL_HANDLE_MIN, SCROLL_RAIL_WIDTH};
use crate::collection::{scroll_from_rail, scroller_span};
use crate::theme::{mix, Tokens};
#[derive(Default)]
struct State {
dragging: Option<f32>,
}
pub struct ScrollRail<'a, Message> {
content: f32,
viewport: f32,
scroll: f32,
on_scroll: Box<dyn Fn(f32) -> Message + 'a>,
tok: Tokens,
}
impl<'a, Message> ScrollRail<'a, Message> {
pub fn new(
content: f32,
viewport: f32,
scroll: f32,
on_scroll: impl Fn(f32) -> Message + 'a,
tok: Tokens,
) -> Self {
Self {
content,
viewport,
scroll,
on_scroll: Box::new(on_scroll),
tok,
}
}
}
fn thumb(content: f32, viewport: f32, scroll: f32, rail: f32) -> (f32, f32) {
scroller_span(content, viewport, scroll, rail, SCROLL_HANDLE_MIN)
}
impl<Message, Renderer> Widget<Message, iced::Theme, Renderer> for ScrollRail<'_, Message>
where
Renderer: iced::advanced::Renderer,
{
fn tag(&self) -> tree::Tag {
tree::Tag::of::<State>()
}
fn state(&self) -> tree::State {
tree::State::new(State::default())
}
fn size(&self) -> Size<Length> {
Size::new(Length::Fixed(SCROLL_RAIL_WIDTH), Length::Fill)
}
fn layout(
&mut self,
_tree: &mut Tree,
_renderer: &Renderer,
limits: &layout::Limits,
) -> layout::Node {
let size = limits.resolve(
Length::Fixed(SCROLL_RAIL_WIDTH),
Length::Fill,
Size::new(SCROLL_RAIL_WIDTH, 0.0),
);
layout::Node::new(size)
}
fn update(
&mut self,
tree: &mut Tree,
event: &Event,
layout: Layout<'_>,
cursor: mouse::Cursor,
_renderer: &Renderer,
_clipboard: &mut dyn Clipboard,
shell: &mut Shell<'_, Message>,
_viewport: &Rectangle,
) {
let bounds = layout.bounds();
let state = tree.state.downcast_mut::<State>();
let rail = bounds.height;
let (off, len) = thumb(self.content, self.viewport, self.scroll, rail);
match event {
Event::Mouse(mouse::Event::ButtonPressed(mouse::Button::Left)) => {
let Some(pos) = cursor.position() else {
return;
};
if !bounds.contains(pos) {
return;
}
let y = pos.y - bounds.y;
if y >= off && y <= off + len {
state.dragging = Some(y - off);
} else {
let thumb_y = (y - len / 2.0).clamp(0.0, (rail - len).max(0.0));
state.dragging = Some(y - thumb_y);
shell.publish((self.on_scroll)(scroll_from_rail(
self.content,
self.viewport,
thumb_y,
rail,
SCROLL_HANDLE_MIN,
)));
}
shell.capture_event();
}
Event::Mouse(mouse::Event::CursorMoved { .. }) => {
let Some(grab) = state.dragging else {
return;
};
let Some(pos) = cursor.position() else {
return;
};
let y = pos.y - bounds.y;
let thumb_y = (y - grab).clamp(0.0, (rail - len).max(0.0));
shell.publish((self.on_scroll)(scroll_from_rail(
self.content,
self.viewport,
thumb_y,
rail,
SCROLL_HANDLE_MIN,
)));
shell.capture_event();
}
Event::Mouse(mouse::Event::ButtonReleased(mouse::Button::Left)) => {
if state.dragging.take().is_some() {
shell.capture_event();
}
}
Event::Mouse(mouse::Event::WheelScrolled { delta }) => {
if !cursor.is_over(bounds) {
return;
}
let dy = match delta {
mouse::ScrollDelta::Lines { y, .. } => -y * 24.0,
mouse::ScrollDelta::Pixels { y, .. } => -y,
};
let max_scroll = (self.content - self.viewport).max(0.0);
shell.publish((self.on_scroll)((self.scroll + dy).clamp(0.0, max_scroll)));
shell.capture_event();
}
_ => {}
}
}
fn mouse_interaction(
&self,
tree: &Tree,
layout: Layout<'_>,
cursor: mouse::Cursor,
_viewport: &Rectangle,
_renderer: &Renderer,
) -> mouse::Interaction {
let state = tree.state.downcast_ref::<State>();
if state.dragging.is_some() {
return mouse::Interaction::Grabbing;
}
let bounds = layout.bounds();
let Some(pos) = cursor.position() else {
return mouse::Interaction::default();
};
if !bounds.contains(pos) {
return mouse::Interaction::default();
}
let (off, len) = thumb(self.content, self.viewport, self.scroll, bounds.height);
let y = pos.y - bounds.y;
if y >= off && y <= off + len {
mouse::Interaction::Grab
} else {
mouse::Interaction::Pointer
}
}
fn draw(
&self,
_tree: &Tree,
renderer: &mut Renderer,
_theme: &iced::Theme,
_style: &renderer::Style,
layout: Layout<'_>,
_cursor: mouse::Cursor,
_viewport: &Rectangle,
) {
let bounds = layout.bounds();
renderer.fill_quad(
renderer::Quad {
bounds,
border: iced::Border {
color: Color::TRANSPARENT,
width: 0.0,
radius: Corner::Soft.radius(),
},
..renderer::Quad::default()
},
Background::Color(self.tok.panel),
);
let (off, len) = thumb(self.content, self.viewport, self.scroll, bounds.height);
if len <= 0.0 {
return;
}
let thumb_bounds = Rectangle {
x: bounds.x,
y: bounds.y + off,
width: bounds.width,
height: len,
};
renderer.fill_quad(
renderer::Quad {
bounds: thumb_bounds,
border: iced::Border {
color: Color::TRANSPARENT,
width: 0.0,
radius: Corner::Soft.radius(),
},
..renderer::Quad::default()
},
Background::Color(mix(self.tok.text, self.tok.canvas, 0.35)),
);
}
}
impl<'a, Message: 'a> From<ScrollRail<'a, Message>> for Element<'a, Message> {
fn from(value: ScrollRail<'a, Message>) -> Self {
Self::new(value)
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::theme::named;
use iced::advanced::clipboard;
use iced::advanced::layout::Limits;
use iced::advanced::widget::{Tree, Widget};
use iced::{Font, Pixels, Point, Theme};
#[test]
fn rail_jump_and_drag_emit_scroll() {
let tok = named("dark").tokens;
let mut widget = ScrollRail::new(10_000.0, 400.0, 0.0, |y| y, tok);
let mut tree = Tree::new(&widget as &dyn Widget<f32, Theme, iced_tiny_skia::Renderer>);
let mut renderer = iced_tiny_skia::Renderer::new(Font::DEFAULT, Pixels::from(16u32));
let limits = Limits::new(Size::ZERO, Size::new(12.0, 400.0));
let node = Widget::<f32, Theme, iced_tiny_skia::Renderer>::layout(
&mut widget,
&mut tree,
&renderer,
&limits,
);
let layout = Layout::new(&node);
let bounds = layout.bounds();
assert!(bounds.height > 0.0);
let viewport = Rectangle::new(Point::ORIGIN, Size::new(40.0, 400.0));
let mut clipboard = clipboard::Null;
let mut messages = Vec::new();
let mid = Point::new(bounds.x + 6.0, bounds.y + bounds.height / 2.0);
{
let mut shell = iced::advanced::Shell::new(&mut messages);
Widget::<f32, Theme, iced_tiny_skia::Renderer>::update(
&mut widget,
&mut tree,
&Event::Mouse(mouse::Event::ButtonPressed(mouse::Button::Left)),
layout,
mouse::Cursor::Available(mid),
&renderer,
&mut clipboard,
&mut shell,
&viewport,
);
}
assert!(!messages.is_empty());
assert!(*messages.last().unwrap() > 0.0);
{
let mut shell = iced::advanced::Shell::new(&mut messages);
Widget::<f32, Theme, iced_tiny_skia::Renderer>::update(
&mut widget,
&mut tree,
&Event::Mouse(mouse::Event::CursorMoved { position: mid }),
layout,
mouse::Cursor::Available(Point::new(mid.x, bounds.y + bounds.height - 4.0)),
&renderer,
&mut clipboard,
&mut shell,
&viewport,
);
Widget::<f32, Theme, iced_tiny_skia::Renderer>::update(
&mut widget,
&mut tree,
&Event::Mouse(mouse::Event::ButtonReleased(mouse::Button::Left)),
layout,
mouse::Cursor::Available(mid),
&renderer,
&mut clipboard,
&mut shell,
&viewport,
);
Widget::<f32, Theme, iced_tiny_skia::Renderer>::update(
&mut widget,
&mut tree,
&Event::Mouse(mouse::Event::WheelScrolled {
delta: mouse::ScrollDelta::Lines { x: 0.0, y: -3.0 },
}),
layout,
mouse::Cursor::Available(mid),
&renderer,
&mut clipboard,
&mut shell,
&viewport,
);
}
let top = Point::new(bounds.x + 6.0, bounds.y + 4.0);
let grab = Widget::<f32, Theme, iced_tiny_skia::Renderer>::mouse_interaction(
&widget,
&tree,
layout,
mouse::Cursor::Available(top),
&viewport,
&renderer,
);
assert_eq!(grab, mouse::Interaction::Grab);
assert_eq!(
Widget::<f32, Theme, iced_tiny_skia::Renderer>::mouse_interaction(
&widget,
&tree,
layout,
mouse::Cursor::Unavailable,
&viewport,
&renderer,
),
mouse::Interaction::default()
);
Widget::<f32, Theme, iced_tiny_skia::Renderer>::draw(
&widget,
&tree,
&mut renderer,
&Theme::Dark,
&iced::advanced::renderer::Style::default(),
layout,
mouse::Cursor::Available(mid),
&viewport,
);
{
let mut shell = iced::advanced::Shell::new(&mut messages);
Widget::<f32, Theme, iced_tiny_skia::Renderer>::update(
&mut widget,
&mut tree,
&Event::Mouse(mouse::Event::ButtonPressed(mouse::Button::Left)),
layout,
mouse::Cursor::Available(top),
&renderer,
&mut clipboard,
&mut shell,
&viewport,
);
}
assert_eq!(
Widget::<f32, Theme, iced_tiny_skia::Renderer>::mouse_interaction(
&widget,
&tree,
layout,
mouse::Cursor::Available(top),
&viewport,
&renderer,
),
mouse::Interaction::Grabbing
);
{
let mut shell = iced::advanced::Shell::new(&mut messages);
Widget::<f32, Theme, iced_tiny_skia::Renderer>::update(
&mut widget,
&mut tree,
&Event::Mouse(mouse::Event::CursorMoved { position: top }),
layout,
mouse::Cursor::Unavailable,
&renderer,
&mut clipboard,
&mut shell,
&viewport,
);
Widget::<f32, Theme, iced_tiny_skia::Renderer>::update(
&mut widget,
&mut tree,
&Event::Keyboard(iced::keyboard::Event::KeyPressed {
key: iced::keyboard::Key::Named(iced::keyboard::key::Named::Escape),
modified_key: iced::keyboard::Key::Named(iced::keyboard::key::Named::Escape),
physical_key: iced::keyboard::key::Physical::Unidentified(
iced::keyboard::key::NativeCode::Unidentified,
),
location: iced::keyboard::Location::Standard,
modifiers: iced::keyboard::Modifiers::default(),
text: None,
repeat: false,
}),
layout,
mouse::Cursor::Available(top),
&renderer,
&mut clipboard,
&mut shell,
&viewport,
);
Widget::<f32, Theme, iced_tiny_skia::Renderer>::update(
&mut widget,
&mut tree,
&Event::Mouse(mouse::Event::ButtonPressed(mouse::Button::Left)),
layout,
mouse::Cursor::Unavailable,
&renderer,
&mut clipboard,
&mut shell,
&viewport,
);
Widget::<f32, Theme, iced_tiny_skia::Renderer>::update(
&mut widget,
&mut tree,
&Event::Mouse(mouse::Event::WheelScrolled {
delta: mouse::ScrollDelta::Pixels { x: 0.0, y: 20.0 },
}),
layout,
mouse::Cursor::Unavailable,
&renderer,
&mut clipboard,
&mut shell,
&viewport,
);
}
let mut empty = ScrollRail::new(10.0, 400.0, 0.0, |y| y, tok);
let mut etree = Tree::new(&empty as &dyn Widget<f32, Theme, iced_tiny_skia::Renderer>);
let enode = Widget::<f32, Theme, iced_tiny_skia::Renderer>::layout(
&mut empty, &mut etree, &renderer, &limits,
);
Widget::<f32, Theme, iced_tiny_skia::Renderer>::draw(
&empty,
&etree,
&mut renderer,
&Theme::Dark,
&iced::advanced::renderer::Style::default(),
Layout::new(&enode),
mouse::Cursor::Unavailable,
&viewport,
);
let outside = Point::new(bounds.x - 20.0, bounds.y + 10.0);
{
let mut shell = iced::advanced::Shell::new(&mut messages);
Widget::<f32, Theme, iced_tiny_skia::Renderer>::update(
&mut widget,
&mut tree,
&Event::Mouse(mouse::Event::ButtonReleased(mouse::Button::Left)),
layout,
mouse::Cursor::Available(mid),
&renderer,
&mut clipboard,
&mut shell,
&viewport,
);
Widget::<f32, Theme, iced_tiny_skia::Renderer>::update(
&mut widget,
&mut tree,
&Event::Mouse(mouse::Event::ButtonPressed(mouse::Button::Left)),
layout,
mouse::Cursor::Available(outside),
&renderer,
&mut clipboard,
&mut shell,
&viewport,
);
Widget::<f32, Theme, iced_tiny_skia::Renderer>::update(
&mut widget,
&mut tree,
&Event::Mouse(mouse::Event::CursorMoved { position: mid }),
layout,
mouse::Cursor::Available(mid),
&renderer,
&mut clipboard,
&mut shell,
&viewport,
);
Widget::<f32, Theme, iced_tiny_skia::Renderer>::update(
&mut widget,
&mut tree,
&Event::Mouse(mouse::Event::WheelScrolled {
delta: mouse::ScrollDelta::Pixels { x: 0.0, y: 20.0 },
}),
layout,
mouse::Cursor::Available(mid),
&renderer,
&mut clipboard,
&mut shell,
&viewport,
);
}
assert_eq!(
Widget::<f32, Theme, iced_tiny_skia::Renderer>::mouse_interaction(
&widget,
&tree,
layout,
mouse::Cursor::Available(outside),
&viewport,
&renderer,
),
mouse::Interaction::default()
);
assert_eq!(
Widget::<f32, Theme, iced_tiny_skia::Renderer>::mouse_interaction(
&widget,
&tree,
layout,
mouse::Cursor::Available(mid),
&viewport,
&renderer,
),
mouse::Interaction::Pointer
);
let limits0 = Limits::new(Size::ZERO, Size::new(12.0, 0.0));
let mut flat = ScrollRail::new(10.0, 400.0, 0.0, |y| y, tok);
let mut ftree = Tree::new(&flat as &dyn Widget<f32, Theme, iced_tiny_skia::Renderer>);
let fnode = Widget::<f32, Theme, iced_tiny_skia::Renderer>::layout(
&mut flat, &mut ftree, &renderer, &limits0,
);
Widget::<f32, Theme, iced_tiny_skia::Renderer>::draw(
&flat,
&ftree,
&mut renderer,
&Theme::Dark,
&iced::advanced::renderer::Style::default(),
Layout::new(&fnode),
mouse::Cursor::Unavailable,
&viewport,
);
}
}