Skip to main content

KeyboardShortcut

Struct KeyboardShortcut 

Source
pub struct KeyboardShortcut {
    pub key: String,
    pub modifiers: KeyboardEventModifierMask,
    pub unshifted_key: Option<String>,
    pub command: LexicalCommand<Rc<KeyboardEvent>>,
    pub description: Option<String>,
    pub disabled: Option<ShortcutDisabledFn>,
    pub dispatch: Option<ShortcutDispatchFn>,
    pub bubble_from_nested_editors: bool,
}
Expand description

KeyboardShortcut (@experimental): a shortcut as data, the key and modifiers to match and the command to dispatch with the matched event. @lexical/extension’s KeyboardShortcutsExtension (keyboard_shortcuts_extension, the extension feature) dispatches a table of them.

Fields§

§key: String§modifiers: KeyboardEventModifierMask§unshifted_key: Option<String>§command: LexicalCommand<Rc<KeyboardEvent>>

command: dispatched with the matched event as its payload.

§description: Option<String>

description, for menus and help.

§disabled: Option<ShortcutDisabledFn>

$disabled: skip the shortcut when it returns true.

§dispatch: Option<ShortcutDispatchFn>

$dispatch: replaces dispatching command; its $next dispatches it.

§bubble_from_nested_editors: bool

bubbleFromNestedEditors.

Implementations§

Source§

impl KeyboardShortcut

Source

pub fn new(key: &str, command: LexicalCommand<Rc<KeyboardEvent>>) -> Self

A shortcut of key with no modifiers that dispatches command.

Trait Implementations§

Source§

impl Clone for KeyboardShortcut

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 KeyboardShortcutMatch for KeyboardShortcut

Source§

fn key(&self) -> &str

key: the KeyboardEvent.key to match, case-insensitive.
Source§

fn modifiers(&self) -> KeyboardEventModifierMask

modifiers: the expected state of the modifier keys (none pressed by default).
Source§

fn unshifted_key(&self) -> Option<&str>

unshiftedKey: the key without Shift, for display.

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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.