Package Exports
- bbcode-parser
- bbcode-parser/bbTag
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (bbcode-parser) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
##Usage:##
var BBCodeParser = require('bbcode-parser');
var parser = new BBCodeParser(BBCodeParser.defaultTags());
var html = parser.parseString('[b]Bold text[/b]');You can also define your own tags:
var BBTag = require('bbcode-parser/bbTag');
var bbTags = {};
//Simple tag. A simple tag means that the generated HTML will be <tagName>content</tagName>
bbTags["b"] = BBTag.createSimpleTag("b");
//Tag with a custom generator.
bbTags["img"] = BBTag.createTag("img", function (tag, content, attr) {
return "<img src=\"" + content + "\" />";
});
//Tag with a custom generator + attributes
bbTags["url"] = BBTag.createTag("url", function (tag, content, attr) {
var link = content;
if (attr["site"] != undefined) {
link = BBCodeParser.escapeHTML(attr["site"]);
}
if (!BBCodeParser.startsWith(link, "http://") && !BBCodeParser.startsWith(link, "https://")) {
link = "http://" + link;
}
return "<a href=\"" + link + "\" target=\"_blank\">" + content + "</a>";
});
//A tag that doesn't support nested tags. Useful when implementing code highlighting.
bbTags["code"] = new BBTag("code", true, false, true, function (tag, content, attr) {
return "<code>" + content + "</code>";
});
var parser = new BBCodeParser(bbTags);BBTag constructor:
- tagName: The name of the tag.
- insertLineBreaks: Indicates if the tag inserts line breaks (\n ->
<br>) in the content. - suppressLineBreaks: Suppresses line breaks for any nested tag.
- noNesting: If the tags doesn't support nested tags.
- tagGenerator: The HTML generator for the tag. If not supplied the default one is used:
<tagName>content</tagName>.
##Documentation##