@mindfiredigital/textigniterjs
v1.0.3
Published
TextIgniter JS is a lightweight, powerful, and intuitive HTML editor built using TypeScript.
Downloads
22
Readme
The @mindfiredigital/textigniterjs is a tool that allows developers to integrate TextIgniter.
Live Demo
Click the button below to open the project on StackBlitz.
Table of Contents
Features
- Bold: When you apply bold formatting to text, it makes the selected text appear thicker and more prominent.
- Italic: Italic text is slanted to the right.
- Underline: Underlining text places a horizontal line beneath it.
- Subscript: Subscript lowers the selected text below the baseline.
- Superscript: Superscript raises the selected text above the baseline.
- Left Align: This feature aligns text to the left margin, creating a straight left edge.
- Center Align: Center alignment places text in the middle of the page or text box.
- Right Align: Text is aligned to the right margin, creating a straight right edge..
- Bullet List: Bullet lists present information as a series of items with bullets.
- Numbered List: Numbered lists provide a sequential order to items.
- Insert Table: This feature allows you to create tables to organize data.
- Insert Layout: This feature allows you to create Layout to organize data.
- Heading: Headings are typically used to divide a document into sections or chapters. They are usually styled differently, such as with larger text or bold formatting.
- Hyperlink: A hyperlink is a clickable link that connects to a webpage or another location within the document.
- Image: This feature allows you to insert images or graphics into your document to enhance its visual appeal or convey additional information.
- GETHTML: This feature allows you to get HTML for the data of editor.
- GETJSON: This feature allows you to get JSON for the data of editor.
- Custom Height: This feature allows you to set height of editor.
Installation
To install the @mindfiredigital/textigniterjs npm package in your project, use the following command:
npm install @mindfiredigital/textigniterjsGetting Started
- Initialization: Initialize the TextIgniter in your project.
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>TextIgniterJS</title>
</head>
<body>
<div id="editor"></div>
<script src="node_modules/@mindfiredigital/textigniterjs/dist/index.js"></script>
<script>
// Initialize the RichTextEditor with specific features
const config = {
features: [
'bold',
'italic',
'underline',
'subscript',
'superscript',
'left_align',
'center_align',
'right_align',
'justify',
'bullet_list',
'numbered_list',
'insert_table',
'insert_layout',
'heading',
'hyperlink',
'image',
],
};
const editor = new TextIgniter('editor', config);
// Example usage of getHtml and getJson methods
function getEditorContent() {
console.log('HTML content:', editor.getHtml());
console.log('JSON content:', editor.getJson());
}
const contentButton = document.createElement('button');
contentButton.innerText = 'Get Content';
contentButton.onclick = getEditorContent;
document.body.appendChild(contentButton);
</script>
</body>
</html>
Contributing
We welcome contributions from the community. If you'd like to contribute to the textigniterjs npm package, please follow our Contributing Guidelines.
License
Copyright (c) Mindfire Digital llp. All rights reserved.
Licensed under the MIT license.