@scena/ruler
    TypeScript icon, indicating that this package has built-in type declarations

    0.8.0 • Public • Published

    Ruler

    npm version React Preact Angular Vue Vue

    A Ruler component that can draw grids and scroll infinitely.

    Demo / API / Guides / Main Project

    ⚙️ Installation

    npm

    $ npm i @scena/ruler

    scripts

    <script src="//daybrush.com/ruler/release/latest/dist/ruler.min.js"></script>

    🚀 How to use

    import Ruler from "@scena/ruler";
    
    const ruler = new Ruler(document.body, {
        type: "horizontal",
    });
    
    
    window.addEventListener("resize", () => {
        ruler.resize();
    });
    
    export interface RulerInterface {
        scroll(scrollPos: number): any;
        resize(): any;
    }
    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;
        textFormat?: (scale: number) => string;
    }
    

    ⭐️ Show Your Support

    Please give a ⭐️ if this project helped you!

    👏 Contributing

    If you have any questions or requests or want to contribute to ruler 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.
    

    Install

    npm i @scena/ruler

    DownloadsWeekly Downloads

    94

    Version

    0.8.0

    License

    MIT

    Unpacked Size

    124 kB

    Total Files

    34

    Last publish

    Collaborators

    • younkue