Yocraft-2000andGitHub
8277d1bc6d
* init * feat: notify options; all, minimal and none * update: plugin.toml * update: add README * feat: add button toggle * feat: add configurable glyph * fix: valid image radius * fix: shell escape entry * feat: add settings * update: add thumbnail.webp * feat: add titlebar and titlebar toggle * feat: add custom image widget setting, reorder keys * fix: auto-size image with titlebar * update: README (new settings) * fix: lowercase correction_level label keys * fix: file type and move shellEscape to the cmd
41 lines
1.4 KiB
Markdown
41 lines
1.4 KiB
Markdown
# QR Code encoder
|
|
|
|
Transform any text or URL into a QR code completely offline. Then scan or copy the code.
|
|
|
|
## Plugin
|
|
|
|
| Field | Value |
|
|
| --- | --- |
|
|
| ID | `yocraft/qrcode` |
|
|
| Entries | Bar widget: `widget`; panel: `panel` |
|
|
|
|
## Requirements
|
|
|
|
Install `qrencode` on `PATH`.
|
|
|
|
## Usage
|
|
|
|
Open the panel from the bar widget or with this command:
|
|
```sh
|
|
noctalia msg panel-toggle yocraft/qrcode:panel
|
|
```
|
|
|
|
Enter your text or URL and click on Generate or press enter to generate the QR code, then scan it from the panel or copy it by clicking on it.
|
|
|
|
## Settings
|
|
|
|
| Setting | Type | Default | Description |
|
|
| --- | --- | --- | --- |
|
|
| `titlebar` | `bool` | `true` | Show titlebar, panel name and buttons like settings and close. |
|
|
| `generate_button` | `bool` | `true` | Show Generate button, disable will submit on enter. |
|
|
| `close_on_copy` | `bool` | `false` | Close the panel when copying the QR code. |
|
|
| `notify` | `select` | `minimal` | Controls the notifications, minimal only notifies when Close on Copy is used. |
|
|
| `size` | `int` | `8` | Specify module size in dots (pixels). |
|
|
| `correction_level` | `select` | `M` | Specify error correction level. |
|
|
| `glyph` | `glyph` | `qrcode` | Bar widget icon glyph name. |
|
|
| `custom_image` | `image` | `""` | Path to a custom image; leave empty to use the icon glyph. |
|
|
|
|
## Notes
|
|
|
|
The plugin runs entirely locally and does not require network access.
|