百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 博客教程 > 正文

Ruby on Rails 作者的 WYSIWYG 编辑器 Trix 火了!

connygpt 2024-09-08 13:28 5 浏览

家好,很高兴又见面了,我是"高级前端?进阶?",由我带着大家一起关注前端前沿、深入前端底层技术,大家一起进步,也欢迎大家关注、点赞、收藏、转发,您的支持是我不断创作的动力。

1.什么是 Trix

Trix is a WYSIWYG editor for writing messages, comments, articles, and lists—the simple documents most web apps are made of. It features a sophisticated document model, support for embedded attachments, and outputs terse and consistent HTML.

Trix 是用于日常写作的富文本编辑器,在 Web 应用程序中撰写格式精美的文本。 同时,Trix 是一个所见即所得(即,WYSIWYG)的编辑器,用于编写消息、评论、文章和列表等,而大多数 Web 应用程序都是由这些简单文档组成的。 Trix 具有复杂的文档模型、对嵌入附件的支持以及输出简洁且一致的 HTML。

Trix 是 Ruby on Rails 的创建者 37signals 的开源项目。Ruby on Rails 是一个全栈框架,附带了在前端和后端构建令人惊叹的 Web 应用程序所需的所有工具。

当 Trix 于 2014 年设计时,大多数 WYSIWYG 编辑器都是 HTML 的 contenteditable 和 execCommand API 的包装器,这些 API 由 Microsoft 设计,用于支持 Internet Explorer 5.5 中的网页实时编辑,并最终被其他浏览器进行逆向工程和复制。

<blockquote contenteditable="true">
  <p>Edit this content to add your own quote</p>
</blockquote>
<cite contenteditable="true">-- Write your own name here</cite>

由于这些 API 没有完全确定和标准化,因此每个浏览器的实现都有自己的一组错误和怪癖,JavaScript 开发人员需要解决这些不一致之处。

Trix 通过将 contenteditable 视为 I/O 设备来避免这些不一致,即当用户输入到达编辑器时,Trix 将该输入转换为其内部文档模型上的编辑操作,然后将该文档重新渲染回编辑器。 这使 Trix 可以完全控制每次击键后发生的情况,并且根本不需要使用 execCommand。

bool = document.execCommand(aCommandName, aShowDefaultUI, aValueArgument)
// 注意:该方法也已经废弃

最终,这种方法也成为所有现代所见即所得编辑器的常用方法。

目前 Trix 在 Github 通过 MIT 协议开源,有超过 18.3k 的 star、1.1k 的 fork、11.9k 的项目依赖量、代码贡献者 100+,妥妥的前端优质开源项目。

2.如何使用 Trix

2.1 安装与使用

Trix 以 ESM 和 UMD 格式打包在一起,可与任何资源打包工具配合使用。 开始使用 Trix 的最简单方法是将其从 npm CDN 包含在页面的 <head> 中:

<head>
  …
  <link rel="stylesheet" type="text/css" href="https://unpkg.com/trix@2.0.8/dist/trix.css">
  <script type="text/javascript" src="https://unpkg.com/trix@2.0.8/dist/trix.umd.min.js"></script>
</head>

当然,开发者也可以通过 NPM、yarn 等包管理工具进行下载和使用:

import Trix from "trix"

document.addEventListener("trix-before-initialize", () => {
  // 这里可以修改 Trix.config 的配置
})

开发者需要在页面上放置一个空的 <trix-editor></trix-editor> 标记,Trix 会在编辑器之前自动插入一个单独的 <trix-toolbar>。

与 HTML <textarea> 一样,<trix-editor> 接受 autofocus 和 placeholder 属性,但是与 <textarea> 不同 <trix-editor> 自动垂直扩展以适应其内容。

2.2 其他特性

Trix 编辑器支持无限制的撤消和重做,连续的输入和格式更改会以五秒的间隔合并在一起,所有其他输入更改都单独记录在撤消历史记录中。

element.editor.undo()
element.editor.redo()

Trix 还支持使用 JSON.stringify 序列化编辑器的状态,并使用 editor.loadJSON 方法恢复保存的状态。序列化状态包括文档和当前选择,但不包括撤消历史记录。

// 将编辑器状态存储在localStorage中
localStorage["editorState"] = JSON.stringify(element.editor)

// 从localStorage重新获取编辑器状态
element.editor.loadJSON(JSON.parse(localStorage["editorState"]))

Trix 支持将格式设置应用于当前选择,可以使用 editor.activateAttribute 方法:

element.editor.insertString("Hello")
element.editor.setSelectedRange([0, 5])
element.editor.activateAttribute("bold")

更多关于 Trix 的用法可以参考文末资料,本文不再过多展开。

参考资料

