Josh Whaley
ad60b396f3
handle two finger scrolling directly in this plugin as to not require others to work
73 lines
3.7 KiB
Markdown
73 lines
3.7 KiB
Markdown
# ComfyUI Touchpad Scroll Controller
|
|
|
|
A ComfyUI extension that enhances touchpad navigation by redirecting two-finger scrolling over to the canvas, including over textareas. This can prevent accidental back/forward browser navigation when using horizontal touchpad gestures and provides smooth zooming and panning for Mac and other touchpad users.
|
|
|
|
> [!NOTE]
|
|
> This projected was created with a [cookiecutter](https://github.com/Comfy-Org/cookiecutter-comfy-extension) template. It helps you start writing custom nodes without worrying about the Python setup.
|
|
|
|
## Quickstart
|
|
|
|
1. Install [ComfyUI](https://docs.comfy.org/get_started).
|
|
1. Install [ComfyUI-Manager](https://github.com/ltdrdata/ComfyUI-Manager)
|
|
1. Look up this extension in ComfyUI-Manager. If you are installing manually, clone this repository under `ComfyUI/custom_nodes`.
|
|
1. Restart ComfyUI.
|
|
|
|
# Features
|
|
|
|
- Optimizes touchpad two-finger scrolling behavior for ComfyUI canvas navigation
|
|
- Prevents accidental browser back/forward navigation when using horizontal touchpad gestures
|
|
- Redirects two-finger scrolling over textareas to pan the canvas instead (configurable in options)
|
|
- Implements smoother touchpad-friendly zoom with ⌃+two-finger scroll or pinch gestures
|
|
- Implements a finer-grained zooming experience with ⌃+⌘+two-finger scroll or pinch gestures
|
|
- Customizable target selectors through settings
|
|
- Toggle functionality on/off through the settings panel
|
|
|
|
## Develop
|
|
|
|
To install the dev dependencies and pre-commit (will run the ruff hook), do:
|
|
|
|
```bash
|
|
cd ComfyUI/custom_nodes/comfyui_touchpad_scroll_controller
|
|
pip install -e .[dev]
|
|
pre-commit install
|
|
```
|
|
|
|
The `-e` flag above will result in a "live" install, in the sense that any changes you make to your node extension will automatically be picked up the next time you run ComfyUI.
|
|
|
|
## Publish to Github
|
|
|
|
Install Github Desktop or follow these [instructions](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) for ssh.
|
|
|
|
1. Create a Github repository that matches the directory name.
|
|
2. Push the files to Git
|
|
|
|
```
|
|
git add .
|
|
git commit -m "project scaffolding"
|
|
git push
|
|
```
|
|
|
|
## Writing custom nodes
|
|
|
|
An example custom node is located in [node.py](src/comfyui_touchpad_scroll_controller/nodes.py). To learn more, read the [docs](https://docs.comfy.org/essentials/custom_node_overview).
|
|
|
|
## Tests
|
|
|
|
This repo contains unit tests written in Pytest in the `tests/` directory. It is recommended to unit test your custom node.
|
|
|
|
- [build-pipeline.yml](.github/workflows/build-pipeline.yml) will run pytest and linter on any open PRs
|
|
- [validate.yml](.github/workflows/validate.yml) will run [node-diff](https://github.com/Comfy-Org/node-diff) to check for breaking changes
|
|
|
|
## Publishing to Registry
|
|
|
|
If you wish to share this custom node with others in the community, you can publish it to the registry. We've already auto-populated some fields in `pyproject.toml` under `tool.comfy`, but please double-check that they are correct.
|
|
|
|
You need to make an account on https://registry.comfy.org and create an API key token.
|
|
|
|
- [ ] Go to the [registry](https://registry.comfy.org). Login and create a publisher id (everything after the `@` sign on your registry profile).
|
|
- [ ] Add the publisher id into the pyproject.toml file.
|
|
- [ ] Create an api key on the Registry for publishing from Github. [Instructions](https://docs.comfy.org/registry/publishing#create-an-api-key-for-publishing).
|
|
- [ ] Add it to your Github Repository Secrets as `REGISTRY_ACCESS_TOKEN`.
|
|
|
|
A Github action will run on every git push. You can also run the Github action manually. Full instructions [here](https://docs.comfy.org/registry/publishing). Join our [discord](https://discord.com/invite/comfyorg) if you have any questions!
|