preact-guides
v0.28.2
Published
A Preact Guides component that can draw ruler and manage guidelines.
Downloads
235
Maintainers
Readme
⚙️ Installation
npm
$ npm i preact-guides
🚀 How to use
import { Component, h } from "preact";
import Guides from "preact-guides";
export default class App extends Component {
render() {
return (<Guides
ref={e => {
this.guides = e;
}}
type="horizontal"
setGuides={guides => {
console.log(guides);
}}
/>);
}
componentDidMount() {
this.guides.resize();
let scrollX = 0;
let scrollY = 0;
window.addEventListener("wheel", e => {
scrollX += e.deltaX;
scrollY += e.deltaY;
this.guides.scrollGuides(scrollY);
this.guides.scroll(scrollX);
});
window.addEventListener("resize", () => {
this.guides.resize();
});
}
}
export interface RulerProps {
type?: "horizontal" | "vertical";
width?: number;
height?: number;
unit?: number;
zoom?: number;
direction?: "start" | "end";
style?: IObject<any>;
backgroundColor?: string;
lineColor?: string;
textColor?: string;
}
export interface GuidesProps extends RulerProps {
className?: string;
setGuides?: (guides: number[]) => any;
rulerStyle?: IObject<any>;
snapThreshold?: number;
snaps?: number[];
}
export interface GuidesInterface {
getGuides(): number[];
scroll(pos: number): void;
scrollGuides(pos: number): void;
loadGuides(guides: number[]): void;
resize(): void;
}
⚙️ Developments
npm run start
Runs the app in the development mode. Open http://localhost:3000 to view it in the browser.
The page will reload if you make edits. You will also see any lint errors in the console.
⭐️ Show Your Support
Please give a ⭐️ if this project helped you!
👏 Contributing
If you have any questions or requests or want to contribute to @scena/react-guides
or other packages, please write the issue or give me a Pull Request freely.
🐞 Bug Report
If you find a bug, please report to us opening a new Issue on GitHub.
📝 License
This project is MIT 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.