How to customize the behavior of the Escape button (PC)

[saif-ellafi]

Hello!!

I have multiple image editors open in different tabs in my app, however if I press ESC anywhere, all editors are closing simultaneously. I wish to close only the active one, or worst case scenario, disable this shortcut so I use mine.

I thought of wrapping everything with my own KeyboardListener widget but not sure if this is a good idea overall.

Thanks in advance!

[hm21]

The problem is that every editor simply listens to keyboard events, making it impossible for editors to determine which one is currently active. However, in version 8.1.7, I added the enableEscapeButton option to the mainEditorConfigs. This allows you to disable the Escape button, enabling you to handle its behavior externally with your own logic when a user presses Escape.

Best regards

[saif-ellafi]

Thank you @hm21 ! indeed detecting which one is active falls in my end responsibility (I can do that), glad there is a way to disable escapeButton, will test!

[saif-ellafi]

@hm21 Couldn't make it to work, unfortunately, I am unsuccessful to change the state of a currently open image editor. Perhaps I am doing something wrong?

    _saveTimer = Timer.periodic(Duration(seconds: 2), (timer) {
      if (!isImageTabActive() || _isSaving) {
        if (listenForEscapeButton) {
          setState(() {
            listenForEscapeButton = false;
          });
        }
        return;
      }

      if (!listenForEscapeButton) {
        setState(() {
          listenForEscapeButton = true;
        });
      }

      if (_imageHasUpdates) {
        _imageHasUpdates = false;
        _captureImageAndSave();
      }
    });

        mainEditor: MainEditorConfigs(
          enableZoom: true,
          editorMinScale: 1.0,
          editorMaxScale: maxScale,
          enableCloseButton: true,
          enableEscapeButton: listenForEscapeButton,
...

[saif-ellafi]

Would it also be possible that the Escape button triggers doneEditing() instead of closeEditor() ? Users may be accidentally losing their work I think.

[saif-ellafi]

I think all this could be better if we could have access to overwrite the ESC behavior, i.e. onEscape ... then we could decide what to do altogether, this could be the best and avoid resetting configs or managing State :) the onEscape function could take care of everything.

[saif-ellafi]

#356