weasel API - v0.8.0
    Preparing search index...

    Interface UseSelectionOptions

    Options for useSelection.

    interface UseSelectionOptions {
        extend?: SelectionExtendKey;
        initial?: readonly NodeId[];
        lock?: boolean;
        mode?: SelectionMode;
    }
    Index

    Properties

    extend? initial? lock? mode?

    Properties

    extend?: SelectionExtendKey

    Default 'shift'. Ignored in single-mode.

    initial?: readonly NodeId[]

    Default [].

    lock?: boolean

    When true, every mutator (set/add/remove/toggle/clear/ applyClick) is a no-op — selection stays at whatever initial pinned it to. Useful for demos that exist to showcase a single pre-selected node (e.g. the bezier-edit curve) and don't want a stray click to deselect.

    mode?: SelectionMode

    Default 'single'.

    Settings

    Member Visibility

    On This Page

    Properties