Valaxy API Docs

Appearance

Function: useBackToTop() ​

ts
function useBackToTop(options): 
  | {
  backToTop?: undefined;
  percentage: Ref<number, number>;
  show: Ref<boolean, boolean>;
}
  | {
  backToTop: () => void;
  percentage: ComputedRef<number>;
  show: ComputedRef<boolean>;
};

Defined in: packages/valaxy/client/composables/widgets/backToTop.ts:8

You can use href="#" to back to top

Parameters ​

options ​

offset ​

number

show backToTop button, when height > offset

Returns ​

| { backToTop?: undefined; percentage: Ref<number, number>; show: Ref<boolean, boolean>; } | { backToTop: () => void; percentage: ComputedRef<number>; show: ComputedRef<boolean>; }

Description ​

你可以使用它来编写自己的 backToTop