Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/daybrush/guides
A Guides component that can draw ruler and manage guidelines.
https://github.com/daybrush/guides
angular editor guidelins guides preact react scena scenejs svelte vue
Last synced: about 1 month ago
JSON representation
A Guides component that can draw ruler and manage guidelines.
- Host: GitHub
- URL: https://github.com/daybrush/guides
- Owner: daybrush
- License: mit
- Created: 2019-11-09T11:41:32.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-07-29T10:13:41.000Z (12 months ago)
- Last Synced: 2024-05-02T05:58:22.406Z (2 months ago)
- Topics: angular, editor, guidelins, guides, preact, react, scena, scenejs, svelte, vue
- Language: TypeScript
- Homepage: https://daybrush.com/guides/
- Size: 8.65 MB
- Stars: 318
- Watchers: 6
- Forks: 43
- Open Issues: 45
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Lists
- awesome-stars - guides
- awesome-stars - guides
README
Guides
A Guides component that can draw ruler and manage guidelines.
Demo /
API /
Ruler /
Main Project
## ⚙️ Installation
### npm
```sh
$ npm i @scena/guides
```
### scripts
```html
```
## 🚀 How to use
```tsx
import Guides from "@scena/guides";
const guides = new Guides(document.body, {
type: "horizontal",
}).on("changeGuides", e => {
console.log(e.guides);
});
let scrollX = 0;
let scrollY = 0;
window.addEventListener("resize", () => {
guides.resize();
});
window.addEventListener("wheel", e => {
scrollX += e.deltaX;
scrollY += e.deltaY;
guides.scrollGuides(scrollY);
guides.scroll(scrollX);
});
```
### Ruler Units
The default unit is px, and a line is drawn every 50px. If you want to use a different unit instead of the px unit, use it like this:
* 1px (Default)
* zoom: 1
* unit: 50 (every 50px)
* 1cm = 37.7952px
* zoom: 37.7952
* unit: 1 (every 1cm)
* 1in = 96px = 2.54cm
* zoom: 96
* unit: 1 (every 1in)
See:
- https://www.w3schools.com/cssref/css_units.asp
- https://www.scaler.com/topics/css/css-units/
## ⚙️ Developments
The `guides` repo is managed as a [monorepo](https://github.com/lerna/lerna) with `yarn`.
```sh
yarn config set registry https://registry.npmjs.org/
```
## ⭐️ Show Your Support
Please give a ⭐️ if this project helped you!
## 👏 Contributing
If you have any questions or requests or want to contribute to `guides` or other packages, please write the [issue](https://github.com/daybrush/guides/issues) or give me a Pull Request freely.
## 🐞 Bug Report
If you find a bug, please report to us opening a new [Issue](https://github.com/daybrush/guides/issues) on GitHub.
## 📝 License
This project is [MIT](https://github.com/daybrush/guides/blob/master/LICENSE) licensed.
```
MIT License
Copyright (c) 2019 Daybrush
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```