mirror of
https://github.com/flarum/core.git
synced 2025-08-08 09:26:34 +02:00
84 lines
2.6 KiB
TypeScript
84 lines
2.6 KiB
TypeScript
/**
|
|
* The `PostStream` component displays an infinitely-scrollable wall of posts in
|
|
* a discussion. Posts that have not loaded will be displayed as placeholders.
|
|
*
|
|
* ### Attrs
|
|
*
|
|
* - `discussion`
|
|
* - `stream`
|
|
* - `targetPost`
|
|
* - `onPositionChange`
|
|
*/
|
|
export default class PostStream extends Component<import("../../common/Component").ComponentAttrs, undefined> {
|
|
constructor();
|
|
discussion: any;
|
|
stream: any;
|
|
scrollListener: ScrollListener | undefined;
|
|
/**
|
|
* Start scrolling, if appropriate, to a newly-targeted post.
|
|
*/
|
|
triggerScroll(): void;
|
|
/**
|
|
*
|
|
* @param {number} top
|
|
*/
|
|
onscroll(top?: number): void;
|
|
calculatePositionTimeout: NodeJS.Timeout | undefined;
|
|
/**
|
|
* Check if either extreme of the post stream is in the viewport,
|
|
* and if so, trigger loading the next/previous page.
|
|
*
|
|
* @param {number} top
|
|
*/
|
|
loadPostsIfNeeded(top?: number): void;
|
|
updateScrubber(top?: number): void;
|
|
/**
|
|
* Work out which posts (by number) are currently visible in the viewport, and
|
|
* fire an event with the information.
|
|
*/
|
|
calculatePosition(top?: number): void;
|
|
/**
|
|
* Get the distance from the top of the viewport to the point at which we
|
|
* would consider a post to be the first one visible.
|
|
*
|
|
* @return {number}
|
|
*/
|
|
getMarginTop(): number;
|
|
/**
|
|
* Scroll down to a certain post by number and 'flash' it.
|
|
*
|
|
* @param {number} number
|
|
* @param {boolean} animate
|
|
* @return {JQueryDeferred}
|
|
*/
|
|
scrollToNumber(number: number, animate: boolean): JQueryDeferred<any>;
|
|
/**
|
|
* Scroll down to a certain post by index.
|
|
*
|
|
* @param {number} index
|
|
* @param {boolean} animate
|
|
* @param {boolean} reply Whether or not to scroll to the reply placeholder.
|
|
* @return {JQueryDeferred}
|
|
*/
|
|
scrollToIndex(index: number, animate: boolean, reply: boolean): JQueryDeferred<any>;
|
|
/**
|
|
* Scroll down to the given post.
|
|
*
|
|
* @param {JQuery} $item
|
|
* @param {boolean} animate
|
|
* @param {boolean} force Whether or not to force scrolling to the item, even
|
|
* if it is already in the viewport.
|
|
* @param {boolean} reply Whether or not to scroll to the reply placeholder.
|
|
* @return {JQueryDeferred}
|
|
*/
|
|
scrollToItem($item: JQuery, animate: boolean, force: boolean, reply: boolean): JQueryDeferred<any>;
|
|
/**
|
|
* 'Flash' the given post, drawing the user's attention to it.
|
|
*
|
|
* @param {JQuery} $item
|
|
*/
|
|
flashItem($item: JQuery): void;
|
|
}
|
|
import Component from "../../common/Component";
|
|
import ScrollListener from "../../common/utils/ScrollListener";
|