{"id":24054071,"url":"https://github.com/scherenhaenden/MagnetarQuill","last_synced_at":"2025-09-15T15:31:25.845Z","repository":{"id":260669043,"uuid":"861660869","full_name":"scherenhaenden/MagnetarQuill","owner":"scherenhaenden","description":null,"archived":false,"fork":false,"pushed_at":"2025-01-01T17:37:20.000Z","size":3284,"stargazers_count":6,"open_issues_count":15,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-01T18:29:07.564Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/scherenhaenden.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-09-23T09:54:03.000Z","updated_at":"2024-12-06T19:59:57.000Z","dependencies_parsed_at":"2025-01-01T18:35:50.785Z","dependency_job_id":null,"html_url":"https://github.com/scherenhaenden/MagnetarQuill","commit_stats":null,"previous_names":["scherenhaenden/magnetarquill"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scherenhaenden%2FMagnetarQuill","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scherenhaenden%2FMagnetarQuill/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scherenhaenden%2FMagnetarQuill/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scherenhaenden%2FMagnetarQuill/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/scherenhaenden","download_url":"https://codeload.github.com/scherenhaenden/MagnetarQuill/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":233128203,"owners_count":18629047,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-01-09T03:01:26.048Z","updated_at":"2025-09-15T15:31:25.805Z","avatar_url":"https://github.com/scherenhaenden.png","language":"TypeScript","funding_links":[],"categories":["Third Party Components"],"sub_categories":["Editors"],"readme":"\n# **MagnetarQuill** 🖋✨\n\u003e **The Next-Gen Universe-Inspired WYSIWYG Editor - Built with Angular** 🚀💫\n\n![MagnetarQuill](magnetar-quill.png)\n\n**MagnetarQuill** is a versatile, extensible, and powerful **WYSIWYG editor component** built with **Angular**, designed to streamline content creation.\n\nInspired by the most extreme phenomena in the universe, the **Magnetar**, and combined with the elegance of a quill, this editor aims to take your text editing experience beyond the ordinary.\n\n---\n## **Current view** 🌟\n*(Assuming magnetar-quill-example.png shows the current state based on completed features)*\n![MagnetarQuill](magnetar-quill-example.png)\n\n---\n\n## **Table of Contents** 📚\n- [Status](#status-🏗️)\n- [Features](#features-🌟)\n- [Installation](#installation-🛠)\n- [Quick Start (Usage in Angular)](#quick-start-usage-in-angular-🚀)\n- [Contributing \u0026 Local Development](#contributing--local-development-🧑‍💻)\n- [Available Commands (for Development)](#available-commands-for-development-📜)\n- [Roadmap](#roadmap-🛣)\n- [License](#license-📄)\n- [Stay Connected](#stay-connected-💬)\n\n---\n\n## **Status** 🏗️\n\nMagnetarQuill is currently under active development. See the [Project Progress](#project-progress-📊) section for detailed status.\n\n---\n\n## **Features** 🌟\n\nBased on the current completed progress, MagnetarQuill offers:\n\n- 🖋 **Basic Text Formatting**: Support for **bold**, **italic**, **underline**, **strikethrough**.\n- 🎨 **Font Options**: Change font family and font size via dropdowns.\n- 🎨 **Color Selection**: Apply text and background colors using color pickers.\n- 📐 **Text Alignment \u0026 Spacing**: Includes options for text alignment and line spacing.\n- 📝 **Lists**: Support for ordered and unordered lists.\n- 📄 **Headers**: Support for custom headers (H1-H6).\n\n*(More features like image support, tables, clipboard enhancements, file export/import, and the plugin system are planned or in progress - see Roadmap and Progress below).*\n\n---\n\n## **Installation** 🛠\n\nTo use the MagnetarQuill component in your Angular project, install the library from npm (once published):\n\n```bash\nnpm i --save magnetar-quill\n````\n\n*(Note: Ensure the package is published to npm for this command to work.)*\n\n### **Prerequisites for Using the Library**\n\n  - An existing **Angular** project (v17.3.0 or higher recommended).\n\n-----\n\n## **Quick Start (Usage in Angular)** 🚀\n\n1.  Import the standalone `LibMagnetarQuillComponent` into your Angular component or module where you want to use the editor:\n\n    ```typescript\n    // Example in a standalone Angular component\n    import { Component } from '@angular/core';\n    import { LibMagnetarQuillComponent } from 'magnetar-quill'; // Adjust path if needed after install\n    import { FormsModule } from '@angular/forms'; // Needed for ngModel\n\n    @Component({\n      selector: 'app-my-editor-page',\n      standalone: true,\n      imports: [ LibMagnetarQuillComponent, FormsModule ], // Import the component\n      template: `\n        \u003ch2\u003eMy Editor\u003c/h2\u003e\n        \u003clib-magnetar-quill [(ngModel)]=\"documentContent\"\u003e\u003c/lib-magnetar-quill\u003e\n        \u003chr\u003e\n        \u003ch3\u003eContent Preview:\u003c/h3\u003e\n        \u003cdiv [innerHTML]=\"documentContent | safeHtml\"\u003e\u003c/div\u003e\n      ` // safeHtml pipe would be needed for rendering raw HTML\n    })\n    export class MyEditorPageComponent {\n      documentContent: string = '\u003cp\u003eStart editing here...\u003c/p\u003e';\n    }\n    ```\n\n    *(Note: You might need a pipe like `safeHtml` to securely render the HTML output from the editor)*\n\n2.  Add the component tag to your template and use `[(ngModel)]` for two-way binding of the editor's HTML content:\n\n    ```html\n    \u003clib-magnetar-quill [(ngModel)]=\"documentContent\"\u003e\u003c/lib-magnetar-quill\u003e\n    ```\n\n3.  You can now use the editor in your application\\!\n\n-----\n\n## **Contributing \u0026 Local Development** 🧑‍💻\n\nIf you want to contribute to MagnetarQuill or run the demo application locally:\n\n### Prerequisites for Development\n\n  - **Node.js** (v16.x or higher)\n  - **Angular CLI** (v17.3.0 or higher)\n\n### Step 1: Clone the Repository\n\n```bash\ngit clone [https://github.com/scherenhaenden/MagnetarQuill.git](https://github.com/scherenhaenden/MagnetarQuill.git)\ncd MagnetarQuill\n```\n\n### Step 2: Install Dependencies\n\n```bash\nnpm install\n```\n\n### Step 3: Run the Development Server\n\n```bash\nng serve\n```\n\nOpen your browser at [http://localhost:4200](https://www.google.com/search?q=http://localhost:4200) to see the **MagnetarQuill** demo application.\n\n-----\n\n## **Available Commands (for Development)** 📜\n\nInside the cloned project directory:\n\n  - `ng serve`: Start the development server.\n  - `ng build`: Build the library/project for production.\n  - `ng test`: Run unit tests.\n  - `ng lint`: Lint the codebase for errors.\n\n-----\n\n## **Roadmap** 🛣\n\n🔭 **Planned \u0026 In-Progress Features**:\n\n  - 📷 Image Insertion, Editing, and Clipboard Support\n  - 📊 Table Insertion and Editing\n  - ✨ Object Context Menu \u0026 Drag-and-Drop Repositioning\n  - ✂ Rich Text Copy-Paste Support \u0026 Sanitization\n  - 🔄 Undo/Redo Functionality with Multi-Step History\n  - 💾 HTML and Markdown Export/Import\n  - 🖥 Full-Screen Mode\n  - 🎨 Light/Dark Theme Support \u0026 Customization\n  - 🔌 Plugin System for Custom Toolbar Tools \u0026 Extensions\n  - 🤝 Advanced collaborative editing tools (Potential Future Enhancement)\n  - ✅ Enhanced accessibility features (Potential Future Enhancement)\n  - 📱 Mobile optimization for touch devices (Potential Future Enhancement)\n\n*(See the detailed progress table below for current status)*\n\n-----\n\n## **Project Progress** 📊\n\nHere’s the updated table with the latest progress:\n\n| Step  | Feature Description                                   | Status       | Version Name         |\n|-------|-------------------------------------------------------|--------------|----------------------|\n| 1     | Project Setup and Angular Initialization              | ✅ Completed  | Version 0.1 - Setup  |\n| 2     | Implement Bold, Italic, Underline, Strikethrough       | ✅ Completed  | Version 0.2 - Basic Text Formatting |\n| 3     | Font Family and Font Size Dropdowns                   | ✅ Completed  | Version 0.3 - Font Options |\n| 4     | Text \u0026 Background Color Pickers                       | ✅ Completed  | Version 0.4 - Color Selection |\n| 5     | Text Alignment \u0026 Line Spacing                         | ✅ Completed  | Version 0.5 - Text Alignment \u0026 Spacing |\n| 6     | Ordered and Unordered Lists                           | ✅ Completed | Version 0.6 - Lists |\n| 7     | Custom Headers (H1-H6)                                | ✅ Completed | Version 0.7 - Headers |\n| 8     | Image Insertion and Editing                           | 🔄 In Progress| Version 0.8 - Image Support |\n| 9     | Copy-Paste Image Support                              | 🔄 In Progress| Version 0.9 - Image Clipboard |\n| 10    | Table Insertion and Editing                           | 🔄 In Progress| Version 0.10 - Table Management |\n| 11    | Object Context Menu                                   | 🔄 In Progress| Version 0.11 - Object Management |\n| 12    | Drag-and-Drop Object Repositioning                    | 🔄 In Progress| Version 0.12 - Object Repositioning |\n| 13    | Rich Text Copy-Paste Support                          | 🔴 Not Started| Version 0.13 - Rich Text Clipboard |\n| 14    | Text Sanitization on Paste                            | 🔴 Not Started| Version 0.14 - Paste Sanitization |\n| 15    | Undo/Redo Functionality                               | 🔴 Not Started| Version 0.15 - Undo/Redo |\n| 16    | Multi-Step History Support                            | 🔴 Not Started| Version 0.16 - History Features |\n| 17    | HTML and Markdown Export                              | 🔴 Not Started| Version 0.17 - File Export |\n| 18    | File Loading (HTML \u0026 RTF)                             | 🔴 Not Started| Version 0.18 - File Import |\n| 19    | Full-Screen Mode                                      | 🔴 Not Started| Version 0.19 - Full-Screen |\n| 20    | Light and Dark Theme Support                          | 🔴 Not Started| Version 0.20 - Theme Customization |\n| 21    | Plugin System for Custom Toolbar Tools                | 🔴 Not Started| Version 0.21 - Plugin Support |\n\n*(Status Key: ✅ Completed | 🔄 In Progress | 🔴 Not Started)*\n\n-----\n\n## **Contributing** 🤝\n\nWe welcome contributions\\! Here's how you can help:\n\n1.  **Fork the repository** (`https://github.com/scherenhaenden/MagnetarQuill.git`).\n2.  **Create a new branch** for your feature or bug fix:\n    ```bash\n    git checkout -b feature/my-awesome-feature\n    ```\n3.  **Commit your changes** and open a pull request against the main repository.\n4.  We’ll review your PR and merge it\\!\n\nPlease read our [Contributing Guidelines](https://www.google.com/search?q=CONTRIBUTING.md) (if available) for more details.\n\n-----\n\n## **License** 📄\n\nMagnetarQuill is licensed under the **Creative Commons Attribution 4.0 International (CC BY 4.0)** License. You are free to use, distribute, and build upon this work, as long as proper attribution is given. See the [LICENSE](https://www.google.com/search?q=LICENSE) file for more details.\n\n-----\n\n## **Stay Connected** 💬\n\nFollow development progress or ask questions:\n\n  - **GitHub Issues**: [MagnetarQuill Issues](https://github.com/scherenhaenden/MagnetarQuill/issues)\n  - **GitHub Discussions**: [MagnetarQuill Discussions](https://github.com/scherenhaenden/MagnetarQuill/discussions)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscherenhaenden%2FMagnetarQuill","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fscherenhaenden%2FMagnetarQuill","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscherenhaenden%2FMagnetarQuill/lists"}