1
0
mirror of https://github.com/flarum/core.git synced 2025-07-25 10:41:24 +02:00
Files
php-flarum/js/dist-typings/forum/components/DiscussionPage.d.ts
flarum-bot c3a684c7ed Bundled output for commit 3537f76eab
Includes transpiled JS/TS, and Typescript declaration files (typings).

[skip ci]
2021-05-12 23:29:46 +00:00

54 lines
1.5 KiB
TypeScript

/**
* The `DiscussionPage` component displays a whole discussion page, including
* the discussion list pane, the hero, the posts, and the sidebar.
*/
export default class DiscussionPage extends Page {
/**
* The discussion that is being viewed.
*
* @type {Discussion}
*/
discussion: any;
/**
* The number of the first post that is currently visible in the viewport.
*
* @type {number}
*/
near: number | undefined;
/**
* Load the discussion from the API or use the preloaded one.
*/
load(): void;
/**
* Get the parameters that should be passed in the API request to get the
* discussion.
*
* @return {Object}
*/
requestParams(): Object;
/**
* Initialize the component to display the given discussion.
*
* @param {Discussion} discussion
*/
show(discussion: any): void;
stream: PostStreamState | undefined;
/**
* Build an item list for the contents of the sidebar.
*
* @return {ItemList}
*/
sidebarItems(): ItemList;
/**
* When the posts that are visible in the post stream change (i.e. the user
* scrolls up or down), then we update the URL and mark the posts as read.
*
* @param {Integer} startNumber
* @param {Integer} endNumber
*/
positionChanged(startNumber: any, endNumber: any): void;
}
import Page from "../../common/components/Page";
import PostStreamState from "../states/PostStreamState";
import ItemList from "../../common/utils/ItemList";