react json editor ajrm
Locale Support & Other
警告:
您可能已经知道,react-json-editor-ajrm 的原始项目并未得到积极维护,并且最终将被弃用。所以我决定设定一个正式的弃用日期。暂定日期为 2023 年 6 月 15 日。
我要感谢那些在项目中使用它的人和那些以某种方式为该项目做出贡献的人。我只是不想再维持这个项目了。它是在我软件工程师职业生涯的早期开发的,它还没有达到今天的标准,也没有达到我的标准。
但别担心。我打算从头开始重写它,为这个项目注入新的生命。
我想汲取过去的经验教训,并避免 React-json-editor-ajrm 当前存在的一些问题。我还想强调做得好的事情,并希望继续下去。
我已经在这里为这个新项目设置了家 enio。如果您有任何问题或意见,我还在这里设置了讨论。
一个时尚的、类似编辑器的、模块化的 React 组件,用于查看、编辑和调试 javascript 对象语法!
$ npm i --save react-json-editor-ajrm
import JSONInput from 'react-json-editor-ajrm';
import locale from 'react-json-editor-ajrm/locale/en';
<JSONInput
id = 'a_unique_id'
placeholder = { sampleObject }
colors = { darktheme }
locale = { locale }
height = '550px'
/>
提示:有两个不同的根路径: react-json-editor-ajrm
和react-json-editor-ajrm/es
。第一个包含多填充的 ES5 代码,第二个包含未多填充的 ES6。 react-json-editor-ajrm/es
版本与create-react-app
不兼容。如果您不确定需要/想要哪一个,请选择第一个 - 它与工具和浏览器具有最佳兼容性。
./examples
文件夹包含两个示例:
$ cd path/to/repo/react-json-editor-ajrm/example/webpack-project
$ npm i
$ npm start
http://localhost:8080
placeholder
属性中的 javascript 对象,以便在组件安装后显示。English
、 German
、 Spanish
、 Chinese
、 French
、 Indonesian
、 Russian
、 Hindi
、 Japanese
和Tamil
。 姓名 | 描述 | 类型 | 必需的 |
---|---|---|---|
语言环境 | 您的编辑器的区域设置。像这样导入语言环境: import locale from 'react-json-editor-ajrm/locale/en' 。了解更多 | 目的 | 强制的 |
ID | 分配给实际文本输入 DOM 节点的可选id 。除了文本输入之外,以下节点还将接收 id: {id}-outer-box 、 {id}-container 、 {id}-warning-box 、 {id}-labels | 细绳 | 选修的 |
占位符 | 发送一个有效的 javascript 对象,以便在安装组件后显示。分配不同的值以重新呈现组件的初始内容。 | 目的 | 选修的 |
重置 | 发送true 以使组件始终重新渲染或“重置”为placeholder 属性上提供的值。 | 布尔值 | 选修的 |
仅供查看 | 如果您希望显示的内容不可编辑,请发送true 。 | 布尔值 | 选修的 |
改变时 | 每当onKeyPress 事件发生时,它都会返回内容值。 | 目的 | 选修的 |
模糊 | 每当onBlur 事件发生时,它都会返回内容值。 | 目的 | 选修的 |
确认好 | 如果您希望复选标记确认隐藏良好的语法,请发送false 。 | 布尔值 | 选修的 |
高度 | 用于设置整个组件的特定高度的简写属性。 | 细绳 | 选修的 |
宽度 | 用于设置整个组件的特定宽度的简写属性。 | 细绳 | 选修的 |
按键更新 | 如果您不希望组件在按键时自动更新,请发送false 。 | 布尔值 | 选修的 |
按键后等待 | 按键后重新呈现内容之前等待的毫秒数。未指定时,值默认为1000 。换句话说,如果在最后一次击键之后 1 秒内没有额外的击键,组件就会更新。少于100 毫秒并没有什么区别。 | 数字 | 选修的 |
修改错误文本 | 用于修改组件原始警告文本的自定义函数。该函数将接收string 类型的单个参数,并且必须同样返回string 。 | 功能 | 选修的 |
错误 | 包含以下属性: | 目的 | 选修的 |
错误原因 | 包含自定义错误消息的字符串 | 细绳 | 选修的 |
错误行 | 一个数字,表示与自定义错误消息相关的行号 | 数字 | 选修的 |
主题 | 指定要使用的内置主题。 | 细绳 | 选修的 |
颜色 | 包含以下属性: | 目的 | 选修的 |
颜色.默认值 | 任何符号的十六进制颜色代码,例如大braces 和comma 。 | 细绳 | 选修的 |
颜色.字符串 | 标识为string 值的标记的十六进制颜色代码。 | 细绳 | 选修的 |
颜色数 | 标识为integeter 、 double 或float 值的标记的十六进制颜色代码。 | 细绳 | 选修的 |
颜色.冒号 | 标识为colon 标记的十六进制颜色代码。 | 细绳 | 选修的 |
颜色.键 | 标识为keys 或属性名称的标记的十六进制颜色代码。 | 细绳 | 选修的 |
颜色.keys_whiteSpace | 标识为用引号引起来的keys 的标记的十六进制颜色代码。 | 细绳 | 选修的 |
颜色.基元 | 标识为boolean 值和 null 的标记的十六进制颜色代码。 | 细绳 | 选修的 |
颜色错误 | 标记有error 标签的标记的十六进制颜色代码。 | 细绳 | 选修的 |
颜色.背景 | 组件背景的十六进制颜色代码。 | 细绳 | 选修的 |
颜色.background_warning | 用于在组件顶部显示警告消息的十六进制颜色代码。 | 细绳 | 选修的 |
风格 | 包含以下属性: | 目的 | 选修的 |
样式.outerBox | 属性修改组件外部容器div的默认样式。 | 目的 | 选修的 |
样式.container | 属性修改组件container 的默认样式。 | 目的 | 选修的 |
style.warningBox | 属性修改警告消息容器div的默认样式。 | 目的 | 选修的 |
样式.errorMessage | 属性修改警告消息的默认样式。 | 目的 | 选修的 |
样式.body | 属性修改行标签和代码的容器div的默认样式。 | 目的 | 选修的 |
style.labelColumn | 属性修改行标签容器div的默认样式。 | 目的 | 选修的 |
样式.标签 | 属性修改每行标签的默认样式。 | 目的 | 选修的 |
样式.contentBox | 属性修改代码中容器div的默认样式。 | 目的 | 选修的 |
outerBox
+-- container
+--- warningBox
+---- errorMessage
+--- body
+---- labelColumn
+----- labels
+---- contentBox
+----- auto generated markup
每当 RJEA 重新呈现其内容时,传递到onChange
属性的任何函数都将接收具有以下键和值的单个对象参数:
钥匙 | 描述 |
---|---|
明文 | 内容的字符串表示形式,包括换行符和缩进。非常适合 console.log() |
标记文本 | 用于呈现内容的自动生成标记的字符串表示形式。 |
json | 内容的 JSON.stringify 版本。 |
js对象 | 内容的javascript object 版本。如果内容的语法不正确,将返回undefined 。 |
线 | 为显示内容而呈现的行数。 |
错误 | 除非内容的语法不正确,否则返回false ,在这种情况下,返回一个带有token 和line 号对应于发生错误的位置和reason |
RJEA 支持内置主题。这是列表。
该项目已根据 MIT 许可证获得许可 - 有关详细信息,请参阅 LICENSE.md 文件。
感谢这些优秀的人?:
安德鲁·雷迪肯 ? ? | 帕特里克·萨克斯 ? | 艾伦·凯尔 ? | 埃斯本病毒 | 马库斯·彼得里科斯基 | 里克·布伦斯特 | 脏猫 ? |
塞德里克 ? | 拉迪特 ? | 阿斯克泰斯 ? | CG韦丹特 ? | 谢巴兹·贾弗里 ? | 瓦桑莎·库马尔 RB ? | 阿迪亚·佩里瓦尔 ? |
阿列克谢·利亚霍夫 | 特伦斯·黄 | 理查德·赫尔 | 东尼古耶尼特18 |
该项目遵循所有贡献者规范。欢迎任何形式的贡献!