starlight-scroll-to-top/common/types.ts

Add a scroll to top button to your documentation website.

// Define configuration options type
export default interface ScrollToTopOptions {
  /**
   * Position of the scroll to top button
   * @default 'right'
   */
  position?: 'left' | 'right'| 'center';
  
  /**
   * Text to show in the tooltip
   * @default 'Scroll to top'
   */
  tooltipText?: string;

  /**
   * Whether to show the tooltip on hover
   * @default false    
   */
  showTooltip?: boolean;

  /**
   * Whether to use smooth scrolling
   * @default true
   */
  smoothScroll?: boolean;

  /**
   * Height after page scroll to be visible (percentage)
   * @default 30
   */
  threshold?: number;

  /**
   * The SVG icon path d attribute
   * @default "M18 15l-6-6-6 6"
   */
  svgPath?: string;

  
  /**
   * The SVG icon stroke width
   * @default "2" 
   */
  svgStrokeWidth?: number;
  
  /**
   * The radius of the button corners. 50% for circle, 0% for square
   * @default "15"
   */
  borderRadius?: string;

  /**
   * Whether to show a circular progress ring around the button
   * @default false
   */
  showProgressRing?: boolean;

  /**
   * Color of the scroll progress ring (CSS color value)
   * @default "yellow"
   */
  progressRingColor?: string;   
}