\n\n\n## ⚙️ Installation\n### npm\n```sh\n$ npm i svelte-guides\n```\n\n## 🚀 How to use\n```html\n\n
\n {\n console.log(e.guides);\n }}\n />\n
\n\n```\n```ts\n\nexport interface RulerProps {\n type?: \"horizontal\" | \"vertical\";\n width?: number;\n height?: number;\n unit?: number;\n zoom?: number;\n direction?: \"start\" | \"end\";\n style?: IObject;\n backgroundColor?: string;\n lineColor?: string;\n textColor?: string;\n}\n\nexport interface GuidesOptions extends RulerProps {\n className?: string;\n setGuides?: (guides: number[]) => any;\n rulerStyle?: IObject;\n snapThreshold?: number;\n snaps?: number[];\n displayDragPos?: boolean;\n dragPosFormat?: (value: number) => string | number;\n}\n\nexport interface GuidesInterface {\n getGuides(): number[];\n scroll(pos: number): void;\n scrollGuides(pos: number): void;\n loadGuides(guides: number[]): void;\n resize(): void;\n}\n\n```\n\n\n\n## ⚙️ Developments\n### `npm run dev`\n\nRuns the app in the development mode. \nOpen [http://localhost:5000](http://localhost:5000) to view it in the browser.\n\nThe page will reload if you make edits. \nYou will also see any lint errors in the console.\n\n\n\n## ⭐️ Show Your Support\nPlease give a ⭐️ if this project helped you!\n\n## 👏 Contributing\n\nIf 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.\n\n## 🐞 Bug Report\n\nIf you find a bug, please report to us opening a new [Issue](https://github.com/daybrush/guides/issues) on GitHub.\n\n\n## 📝 License\n\nThis project is [MIT](https://github.com/daybrush/guides/blob/master/LICENSE) licensed.\n\n```\nMIT License\n\nCopyright (c) 2019 Daybrush\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n```\n","readmeFilename":"README.md","description":"A Svelte Guides component that can draw ruler and manage guidelines.","homepage":"https://daybrush.com/guides","repository":{"type":"git","url":"git+https://github.com/daybrush/guides.git"},"author":{"name":"Daybrush"},"bugs":{"url":"https://github.com/daybrush/guides/issues"}}
![](\"https://raw.githubusercontent.com/daybrush/guides/master/demo/images/guides.png\"/)
![\"npm](\"https://img.shields.io/npm/v/svelte-guides.svg?style=flat-square&color=007acc&label=version\")
![](\"https://img.shields.io/badge/language-typescript-blue.svg?style=flat-square\"/){kind=icon}
\n![](\"https://img.shields.io/github/license/daybrush/guides.svg?style=flat-square&label=license&color=08CE5D\"/)
![\"React\"](\"https://img.shields.io/static/v1.svg?label=&message=React&style=flat-square&color=61daeb\")
![\"Preact\"](\"https://img.shields.io/static/v1.svg?label=&message=Preact&style=flat-square&color=673ab8\")
![\"Angular\"](\"https://img.shields.io/static/v1.svg?label=&message=Angular&style=flat-square&color=C82B38\")