@fastkit/scroller 0.16.0 → 0.17.0-next.0

package/dist/scroller.d.ts

@@ -1,820 +0,0 @@
-import { EV } from '@fastkit/ev';
-
-declare const easings: {
-    ease: EasingValues;
-    linear: EasingValues;
-    'ease-in': EasingValues;
-    'ease-out': EasingValues;
-    'ease-in-out': EasingValues;
-};
-type EasingName = keyof typeof easings;
-type EasingValues = [number, number, number, number];
-
-/**
- * スクロール系メソッドの基本オプション設定です。
- */
-interface ScrollBaseSettings {
-    /**
-     * アニメーションの総合時間をms単位で指定します。
-     */
-    duration: number;
-    /**
-     * アニメーションのイージングを指定します。
-     * {@link EasingName}
-     */
-    easing: EasingName;
-    /**
-     * スクロールアニメーションがユーザーのインタラクションにより中断可能かをboolean値で示します。
-     */
-    cancelable: boolean;
-}
-/**
- * Scrollerで利用するスクロール系メソッドのオプション設定です。
- */
-interface ScrollerScrollSettings extends ScrollBaseSettings {
-    onProgress?: ScrollCallback;
-    onCancel?: ScrollCallback;
-    onDone?: ScrollCallback;
-}
-interface ScrollSettings extends ScrollerScrollSettings {
-    container: string | Element;
-}
-type ScrollerScrollOptions = Partial<ScrollerScrollSettings>;
-type ScrollOptions = Partial<ScrollSettings>;
-/**
- * スクロール関連メソッドによるスクロールアニメーションをキャンセルするメソッドです。<br>
- * ユーザーのインタラクション起因の中断の場合、Eventオブジェクトが渡されます。
- */
-type ScrollCanceller = (event?: Event | null, checkCancelable?: boolean) => void;
-/**
- * スクロール関連メソッドの返却値となるインターフェースです。
- */
-interface ScrollResult {
-    /**
-     * スクロールをキャンセルするメソッドです。
-     */
-    cancel: ScrollCanceller;
-    /**
-     * スクロールの完了、キャンセル、中断を問わず終了を検知するPromiseインスタンスです。
-     */
-    promise: Promise<void>;
-    /**
-     * スクロール開始位置から完了位置までの想定px数をx、y軸共に返却します。<br>
-     * スクロールが途中でキャンセルされた場合はこのpxが加算されていない事もあります。
-     */
-    plans: {
-        x: number;
-        y: number;
-    };
-}
-/**
- * スクロール関連の各種メソッドにおいて、コールバックメソッドに渡されるインターフェースです。
- */
-interface ScrollCallbackValues {
-    /**
-     * スクロール中のコンテナ要素です。
-     */
-    container: Element;
-    /**
-     * スクロールの進捗を0〜1で示します。
-     */
-    progress: number;
-    /**
-     * スクロールが中断されている場合trueを示します。
-     */
-    aborted: boolean;
-    /**
-     * ユーザーのインタラクションによりスクロールが中断されていた場合、そのEventオブジェクトが設定されます。
-     */
-    abortEventSource: Event | null;
-}
-type ScrollCallback = (scrollToCallbackValues: ScrollCallbackValues) => any;
-/**
- * スクロール値をx軸、y軸で示します。
- */
-interface ScrollPosition {
-    x: number;
-    y: number;
-}
-declare const defaultBaseSettings: ScrollBaseSettings;
-declare const defaultSettings: ScrollSettings;
-
-/**
- * 指定の差分だけコンテナをスクロールします。
- * @param diffX - 横軸の移動量（px）です。デフォルトは0です。
- * @param diffY - 縦軸の移動量（px）です。デフォルトは0です。
- * @param options - スクロールオプション
- */
-declare function scrollBy(diffX: number, diffY: number, options?: ScrollOptions): ScrollResult;
-
-/**
- * 任意の位置（px）へコンテナをスクロールします。
- * @param scrollPosition - スクロール先を指定します。x, y 共にオプショナルなるです。未指定の軸は現在のスクロール値のまま保持されます。
- * @param options - スクロールオプション
- */
-declare function scrollTo(scrollPosition: Partial<ScrollPosition>, options?: ScrollOptions): ScrollResult;
-
-/**
- * スクロール先の要素をElement or CSSクエリストリングで示します。
- */
-type ScrollToElementTarget = string | Element;
-/**
- * 要素へスクロールする際のオプション設定です。
- */
-interface ScrollToElementSettings {
-    /**
-     * 要素へスクロールする際、そのスクロール先をずらす際に設定します。<br>
-     * x, y 個別に設定が可能ですが、シングルのnumberのみを指定した場合、x, y のそれぞれのオプションが有効な場合にのみその軸に設定されます。
-     */
-    offset: number | {
-        x?: number;
-        y?: number;
-    };
-    /**
-     * 横スクロールの可否を示します。
-     */
-    x: boolean;
-    /**
-     * 縦スクロールの可否を示します。
-     */
-    y: boolean;
-}
-/**
- * 要素スクロール利用事のデフォルト設定です。
- * {@link ScrollToElementSettings}
- */
-declare const scrollToElementSettingsDefaults: ScrollToElementSettings;
-/**
- * 要素へスクロールさせる際のオプション設定です。
- */
-type ScrollToElementOptions = Partial<ScrollOptions & ScrollToElementSettings>;
-/**
- * 任意の要素の位置へスクロールします。
- * @param target - スクロール先の要素
- * @param options - スクロールオプション
- */
-declare function scrollToElement(target: ScrollToElementTarget, options?: ScrollToElementOptions): ScrollResult;
-
-/**
- * y軸の両端の辺を示します。
- */
-type ScrollYSide = 'top' | 'bottom';
-/**
- * x軸の両端の辺を示します。
- */
-type ScrollXSide = 'left' | 'right';
-/**
- * コンテナの4辺を示します。
- */
-type ScrollSide = ScrollYSide | ScrollXSide;
-/**
- * コンテナの辺へスクロールさせる際のターゲット指定のパターンです。
- */
-type ScrollToSideTargets = ScrollSide | [ScrollSide] | [ScrollYSide, ScrollXSide] | [ScrollXSide, ScrollYSide];
-/**
- * コンテナをいずれかの辺までスクロールします。
- * @param targets - 辺を指定します。シングルの文字列、及び配列に対応しています。
- * @param options - スクロールオプション
- */
-declare function scrollToSide(targets: ScrollToSideTargets, options?: ScrollOptions): ScrollResult;
-/**
- * コンテナを上辺までスクロールします。
- * @param options - スクロールオプション
- */
-declare function scrollToTop(options?: ScrollOptions): ScrollResult;
-/**
- * コンテナを右辺までスクロールします。
- * @param options - スクロールオプション
- */
-declare function scrollToRight(options?: ScrollOptions): ScrollResult;
-/**
- * コンテナを下辺までスクロールします。
- * @param options - スクロールオプション
- */
-declare function scrollToBottom(options?: ScrollOptions): ScrollResult;
-/**
- * コンテナを左辺までスクロールします。
- * @param options - スクロールオプション
- */
-declare function scrollToLeft(options?: ScrollOptions): ScrollResult;
-/**
- * コンテナを左上コーナーまでスクロールします。
- * @param options - スクロールオプション
- */
-declare function scrollToLeftTop(options?: ScrollOptions): ScrollResult;
-/**
- * コンテナを左下コーナーまでスクロールします。
- * @param options - スクロールオプション
- */
-declare function scrollToLeftBottom(options?: ScrollOptions): ScrollResult;
-/**
- * コンテナを右上コーナーまでスクロールします。
- * @param options - スクロールオプション
- */
-declare function scrollToRightTop(options?: ScrollOptions): ScrollResult;
-/**
- * コンテナを右下コーナーまでスクロールします。
- * @param options - スクロールオプション
- */
-declare function scrollToRightBottom(options?: ScrollOptions): ScrollResult;
-
-declare const SCROLLABLE_KEY_CODES: number[];
-interface PreventScrollOptions {
-    hideScrollbar: boolean;
-}
-interface PreventScrollContext {
-    options: PreventScrollOptions;
-    el: PreventScrollElement;
-    overflowOrigin?: string | null;
-    lockPosition: {
-        x: number;
-        y: number;
-    };
-}
-interface PreventScrollElement extends HTMLElement {
-    __ps_ctx__: PreventScrollContext;
-}
-declare function enableScroll(el: Element): void;
-declare function disableScroll(el: Element, opts?: Partial<PreventScrollOptions>): void;
-
-type ScrollToElementAdditionalOffset = number | {
-    x?: number;
-    y?: number;
-} | ((scroller: Scroller) => number | {
-    x?: number;
-    y?: number;
-} | undefined);
-/**
- * [[Scroller]]を任意のElementまでスクロールさせる際のオプションです。
- * 詳細は [[ScrollerScrollOptions]] 及び、 [[ScrollToElementSettings]] を参照してください。
- */
-type ScrollerScrollToElementOptions = Partial<ScrollerScrollOptions & ScrollToElementSettings>;
-/**
- * Scrollerに縦スクロールが発生した際の方向を示すTypeです。
- */
-type ScrollYDirection = 'top' | 'bottom';
-/**
- * Scrollerに横スクロールが発生した際の方向を示すTypeです。
- */
-type ScrollXDirection = 'left' | 'right';
-/**
- * Scrollerにスクロールが発生した際の方向を示すTypeです。
- */
-type ScrollDirection = ScrollYDirection | ScrollXDirection;
-/**
- * スクロールの軸を示します。
- * xは水平、
- * yは垂直をそれぞれ示します
- */
-type ScrollAxis = 'x' | 'y';
-interface ScrollSizeObserverSetting {
-    interval: number;
-    width: boolean;
-    height: boolean;
-}
-/**
- * Scrollerの基本セッティングです。
- * 個々のフィールドの詳細は[[Scroller]]の同名プロパティを参照してください。
- */
-interface ScrollerSetting {
-    el: Element | string | null;
-    scrollingJudgeInterval: number;
-    baseAxis: ScrollAxis;
-    scrollSizeObserver: Partial<ScrollSizeObserverSetting>;
-}
-/**
- * Elementのscrollイベントを検知した際に、通知する情報です
- * 現在のスクロールポジションや、スクロール開始（or前回のtick）からのスクロール量が渡されます。
- */
-interface ScrollerPayload {
-    /**
-     * [[Scroller.scrollTop]] が渡されます
-     */
-    top: number;
-    /**
-     * [[Scroller.scrollLeft]] が渡されます
-     */
-    left: number;
-    /**
-     * [[Scroller.scrollBottom]] が渡されます
-     */
-    bottom: number;
-    /**
-     * [[Scroller.scrollRight]] が渡されます
-     */
-    right: number;
-    /**
-     * 発生したスクロールの軸が渡されます。
-     * 斜めスクロールが発生した際は、x、yのうち移動量が大きいものが自動判定されて渡されます。
-     * どちらも同じ移動量であった場合は[[Scroller.baseAxis]]の設定値が渡されます。
-     */
-    axis: ScrollAxis;
-    /**
-     * 発生したスクロールの方向が渡されます。
-     * 斜めスクロールが発生した際は、x、yのうち移動量が大きいものが自動判定されて渡されます。
-     * どちらも同じ移動量であった場合は[[Scroller.baseAxis]]の設定値が渡されます。
-     */
-    direction: ScrollDirection;
-    /**
-     * 発生したスクロールの水平方向が渡されます。
-     */
-    directionX: ScrollXDirection;
-    /**
-     * 発生したスクロールの垂直方向が渡されます。
-     */
-    directionY: ScrollYDirection;
-    /**
-     * [[Scroller.on]]('scroll')時の前回からの水平移動量が渡されます。
-     */
-    tickedX: number;
-    /**
-     * [[Scroller.on]]('scroll')時の前回からの垂直移動量が渡されます。
-     */
-    tickedY: number;
-    /**
-     * [[Scroller.on]]('scrollStart')時からの合計水平移動量が渡されます。
-     */
-    totalX: number;
-    /**
-     * [[Scroller.on]]('scrollStart')時からの合計垂直移動量が渡されます。
-     */
-    totalY: number;
-}
-/**
- * Scrollerは設定されたElementのスクロール開始、tick、終了を検知し
- * イベントを通知します。
- * これらのイベントを購読する事でスクロール量や移動方向を検知可能です。
- */
-interface ScrollerScrollEventMap {
-    /**
-     * スクロールの開始時に発生します。
-     */
-    scrollStart: ScrollerPayload;
-    /**
-     * 毎スクロール検知時に発生します。
-     */
-    scroll: ScrollerPayload;
-    /**
-     * スクロールの終了時に発生します。
-     */
-    scrollEnd: ScrollerPayload;
-}
-/**
- * Scrollerに発生するイベントの全てです。
- */
-interface ScrollerEventMap extends ScrollerScrollEventMap {
-    /**
-     * Scrollerが利用可能になった時（Elementが設定されて初期化が完了した）に発生します。
-     */
-    ready: void;
-    /**
-     * [[Scroller.state]]が変更された時に発生します。
-     */
-    changeState: ScrollerState;
-    /**
-     * [[Scroller.el]]のサイズ変更を検知した際に発生します。
-     */
-    resize: {
-        width: number;
-        height: number;
-    };
-    /**
-     * [[Scroller.lastAxis]]の変更を検知した際に発生します。
-     */
-    changeAxis: ScrollAxis;
-    /**
-     * [[Scroller.lastDirection]]の変更を検知した際に発生します。
-     */
-    changeLastDirection: ScrollDirection;
-    /**
-     * [[Scroller.lastYDirection]]の変更を検知した際に発生します。
-     */
-    changeLastYDirection: ScrollYDirection;
-    /**
-     * [[Scroller.lastXDirection]]の変更を検知した際に発生します。
-     */
-    changeLastXDirection: ScrollXDirection;
-}
-/**
- * Scrollerの状態を示します。
- */
-declare enum ScrollerState {
-    /**
-     * Scrollerが初期化されていない（Elementが設定されていない）状態を示します。
-     */
-    Pending = "pending",
-    /**
-     * Scrollerが初期化されているが、[[Scroller.el]]のリサイズやスクロールのイベント監視が動作していない状態を示します。
-     */
-    Ready = "ready",
-    /**
-     * Scrollerが初期化されていて、[[Scroller.el]]のリサイズやスクロールのイベント監視が動作している状態を示します。
-     */
-    Running = "running",
-    /**
-     * [[Scroller.destroy]]が実行され、Scrollerが利用不可である状態を示します。
-     */
-    Destroyed = "destroyed"
-}
-/**
- * Scrollerクラスの状態を監視＆同期するオブジェクトが
- * 保有すべきプロパティ一覧です。
- * 個々のプロパティ名は、同名のScrollerクラスのプロパティを参照して下さい
- */
-interface ScrollerObserver {
-    state: ScrollerState;
-    isPending: boolean;
-    isReady: boolean;
-    isRunning: boolean;
-    isDestroyed: boolean;
-    scrollEnabled: boolean;
-    containerWidth: number;
-    containerHeight: number;
-    scrollWidth: number;
-    scrollHeight: number;
-    scrollableX: boolean;
-    scrollableY: boolean;
-    scrollTop: number;
-    scrollLeft: number;
-    scrollRight: number;
-    scrollBottom: number;
-    lastAxis: ScrollAxis;
-    lastDirection: ScrollDirection;
-    lastYDirection: ScrollYDirection;
-    lastXDirection: ScrollXDirection;
-    nowScrolling: boolean;
-}
-/**
- * Scrollerクラスの状態を監視＆同期するオブジェクトが
- * 保有すべきプロパティ一のキー覧です。
- */
-type ScrollerObservableKeys = keyof ScrollerObserver;
-/**
- * スクロールを停止させるためのソースオブジェクト
- */
-type ScrollStopper = number | string | Record<string, unknown> | symbol;
-/**
- * 任意のElement（or HTML Document）のスクロールやサイズ変更を監視し、その情報を通知するクラスです。<br>
- * <a href="https://dadajam4.github.io/dadajam4/ev/classes/_ev_.ev.html" target="_blank">EV</a>を継承しており、イベントの購読[[Scroller.on]]等のインターフェースを利用するか、
- * [[Scroller.observe]]メソッドを利用します。<br>
- * [[Scroller.on]]、[[Scroller.once]]で購読可能なイベントについては[[ScrollerEventMap]]を参照してください。
- */
-declare class Scroller extends EV<ScrollerEventMap> {
-    /**
-     * Scrollerクラスの状態を監視＆同期するオブジェクトが
-     * 保有すべきプロパティ一のキーの配列です。
-     */
-    static readonly scrollerObservableKeys: (keyof ScrollerObserver)[];
-    /**
-     * Scrollerの状態を示すenum値です。
-     * {@link ScrollerState}
-     */
-    static readonly States: typeof ScrollerState;
-    /**
-     * スクロールを検知してから、移動がなくなった際に、何ms後にスクロール終了と判定するかのインターバル値を示します。
-     * デフォルトは500です。
-     */
-    scrollingJudgeInterval: number;
-    /**
-     * 縦、横のどちらのスクロールを基準とするかを示します。
-     * デフォルトはyです。<br>
-     * この設定は[[Scroller.toElement]]のデフォルト値にも影響します。
-     */
-    baseAxis: ScrollAxis;
-    /**
-     * スクロール系メソッド[[Scroller.to]]等を利用する際のデフォルトの設定を示します。
-     */
-    scrollSettingsDefaults: ScrollBaseSettings;
-    /**
-     * [[Scroller.toElement]]のデフォルトオプションの設定を示します。
-     */
-    scrollToElementSettingsDefaults: ScrollerScrollToElementOptions;
-    scrollSizeObserver?: ScrollSizeObserverSetting;
-    /**
-     * 設定されたElement要素です。
-     * 初期化が完了していない時には本getterはundefinedを返却する事に注意してください。
-     */
-    get el(): Element | null;
-    /**
-     * 現在の状態です。<br>
-     * {@link ScrollerState}
-     */
-    get state(): ScrollerState;
-    /**
-     * 未初期化である場合trueを示します。
-     */
-    get isPending(): boolean;
-    /**
-     * 初期化済み＆停止状態である場合trueを示します。
-     */
-    get isReady(): boolean;
-    /**
-     * 初期化済み＆動作中である場合trueを示します。
-     */
-    get isRunning(): boolean;
-    /**
-     * インスタンスが破棄済みである場合trueを示します。
-     */
-    get isDestroyed(): boolean;
-    /**
-     * スクロールの有効状態を取得します
-     */
-    get scrollEnabled(): boolean;
-    /**
-     * スクロール要素の幅を示します。
-     */
-    get containerWidth(): number;
-    /**
-     * スクロール要素の高さを示します。
-     */
-    get containerHeight(): number;
-    /**
-     * スクロール要素内のコンテンツの幅を示します。
-     */
-    get scrollWidth(): number;
-    /**
-     * スクロール要素内のコンテンツの高さを示します。
-     */
-    get scrollHeight(): number;
-    /**
-     * x軸にスクロール可能な場合trueを示します
-     */
-    get scrollableX(): boolean;
-    /**
-     * y軸にスクロール可能な場合trueを示します
-     */
-    get scrollableY(): boolean;
-    /**
-     * 現在の上辺からのスクロール量を示します。
-     */
-    get scrollTop(): number;
-    set scrollTop(scrollTop: number);
-    /**
-     * 現在の右辺からのスクロール量を示します。
-     */
-    get scrollRight(): number;
-    set scrollRight(scrollRight: number);
-    /**
-     * 現在の下辺からのスクロール量を示します。
-     */
-    get scrollBottom(): number;
-    set scrollBottom(scrollBottom: number);
-    /**
-     * 現在の左辺からのスクロール量を示します。
-     */
-    get scrollLeft(): number;
-    set scrollLeft(scrollLeft: number);
-    /**
-     * 現在スクロール中である場合trueを示します。
-     */
-    get nowScrolling(): boolean;
-    /**
-     * 最後に検知したスクロールの軸を示します。
-     */
-    get lastAxis(): ScrollAxis;
-    /**
-     * 最後に検知したスクロールの方向を示します。
-     */
-    get lastDirection(): ScrollDirection;
-    /**
-     * 最後に検知したスクロールの垂直方向を示します。
-     */
-    get lastYDirection(): ScrollYDirection;
-    /**
-     * 最後に検知したスクロールの水平方向を示します。
-     */
-    get lastXDirection(): ScrollXDirection;
-    /**
-     * 最後に検知したスクロールにより通知した情報を示します。
-     */
-    get lastPayload(): ScrollerPayload;
-    private _el;
-    private _eventTarget;
-    private _isDocumentElement;
-    private _isBodyElement;
-    private _isRootElement;
-    private _state;
-    private _containerWidth;
-    private _containerHeight;
-    private _scrollWidth;
-    private _scrollHeight;
-    private _scrollTop;
-    private _scrollRight;
-    private _scrollBottom;
-    private _scrollLeft;
-    private _lastAxis;
-    private _lastDirection;
-    private _lastYDirection;
-    private _lastXDirection;
-    private _nowScrolling;
-    private _readyResolvers;
-    private _scrollingJudgeTimerId;
-    private _startX;
-    private _startY;
-    private _tickedX;
-    private _tickedY;
-    private _lastTotalX;
-    private _lastTotalY;
-    private _scrollListener?;
-    private _resizeListener?;
-    private _resizeObserver?;
-    private _scrollToResult;
-    private _observers;
-    private _scrollStoppers;
-    private _scrollSizeObserverPollingId;
-    private _scrollSizeObserverSuspended;
-    private _visibilityListener;
-    /**
-     * Scrollerインスタンスを作成します。
-     * コンテキストとなるElementをこの時点で指定するか否かは任意です。
-     *
-     * @param settingOrElementOrQueryString - 任意です。{@link ScrollerSetting}か Element（or cssクエリセレクタ文字列）を直接指定します。この時点でElementを指定しない場合は、[[setElement]]を実行するまでインスタンスは動作しません。
-     */
-    constructor(settingOrElementOrQueryString?: Partial<ScrollerSetting> | Element | string);
-    /**
-     * インスタンスにElementを設定します。特別な理由（SSRの利用等）によりコンストラクタでElementを指定できない場合、
-     * 本メソッドを利用しブラウザコンテキスト配下で本メソッドを実行してください。
-     * @param el - Element、もしくはCSSクエリセレクタ文字列を指定します。
-     */
-    setElement(el?: Element | string | null): void;
-    private _scrollToElementAdditionalOffset;
-    setScrollToElementAdditionalOffset(offset: ScrollToElementAdditionalOffset | undefined): void;
-    deleteScrollToElementAdditionalOffset(): void;
-    /**
-     * インスタンスが実行可能になった際にresolveされるPromiseインスタンスを返却します。
-     */
-    ready(): Promise<void>;
-    /**
-     * インスタンスの動作を開始します。本インスタンスはElementが設定され初期化された際に自動で動作を開始しますが、
-     * [[Scroller.stop]]メソッドを利用し動作を停止した後に再開する場合に本メソッドを利用します。
-     */
-    start(): Promise<void>;
-    /**
-     * インスタンスの動作（スクロール、リサイズイベントの検知等）を停止します。
-     * 何らかの理由で動作を停止させたい場合に利用してください。
-     * 本メソッドを実行後もインスタンス内の状態は保持されたままです。
-     * 完全にインスタンスを破棄するためには[[Scroller.destroy]]を利用してください。
-     */
-    stop(): void;
-    /**
-     * インスタンスの動作を停止し、内部情報を完全に破棄します。
-     * これに伴い、スクロール中であった場合にはキャンセルされ、以後イベント通知は完全に行われません。
-     * また[[Scroller.start]]メソッドでの再利用も不可となります。
-     * 本インスタンスの利用を完全に停止する場合に必ず実行し、利用側のオブジェクト等において本インスタンスへの参照を完全に削除してください。
-     * 本メソッドはSPA等でのサービスにおいては意識的に実行する事を強く推奨します。
-     */
-    destroy(): void;
-    /**
-     * インスタンス内部のスクロール量や、Elementのサイズを強制的に更新します。
-     * 基本的に利用が必要なケースはありませんが、何らかの理由で更新をトリガーしたい場合に利用します。
-     */
-    update(): void;
-    /**
-     * インスタンス内の情報をjsonオブジェクトとして返却します。
-     * 情報の詳細は[[ScrollerObserver]]を参照してください。
-     */
-    toJSON(): ScrollerObserver;
-    /**
-     * [[Scroller.toJSON]]の情報を文字列として返却します。
-     */
-    toString(): string;
-    /**
-     * 本インスタンスの情報を購読するためのオブジェクトを設定する事で、
-     * インスタンスの内部情報が変更される度にパラメータが同期されます。
-     * 設定するオブジェクトは[[ScrollerObserver]]のインターフェースを満たしていれば内容は問いません。
-     * 本機能により同期される方法は単純にオブジェクトプロパティへの変数代入です。
-     * 従って対象となるプロパティをgetterとして実装（Ex: Vue computed等、、）しておく事により、
-     * 同期を受け取るオブジェクト側でパラメータ変更後の動作をリアクティブに実装可能です。
-     * @param observer - 同期させたいオブジェクト
-     * @returns 同期を停止するためのメソッド
-     */
-    observe(observer: ScrollerObserver): () => void;
-    /**
-     * [[Scroller.observe]]でパラメータ同期中のオブジェクトを停止します。
-     * [[Scroller.destroy]]実行時にも、同期中のオブジェクトは全停止されますが、destroy前に任意のタイミングで停止したい場合
-     * 本メソッドを利用します。
-     * @param observer - 同期中のオブジェクト
-     */
-    unobserve(observer: ScrollerObserver): void;
-    /**
-     * スクロール中であった場合、スクロールをキャンセルします。
-     */
-    cancel(): void;
-    /**
-     * x, yの差分pxを指定しスクロールします。
-     * メソッド、パラメータの詳細は[[scrollBy]]を参照してください。
-     * @param diffX - 横移動量
-     * @param diffY - 縦移動量
-     * @param options - スクロールオプション
-     */
-    by(diffX: number, diffY: number, options?: ScrollerScrollOptions): ScrollResult;
-    /**
-     * 指定の座標へスクロールします。
-     * メソッド、パラメータの詳細は[[scrollTo]]を参照してください。
-     * @param scrollPosition - 座標
-     * @param options - スクロールオプション
-     */
-    to(scrollPosition: Partial<ScrollPosition>, options?: ScrollerScrollOptions): ScrollResult;
-    /**
-     * 指定の要素の位置へスクロールします。
-     * メソッド、パラメータの詳細は[[scrollToElement]]を参照してください。
-     * オプションのx, yが未設定であった場合、[[Scroller.baseAxis]]により自動設定されます。
-     * @param target - スクロール先の要素
-     * @param options - スクロールオプション
-     */
-    toElement(target: ScrollToElementTarget, options?: ScrollerScrollToElementOptions): ScrollResult;
-    /**
-     * 指定の辺へスクロールします。
-     * メソッド、パラメータの詳細は[[scrollToSide]]を参照してください。
-     * @param targets - スクロール先
-     * @param options - スクロールオプション
-     */
-    toSide(targets: ScrollToSideTargets, options?: ScrollerScrollOptions): ScrollResult;
-    /**
-     * 上辺へスクロールします。
-     * メソッド、パラメータの詳細は[[scrollToTop]]を参照してください。
-     * @param options - スクロールオプション
-     */
-    toTop(options?: ScrollerScrollOptions): ScrollResult;
-    /**
-     * 右辺へスクロールします。
-     * メソッド、パラメータの詳細は[[scrollToRight]]を参照してください。
-     * @param options - スクロールオプション
-     */
-    toRight(options?: ScrollerScrollOptions): ScrollResult;
-    /**
-     * 下辺へスクロールします。
-     * メソッド、パラメータの詳細は[[scrollToBottom]]を参照してください。
-     * @param options - スクロールオプション
-     */
-    toBottom(options?: ScrollerScrollOptions): ScrollResult;
-    /**
-     * 左辺へスクロールします。
-     * メソッド、パラメータの詳細は[[scrollToLeft]]を参照してください。
-     * @param options - スクロールオプション
-     */
-    toLeft(options?: ScrollerScrollOptions): ScrollResult;
-    /**
-     * 左上コーナーへスクロールします。
-     * メソッド、パラメータの詳細は[[scrollToLeftTop]]を参照してください。
-     * @param options - スクロールオプション
-     */
-    toLeftTop(options?: ScrollerScrollOptions): ScrollResult;
-    /**
-     * 左下コーナーへスクロールします。
-     * メソッド、パラメータの詳細は[[scrollToLeftBottom]]を参照してください。
-     * @param options - スクロールオプション
-     */
-    toLeftBottom(options?: ScrollerScrollOptions): ScrollResult;
-    /**
-     * 右上コーナーへスクロールします。
-     * メソッド、パラメータの詳細は[[scrollToRightTop]]を参照してください。
-     * @param options - スクロールオプション
-     */
-    toRightTop(options?: ScrollerScrollOptions): ScrollResult;
-    /**
-     * 右下コーナーへスクロールします。
-     * メソッド、パラメータの詳細は[[scrollToRightBottom]]を参照してください。
-     * @param options - スクロールオプション
-     */
-    toRightBottom(options?: ScrollerScrollOptions): ScrollResult;
-    /**
-     * スクロールの停止を要求します。
-     * @param stopper - 停止要求ソース
-     */
-    pushScrollStopper(stopper: ScrollStopper): () => void;
-    /**
-     * スクロールの停止要求を解除します。<br>
-     * 別のプロセスにより異なる[[ScrollStopper]]が登録されている場合、
-     * スクロールは再開されない事に注意してください。
-     * @param stopper - 停止要求ソース
-     */
-    removeScrollStopper(stopper: ScrollStopper): void;
-    private _setup;
-    private _setState;
-    private _checkDestroyed;
-    private _update;
-    private _updateContainerSize;
-    private _updateScrollSize;
-    private _startScrollSizeObserver;
-    private _stopScrollSizeObserver;
-    private _updateScrollPositions;
-    private _startListeners;
-    private _stopListeners;
-    private _clearScrollingJudgeTimer;
-    private _onResize;
-    private _triggerScrollTick;
-    private _onScroll;
-    private _syncToObserver;
-    private _syncToObservers;
-    private _checkElement;
-    private _createMergedScrollOptions;
-    private _createMergedScrollToElementOptions;
-    private _clearScrollToResult;
-    private _setScrollToResult;
-    private _updateScrollable;
-    private _scrollEnable;
-    private _scrollDisable;
-}
-
-export { type PreventScrollContext, type PreventScrollElement, type PreventScrollOptions, SCROLLABLE_KEY_CODES, type ScrollAxis, type ScrollBaseSettings, type ScrollCallback, type ScrollCallbackValues, type ScrollCanceller, type ScrollDirection, type ScrollOptions, type ScrollPosition, type ScrollResult, type ScrollSettings, type ScrollSide, type ScrollSizeObserverSetting, type ScrollStopper, type ScrollToElementAdditionalOffset, type ScrollToElementOptions, type ScrollToElementSettings, type ScrollToElementTarget, type ScrollToSideTargets, type ScrollXDirection, type ScrollXSide, type ScrollYDirection, type ScrollYSide, Scroller, type ScrollerEventMap, type ScrollerObservableKeys, type ScrollerObserver, type ScrollerPayload, type ScrollerScrollEventMap, type ScrollerScrollOptions, type ScrollerScrollSettings, type ScrollerScrollToElementOptions, type ScrollerSetting, ScrollerState, defaultBaseSettings, defaultSettings, disableScroll, enableScroll, scrollBy, scrollTo, scrollToBottom, scrollToElement, scrollToElementSettingsDefaults, scrollToLeft, scrollToLeftBottom, scrollToLeftTop, scrollToRight, scrollToRightBottom, scrollToRightTop, scrollToSide, scrollToTop };