dooring/packages/dooringx-lib/README.md

<div align=center >
<img  src="https://img-blog.csdnimg.cn/img_convert/520863a38a93d960862f92c805bc97cc.png#pic_center"/>
</div>

<a href="https://www.npmjs.com/package/dooringx-lib">
    <img src="https://img.shields.io/badge/npm-dooringx--lib-brightgreen" alt="dooringx npm package">
  </a>



This is the repository for DooringX.
- 💪 The Next Generation Dooring Framework
- 🔥 Written in TypeScript
- 🛠️ Rich Features
- 🔩 Universal Plugin Interface
- 🏠 预览 [x.dooring](http://x.dooring.cn/editor/home)
# 简介 | Brief Intro

dooringx-lib 是 dooringx 的基座，是移除了 dooringx 插件的可视化拖拽框架。



dooringx-lib 提供自己的一套数据流事件机制以及弹窗等解决方案，可以让你更快地自己定制开发可视化拖拽平台。


dooringx-lib 在运行时维护一套数据流，主要分为json数据部分，左侧组件部分，右侧配置项部分，快捷键部分，弹窗部分，事件与函数部分，数据源部分。



其除了提供基础的拖拽、移动、缩放、全选、旋转等功能外，还可以使用暴露的组件。如果觉得组件不够定制化，可以调整样式或者自己重新写。

## 文档 | Doc

[Read the Docs to Learn More](https://h5-dooring.github.io/dooringx/).

[阅读文档了解更多信息](https://h5-dooring.github.io/dooringx/).

## 二次开发安装 | Installation
```bash
npm/yarn  install dooringx-lib
```

## 项目上手 | Quick Start

  ```bash
# 克隆项目
# cnpmjs
git clone https://github.com.cnpmjs.org/H5-Dooring/dooringx.git

# or
git clone https://github.com/H5-Dooring/dooringx.git


# 进入项目目录
cd dooringx

# 安装依赖
yarn install

# 启动 dooringx-lib
yarn start

# 启动基础示例
yarn start:example

# 启动 dooringx doc 文档
yarn start:doc

  ```


## 同步代码 | Synchronizing Code

```
# add upstream
git remote add upstream https://github.com/H5-Dooring/dooringx

# 抓取源仓库修改 master分支
git fetch upstream main

# 切换分支
git checkout main

# 合并远程分支
git merge upstream/main
```
## 🤝 贡献 | Contributing

欢迎参与贡献，提出问题、新功能合并请求等！

最新的贡献情况可以参阅 GitHub 提供的[contributors](https://github.com/H5-Dooring/dooringx/graphs/contributors)页面

### ❓ 问题 | Issue
Contributions, issues and feature requests are welcome!.
<br />Feel free to check [issues page](https://github.com/H5-Dooring/dooringx/issues).

欢迎提Issues 或者 联系qq:673632758

## 持续升级 | Continuous Upgrades
[Change Log](./CHANGELOG.md)


## ✂️ 快照 | Screen Shots

<img src="https://yehuozhili-1259443377.cos.ap-nanjing.myqcloud.com/xxa.jpg"/>

<img src="https://yehuozhili-1259443377.cos.ap-nanjing.myqcloud.com/xxb.jpg"/>


### 其他项目 | Other Projects

| Project               |       Version                          | Repo                 |
| --------------------- | ------------------------------- | -------------------- |
| h5-Dooring | [![rc][h5-badge]][h5-Dooring]     | [[GitHub][h5-Dooring]] |
| v6.dooring | [![rc][v6-badge]][v6.dooring]     | [[GitHub][v6.dooring]] |
| pc-Dooring | [![rc][pc-badge]][pc-Dooring]     | [[GitHub][pc-Dooring]] |




[h5-badge]: https://img.shields.io/badge/Dooring-h5-brightgreen.svg
[h5-Dooring]: https://github.com/MrXujiang/h5-Dooring

[v6-badge]: https://img.shields.io/badge/version-1.0.0-blue.svg?cacheSeconds=2592000
[v6.dooring]: https://github.com/MrXujiang/v6.dooring.public

[pc-badge]: https://img.shields.io/badge/version-1.2-blue.svg?cacheSeconds=2592000
[pc-Dooring]: https://github.com/MrXujiang/pc-Dooring



###  团队介绍 | Team 

- [徐小夕 | 产品负责](https://github.com/MrXujiang)
- [yehuozhili | 技术负责](https://github.com/yehuozhili)
  - [XiaoZhaoxiaaa | 技术](https://github.com/XiaoZhaoxiaaa)
  - [GeekQiaQia | 技术](https://github.com/GeekQiaQia)
  - [RalapChen | 技术](https://github.com/RalapChen)
  - [taozhi1010 | 技术](https://github.com/taozhi1010)
- [47℃ | 设计/交互]()
- [大风吹 | 后台管理产品]()

### 技术交流 | Technical Communication

<a href="https://user-images.githubusercontent.com/12525636/143815456-9d056876-2a0b-4564-8372-1cfca76b690e.png" target="_blank"><img src="https://user-images.githubusercontent.com/12525636/143815456-9d056876-2a0b-4564-8372-1cfca76b690e.png" width=260 />dooringx-lib技术交流与反馈</a>




## License

MIT


## Todo

文档更新

脚手架

基础组件库