Newer
Older
alert / js / node_modules / flarum / common / components / Navigation.d.ts
@Réz István Réz István on 18 Nov 2021 1 KB first commit
/**
 * The `Navigation` component displays a set of navigation buttons. Typically
 * this is just a back button which pops the app's History. If the user is on
 * the root page and there is no history to pop, then in some instances it may
 * show a button that toggles the app's drawer.
 *
 * If the app has a pane, it will also include a 'pin' button which toggles the
 * pinned state of the pane.
 *
 * Accepts the following attrs:
 *
 * - `className` The name of a class to set on the root element.
 * - `drawer` Whether or not to show a button to toggle the app's drawer if
 *   there is no more history to pop.
 */
export default class Navigation extends Component<import("../Component").ComponentAttrs> {
    /**
     * Get the back button.
     *
     * @return {Object}
     * @protected
     */
    protected getBackButton(): any;
    /**
     * Get the pane pinned toggle button.
     *
     * @return {Object|String}
     * @protected
     */
    protected getPaneButton(): any | string;
    /**
     * Get the drawer toggle button.
     *
     * @return {Object|String}
     * @protected
     */
    protected getDrawerButton(): any | string;
}
import Component from "../Component";