Class BBCodeLibrary

This is the BBCodeLibrary class, it is responsible for defining the default Emoji, the default tags, and providing the functions to parse the default tags. You can extend this Library and pass it to BBCode when creating it, or create new tags using the addRule function.

Hierarchy

BBCodeLibrary

Index

Constructors

constructor

new BBCodeLibrary(): BBCodeLibrary
Returns BBCodeLibrary

Properties

defaultEmoji

defaultEmoji: Record<string, string> = ...

Var

defaultEmoji Standard library of Emoji definitions.

defaultTagRules

defaultTagRules: Record<string, TagRules> = ...

Var

defaultTagRules TagRules Standard rules for what to do when a BBCode tag is encountered.

`Protected` imageExtensions

imageExtensions: string[] = ...

Var

array The file extensions that are considered valid local images.

Methods

doEmail

doEmail(bbcode, action, name, defaultValue, params, content): string | true
Format an [email] tag by producing an ... element.

The e-mail address must be a valid address including at least a '@' and a valid domain name or IPv4 or IPv6 address after the '@'.
Parameters
- bbcode: BBCode
- action: BBEnum.BBAction
  
  The current action being performed on the tag.
- name: string
  
  The name of the tag.
- defaultValue: string
  
  The default value passed to the tag in the form: [tag=default].
- params: TagType
  
  All of the parameters passed to the tag.
- content: string
  
  The content of the tag. Only available when action is OUTPUT.
Returns string | true
string Returns the email link HTML.
- Defined in src/bbcodelibrary.ts:478

doFont

doFont(bbcode, action, name, defaultValue, params, content): string
Format a [font] tag by producing a with a style with a different font-family.

This is complicated by the fact that we have to recognize the five special font names and quote all the others.
Parameters
- bbcode: BBCode
- action: BBEnum.BBAction
  
  The current action being performed on the tag.
- name: string
  
  The name of the tag.
- defaultValue: string
  
  The default value passed to the tag in the form: [tag=default].
- params: TagType
  
  All of the parameters passed to the tag.
- content: string
  
  The content of the tag. Only available when action is OUTPUT.
Returns string
Returns a span with the font family CSS.
- Defined in src/bbcodelibrary.ts:556

doImage

doImage(bbcode, action, name, defaultValue, params, content): string | true
Format an [img] tag. The URL only allows http, https, and ftp protocols for safety.
Parameters
- bbcode: BBCode
- action: BBEnum.BBAction
  
  The current action being performed on the tag.
- name: string
  
  The name of the tag.
- defaultValue: string
  
  The default value passed to the tag in the form: [tag=default].
- params: TagType
  
  All of the parameters passed to the tag.
- content: string
  
  The content of the tag. Only available when action is OUTPUT.
Returns string | true
Returns the image tag.
- Defined in src/bbcodelibrary.ts:622

doList

doList(bbcode, action, name, defaultValue, params, content): string | boolean

Format a [list] tag.

This is complicated by the number of different ways a list can be started. The following parameters are allowed:

[list]           Unordered list, using default marker
[list=circle]    Unordered list, using circle marker
[list=disc]      Unordered list, using disc marker
[list=square]    Unordered list, using square marker

[list=1]         Ordered list, numeric, starting at 1
[list=A]         Ordered list, capital letters, starting at A
[list=a]         Ordered list, lowercase letters, starting at a
[list=I]         Ordered list, capital Roman numerals, starting at I
[list=i]         Ordered list, lowercase Roman numerals, starting at i
[list=greek]     Ordered list, lowercase Greek letters, starting at alpha
[list=01]        Ordered list, two-digit numeric with 0-padding, starting at 01

Parameters

bbcode: BBCode
action: BBEnum.BBAction

The current action being performed on the tag.
name: string

The name of the tag.
defaultValue: string

The default value passed to the tag in the form: [tag=default].
params: TagType

All of the parameters passed to the tag.
content: string

The content of the tag. Only available when action is OUTPUT.

Returns string | boolean

Returns the list HTML or a boolen result when action is BBAction.BBCODE_CHECK.

doQuote

doQuote(bbcode, action, name, defaultValue, params, content): string | boolean
Format a [quote] tag.

This tag can come in a variety of flavors:
```
[quote]...[/quote]
[quote=Tom]...[/quote]
[quote name="Tom"]...[/quote]
```
In the third form, you can also add a date="" parameter to display the date on which Tom wrote it, and you can add a url="" parameter to turn the author's name into a link. A full example might be:
```
[quote name="Tom" date="July 4, 1776 3:48 PM" url="http://www.constitution.gov"]...[/quote]
```
The URL only allows http, https, mailto, gopher, ftp, and feed protocols for safety.
Parameters
- bbcode: BBCode
- action: BBEnum.BBAction
  
  The current action being performed on the tag.
