nicklist in sidebar

Author: Hummer12007

CHANGELOG.md

@@ -7,6 +7,7 @@ Added:
 - Setting to style unread query buffers as highlights in the sidebar (`sidebar.unread_indicator.query_as_highlight`)
 - Settings to configure card and imagge preview dimensions 
 - Support for transparent background.
+- Settings to show nicklist in the sidebar together with the buflist (`sidebar.show_nicklist`, `sidebar.split`, `sidebar.buflist_space`, `sidebar.nicklist_space`)
 
 Fixed:
 

book/src/configuration/sidebar/README.md

@@ -7,6 +7,10 @@ Sidebar settings for Halloy.
     - [server\_icon](#server_icon)
     - [position](#position)
     - [max\_width](#max_width)
+    - [show\_nicklist](#show_nicklist)
+    - [split](#split)
+    - [buflist\_space](#buflist_space)
+    - [nicklist\_space](#nicklist_space)
     - [show\_menu\_button](#show_menu_button)
     - [order\_by](#order_by)
   - [Scrollbar](#scrollbar)
@@ -62,6 +66,61 @@ Specify sidebar max width in pixels. Only used if `position` is `"left"` or `"ri
 max_width = 200
 ```
 
+### show_nicklist
+
+Show the nicklist for the focused channel in the sidebar (rendered below the buffer list). Only used if `position` is `"left"` or `"right"`.
+
+```toml
+# Type: bool
+# Values: true, false
+# Default: false
+
+[sidebar]
+show_nicklist = true
+```
+
+### split
+
+When `show_nicklist` is enabled, controls how the vertical space is split between the buffer list and the nicklist.
+
+- `false`: buffer list shrinks; nicklist takes the remaining space.
+- `true`: buffer list and nicklist use proportional space controlled by `buflist_space` and `nicklist_space`.
+
+```toml
+# Type: bool
+# Values: true, false
+# Default: false
+
+[sidebar]
+split = true
+```
+
+### buflist_space
+
+Relative space for the buffer list when `split = true`.
+
+```toml
+# Type: integer
+# Values: any positive integer
+# Default: 2
+
+[sidebar]
+buflist_space = 2
+```
+
+### nicklist_space
+
+Relative space for the nicklist when `split = true`.
+
+```toml
+# Type: integer
+# Values: any positive integer
+# Default: 1
+
+[sidebar]
+nicklist_space = 1
+```
+
 ### show_menu_button
 
 Show or hide the user menu button in the sidebar.

data/src/config/sidebar.rs

@@ -7,13 +7,19 @@ use crate::serde::deserialize_positive_integer;
 use crate::server::Server;
 use crate::{isupport, target};
 
-#[derive(Debug, Clone, Default, Deserialize)]
+#[derive(Debug, Clone, Deserialize)]
 #[serde(default)]
 pub struct Sidebar {
     pub max_width: Option<u16>,
     #[serde(deserialize_with = "deserialize_unread_indicator")]
     pub unread_indicator: UnreadIndicator,
     pub position: Position,
+    pub show_nicklist: bool,
+    pub split: bool,
+    #[serde(deserialize_with = "deserialize_positive_integer")]
+    pub buflist_space: u16,
+    #[serde(deserialize_with = "deserialize_positive_integer")]
+    pub nicklist_space: u16,
     pub order_by: OrderBy,
     pub scrollbar: Scrollbar,
     #[serde(
@@ -26,6 +32,26 @@ pub struct Sidebar {
     pub spacing: Spacing,
 }
 
+impl Default for Sidebar {
+    fn default() -> Self {
+        Self {
+            max_width: None,
+            unread_indicator: UnreadIndicator::default(),
+            position: Position::default(),
+            show_nicklist: false,
+            split: false,
+            buflist_space: 2,
+            nicklist_space: 1,
+            order_by: OrderBy::default(),
+            scrollbar: Scrollbar::default(),
+            server_icon: ServerIcon::default(),
+            user_menu: UserMenu::default(),
+            padding: Padding::default(),
+            spacing: Spacing::default(),
+        }
+    }
+}
+
 #[derive(Debug, Clone, Deserialize)]
 #[serde(rename_all = "kebab-case")]
 pub enum ServerIcon {

data/src/serde.rs

@@ -133,21 +133,22 @@ where
     }
 }
 
-pub fn deserialize_positive_integer<'de, D>(
+pub fn deserialize_positive_integer<'de, D, T>(
     deserializer: D,
-) -> Result<u32, D::Error>
+) -> Result<T, D::Error>
 where
     D: Deserializer<'de>,
+    T: Deserialize<'de> + PartialEq + Default,
 {
-    let integer: u32 = Deserialize::deserialize(deserializer)?;
+    let value: T = T::deserialize(deserializer)?;
 
-    if integer == 0 {
+    if value == T::default() {
         Err(serde::de::Error::invalid_value(
-            serde::de::Unexpected::Unsigned(integer.into()),
+            serde::de::Unexpected::Unsigned(0),
             &"any positive integer",
         ))
     } else {
-        Ok(integer)
+        Ok(value)
     }
 }
 

src/buffer/channel.rs

@@ -412,7 +412,7 @@ fn topic<'a>(
     )
 }
 
-mod nick_list {
+pub(crate) mod nick_list {
     use context_menu::Message;
     use data::user::ChannelUsers;
     use data::{Config, Server, User, config, isupport, target};

src/screen/dashboard.rs

@@ -543,6 +543,18 @@ impl Dashboard {
 
                         (Task::none(), None)
                     }
+                    sidebar::Event::NicklistEvent(message) => {
+                        let Focus { window, pane } = self.focus;
+                        let event = buffer::context_menu::update(message);
+
+                        self.handle_buffer_event(
+                            window,
+                            pane,
+                            buffer::Event::ContextMenu(event),
+                            clients,
+                            config,
+                        )
+                    }
                     sidebar::Event::OpenConfigFile => {
                         let _ = open::that_detached(Config::path());
                         (Task::none(), None)

src/screen/dashboard/sidebar.rs

@@ -11,6 +11,7 @@ use iced::{Alignment, Length, Padding, Task, padding};
 use tokio::time;
 
 use super::{Focus, Panes, Server};
+use crate::buffer::context_menu as buffer_context_menu;
 use crate::widget::{Element, Text, context_menu, double_pass};
 use crate::{Theme, font, icon, platform_specific, theme, window};
 
@@ -38,6 +39,7 @@ pub enum Message {
     ReloadComplete,
     MarkAsRead(buffer::Upstream),
     MarkServerAsRead(Server),
+    NicklistEvent(buffer_context_menu::Message),
     QuitApplication,
 }
 
@@ -61,6 +63,7 @@ pub enum Event {
     ConfigReloaded(Result<Config, config::Error>),
     MarkAsRead(buffer::Upstream),
     MarkServerAsRead(Server),
+    NicklistEvent(buffer_context_menu::Message),
     QuitApplication,
 }
 
@@ -156,6 +159,9 @@ impl Sidebar {
             Message::MarkServerAsRead(server) => {
                 (Task::none(), Some(Event::MarkServerAsRead(server)))
             }
+            Message::NicklistEvent(message) => {
+                (Task::none(), Some(Event::NicklistEvent(message)))
+            }
             Message::OpenConfigFile => {
                 (Task::none(), Some(Event::OpenConfigFile))
             }
@@ -393,7 +399,7 @@ impl Sidebar {
     pub fn view<'a>(
         &'a self,
         servers: &server::Map,
-        clients: &data::client::Map,
+        clients: &'a data::client::Map,
         history: &'a history::Manager,
         panes: &'a Panes,
         focus: Focus,
@@ -564,27 +570,49 @@ impl Sidebar {
 
             match config.sidebar.position {
                 sidebar::Position::Left | sidebar::Position::Right => {
-                    // Add buffers to a column.
-                    let buffers = column![
-                        Scrollable::new(
-                            Column::with_children(buffers).spacing(1)
-                        )
-                        .direction(
-                            scrollable::Direction::Vertical(
-                                scrollable::Scrollbar::default()
-                                    .width(config.sidebar.scrollbar.width)
-                                    .scroller_width(
-                                        config.sidebar.scrollbar.scroller_width
-                                    )
+                    let nicklist: Option<Element<'a, Message>> =
+                        if config.sidebar.show_nicklist {
+                            focused_channel_nicklist(
+                                panes, focus, clients, config, theme, width,
                             )
-                        )
-                    ];
+                            .map(|list| {
+                                container(list)
+                                    .padding([0, 2])
+                                    .height(if config.sidebar.split {
+                                        Length::FillPortion(
+                                            config.sidebar.nicklist_space,
+                                        )
+                                    } else {
+                                        Length::Fill
+                                    })
+                                    .into()
+                            })
+                        } else {
+                            None
+                        };
 
-                    // Wrap buffers in a column with user_menu_button
-                    let content = column![
-                        container(buffers).height(Length::Fill),
-                        user_menu_button,
-                    ];
+                    let buflist_height =
+                        if config.sidebar.split && nicklist.is_some() {
+                            Length::FillPortion(config.sidebar.buflist_space)
+                        } else if nicklist.is_some() {
+                            Length::Shrink
+                        } else {
+                            Length::Fill
+                        };
+
+                    let buflist = Scrollable::new(
+                        Column::with_children(buffers).spacing(0),
+                    )
+                    .direction(scrollable::Direction::Vertical(
+                        scrollable::Scrollbar::default()
+                            .width(config.sidebar.scrollbar.width)
+                            .scroller_width(
+                                config.sidebar.scrollbar.scroller_width,
+                            ),
+                    ))
+                    .height(buflist_height);
+
+                    let content = column![buflist, nicklist, user_menu_button,];
 
                     container(content)
                 }
@@ -656,6 +684,41 @@ impl Sidebar {
     }
 }
 
+fn focused_channel_nicklist<'a>(
+    panes: &'a Panes,
+    focus: Focus,
+    clients: &'a data::client::Map,
+    config: &'a Config,
+    theme: &'a Theme,
+    width: Length,
+) -> Option<Element<'a, Message>> {
+    if !matches!(width, Length::Fill) {
+        return None;
+    }
+
+    let (server, channel) =
+        panes.iter().find_map(|(window, pane, state)| {
+            if (Focus { window, pane }) != focus {
+                return None;
+            }
+            match state.buffer.upstream() {
+                Some(buffer::Upstream::Channel(server, channel)) => {
+                    Some((server, channel))
+                }
+                _ => None,
+            }
+        })?;
+
+    let users = clients.get_channel_users(server, channel);
+    let prefix = clients.get_prefix(server);
+    let list = crate::buffer::channel::nick_list::view(
+        server, prefix, channel, users, None, config, theme,
+    )
+    .map(Message::NicklistEvent);
+
+    Some(list)
+}
+
 #[derive(Debug, Clone, Copy)]
 enum Menu {
     RefreshConfig,