Skip to content

Commit

Permalink
doc: 基础功能使用
Browse files Browse the repository at this point in the history
  • Loading branch information
wll8 committed Sep 26, 2024
1 parent 2949d1d commit 0087656
Show file tree
Hide file tree
Showing 2 changed files with 72 additions and 4 deletions.
4 changes: 2 additions & 2 deletions packages/doc/src/docs/getting-started/your-first-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ title: 通过体验程序了解 ele-crud

``` sh
# 安装程序
npm i -g ele-crud
npm i -g ele-crud-cli

# 运行程序
crud
```

首先运行 `npm i -g ele-crud` 安装 `ele-crud`,然后再运行 `crud` 启动程序,这时候你的控制台可以看到以下内容:
首先运行 `npm i -g ele-crud-cli` 安装 `ele-crud-cli`,然后再运行 `ele-crud-cli` 启动程序,这时候你的控制台可以看到以下内容:

``` txt
服务已启动, 打开链接 http://127.0.0.1:8800/live/ 即刻使用吧~
Expand Down
72 changes: 70 additions & 2 deletions packages/doc/src/docs/use/function.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,73 @@
---
title: function
title: 基础功能使用
---

function
假设我们要创建一个简单的图书管理模块。我们需要会经过以下步骤:

- 添加`图书`管理模块
-`图书`配置字段,例如`书名``阅读量`
- 点击预览。

## 功能

表示你要创建的功能模块名称,比如点击`新增`,在`名称`中输入 book,在描述中输入`图书管理`

![240926_171429](https://github.com/user-attachments/assets/09f312c5-fcca-4308-9e07-b2586e49a1ed)


## 信息

也就是上面创建的`功能`基础信息配置。

![240926_171540](https://github.com/user-attachments/assets/b9a9786d-be40-4496-9db4-72704f31cdc9)


## 选项配置

图书列表中,可以有哪些操作,例如是否允许新增、是否允许删除。

选项配置与 avue 中的 [curd/option](https://avuejs.com/crud/crud-doc.html#option) 兼容,可以直接搜索和快捷填写配置。

![240926_171945](https://github.com/user-attachments/assets/ca9a01b5-dea9-4de2-89a9-6436eb172a47)

这时候点击`预览`,可以看到一张空的表格,因为我们还没有定义`图书`有哪些属性。

![image](https://github.com/user-attachments/assets/aec478d4-e34b-415a-a40f-13c11dd6ef73)

## 字段配置

在这里,我们可以定义`图书`有哪些属性,例如`书名``阅读量`

![240926_172921](https://github.com/user-attachments/assets/057bb27a-b6fa-4b2d-83f8-ef926dabda2f)

配置属性后点击保存,预览时即可查看已经实现好了的增删改查功能。

如果我们再添加一个`封面`,也是可以的。

![240926_173759](https://github.com/user-attachments/assets/79c09291-1716-464a-9896-2dfc89f80fa5)


## 输出配置

用于定制化输出的形式,例如配置是从后端加载还是从前端加载。

[开发中]


## 关联配置

配置当前功能模块关联的其他功能。

[开发中]

## 预览

即时查看当前配置所渲染的 crud 功能。

## 数据

查看生成的配置数据,可直接复制它到 ele-crud 项目或 avue 项目中使用。

## 默认值

用于保存常用的配置项。在这里配置之后,创建功能模块时,会自动读取这些配置。

0 comments on commit 0087656

Please sign in to comment.