Struct MenuOptions 

pub struct MenuOptions { /* private fields */ }

Controls and characters that can be configured to change the way the menu acts and displays

Example

let options = MenuOptions::new()
    .cursor("→")
    .select_key(console::Key::Tab)
    .max_lines_visible(6);

menu!("Only 6 lines are visible!",
    menu_items_list,
    options
    )

Implementations

impl MenuOptions

pub fn new() -> Self

Create a new MenuOptions with all the defaults

pub fn cursor(self, cursor: &str) -> Self

Set the user’s row-indicator/cursor to a custom character. The default is: ‘>’

pub fn cursor_width(self, cursor_width: usize) -> Self

Override the space given for the cursor navigation column

pub fn selected_indicator(self, indicator: &str) -> Self

Set the “Item Selected” indicator to a custom character. Defaults is: ‘X’

pub fn selected_indicator_width(self, indicator_width: usize) -> Self

Override the space given for the cursor navigation column

pub fn select_key(self, key: Key) -> Self

Set the key that is used to select an item. The default is: [console::Key::Char(' ')]

pub fn max_lines_visible(self, max_lines: usize) -> Self

Set the maximum number of items that will be displayed at any one time. The default is: 10

pub fn minimum_search_threshold(self, threshold: f32) -> Self

Set the degree of “fuzziness” that it will match too. Higher numbers will return more results, but less accurate ones. Has to be 1.0 >= x >= 0 or will panic The default is: 0.005

pub fn show_selected_in_search(self, show_in_search: bool) -> Self

Set if ‘selected’ rows are still shown during searches they aren’t results for The default is: true

pub fn only_one_selection(self, only_one: bool) -> Self

Set if the menu should exit and return only the first user selection. The default is: false

pub fn clear_on_close(self, do_clear: bool) -> Self

Set if the menu should delete any left-over lines from the terminal. The default is: true

Trait Implementations

impl Clone for MenuOptions

fn clone(&self) -> MenuOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MenuOptions

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

Formats the value using the given formatter.

impl Default for MenuOptions

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for MenuOptions

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for MenuOptions