src/forum/utils

Index

Namespaces

<internal>

Classes

Properties

Functions

Type literals

Properties

default

default: { controls: any; deleteAction: any; destructiveControls: any; hideAction: any; moderationControls: any; renameAction: any; replyAction: any; restoreAction: any; userControls: any }

Type declaration

controls:function
- controls(discussion: Discussion, context: Component<any, any>): ItemList<Children>
- - Defined in src/forum/utils/DiscussionControls.js:24
  Get a list of controls for a discussion.
  
  Parameters
  - discussion: Discussion
  - context: Component<any, any>
    
    The parent component under which the controls menu will be displayed.
  Returns ItemList<Children>
deleteAction:function
- deleteAction(): Promise<void>
- - Defined in src/forum/utils/DiscussionControls.js:237
  Delete the discussion after confirming with the user.
  
  Returns Promise<void>
destructiveControls:function
- destructiveControls(discussion: Discussion): ItemList<Children>
- - Defined in src/forum/utils/DiscussionControls.js:124
  Get controls for a discussion which are destructive (e.g. delete).
  
  Parameters
  - discussion: Discussion
  Returns ItemList<Children>
hideAction:function
- hideAction(): Promise<void>
- - Defined in src/forum/utils/DiscussionControls.js:215
  Hide a discussion.
  
  Returns Promise<void>
moderationControls:function
- moderationControls(discussion: Discussion): ItemList<Children>
- - Defined in src/forum/utils/DiscussionControls.js:96
  Get controls for a discussion pertaining to moderation (e.g. rename, lock).
  
  Parameters
  - discussion: Discussion
  Returns ItemList<Children>
renameAction:function
- renameAction(): any
- - Defined in src/forum/utils/DiscussionControls.js:252
  Rename the discussion.
  
  Returns any
replyAction:function
- replyAction(goToLast: boolean, forceRefresh: boolean): Promise<void>
- - Defined in src/forum/utils/DiscussionControls.js:182
  Open the reply composer for the discussion. A promise will be returned, which resolves when the composer opens successfully. If the user is not logged in, they will be prompted. If they don't have permission to reply, the promise will be rejected.
  
  Parameters
  - goToLast: boolean
    
    Whether or not to scroll down to the last post if the discussion is being viewed.
  - forceRefresh: boolean
    
    Whether or not to force a reload of the composer component, even if it is already open for this discussion.
  Returns Promise<void>
restoreAction:function
- restoreAction(): Promise<void>
- - Defined in src/forum/utils/DiscussionControls.js:226
  Restore a discussion.
  
  Returns Promise<void>
userControls:function
- userControls(discussion: Discussion, context: Component<any, any>): ItemList<Children>
- - Defined in src/forum/utils/DiscussionControls.js:48
  Get controls for a discussion pertaining to the current user (e.g. reply, follow).
  
  Parameters
  - discussion: Discussion
  - context: Component<any, any>
    
    The parent component under which the controls menu will be displayed.
  Returns ItemList<Children>

default

default: { controls: any; deleteAction: any; destructiveControls: any; editAction: any; hideAction: any; moderationControls: any; restoreAction: any; userControls: any }

Type declaration

controls:function
- controls(post: Post, context: Component<any, any>): ItemList<Children>
- - Defined in src/forum/utils/PostControls.js:21
  Get a list of controls for a post.
  
  Parameters
  - post: Post
  - context: Component<any, any>
    
    The parent component under which the controls menu will be displayed.
  Returns ItemList<Children>
  ')}
deleteAction:function
- deleteAction(context: any): Promise<void>
- - Defined in src/forum/utils/PostControls.js:175
  Delete a post.
  
  Parameters
  - context: any
  Returns Promise<void>
destructiveControls:function
- destructiveControls(post: Post, context: Component<any, any>): ItemList<Children>
- - Defined in src/forum/utils/PostControls.js:87
  Get controls for a post that are destructive (e.g. delete).
  
  Parameters
  - post: Post
  - context: Component<any, any>
    
    The parent component under which the controls menu will be displayed.
  Returns ItemList<Children>
  ')}
editAction:function
- editAction(): Promise<void>
- - Defined in src/forum/utils/PostControls.js:138
  Open the composer to edit a post.
  
  Returns Promise<void>
hideAction:function
- hideAction(): Promise<void>
- - Defined in src/forum/utils/PostControls.js:152
  Hide a post.
  
  Returns Promise<void>
