Python AdminUI

• 语言: 中文（简体）
• 格式: .pdf
• 来源: readthedocs.org

摘要

文档主要介绍了《Python AdminUI》的使用方法，包括安装和快速入门、创建表单、页面操作、上传文件、创建菜单、布局和详情页、带参数的页面、使用数据表格等功能。文档详细说明了如何使用AdminUI框架快速构建管理界面，并提供了丰富的类和方法，如Card、Header、DataTable、MenuItem等，帮助开发者实现高效的界面设计和功能开发。

AI总结

《Python AdminUI》文档主要介绍了如何使用Python进行管理界面的开发，基于Ant Design Pro框架，结合FastAPI作为后端支持。以下是文档的核心内容总结：

### 1. 安装与快速入门
- **基本概念**：通过`AdminApp`对象创建应用程序，并使用`@app.page`装饰器添加页面。
- **推荐框架**：建议使用FastAPI代替Flask，以实现更高效的API开发。

### 2. 创建表单
- **表单控件**：支持多种表单控件，包括文本框（`TextField`、`TextArea`）、下拉框（`SelectBox`）、复选框（`CheckboxGroup`）和单选框（`RadioGroup`）。
- **回调功能**：表单控件变化时可触发回调函数。
- **特殊控件**：支持滑块（`Slider`）、开关（`Switch`）等交互控件。

### 3. 页面操作
- **导航与通知**：支持通过`NavigateTo`实现页面跳转，以及通过`Notification`发送右上角通知。
- **组合操作**：可将导航和通知操作组合为列表形式。

### 4. 上传文件
- **上传功能**：通过`AdminApp`指定上传文件夹即可启用文件上传功能。

### 5. 创建菜单
- **菜单项**：使用`MenuItem`类创建菜单项，支持图标、权限控制和子菜单嵌套。
- **菜单设置**：通过`AdminApp`的`set_menu`方法添加菜单项。

### 6. 布局与详情页
- **容器组件**：提供`Card`、`ChartCard`等容器组件用于布局。
- **标题与段落**：支持`Header`显示标题，`Paragraph`显示段落文本。
- **多列布局**：通过`Row`和`Column`实现响应式多列布局。

### 7. 带参数的页面
- **参数传递**：页面可以包含参数，用于动态内容展示。

### 8. 数据表格
- **数据准备**：通过`DataTable`类为表格准备数据。
- **列渲染**：支持将列渲染为链接（`Render a column as a link`）或徽章（`Render a column as a badge`）。
- **功能扩展**：支持分页（`Pagination`）、排序（`Sortable`）、过滤（`Filterable`）和行操作链接（`TableRowAction`）。

### 9. 其他功能
- **富文本**：通过`RawHTML`显示富文本，但需注意安全问题。
- **组织应用**：支持将应用程序拆分为多个文件，便于管理。

### 10. 示例
- 提供了一个简单的表单示例，展示了如何创建表单页面并运行。

文档内容涵盖了从安装配置到功能实现的完整流程，适合快速开发基于Python的管理界面应用。