https://github.com/longlongago2/bricky
A rich editor based on slatejs
https://github.com/longlongago2/bricky
react rich-editor slate slate-editor slate-react
Last synced: about 2 months ago
JSON representation
A rich editor based on slatejs
- Host: GitHub
- URL: https://github.com/longlongago2/bricky
- Owner: longlongago2
- License: mit
- Created: 2022-12-15T02:00:24.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-09-05T08:55:26.000Z (almost 3 years ago)
- Last Synced: 2025-02-14T23:33:51.131Z (over 1 year ago)
- Topics: react, rich-editor, slate, slate-editor, slate-react
- Language: TypeScript
- Homepage: https://github.com/longlongago2/bricky#readme
- Size: 682 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.CN.md
- License: LICENSE
Awesome Lists containing this project
README
# bricky
> 一款基于 slate.js 的富文本编辑器
`react` `slate.js` `typescript` `antd` `rich-editor`
## 使用
### 1、安装
```bash
npm install bricky
```
### 2、Javascript / Typescript
#### app.tsx
```javascript
import { Editor } from 'bricky';
```
#### tsconfig.json
```json
{
"compilerOptions": { },
"include": [
"src",
"./node_modules/bricky/esm/slate.d.ts" // extend slate CustomTypes
]
}
```
or
#### vite-env.d.ts
```typescript
///
```
## 本地安装调试
```bash
cd ~/bricky # 进入本项目根目录
npm link # 将本项目包创建全局链接，类似安装到全局
cd ~/my-project # 进入其他项目目录
npm link bricky # 链接 bricky 包, --save: 保存到 package.json
```