moderationControls:function
- moderationControls(post: Post, context: Component<any, any>): ItemList<Children>
- - Defined in src/forum/utils/PostControls.js:57
  Get controls for a post pertaining to moderation (e.g. edit).
  
  Parameters
  - post: Post
  - context: Component<any, any>
    
    The parent component under which the controls menu will be displayed.
  Returns ItemList<Children>
  ')}
restoreAction:function
- restoreAction(): Promise<void>
- - Defined in src/forum/utils/PostControls.js:164
  Restore a post.
  
  Returns Promise<void>
userControls:function
- userControls(post: Post, context: Component<any, any>): ItemList<Children>
- - Defined in src/forum/utils/PostControls.js:44
  Get controls for a post pertaining to the current user (e.g. report).
  
  Parameters
  - post: Post
  - context: Component<any, any>
    
    The parent component under which the controls menu will be displayed.
  Returns ItemList<Children>
  ')}

default

default: { controls: any; deleteAction: any; destructiveControls: any; editAction: any; moderationControls: any; showDeletionAlert: any; userControls: any }

Type declaration

controls:function
- controls(user: User, context: Component<any, any>): ItemList<Children>
- - Defined in src/forum/utils/UserControls.js:21
  Get a list of controls for a user.
  
  Parameters
  - user: User
  - context: Component<any, any>
    
    The parent component under which the controls menu will be displayed.
  Returns ItemList<Children>
deleteAction:function
- deleteAction(user: User): void
- - Defined in src/forum/utils/UserControls.js:101
  Delete the user.
  
  Parameters
  - user: User
  Returns void
destructiveControls:function
- destructiveControls(user: User): ItemList<Children>
- - Defined in src/forum/utils/UserControls.js:81
  Get controls for a user which are destructive (e.g. delete).
  
  Parameters
  - user: User
  Returns ItemList<Children>
editAction:function
- editAction(user: User): void
- - Defined in src/forum/utils/UserControls.js:145
  Edit the user.
  
  Parameters
  - user: User
  Returns void
moderationControls:function
- moderationControls(user: User): ItemList<Children>
- - Defined in src/forum/utils/UserControls.js:57
  Get controls for a user pertaining to moderation (e.g. suspend, edit).
  
  Parameters
  - user: User
  Returns ItemList<Children>
showDeletionAlert:function
- showDeletionAlert(user: User, type: string): void
- - Defined in src/forum/utils/UserControls.js:125
  Show deletion alert of user.
  
  Parameters
  - user: User
  - type: string
  Returns void
userControls:function
- userControls(): ItemList<Children>
- - Defined in src/forum/utils/UserControls.js:44
  Get controls for a user pertaining to the current user (e.g. poke, follow).
  
  Returns ItemList<Children>

Functions

alertEmailConfirmation

alertEmailConfirmation(app: ForumApplication): void

- Defined in src/forum/utils/alertEmailConfirmation.js:11
Shows an alert if the user has not yet confirmed their email address.

Parameters
- app: ForumApplication
Returns void

isSafariMobile

isSafariMobile(): boolean

- Defined in src/forum/utils/isSafariMobile.ts:4
see
https://stackoverflow.com/a/31732310

Returns boolean

slidable

slidable(element: HTMLElement | Element | SVGElement): { reset: any }

- Defined in src/forum/utils/slidable.js:15
The slidable utility adds touch gestures to an element so that it can be slid away to reveal controls underneath, and then released to activate those controls.

It relies on the element having children with particular CSS classes.

The function returns a record with a reset proeprty. This is a function which reverts the slider to its original position. This should be called, for example, when a controls dropdown is closed.

Parameters
- element: HTMLElement | Element | SVGElement
Returns { reset: any }
- reset:function
  - reset(): void
  - - Defined in src/forum/utils/slidable.js:13
    Returns void

Type literals

__type

controls

controls(post: Post, context: Component<any, any>): ItemList<Children>

- Defined in src/forum/utils/PostControls.js:21
Get a list of controls for a post.

Parameters
- post: Post
- context: Component<any, any>
  
  The parent component under which the controls menu will be displayed.
Returns ItemList<Children>
')}

deleteAction

deleteAction(context: any): Promise<void>

- Defined in src/forum/utils/PostControls.js:175
Delete a post.

Parameters
- context: any
Returns Promise<void>

Protected destructiveControls

destructiveControls(post: Post, context: Component<any, any>): ItemList<Children>

