mirror of
https://github.com/flarum/core.git
synced 2025-08-10 18:35:56 +02:00
Bundled output for commit 3537f76eab
Includes transpiled JS/TS, and Typescript declaration files (typings). [skip ci]
This commit is contained in:
170
js/dist-typings/forum/states/ComposerState.d.ts
vendored
Normal file
170
js/dist-typings/forum/states/ComposerState.d.ts
vendored
Normal file
@@ -0,0 +1,170 @@
|
||||
export default ComposerState;
|
||||
declare class ComposerState {
|
||||
/**
|
||||
* The composer's current position.
|
||||
*
|
||||
* @type {ComposerState.Position}
|
||||
*/
|
||||
position: {
|
||||
HIDDEN: string;
|
||||
NORMAL: string;
|
||||
MINIMIZED: string;
|
||||
FULLSCREEN: string;
|
||||
};
|
||||
/**
|
||||
* The composer's intended height, which can be modified by the user
|
||||
* (by dragging the composer handle).
|
||||
*
|
||||
* @type {Integer}
|
||||
*/
|
||||
height: any;
|
||||
/**
|
||||
* The dynamic component being shown inside the composer.
|
||||
*
|
||||
* @type {Object}
|
||||
*/
|
||||
body: Object;
|
||||
/**
|
||||
* A reference to the text editor that allows text manipulation.
|
||||
*
|
||||
* @type {EditorDriverInterface|null}
|
||||
*/
|
||||
editor: EditorDriverInterface | null;
|
||||
/**
|
||||
* Load a content component into the composer.
|
||||
*
|
||||
* @param {ComposerBody} componentClass
|
||||
* @public
|
||||
*/
|
||||
public load(componentClass: any, attrs: any): void;
|
||||
/**
|
||||
* Clear the composer's content component.
|
||||
*/
|
||||
clear(): void;
|
||||
onExit: {
|
||||
callback: Function;
|
||||
message: string;
|
||||
} | null | undefined;
|
||||
fields: {
|
||||
content: Stream<string>;
|
||||
} | undefined;
|
||||
/**
|
||||
* Show the composer.
|
||||
*
|
||||
* @public
|
||||
*/
|
||||
public show(): void;
|
||||
/**
|
||||
* Close the composer.
|
||||
*
|
||||
* @public
|
||||
*/
|
||||
public hide(): void;
|
||||
/**
|
||||
* Confirm with the user so they don't lose their content, then close the
|
||||
* composer.
|
||||
*
|
||||
* @public
|
||||
*/
|
||||
public close(): void;
|
||||
/**
|
||||
* Minimize the composer. Has no effect if the composer is hidden.
|
||||
*
|
||||
* @public
|
||||
*/
|
||||
public minimize(): void;
|
||||
/**
|
||||
* Take the composer into fullscreen mode. Has no effect if the composer is
|
||||
* hidden.
|
||||
*
|
||||
* @public
|
||||
*/
|
||||
public fullScreen(): void;
|
||||
/**
|
||||
* Exit fullscreen mode.
|
||||
*
|
||||
* @public
|
||||
*/
|
||||
public exitFullScreen(): void;
|
||||
/**
|
||||
* Determine whether the body matches the given component class and data.
|
||||
*
|
||||
* @param {object} type The component class to check against. Subclasses are
|
||||
* accepted as well.
|
||||
* @param {object} data
|
||||
* @return {boolean}
|
||||
*/
|
||||
bodyMatches(type: object, data?: object): boolean;
|
||||
/**
|
||||
* Determine whether or not the Composer is visible.
|
||||
*
|
||||
* True when the composer is displayed on the screen and has a body component.
|
||||
* It could be open in "normal" or full-screen mode, or even minimized.
|
||||
*
|
||||
* @returns {boolean}
|
||||
*/
|
||||
isVisible(): boolean;
|
||||
/**
|
||||
* Determine whether or not the Composer is covering the screen.
|
||||
*
|
||||
* This will be true if the Composer is in full-screen mode on desktop,
|
||||
* or if we are on a mobile device, where we always consider the composer as full-screen..
|
||||
*
|
||||
* @return {Boolean}
|
||||
* @public
|
||||
*/
|
||||
public isFullScreen(): boolean;
|
||||
/**
|
||||
* Check whether or not the user is currently composing a reply to a
|
||||
* discussion.
|
||||
*
|
||||
* @param {Discussion} discussion
|
||||
* @return {Boolean}
|
||||
*/
|
||||
composingReplyTo(discussion: any): boolean;
|
||||
/**
|
||||
* Confirm with the user that they want to close the composer and lose their
|
||||
* content.
|
||||
*
|
||||
* @return {Boolean} Whether or not the exit was cancelled.
|
||||
*/
|
||||
preventExit(): boolean;
|
||||
/**
|
||||
* Configure when / what to ask the user before closing the composer.
|
||||
*
|
||||
* The provided callback will be used to determine whether asking for
|
||||
* confirmation is necessary. If the callback returns true at the time of
|
||||
* closing, the provided text will be shown in a standard confirmation dialog.
|
||||
*
|
||||
* @param {Function} callback
|
||||
* @param {String} message
|
||||
*/
|
||||
preventClosingWhen(callback: Function, message: string): void;
|
||||
/**
|
||||
* Minimum height of the Composer.
|
||||
* @returns {Integer}
|
||||
*/
|
||||
minimumHeight(): any;
|
||||
/**
|
||||
* Maxmimum height of the Composer.
|
||||
* @returns {Integer}
|
||||
*/
|
||||
maximumHeight(): any;
|
||||
/**
|
||||
* Computed the composer's current height, based on the intended height, and
|
||||
* the composer's current state. This will be applied to the composer's
|
||||
* content's DOM element.
|
||||
* @returns {Integer|String}
|
||||
*/
|
||||
computedHeight(): any | string;
|
||||
}
|
||||
declare namespace ComposerState {
|
||||
namespace Position {
|
||||
const HIDDEN: string;
|
||||
const NORMAL: string;
|
||||
const MINIMIZED: string;
|
||||
const FULLSCREEN: string;
|
||||
}
|
||||
}
|
||||
import EditorDriverInterface from "../../common/utils/EditorDriverInterface";
|
||||
import Stream from "../../common/utils/Stream";
|
Reference in New Issue
Block a user