README.zh-CN.md

Ant Design ProEditor

🌟 An Editor UI Framework and Components

Changelog · Report Bug · Request Feature

📦 Install

本组件库为 纯 ESM。

使用 npm 安装：

$ npm install @ant-design/pro-editor

使用 pnpm 安装：

$ pnpm add @ant-design/pro-editor

🔨 Usage

import { SmileOutlined } from '@ant-design/icons';
import { ActionIcon } from '@ant-design/pro-editor';

export default () => (
  <ActionIcon
    title={'功能按钮的说明'}
    icon={<SmileOutlined />}
    onClick={() => {
      alert('触发动作');
    }}
  />
);

适配 NextJS

为适配 nextjs 的 SSR 模式, 需要将本包的相关依赖添加到 next.config.js 的 transpilePackages 配置中:

// next.config.js
const nextConfig = {
  // ...other config
  transpilePackages: ['@ant-design/pro-editor', 'leva'],
};

⌨️ Development

$ git clone git@github.com:ant-design/pro-editor.git
$ cd pro-editor
$ npm install
$ npm start

Open your browser and visit http://localhost:8000

🤝 Contributing

• Release Guide

📊 Total: 7

📝 License

Copyright © 2023 - present AFX & Ant Digital
This project is MIT licensed.