https://github.com/swetrix/captcha-frame
Swetrix CAPTCHA iframe
https://github.com/swetrix/captcha-frame
captcha privacy swetrix
Last synced: 3 months ago
JSON representation
Swetrix CAPTCHA iframe
- Host: GitHub
- URL: https://github.com/swetrix/captcha-frame
- Owner: Swetrix
- License: mit
- Created: 2023-03-02T22:42:04.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-17T20:53:22.000Z (about 2 years ago)
- Last Synced: 2025-02-09T03:27:41.444Z (over 1 year ago)
- Topics: captcha, privacy, swetrix
- Language: HTML
- Homepage: https://captcha.swetrix.com
- Size: 118 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
> [!NOTE]
> This repository has been archived. Development has moved to the [Swetrix monorepo](https://github.com/Swetrix/swetrix) under [`packages/captcha`](https://github.com/Swetrix/swetrix/tree/main/packages/captcha). Please open issues and pull requests there instead.
## Description
Swetrix CAPTCHA is a privacy-oriented, simple and opensource CAPTCHA service.
See the full documentation at https://docs.swetrix.com/captcha/introduction
## Features
- **Privacy-focused**: No tracking, no cookies
- **Accessible**: Full keyboard navigation, ARIA support, screen reader announcements, respects `prefers-reduced-motion`
- **Progress indicator**: Visual progress bar during verification
- **Auto theme detection**: Automatically matches browser's light/dark mode preference
- **Lightweight**: Minimal footprint, fast loading
## Usage
```html
```
### Options
| Attribute | Description | Values | Default |
|-----------|-------------|--------|---------|
| `data-project-id` | Your project ID | Valid project ID | Required |
| `data-theme` | Color theme | `auto`, `light`, `dark` | `auto` |
| `data-response-input-name` | Hidden input name | Any string | `swetrix-captcha-response` |
| `data-lang` | Force a specific language | `en`, `de`, `fr`, `pl`, `uk` | Auto-detected |
### Language Support
The widget supports **English**, **German**, **French**, **Polish**, and **Ukrainian**.
Language is detected automatically in this order:
1. `data-lang` attribute on the widget element
2. `lang` attribute on parent elements (e.g., ``)
3. Browser's preferred language
### Theme Options
- `auto`: Automatically detects user's browser theme preference using `prefers-color-scheme`
- `light`: Forces light theme
- `dark`: Forces dark theme
## Development
To build the captcha run:
```bash
npm run build
```
After you build it, a new folder `dist` will appear. You can run `test.html` file via an extension like `Live server` to test it (don't forget to set up a valid project ID or one of our [dummy project IDs](https://docs.swetrix.com/captcha/testing)).
## License
Swetrix CAPTCHA client is released under the MIT licence, see [LICENSE](LICENSE).
## Bugs and security
Swetrix is open to pull-requests. Feel free to propose new features or submit bug requests via pull reuqests.\
For severe security issues, please contact us at security@swetrix.com
## Contact
You can contact us via email at contact@swetrix.com