- Defined in src/forum/utils/PostControls.js:87
Get controls for a post that are destructive (e.g. delete).

Parameters
- post: Post
- context: Component<any, any>
  
  The parent component under which the controls menu will be displayed.
Returns ItemList<Children>
')}

editAction

editAction(): Promise<void>

- Defined in src/forum/utils/PostControls.js:138
Open the composer to edit a post.

Returns Promise<void>

hideAction

hideAction(): Promise<void>

- Defined in src/forum/utils/PostControls.js:152
Hide a post.

Returns Promise<void>

Protected moderationControls

moderationControls(post: Post, context: Component<any, any>): ItemList<Children>

- Defined in src/forum/utils/PostControls.js:57
Get controls for a post pertaining to moderation (e.g. edit).

Parameters
- post: Post
- context: Component<any, any>
  
  The parent component under which the controls menu will be displayed.
Returns ItemList<Children>
')}

restoreAction

restoreAction(): Promise<void>

- Defined in src/forum/utils/PostControls.js:164
Restore a post.

Returns Promise<void>

Protected userControls

userControls(post: Post, context: Component<any, any>): ItemList<Children>

- Defined in src/forum/utils/PostControls.js:44
Get controls for a post pertaining to the current user (e.g. report).

Parameters
- post: Post
- context: Component<any, any>
  
  The parent component under which the controls menu will be displayed.
Returns ItemList<Children>
')}

__type

controls

controls(user: User, context: Component<any, any>): ItemList<Children>

- Defined in src/forum/utils/UserControls.js:21
Get a list of controls for a user.

Parameters
- user: User
- context: Component<any, any>
  
  The parent component under which the controls menu will be displayed.
Returns ItemList<Children>

deleteAction

deleteAction(user: User): void

- Defined in src/forum/utils/UserControls.js:101
Delete the user.

Parameters
- user: User
Returns void

Protected destructiveControls

destructiveControls(user: User): ItemList<Children>

- Defined in src/forum/utils/UserControls.js:81
Get controls for a user which are destructive (e.g. delete).

Parameters
- user: User
Returns ItemList<Children>

editAction

editAction(user: User): void

- Defined in src/forum/utils/UserControls.js:145
Edit the user.

Parameters
- user: User
Returns void

Protected moderationControls

moderationControls(user: User): ItemList<Children>

- Defined in src/forum/utils/UserControls.js:57
Get controls for a user pertaining to moderation (e.g. suspend, edit).

Parameters
- user: User
Returns ItemList<Children>

showDeletionAlert

showDeletionAlert(user: User, type: string): void

- Defined in src/forum/utils/UserControls.js:125
Show deletion alert of user.

Parameters
- user: User
- type: string
Returns void

Protected userControls

userControls(): ItemList<Children>

- Defined in src/forum/utils/UserControls.js:44
Get controls for a user pertaining to the current user (e.g. poke, follow).

Returns ItemList<Children>

Index

Namespaces

Classes

Properties

Functions

Type literals

Properties

default

Type declaration

controls:function

Parameters

discussion: Discussion

context: Component<any, any>

Returns ItemList<Children>

deleteAction:function

Returns Promise<void>

destructiveControls:function

Parameters

discussion: Discussion

Returns ItemList<Children>

hideAction:function

Returns Promise<void>

moderationControls:function

Parameters

discussion: Discussion

Returns ItemList<Children>

renameAction:function

Returns any

replyAction:function

Parameters

goToLast: boolean

forceRefresh: boolean

Returns Promise<void>

restoreAction:function

Returns Promise<void>

userControls:function

Parameters

discussion: Discussion

context: Component<any, any>

Returns ItemList<Children>

default

Type declaration

controls:function

Parameters

post: Post

context: Component<any, any>

Returns ItemList<Children>

deleteAction:function

Parameters

context: any

Returns Promise<void>

destructiveControls:function

Parameters

post: Post

context: Component<any, any>

Returns ItemList<Children>

editAction:function

Returns Promise<void>

hideAction:function

Returns Promise<void>

moderationControls:function

Parameters

post: Post

context: Component<any, any>

Returns ItemList<Children>

restoreAction:function

Returns Promise<void>

userControls:function

Parameters

post: Post

context: Component<any, any>

Returns ItemList<Children>

default

Type declaration

controls:function

Parameters

user: User

context: Component<any, any>

Returns ItemList<Children>

deleteAction:function