@empathyco/x-components/docs/API-reference/api/x-components.scroll.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; [Scroll](./x-components.scroll.md)

## Scroll variable

Scrollable container that emits scroll related X Events. It exposes all the listeners and props from the [BaseScroll](./x-components.basescroll.md) component.

**Signature:**

```typescript
_default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
    id: {
        type: StringConstructor;
        default: string;
    };
}>, {
    scrollRef: import("vue").Ref<ComponentPublicInstance | undefined, ComponentPublicInstance | undefined>;
    emitScrollAtEnd: (isAtEnd: boolean) => void;
    emitScrollAlmostAtEnd: (isAlmostAtEnd: boolean) => void;
    emitScrollAtStart: (isAtStart: boolean) => void;
    emitScrollDirectionChange: (direction: ScrollDirection) => void;
    emitScroll: (position: number) => void;
}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
    id: {
        type: StringConstructor;
        default: string;
    };
}>> & Readonly<{}>, {
    id: string;
}, {}, {
    BaseScroll: import("vue").DefineComponent<{}, {}, any>;
}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>
```