https://github.com/alanfriedman/uxshot
https://github.com/alanfriedman/uxshot
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/alanfriedman/uxshot
- Owner: alanfriedman
- Created: 2019-09-10T00:39:25.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-04T09:48:21.000Z (over 2 years ago)
- Last Synced: 2025-03-20T08:41:12.100Z (3 months ago)
- Language: JavaScript
- Size: 469 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 16
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# uxshot
Create and share screenshots and screen recordings right from your browser.
## Usage as an npm module
```
import uxshot from 'uxshot';
uxshot({
screenshotKey: 'ctrl+s',
videoKey: 'ctrl+r'
});
```
Take a screenshot: `ctrl+s`
Record your screen: `ctrl+r`
## Usage from a cdn
You need to include hotkeys-js and ux shot:
```html
window.uxshot.init({
screenshotKey: 'ctrl+s',
videoKey: 'ctrl+r'
});
```
### Options
```
uxshot({
screenshotKey: 'ctrl+s',
videoKey: 'ctrl+r'
});
```
Use any hotkey string supported by [HotKeys.js](https://wangchujiang.com/hotkeys)