Trong bài này, chúng ta sẽ triển khai ActionText table editor cơ bản cho ứng dụng Rails. Chúng ta sẽ học:
- ActionText và Trix xử lý attachment như thế nào
- Triển khai kiểu
Attachableriêng, tận dụng để xây dựng table editor cơ bản - Turbo Frames dùng để edit table như thế nào
- Turbo giúp và cản trở cùng lúc
Bài viết lấy cảm hứng từ 'Adding Tables to ActionText With Stimulus.js' năm 2020. Đó là trước Turbo, mà chúng ta kỳ vọng đơn giản hóa mọi thứ đáng kể.
Hãy bắt đầu!
ActionText Attachments Trong Rails 101
Lưu ý: Demo này giả định hiểu biết về Trix và Turbo Frames. Bạn có thể thấy bài 'Get Started with Hotwire in Your Ruby on Rails App' hữu ích học cơ bản Hotwire và Turbo Frames.
Bạn có thể làm theo demo code với GitHub repo này.
Theo tài liệu ActionText:
Action Text mang rich text content và editing đến Rails. Nó bao gồm editor Trix xử lý mọi thứ từ formatting đến links, quotes, lists, đến embedded images và galleries.
Ở high level, attachments là phần của document model ActionText. Chúng render custom template cho bất kỳ resource nào resolvable bởi Signed Global ID (SGID). Nói cách khác, ActionText lưu tham chiếu đến SGID nhất định như element <action-text-attachment>:
Bất cứ khi ActionText gặp element đó, nó gọi phương thức to_attachable_partial_path trên resource tương ứng. Mặc định, phương thức này delegate đến to_partial_path.
Vì vậy, như preview, đây là cách biểu diễn Table trong ActionText trông như khi render về HTML:
Để tuân thủ ActionText Attachment API, class chỉ cần làm hai việc:
- Triển khai
to_sgidbằng includeGlobalID::Identification. Mặc định, tất cả con cháuActiveRecord::Baseđã làm. - Include module
ActionText::Attachable.
Module ActionText::Attachable cung cấp cách canonical chuyển model bất kỳ đến/từ SGID qua attachable_sgid và from_attachable_sgid. Chúng ta sẽ dùng sau.
Nó cũng cung cấp accessor tiện lợi cho attachment metadata, như file size, name, content type.
Cuối cùng, cung cấp vị trí mặc định cho partial dùng render attachment trong editor và rich text view.
Thêm Model Table
Chúng ta sẽ tận dụng Attachment API của ActionText để triển khai giải pháp table. Vì vậy, phải tạo custom model nắm bắt data table và include Attachable. Chúng ta dùng cột JSON(B) đơn giản để giữ mảng hai chiều cho data table.
Để bắt đầu exploration, tạo Rails app mới với ActionText enabled:
Vì tôi không cảm thấy sáng tạo hôm nay, hãy scaffold model Article với title và rich text content:
Cẩn thận, đây là gotcha (cạm bẫy) bất ngờ! Lệnh install trên tạo migration CreateActionTextTables, nên cần rename thành CreateActionTextTablesTable. Thêm, chúng ta để default 2x2 table dùng null: false, default: [["", ""], ["", ""]].
Thêm Table Vào Model ActionText Rails
Trước khi tiếp tục thực sự thêm table vào rich text, cần patch toolbar Trix:
Ở đây, chúng ta thủ công append button vào toolbarElement của Trix. Kết nối nó với Stimulus controller trix-table (chưa xây dựng) sẽ insert table vào document. Đưa button này SVG đẹp làm content trong CSS và setup table styles:
Như bạn thấy, chúng ta đã thêm thành công vào group "file-tools":

Bây giờ quay lại thêm và thao tác table với Turbo. Để làm vậy, trước cần controller với action create:
Action này có thể mượn từ bài 'On Rails' trích dẫn ở intro. Nó construct JSON cần thiết insert attachment client-side: bao gồm SGID và content render từ partial editor, như sau.
Chúng ta thêm resourceful table routes vào config:
Bây giờ đến lúc nhảy vào deep end: xây dựng model table. Đầu tiên, include ActionText::Attachable và định nghĩa partial paths:
Lưu ý chúng ta chưa định nghĩa cách content table lưu trữ. Vì khai báo cột JSON(B) trong database, tự do chọn format bất kỳ. Khác một chút với blog post trích dẫn, hãy dùng mảng hai chiều. Vì vậy, đơn giản lồng loop qua content như sau:
Partial trên render khi được request bởi ActionView, ví dụ. Tiếp, cũng cần partial editor dùng inline trong Trix:
Khác biệt duy nhất, như bạn thấy, là bây giờ wrap trong Turbo Frame, dùng SGID làm DOM id. Thêm, cung cấp row và column index cho separator block và chuẩn bị inline edit bằng cách làm inner DIV contenteditable — chúng ta sẽ đến sau.
Chúng ta sẽ kết nối button table toolbar với server-side controller action vừa viết. Để làm vậy, trước cần đưa thư viện request.js của Rails vào dự án. Thư viện giúp administer post request từ client, bao gồm CSRF tokens:
Xây Dựng Stimulus Controller Trix Table Mới
Bây giờ mọi thứ setup, hãy tạo trix-table Stimulus controller mới. Trong đó, triển khai action attachTable được tham chiếu bởi toolbar button:
Nó sẽ POST đến route create của table, insert JSON response như Trix attachment. Lại mượn từ OnRails blog post, thay thế rails-ujs deprecated bằng request.js mới.
Bây giờ phải thực sự dùng controller này trong app bằng cách thêm vào form markup:
Vẻ đẹp của Stimulus.js là chỉ thêm hai data attribute vào element form đạt kết quả. Chúng ta giờ có thể thêm table vào content article bằng một click:

