npm package: @mindfiredigital/textigniterjs-web-component
Description: TextIgniterJS Web-Component
Latest version: 1.0.5

<h1 align="center">TextIgniterJS</h1><br><br>
<p align="center">
<a href="https://www.npmjs.com/package/@mindfiredigital/textigniterjs"><img src="https://img.shields.io/npm/v/@mindfiredigital/textigniterjs.svg?sanitize=true" alt="Version"></a>
<a href="https://www.npmjs.com/package/@mindfiredigital/textigniterjs"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" alt="PRs"></a>
</p>

<br>

<p align="center"> Experience a Lightweight , powerful and intuitive HTML Editor built with Core Typescript. </p>

The `@mindfiredigital/textigniterjs` is a tool that allows developers to integrate TextIgniter.
<br>

<p align="center">
  <!-- <img alt="Screenshot of the React Text Igniter" src="https://res.cloudinary.com/dxf1kplcx/image/upload/v1725448061/react-text-igniter-screenshot_c4dq9c.png"\>
</p> -->

## Live Demo

Click the button below to open the project on StackBlitz.

<a href="https://stackblitz.com/edit/stackblitz-starters-kezevu?file=index.html" target="_blank">
  <img src="https://developer.stackblitz.com/img/open_in_stackblitz.svg" alt="Open in StackBlitz">
</a>

## Table of Contents

- [Features](#features)
- [Installation](#installation)
- [Getting Started](#getting-started)
- [Contributing](#contributing)
- [License](#license)

<br>

## 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.

<br>

## Installation

To install the `@mindfiredigital/textigniterjs` npm package in your project, use the following command:

```bash
npm install @mindfiredigital/textigniterjs
```

<br>

## Getting Started

- **Initialization**: Initialize the TextIgniter in your project.

```javascript
<!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>


```

<br>

## Contributing

We welcome contributions from the community. If you'd like to contribute to the `textigniterjs` npm package, please follow our [Contributing Guidelines](CONTRIBUTING.md).
<br>

## License

Copyright (c) Mindfire Digital llp. All rights reserved.

Licensed under the MIT license.