- name: string
  
  The name of the tag.
- defaultValue: string
  
  The default value passed to the tag in the form: [tag=default].
- params: TagType
  
  All of the parameters passed to the tag.
- content: string
  
  The content of the tag. Only available when action is OUTPUT.
Returns string | boolean
Returns the quote HTML or true if action is BBAction.BBCODE_CHECK.
- Defined in src/bbcodelibrary.ts:699

doRule

doRule(bbcode, action, name, defaultValue, params, content): string | boolean
Format a [rule] tag.

This substitutes the content provided by the BBCode object, whatever that may be.
Parameters
- bbcode: BBCode
- action: BBEnum.BBAction
  
  The current action being performed on the tag.
- name: string
  
  The name of the tag.
- defaultValue: string
  
  The default value passed to the tag in the form: [tag=default].
- params: TagType
  
  All of the parameters passed to the tag.
- content: string
  
  The content of the tag. Only available when action is OUTPUT.
Returns string | boolean
Returns the rule HTML or true if action is BBAction.BBCODE_CHECK.
- Defined in src/bbcodelibrary.ts:663

doSize

doSize(bbcode, action, name, defaultValue, params, content): string
Format a [size] tag by producing a with a style with a different font-size.
Parameters
- bbcode: BBCode
- action: BBEnum.BBAction
  
  The current action being performed on the tag.
- name: string
  
  The name of the tag.
- defaultValue: string
  
  The default value passed to the tag in the form: [tag=default].
- params: TagType
  
  All of the parameters passed to the tag.
- content: string
  
  The content of the tag. Only available when action is OUTPUT.
Returns string
Returns a span with the font size CSS.
- Defined in src/bbcodelibrary.ts:504

doURL

doURL(bbcode, action, name, defaultValue, params, content): string | true
Format a [url] tag by producing an ... element.

The URL only allows http, https, mailto, and ftp protocols for safety.
Parameters
- bbcode: BBCode
- action: BBEnum.BBAction
  
  The current action being performed on the tag.
- name: string
  
  The name of the tag.
- defaultValue: string
  
  The default value passed to the tag in the form: [tag=default].
- params: TagType
  
  All of the parameters passed to the tag.
- content: string
  
  The content of the tag. Only available when action is OUTPUT.
Returns string | true
Returns the full HTML url.
- Defined in src/bbcodelibrary.ts:436

doWiki

doWiki(bbcode, action, name, defaultValue, params, content): string | boolean
Format a [wiki] tag by producing an ... element.
Parameters
- bbcode: BBCode
- action: BBEnum.BBAction
  
  The current action being performed on the tag.
- name: string
  
  The name of the tag.
- defaultValue: string
  
  The default value passed to the tag in the form: [tag=default].
- params: TagType
  
  All of the parameters passed to the tag.
- content: string
  
  The content of the tag. Only available when action is OUTPUT.
Returns string | boolean
Returns a link to the wiki.
- Defined in src/bbcodelibrary.ts:597

Class BBCodeLibrary

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns BBCodeLibrary

Properties

defaultEmoji

Var

defaultTagRules

Var

Protected imageExtensions

Var

Methods

doEmail

Parameters

bbcode: BBCode

action: BBEnum.BBAction

name: string

defaultValue: string

params: TagType

content: string

Returns string | true

doFont

Parameters

bbcode: BBCode

action: BBEnum.BBAction

name: string

defaultValue: string

params: TagType

content: string

Returns string

doImage

Parameters

bbcode: BBCode

action: BBEnum.BBAction

name: string

defaultValue: string

params: TagType

content: string

Returns string | true

doList

Parameters

bbcode: BBCode

action: BBEnum.BBAction

name: string

defaultValue: string

params: TagType

content: string

Returns string | boolean

doQuote

Parameters

bbcode: BBCode

action: BBEnum.BBAction

name: string

defaultValue: string

params: TagType

content: string

Returns string | boolean

doRule

Parameters

bbcode: BBCode

action: BBEnum.BBAction

name: string

defaultValue: string

params: TagType

content: string

Returns string | boolean

doSize

Parameters

bbcode: BBCode

action: BBEnum.BBAction

name: string

defaultValue: string

params: TagType

content: string

Returns string

`Protected` imageExtensions