Thao Tác Table Qua Turbo Frames
Bây giờ có thể tạo table attachment, chuyển focus thao tác content. Turbo Frames gần như natural fit ở đây.
Thêm & Xóa Hàng Và Cột Table
Để thêm/xóa hàng và cột, tạo mini-toolbar 4 button, mỗi operation. Dùng helper button_to và set URL đến route update cho table tương ứng. Thêm operation muốn trigger như param thêm:
Lượt lại, cũng cần thêm controller action vào TablesController. Quan sát action update delegate actions đến model.
Sau khi thay đổi cấu trúc table lưu, redirect đến edit view của table. Nó render cùng partial editor, side-effect là refer đến cùng Turbo Frame. Do đó Turbo detect matching frame và substitute.
Bây giờ phải triển khai lệnh thiếu trên model Table.
Đáng chú ý, do cấu trúc dữ liệu đơn giản mảng hai chiều, phương thức add/remove<sub>column</sub>/row chỉ proxy sửa column và row count. Khi đã có, thay đổi cấu trúc table bằng click button:

Chỉnh Sửa Nội Dung Ô Table
Ngoài thay đổi số cột/hàng, cũng muốn edit nội dung cell. Để đạt, lại dựa vào blog post trích dẫn và tạo Stimulus table editor controller.
Phương thức updateCell sẽ issue PATCH request khi cell edited, truyền row và column index làm param. Bây giờ, chỉ còn kết nối nó với DOM:
Server-side TablesController, tất nhiên, cần cách handle operation. May mắn, dễ dàng trong proof of concept đơn giản bằng thêm branch vào condition. Cũng đảm bảo action update handle JSON request, dù chỉ return empty object.
Lưu ý: trong production app, tôi khuyên chọn strategy khác để sanitize operation thay vì if/elsif/else. Tôi có thể dùng Mediator hoặc Proxy.
Hạn Chế Của Trix Trong Ruby
Đến đây, tôi giả định câu chuyện hoàn hảo, nhưng tôi bỏ qua chi tiết quan trọng. Dù persist model database ổn, chúng ta không sync với internal shadow representation của Trix. Đó là lý do table snap back (nhảy về) representation đã lưu khi focus out:

Nếu refresh trang, content thêm sẽ xuất hiện, vì document Trix được khởi tạo mới.
Tôi ghim vấn đề ở chỗ Trix sync internal document khi selection thay đổi. Nó unfurl từ shadow element ở đây.
Tôi thử hook vào event turbo:submit và prevent sync khi blur table, nhưng giải pháp đều rất rối và phụ thuộc internal API.
Cách Turbo-esque nhất, tôi đoán, là wrap toàn bộ form trong eager-loaded Turbo Frame và bảo nó reload khi content Trix thay đổi.
Cái này nên work:
Nếu bao form trong Turbo Frame load từ src:
Cách này chỉ work với base record đã persisted.
Lời Cảnh Báo Cuối Cùng Về Trix
Proof of concept chúng ta xây dùng server-rendered HTML loại bỏ complexity serialize table JSON và listen JS event. Nó portable đến bất kỳ ActionText install và dễ extract thành gem.
Có vài nhược điểm, rõ ràng nhất là re-sync cần thiết với document model Trix. Có tình huống workaround đề xuất workable và khác no-go. Cho đến Trix có Turbo-compatible interface, không cách nào tránh.
Bẫy thứ hai: không dùng Trix undo (nhưng đúng cho bất kỳ Trix attachment). Khôn ngoan là chờ upstream changes thay vì tweak internal API.
Kết Luận
Trong bài, chúng ta nhìn nhanh cơ bản ActionText Attachments. Sau đó thêm table vào ActionText model trước khi tinh chỉnh dùng Turbo Frames. Cuối, chạm đến hạn chế Trix.
Cho Trix v2 đang phát triển, dịch từ CoffeeScript sang modern JavaScript thuần túy, bây giờ là lúc tốt để giải quyết Turbo compatibility. Hiện tại, scope wrapper như vậy vượt quá khả năng tôi, nhưng trông như window of opportunity (cửa sổ cơ hội).
Chúc bạn viết mã vui vẻ!
P.S. Nếu bạn muốn đọc các bài Ruby Magic ngay khi chúng xuất bản, hãy đăng ký bản tin Ruby Magic của chúng tôi và không bao giờ bỏ lỡ bất kỳ bài viết nào!