Skip to content

ggerman/trix_genius

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

63 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

✨ TrixGenius (Alpha 0.1.2)

Gem Version

TrixGenius is a Rails engine and generator that extends the Trix Editor with enhanced functionality using Hotwire (Turbo + Stimulus). It adds AI-powered buttons to the Trix toolbar — including a Correct Spelling feature — to make rich-text editing smarter, more dynamic, and user-friendly.

⚙️ Features (Alpha)

  • 🚀 Plug-and-play generator to scaffold Trix enhancements into your app.
  • 🎛️ StimulusJS controller for rich interaction with Trix Editor.
  • ✍️ Correct Spelling button — adds a toolbar button to trigger spelling corrections (via API or local logic).
  • 🔌 Hooks ready for integration with services like DeepSeek AI.
  • 🧪 Designed for customization and extension.

⚠️ This is an alpha release. APIs and behaviors are subject to change as we gather feedback.

Installation

  1. Add the gem to your Gemfile: https://rubygems.org/gems/trix-genius

    gem 'trix-genius', '~> 0.1.1'
  2. Install the gem:

    bundle install
  3. Set up Action Text:

    bin/rails action_text:install
  4. (Optional) Create a scaffold to test it out:

    bin/rails g scaffold Post title:string content:rich_text
    bin/rails db:migrate
  5. Install TrixGenius into your app:

    bin/rails g trix_genius:install

Usage

Once installed, your Trix editor will have an AI-enhanced Correct Spelling button.
This is enabled by default and ready to use in any form where you use Action Text’s rich_text_area.

Configuration

Make sure your .env or Rails credentials include the required key:

DEEPSEEK_API_KEY=your_api_key_here

🧠 Add a "Correct Spelling" Button to Trix

To enable the "Correct Spelling" button:

  1. Make sure trix-genius is installed and your controller is connected.
  2. The generator adds a correct_spelling button to the Trix toolbar via Stimulus.
  3. Inside your trix_genius_controller.js, the correctSpelling method can trigger an AI call or local spellchecker logic.

Example Trix Toolbar Button (HTML)

<%= form.rich_textarea :content, rows: 4, data: { controller: "trix" }, class: ["block shadow-sm rounded-md border px-3 py-2 mt-2 w-full", {"border-gray-400 focus:outline-blue-600": post.errors[:content].none?, "border-red-400 focus:outline-red-600": post.errors[:content].any?}] %>

Press Button to Correct the text Spelling:

✨ New Feature: Math Expression Evaluation

Trix Genius now supports evaluating math expressions inside parentheses within the Trix WYSIWYG editor — with a single click!

When a user types a math expression like (5 + 3 * 2), they can press the "Calculate" button (provided by the gem) to automatically evaluate and replace the expression with its result.

➕ Example

Input (before pressing "Calculate"):

➕ Example

Pending

  • Add ChatGPT
  • Add qwen.ai
  • Allow enabled or disabled each feature
  • Upload specs for Calculate Expression

👨‍💻 About the Author
Hi! I'm Germán, a passionate Ruby on Rails developer with experience in AI-powered applications, StimulusJS, and open-source development.

📢 Let's connect!
🔗 Website
🐙 GitHub
💼 LinkedIn
📧 Get in Touch

Top Langs

About

Trix Genius – Enhance your Trix Editor with powerful custom features and StimulusJS support.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors