rich-text-converter
v1.0.1
Published
A JavaScript library to convert normal text into rich text with support for hashtags, mentions, bold, and underline.
Downloads
52
Maintainers
Readme
Rich Text Converter
A JavaScript library to convert normal text into rich text with support for hashtags, mentions, bold, and underline.
Installation
Using npm
You can install this package via npm:
npm install rich-text-converter
CDN Integration
You can also use the library directly from a CDN:
<!-- Include RichTextConvertor.js from jsDelivr -->
<script src="https://cdn.jsdelivr.net/gh/SH20RAJ/RichTextConvertor/RichTextConvertor.min.js"></script>
Usage
Browser
// Create a new instance of RichTextConverter
const converter = new RichTextConverter();
// Example usage
const inputText = "Check out #trending topics and mention @user in this **cool** __text__!";
const richText = converter.convert(inputText);
console.log(richText);
Node.js
You can also use the library in Node.js:
const RichTextConverter = require('rich-text-converter');
// Create a new instance of RichTextConverter
const converter = new RichTextConverter();
// Example usage
const inputText = "Check out #trending topics and mention @user in this **cool** __text__!";
const richText = converter.convert(inputText);
console.log(richText);
Configuration
You can customize the conversion by providing your own configurations for hashtags, mentions, bold, and underline styles:
const config = {
hashtags: {
url: 'https://example.com/hashtag/$1',
},
mentions: {
url: 'https://example.com/user/$1',
},
bold: {
replace: '<strong>$1</strong>',
},
underline: {
replace: '<u>$1</u>',
},
};
const converter = new RichTextConverter(config);
License
This project is licensed under the MIT License - see the LICENSE file for details.
Credits
This library is created and maintained by SH20RAJ.
If you find any issues or have suggestions, feel free to open an issue or contribute by submitting a pull request.