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

import type Mithril from 'mithril';
import Page, { IPageAttrs } from '../../common/components/Page';
import ItemList from '../../common/utils/ItemList';
import PostStreamState from '../states/PostStreamState';
import Discussion from '../../common/models/Discussion';
export interface IDiscussionPageAttrs extends IPageAttrs {
    id: string;
    near?: number;
}
/**
 * The `DiscussionPage` component displays a whole discussion page, including
 * the discussion list pane, the hero, the posts, and the sidebar.
 */
export default class DiscussionPage<CustomAttrs extends IDiscussionPageAttrs = IDiscussionPageAttrs> extends Page<CustomAttrs> {
    /**
     * The discussion that is being viewed.
     */
    protected discussion: Discussion | null;
    /**
     * A public API for interacting with the post stream.
     */
    protected stream: PostStreamState | null;
    /**
     * The number of the first post that is currently visible in the viewport.
     */
    protected near: number;
    protected useBrowserScrollRestoration: boolean;
    oninit(vnode: Mithril.Vnode<CustomAttrs, this>): void;
    onremove(vnode: Mithril.VnodeDOM<CustomAttrs, this>): void;
    view(): JSX.Element;
    /**
     * List of components shown while the discussion is loading.
     *
     * @returns {ItemList}
     */
    loadingItems(): ItemList<unknown>;
    /**
     * Function that renders the `sidebarItems` ItemList.
     *
     * @returns {import('mithril').Children}
     */
    sidebar(): JSX.Element;
    /**
     * Renders the discussion's hero.
     *
     * @returns {import('mithril').Children}
     */
    hero(): JSX.Element;
    /**
     * List of items rendered as the main page content.
     *
     * @returns {ItemList}
     */
    pageContent(): ItemList<unknown>;
    /**
     * List of items rendered inside the main page content container.
     *
     * @returns {ItemList}
     */
    mainContent(): ItemList<unknown>;
    /**
     * 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(): {
        bySlug: boolean;
        page: {
            near: number;
        };
    };
    /**
     * Initialize the component to display the given discussion.
     */
    show(discussion: Discussion): void;
    /**
     * Build an item list for the contents of the sidebar.
     */
    sidebarItems(): ItemList<Mithril.Vnode<{}, {}>>;
    /**
     * 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.
     */
    positionChanged(startNumber: number, endNumber: number): void;
}