forked from mengyxu/noob-components
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
48 lines
1.5 KiB
48 lines
1.5 KiB
3 months ago
|
# Plugs Composables Guidelines
|
||
|
|
|
||
|
|
> Vue 3 Composition API patterns for reusable stateful logic in `plugs/composables/`.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Overview
|
||
|
|
|
||
|
|
This directory documents the composables in `plugs/composables/`. These are reusable Vue composition API functions that encapsulate complex stateful logic.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Guidelines Index
|
||
|
|
|
||
|
|
| Guide | File | Description | Status |
|
||
|
|
|-------|------|-------------|--------|
|
||
|
|
| useListTable | [use-list-table.md](./use-list-table.md) | List/table management with pagination | Filled |
|
||
|
|
| useModifyForm | [use-modify-form.md](./use-modify-form.md) | Form open/edit/add dialog flow | Filled |
|
||
|
|
| useLoading | [use-loading.md](./use-loading.md) | Element Plus loading overlay | Filled |
|
||
|
|
| useRefreshFlags | [use-refresh-flags.md](./use-refresh-flags.md) | Auto-refresh flag management | Filled |
|
||
|
|
| useActionPers | [use-action-pers.md](./use-action-pers.md) | Action permissions | Filled |
|
||
|
|
| useSysDict | [use-sys-dict.md](./use-sys-dict.md) | System dictionary | Filled |
|
||
|
|
| useWatchOnce | [use-watch-once.md](./use-watch-once.md) | One-time watcher | Filled |
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Quick Reference
|
||
|
|
|
||
|
|
### Naming Convention
|
||
|
|
- All composables prefixed with `use`
|
||
|
|
- Files: `use*.ts`
|
||
|
|
- Interfaces: `*Options`, `*Prop`, `*Column`
|
||
|
|
|
||
|
|
### Common Dependencies
|
||
|
|
- `vue` - Composition API core
|
||
|
|
- `vuex` / `pinia` - State management
|
||
|
|
- `vue-router` - Route access
|
||
|
|
- `element-plus` - UI components
|
||
|
|
- `plugs/http` - API layer
|
||
|
|
- `plugs/element` - Element Plus wrappers
|
||
|
|
|
||
|
|
### Export Pattern
|
||
|
|
All composables are re-exported from `plugs/composables/index.ts`.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
**Language**: English
|