@empathyco/x-components/docs/API-reference/api/x-components.scrolltotop.md

Empathy X Components

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [ScrollToTop](./x-components.scrolltotop.md)

## ScrollToTop variable

The `ScrollToTop` component is a button that the user can click to make a container scroll up to its initial position.

**Signature:**

```typescript
_default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
    animation: {
        type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
        default: () => import("vue").DefineComponent<{}, {}, any>;
    };
    thresholdPx: NumberConstructor;
    scrollId: {
        type: StringConstructor;
        default: string;
    };
}>, {
    events: import("vue").ComputedRef<Partial<XEventsTypes>>;
    isVisible: import("vue").ComputedRef<boolean>;
}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
    animation: {
        type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
        default: () => import("vue").DefineComponent<{}, {}, any>;
    };
    thresholdPx: NumberConstructor;
    scrollId: {
        type: StringConstructor;
        default: string;
    };
}>> & Readonly<{}>, {
    animation: string | Function | Record<string, any>;
    scrollId: string;
}, {}, {
    BaseEventButton: import("vue").DefineComponent<{}, {}, any>;
}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>
```