svrollbar/types/Svrollbar.svelte.d.ts

simple custom scrollbar made by svelte

/// <reference types="svelte" />
import { SvelteComponentTyped } from "svelte";

export interface SvrollbarProps {
  /**
   * the scrolling host element.
   * @default undefined
   */
  viewport?: Element;

  /**
   * the area scrolled by host element.
   * @default undefined
   */
  contents?: Element;

  /**
   * milliseconds to keep scrollbar visible.
   * @default 1000
   */
  hideAfter?: number;

  /**
   * make scrollbar always visible if the content is scrollable.
   * @default false
   */
  alwaysVisible?: boolean;

  /**
   * make scrollbar initially visible if the content is scrollable.
   *
   * after you interact with your scrollable contents, scrollbar fallback to the default visibility behavior.
   * @default false
   */
  initiallyVisible?: boolean;

  /**
   * margin (px) from viewport top, right, bottom and left.
   * @default {}
   */
  margin?: { top?: number; right?: number; buttom?: number; left?: number };

  /**
   * svelte transition to show track in.
   * @default (node) => fade(node, { duration: 100 })
   */
  vTrackIn?: (
    node: HTMLElement,
    params: any
  ) => import("svelte/transition").TransitionConfig;

  /**
   * svelte transition to hide track out.
   * @default (node) => fade(node, { duration: 300 })
   */
  vTrackOut?: (
    node: HTMLElement,
    params: any
  ) => import("svelte/transition").TransitionConfig;

  /**
   * svelte transition to show thumb in.
   * @default (node) => fade(node, { duration: 100 })
   */
  vThumbIn?: (
    node: HTMLElement,
    params: any
  ) => import("svelte/transition").TransitionConfig;

  /**
   * svelte transition to hide thumb out.
   * @default (node) => fade(node, { duration: 300 })
   */
  vThumbOut?: (
    node: HTMLElement,
    params: any
  ) => import("svelte/transition").TransitionConfig;
}

export default class Svrollbar extends SvelteComponentTyped<
  SvrollbarProps,
  { show: CustomEvent<any>; hide: CustomEvent<any> },
  {}
> {}