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/EventPost.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

40 lines
954 B
TypeScript

/**
* The `EventPost` component displays a post which indicating a discussion
* event, like a discussion being renamed or stickied. Subclasses must implement
* the `icon` and `description` methods.
*
* ### Attrs
*
* - All of the attrs for `Post`
*
* @abstract
*/
export default class EventPost extends Post {
/**
* Get the name of the event icon.
*
* @return {String}
*/
icon(): string;
/**
* Get the description text for the event.
*
* @param {Object} data
* @return {String|Object} The description to render in the DOM
*/
description(data: Object): string | Object;
/**
* Get the translation key for the description of the event.
*
* @return {String}
*/
descriptionKey(): string;
/**
* Get the translation data for the description of the event.
*
* @return {Object}
*/
descriptionData(): Object;
}
import Post from "./Post";