Skip to content

ant-design/pro-editor

Folders and files

NameName
Last commit message
Last commit date
Sep 1, 2023
May 8, 2023
Aug 22, 2023
Nov 24, 2023
May 30, 2023
Nov 24, 2023
Nov 24, 2023
Jun 13, 2023
Jun 13, 2023
Nov 24, 2023
May 8, 2023
May 8, 2023
Jun 12, 2023
Aug 27, 2023
Nov 24, 2023
May 15, 2023
May 8, 2023
May 8, 2023
Jun 13, 2023
May 8, 2023
Nov 24, 2023
May 8, 2023
Nov 24, 2023
Nov 24, 2023
Nov 24, 2023
Nov 24, 2023
Nov 24, 2023
Jun 8, 2023

Repository files navigation

Ant Design ProEditor

🌟 An Editor UI Framework and Components

Changelog · Report Bug · Request Feature

NPM version NPM downloads install size

Test CI status Deploy CI Coverage

contributors forks stargazers issues

 docs by dumi Build With father

📦 Install

This component library is pure ESM.

Install via npm:

$ npm install @ant-design/pro-editor

Install via 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={'Function button description'}
    icon={<SmileOutlined />}
    onClick={() => {
      alert('Trigger action');
    }}
  />
);

Adapt to NextJS

To adapt to nextjs's SSR mode, you need to add the relevant dependencies of this package to the transpilePackages configuration in next.config.js:

// 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 PRs Welcome

📊 Total: 7

📝 License

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