npm 包 @atlaskit/editor-jira-transformer 使用教程

概述

@atlaskit/editor-jira-transformer 是一个基于 React 的 npm 包，用于将 Jira 中的原始内容转换成文本编辑器中的 HTML 格式。该 npm 包是 Atlassian 团队发布的一个开源项目，旨在提高开发者在 Jira 中使用 React 进行前端开发的效率。

安装

@atlaskit/editor-jira-transformer 是一个基于 npm 的第三方软件包，因此它可以通过如下命令进行安装：

npm install @atlaskit/editor-jira-transformer --save

用法

使用 @atlaskit/editor-jira-transformer 非常简单，只需在 import 中添加类似以下的语句即可：

import { JIRATransformer } from '@atlaskit/editor-jira-transformer';

在 render() 方法中，使用 JIRATransformer 将原始文本转换为 HTML：

render() {
  const transformer = new JIRATransformer();
  const html = transformer.transform(comment.body);

  return (
    <div className="comment-body" dangerouslySetInnerHTML={{ __html: html }} />
  );
}

请注意，上述示例代码中的 comment.body 是指 Jira 中的评论内容。如果希望将 Jira 的文章或问题转换为 HTML，则只需将其指定为 transformer.transform() 方法的参数即可。

参数

@atlaskit/editor-jira-transformer 支持以下选项：

• emojiProvider: 提供一个可以访问 emoji 代码和表情符号的提供程序。

例如：

import { JIRATransformer } from '@atlaskit/editor-jira-transformer';

import EmojiResource from '@atlaskit/emoji/emoji-resource';
import { emoji } from '@atlaskit/util-data-test';

const emojiProvider = emoji.storyData.getEmojiResource();
const transformer = new JIRATransformer({ emojiProvider });

示例代码

以下是一个完整的示例，其中使用了 @atlaskit/editor-jira-transformer 将 Jira 评论转换为 HTML：

-- -------------------- ---- -------
------ ------ - --------- - ---- --------
------ - --------------- - ---- ------------------------------------
------ ------------- ---- ---------------------------------
------ - ----- - ---- ---------------------------

----- ------- ------- --------- -
  ------------------------ -
    ----- ------------- - -----------------------------------
    ----- ----------- - --- ----------------- ------------- ---
    ------ ----------------------------
  -

  -------- -
    ----- - ------- - - -----------

    ------ -
      ---- --------------------
        ---- ---------------------------
          ----- --------------------------------------------------
          ----- ---------------------------------------------------------------
        ------
        ---- ------------------------ -------------------------- ------- ------------------------------------- -- --
      ------
    --
  -
-

------ ------- --------

总结

@atlaskit/editor-jira-transformer 是一个非常有用的 npm 包，可以很好地将 Jira 中的原始文本转换为 HTML。使用它不仅可以提高开发效率，而且可以减少手动处理文本的工作量。希望以上内容能够帮助读者更好地使用该 npm 包。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5eedaa8cb5cbfe1ea06104fe