📜  react-render-html (1)

📅  最后修改于: 2023-12-03 14:46:59.772000             🧑  作者: Mango

react-render-html

简介

react-render-html 是一个用于在 React 应用中渲染 HTML 内容的开源库。它可以方便地将包含 HTML 标签和样式的字符串转换为 React 组件,并在页面中进行渲染。

特性
  • 将带有 HTML 标签的字符串转换为 React 组件
  • 支持渲染 HTML 标签、属性和样式
  • 转义和处理 HTML 实体,防止注入攻击
  • 提供灵活的选项和配置,允许自定义转换规则和样式处理
安装

你可以使用 npm 或者 yarn 来安装 react-render-html:

npm install react-render-html

或者

yarn add react-render-html
使用示例
import React from 'react';
import renderHTML from 'react-render-html';

function App() {
  const htmlString = '<h1>Hello, <span style="color: red;">World!</span></h1>';
  
  return (
    <div>
      {renderHTML(htmlString)}
    </div>
  );
}

export default App;

以上代码中,renderHTML 函数将 htmlString 变量中的 HTML 字符串转换为了一个 React 组件,并将其渲染在页面中。转换后的组件会保留 HTML 标签和相应的样式。

自定义选项

react-render-html 提供了一些选项,可以根据需要进行配置和自定义。以下是一些常用的选项:

  • allowedTags:允许渲染的 HTML 标签列表,默认为全部标签。
  • allowedAttributes:允许渲染的 HTML 属性列表,默认为全部属性。
  • transform:自定义转换规则,可用于修改标签或属性的行为。
  • sanitize:是否开启 HTML 清理功能,防止注入攻击,默认为 true
  • wrapperComponent:自定义包装组件,用于包裹转换后的 HTML 内容。

详细的自定义选项和配置,请参考官方文档。

贡献

如果你对 react-render-html 感兴趣,欢迎参与贡献!你可以在 GitHub 上查看源代码、提交问题和拉取请求。