@skax/drag-scroll - v1.1.2
    Preparing search index...

    Class DragScroll

    拖拽滚动(使用 PointerEvent 统一处理鼠标和触摸事件) DragScroll

    const container = document.getElementById('scrollContainer');
    const dragScroll = new DragScroll(container, {
    width: '300px',
    height: '500px',
    content: '<div>...</div>',
    });
    Index

    Constructors

    Properties

    $container: HTMLElement

    容器元素 classname drag-scroll-container

    $content: HTMLElement

    内容容器元素 classname drag-scroll-content

    currentY: number

    当前平移 Y 位置

    isDragging: boolean

    是否正在拖拽

    配置项

    velocity: number

    滚动速度

    Accessors

    • get canDrag(): boolean

      内容是否可滚动

      Returns boolean

    • get height(): number

      获取容器高度

      Returns number

      const height = dragScroll.height;
      
    • get readonly(): boolean

      只读属性

      Returns boolean

    • set readonly(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get width(): number

      获取容器宽度

      Returns number

      const width = dragScroll.width;
      

    Methods

    • 销毁方法,用于清理资源

      Returns void

      dragScroll.destroy();
      dragScroll = null;
    • 设置 HTML 内容

      Parameters

      • html: string | (() => string)

        HTML 字符串或返回 HTML 字符串的函数

      Returns void

      dragScroll.innerHtml('<div>New Content</div>');
      dragScroll.innerHtml(() => '<div>Dynamic Content</div>');
    • 设置容器尺寸

      Parameters

      • Optionalwidth: string | number

        容器宽度

      • Optionalheight: string | number

        容器高度

      Returns void

      dragScroll.resize(500, '400px');
      dragScroll.resize('80%', '600px');
    • Y轴滚动到指定位置

      Parameters

      • y: number

        Y轴平移值 (需正值不支持负值)

      • triggerChange: boolean = true

      Returns void

      dragScroll.scrollToY(200);
      dragScroll.scrollToY(0); // 平移到顶部
      dragScroll.scrollToY(-2); // 无效