php-flarum/js/dist-typings/forum/components/DiscussionPage.d.ts

/**
 * 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<import("../../common/components/Page").IPageAttrs> {
    constructor();
    useBrowserScrollRestoration: boolean | undefined;
    /**
     * 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;
    bodyClass: string | undefined;
    /**
     * List of components shown while the discussion is loading.
     *
     * @returns {ItemList}
     */
    loadingItems(): ItemList;
    /**
     * Function that renders the `sidebarItems` ItemList.
     *
     * @returns {import('mithril').Children}
     */
    sidebar(): import('mithril').Children;
    /**
     * Renders the discussion's hero.
     *
     * @returns {import('mithril').Children}
     */
    hero(): import('mithril').Children;
    /**
     * List of items rendered as the main page content.
     *
     * @returns {ItemList}
     */
    pageContent(): ItemList;
    /**
     * List of items rendered inside the main page content container.
     *
     * @returns {ItemList}
     */
    mainContent(): ItemList;
    /**
     * 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 ItemList from "../../common/utils/ItemList";
import PostStreamState from "../states/PostStreamState";