Skip to main content

BoardModel

Struct BoardModel 

Source
pub struct BoardModel {
    pub id: WidgetId,
    pub columns: Vec<BoardColumn>,
    pub selected_card_id: Option<CardId>,
    pub col_scroll_offset: usize,
}
Expand description

Top-level model for a [Board] widget.

The host constructs this from its own state each frame and passes it to backend.draw_board(rect, &model).

§Examples

use quadraui::{board_layout, BoardCard, BoardColumn, BoardHit, BoardMeasure, BoardModel, WidgetId};

let model = BoardModel {
    id: WidgetId::new("board:issues"),
    columns: vec![BoardColumn {
        id: WidgetId::new("column:backlog"),
        title: "Backlog".to_string(),
        cards: vec![BoardCard {
            id: WidgetId::new("card:1"),
            title: "Fix flaky test".to_string(),
            labels: vec![],
            badges: vec![],
            hint: None,
        }],
        scroll_offset: 0,
    }],
    selected_card_id: None,
    col_scroll_offset: 0,
};

let measure = BoardMeasure::new(20.0, 1.0, 1.0, 3.0, 1.0);
let layout = board_layout(&model, 0.0, 0.0, 80.0, 24.0, measure);

assert_eq!(layout.hit_test(1.0, 2.0), BoardHit::Card(WidgetId::new("card:1")));

Fields§

§id: WidgetId

Unique identifier for this board widget.

§columns: Vec<BoardColumn>

Ordered list of columns rendered left-to-right.

§selected_card_id: Option<CardId>

The currently selected card, if any (host-owned).

§col_scroll_offset: usize

Horizontal scroll: index of the first visible column. Updated by the host in response to h/l navigation when the board overflows the viewport.

Implementations§

Source§

impl BoardModel

Source

pub fn move_selection(&mut self, dir: MoveDir)

Handle a keyboard event on the focused board.

Returns a BoardAction if the key is consumed, None if the caller should handle it.

§Keybindings (v1 hardcoded, generic navigation only)
KeyAction
j / ↓Move selection down
k / ↑Move selection up
h / ←Move selection left (between columns)
l / →Move selection right (between columns)
EnterOpen issue
gJump to top of focused column
GJump to bottom of focused column

Hosts that need workflow-specific verbs (e.g. merge, dispatch, review) should handle those keys themselves before or after calling this method — it only ever consumes the generic navigation keys above. Move the selection in the given direction, updating selected_card_id and col_scroll_offset as needed.

Callers that want the BoardAction for external routing should use [handle_key] instead. This method is for apps (like BoardApp) that just want the state to update immediately.

Source

pub fn jump_to_top(&mut self)

Select the first card in the currently-focused column.

Source

pub fn jump_to_bottom(&mut self)

Select the last card in the currently-focused column.

Source

pub fn selected_col_index(&self) -> Option<usize>

Return the column index of the currently-selected card, if any.

Source

pub fn selected_position(&self) -> Option<(usize, usize)>

Return (col_index, card_index) of the currently-selected card, or None if no card is selected (or the selected id is no longer present on the board).

Source

pub fn handle_key( &self, key: &str, _modifiers: Modifiers, ) -> Option<BoardAction>

Trait Implementations§

Source§

impl Clone for BoardModel

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for BoardModel

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for BoardModel

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for BoardModel

Source§

impl PartialEq for BoardModel

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for BoardModel

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for BoardModel

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync> ⓘ

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more