https://github.com/basecamp/trix

https://trix-editor.org/

https://www.bypeople.com/trix-rich-text-editor-for-everyday-writing/

https://www.youtube.com/watch?v=ZMcejBBDz4E

相关推荐

自学Python,写一个挨打的游戏代码来初识While循环

自学Python的第11天。旋转~跳跃~,我~闭着眼!学完循环,沐浴着while的光芒,闲来无事和同事一起扯皮,我说:“编程语言好神奇,一个小小的循环,竟然在生活中也可以找到原理和例子”,同事也...

常用的 Python 工具与资源,你知道几个?

最近几年你会发现,越来越多的人开始学习Python,工欲善其事必先利其器,今天纬软小编就跟大家分享一些常用的Python工具与资源,记得收藏哦!不然下次就找不到我了。1、PycharmPychar...

一张思维导图概括Python的基本语法, 一周的学习成果都在里面了

一周总结不知不觉已经自学Python一周的时间了,这一周,从认识Python到安装Python,再到基本语法和基本数据类型,对于小白的我来说无比艰辛的,充满坎坷。最主要的是每天学习时间有限。只...

三日速成python?打工人,小心钱包,别当韭菜

随着人工智能的热度越来越高,许多非计算机专业的同学们也都纷纷投入到学习编程的道路上来。而Python,作为一种相对比较容易上手的语言,也越来越受欢迎。网络上各类网课层出不穷,各式广告令人眼花缭乱。某些...

Python自动化软件测试怎么学?路线和方法都在这里了

Python自动化测试是指使用Python编程语言和相关工具,对软件系统进行自动化测试的过程。学习Python自动化测试需要掌握以下技术:Python编程语言:学习Python自动化测试需要先掌握Py...

Python从放弃到入门:公众号历史文章爬取为例谈快速学习技能

这篇文章不谈江流所专研的营销与运营,而聊一聊技能学习之路,聊一聊Python这门最简单的编程语言该如何学习,我完成的第一个Python项目,将任意公众号的所有历史文章导出成PDF电子书。或许我这个Py...

【黑客必会】python学习计划

阅读Python文档从Python官方网站上下载并阅读Python最新版本的文档(中文版),这是学习Python的最好方式。对于每个新概念和想法,请尝试运行一些代码片段,并检查生成的输出。这将帮助您更...

公布了!2025CDA考试安排

CDA数据分析师报考流程数据分析师是指在不同行业中专门从事行业数据搜集、整理、分析依据数据作出行业研究评估的专业人员CDA证书分为1-3级,中英文双证就业面广,含金量高!!?报考条件:满18...

一文搞懂全排列、组合、子集问题(经典回溯递归)

原创公众号:【bigsai】头条号:程序员bigsai前言Hello,大家好,我是bigsai,longtimenosee!在刷题和面试过程中,我们经常遇到一些排列组合类的问题,而全排列、组合...

「西法带你学算法」一次搞定前缀和

我花了几天时间,从力扣中精选了五道相同思想的题目,来帮助大家解套,如果觉得文章对你有用,记得点赞分享,让我看到你的认可,有动力继续做下去。467.环绕字符串中唯一的子字符串[1](中等)795.区...

平均数的5种方法,你用过几种方法?

平均数,看似很简单的东西,其实里面包含着很多学问。今天,分享5种经常会用到的平均数方法。1.算术平均法用到最多的莫过于算术平均法,考试平均分、平均工资等等,都是用到这个。=AVERAGE(B2:B11...

【干货收藏】如何最简单、通俗地理解决策树分类算法?

决策树(Decisiontree)是基于已知各种情况(特征取值)的基础上,通过构建树型决策结构来进行分析的一种方式,是常用的有监督的分类算法。决策树算法是机器学习中的一种经典算法,它通过一系列的规则...

面试必备:回溯算法详解

我们刷leetcode的时候,经常会遇到回溯算法类型题目。回溯算法是五大基本算法之一,一般大厂也喜欢问。今天跟大家一起来学习回溯算法的套路,文章如果有不正确的地方,欢迎大家指出哈,感谢感谢~什么是回溯...

「机器学习」决策树——ID3、C4.5、CART(非常详细)

决策树是一个非常常见并且优秀的机器学习算法,它易于理解、可解释性强,其可作为分类算法,也可用于回归模型。本文将分三篇介绍决策树,第一篇介绍基本树(包括ID3、C4.5、CART),第二篇介绍Ran...

大话AI算法: 决策树

所谓的决策树算法,通俗的说就是建立一个树形的结构,通过这个结构去一层一层的筛选判断问题是否好坏的算法。比如判断一个西瓜是否好瓜,有20条西瓜的样本提供给你,让你根据这20条(通过机器学习)建立起...