@origen-ui/admin-cli 3.0.1 → 3.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +5 -3
- package/package.json +16 -16
- package/templates/current/clean/.agents/skills/admin-component-usage/SKILL.md +3 -4
- package/templates/current/clean/.agents/skills/admin-component-usage/references/component-directory.md +7 -45
- package/templates/current/clean/.agents/skills/build-admin-feature/references/component-selection.md +28 -24
- package/templates/current/clean/.claude/skills/admin-component-usage/SKILL.md +3 -4
- package/templates/current/clean/.claude/skills/admin-component-usage/references/component-directory.md +7 -45
- package/templates/current/clean/.claude/skills/build-admin-feature/references/component-selection.md +28 -24
- package/templates/current/clean/.codebuddy/skills/admin-component-usage/SKILL.md +3 -4
- package/templates/current/clean/.codebuddy/skills/admin-component-usage/references/component-directory.md +7 -45
- package/templates/current/clean/.codebuddy/skills/build-admin-feature/references/component-selection.md +28 -24
- package/templates/current/clean/.codex/AGENTS.md +2 -2
- package/templates/current/clean/.cursor/skills/admin-component-usage/SKILL.md +3 -4
- package/templates/current/clean/.cursor/skills/admin-component-usage/references/component-directory.md +7 -45
- package/templates/current/clean/.cursor/skills/build-admin-feature/references/component-selection.md +28 -24
- package/templates/current/clean/.env.mock +1 -1
- package/templates/current/clean/.env.production +1 -1
- package/templates/current/clean/.prettierignore +11 -0
- package/templates/current/clean/.qoder/skills/admin-component-usage/SKILL.md +3 -4
- package/templates/current/clean/.qoder/skills/admin-component-usage/references/component-directory.md +7 -45
- package/templates/current/clean/.qoder/skills/build-admin-feature/references/component-selection.md +28 -24
- package/templates/current/clean/.zcode/skills/admin-component-usage/SKILL.md +3 -4
- package/templates/current/clean/.zcode/skills/admin-component-usage/references/component-directory.md +7 -45
- package/templates/current/clean/.zcode/skills/build-admin-feature/references/component-selection.md +28 -24
- package/templates/current/clean/AGENTS.md +2 -2
- package/templates/current/clean/CHANGELOG.md +21 -0
- package/templates/current/clean/component-catalog.v2.json +15 -15
- package/templates/current/clean/docs/components/index.md +19 -19
- package/templates/current/clean/package.json +3 -3
- package/templates/current/clean/scaffold.lock.json +42 -42
- package/templates/current/clean/scripts/check-admin-scaffold.mjs +6 -15
- package/templates/current/clean/scripts/lib/admin-component-catalog.mjs +20 -21
- package/templates/current/clean/scripts/lib/admin-skill-inventory.mjs +18 -0
- package/templates/current/clean/src/store/auth.ts +1 -1
- package/templates/current/clean/src/templates/og-table.ts +0 -2
- package/templates/current/clean/tests/unit/store/auth.spec.ts +32 -0
- package/templates/current/clean/tests/unit/templates/templates.spec.ts +0 -2
- package/templates/current/examples/.agents/skills/admin-component-usage/SKILL.md +3 -4
- package/templates/current/examples/.agents/skills/admin-component-usage/references/component-directory.md +7 -45
- package/templates/current/examples/.agents/skills/build-admin-feature/references/component-selection.md +28 -24
- package/templates/current/examples/.claude/skills/admin-component-usage/SKILL.md +3 -4
- package/templates/current/examples/.claude/skills/admin-component-usage/references/component-directory.md +7 -45
- package/templates/current/examples/.claude/skills/build-admin-feature/references/component-selection.md +28 -24
- package/templates/current/examples/.codebuddy/skills/admin-component-usage/SKILL.md +3 -4
- package/templates/current/examples/.codebuddy/skills/admin-component-usage/references/component-directory.md +7 -45
- package/templates/current/examples/.codebuddy/skills/build-admin-feature/references/component-selection.md +28 -24
- package/templates/current/examples/.codex/AGENTS.md +2 -2
- package/templates/current/examples/.cursor/skills/admin-component-usage/SKILL.md +3 -4
- package/templates/current/examples/.cursor/skills/admin-component-usage/references/component-directory.md +7 -45
- package/templates/current/examples/.cursor/skills/build-admin-feature/references/component-selection.md +28 -24
- package/templates/current/examples/.env.mock +1 -1
- package/templates/current/examples/.env.production +1 -1
- package/templates/current/examples/.prettierignore +11 -0
- package/templates/current/examples/.qoder/skills/admin-component-usage/SKILL.md +3 -4
- package/templates/current/examples/.qoder/skills/admin-component-usage/references/component-directory.md +7 -45
- package/templates/current/examples/.qoder/skills/build-admin-feature/references/component-selection.md +28 -24
- package/templates/current/examples/.zcode/skills/admin-component-usage/SKILL.md +3 -4
- package/templates/current/examples/.zcode/skills/admin-component-usage/references/component-directory.md +7 -45
- package/templates/current/examples/.zcode/skills/build-admin-feature/references/component-selection.md +28 -24
- package/templates/current/examples/AGENTS.md +2 -2
- package/templates/current/examples/CHANGELOG.md +21 -0
- package/templates/current/examples/component-catalog.v2.json +15 -15
- package/templates/current/examples/docs/components/index.md +19 -19
- package/templates/current/examples/package.json +3 -3
- package/templates/current/examples/scaffold.lock.json +42 -42
- package/templates/current/examples/scripts/check-admin-scaffold.mjs +6 -15
- package/templates/current/examples/scripts/lib/admin-component-catalog.mjs +20 -21
- package/templates/current/examples/scripts/lib/admin-skill-inventory.mjs +18 -0
- package/templates/current/examples/src/store/auth.ts +1 -1
- package/templates/current/examples/src/templates/og-table.ts +0 -2
- package/templates/current/examples/tests/unit/store/auth.spec.ts +32 -0
- package/templates/current/examples/tests/unit/templates/templates.spec.ts +0 -2
- package/templates/current/clean/tsconfig.node.json +0 -9
- package/templates/current/examples/tsconfig.node.json +0 -9
|
@@ -1,21 +1,21 @@
|
|
|
1
1
|
# Admin component directory
|
|
2
2
|
|
|
3
|
-
Generated from `catalog/components.v2.json
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
the published API state, while Admin usage links point to verified source
|
|
7
|
-
evidence. A component with no recorded use is available but not currently used.
|
|
3
|
+
Generated from `catalog/components.v2.json`. The UI component section contains
|
|
4
|
+
public Vue components only; non-UI runtime APIs appear separately under
|
|
5
|
+
companion capabilities. Lifecycle status describes the published API state.
|
|
8
6
|
|
|
9
7
|
<!-- component-directory:start -->
|
|
10
8
|
|
|
9
|
+
Package versions are pinned in `component-catalog.v2.json` (`packageVersions`) and intentionally omitted here so this document stays release-independent.
|
|
10
|
+
|
|
11
|
+
Integration examples live under `src/views/**` (pages) and `src/layouts/**` (workspace shell).
|
|
12
|
+
|
|
11
13
|
## dialog
|
|
12
14
|
|
|
13
|
-
- Package and version: `@origen-ui/dialog` 3.0.1.
|
|
14
15
|
- Public import: `OgDialog` from `@origen-ui/dialog`.
|
|
15
16
|
- Use when: Parent-controlled dialog UI.
|
|
16
17
|
- Lifecycle status: current.
|
|
17
18
|
- API summary: props: modelValue, ogCloseGuard, ogPresentation, ogMetadata, ogComponent, ogComponentProps, ogContentApi, ogLocale, ogConfirmHandler, ogConfirmLoading, ogLoading, ogProtectUnsaved, ogCancelable, ogErrorFeedback, ogShowFooter, ogFooter, ogDialogEvents, ogDrawerEvents; events: update:modelValue, confirm, cancel, actionError, close, closeError, closeResult, closed, confirmError, open, opened; slots: default, header, footer; exposes: open, close, confirm, complete, getPayload, registerContent, requestClose, setLoading, getSurfaceInstance.
|
|
18
|
-
- Admin usage: Available; no recorded use in this Admin project.
|
|
19
19
|
- Extension boundary: owned props: modelValue, ogCloseGuard, ogPresentation, ogMetadata, ogComponent, ogComponentProps, ogContentApi, ogLocale, ogConfirmHandler, ogConfirmLoading, ogLoading, ogProtectUnsaved, ogCancelable, ogErrorFeedback, ogShowFooter, ogFooter, ogDialogEvents, ogDrawerEvents; owned events: confirm, cancel; owned slots: default, header, footer; exposes: open, close, confirm, complete, getPayload, registerContent, requestClose, setLoading, getSurfaceInstance; Direct top-level ElDialog or ElDrawer props selected by ogPresentation.type; ogDialogEvents / ogDrawerEvents bridge non-workflow events; getSurfaceInstance.
|
|
20
20
|
- Avoid: Element Plus ElDialog in business features.
|
|
21
21
|
- Consumer skill and call guidance: [use-og-dialog](../../use-og-dialog/SKILL.md).
|
|
@@ -23,12 +23,10 @@ evidence. A component with no recorded use is available but not currently used.
|
|
|
23
23
|
|
|
24
24
|
## editor
|
|
25
25
|
|
|
26
|
-
- Package and version: `@origen-ui/editor` 3.0.1.
|
|
27
26
|
- Public import: `OgEditor, OgEditorSetup` from `@origen-ui/editor`.
|
|
28
27
|
- Use when: Rich text authoring.
|
|
29
28
|
- Lifecycle status: current.
|
|
30
29
|
- API summary: props: modelValue, ogSetup, ogToolbar, ogReadonly, ogDisabled, ogPlaceholder, ogMinHeight, ogMaxHeight, ogMaxLength, ogAutofocus, ogLocale, ogUpload, ogSanitize, ogVideoResolvers, ogLinkDialog, ogMediaDialog, ogSourceDialog; events: update:modelValue, change, ready, focus, blur, limit, uploadStart, uploadProgress, uploadSuccess, uploadError, uploadCancel, mediaRemove; slots: toolbar-prefix, toolbar-suffix, status; exposes: focus, blur, clear, getHTML, getJSON, getText, setContent, insertContent, undo, redo, isEmpty, cancelUpload, retryUpload, removeMedia.
|
|
31
|
-
- Admin usage: Available; no recorded use in this Admin project.
|
|
32
30
|
- Extension boundary: owned props: ogSetup, ogToolbar, ogReadonly, ogDisabled, ogPlaceholder, ogMinHeight, ogMaxHeight, ogMaxLength, ogAutofocus, ogLocale, ogUpload, ogSanitize, ogVideoResolvers, ogLinkDialog, ogMediaDialog, ogSourceDialog, modelValue; owned events: update:modelValue, change, ready, focus, blur, limit, uploadStart, uploadProgress, uploadSuccess, uploadError, uploadCancel, mediaRemove; owned slots: toolbar-prefix, toolbar-suffix, status; exposes: focus, blur, clear, getHTML, getJSON, getText, setContent, insertContent, undo, redo, isEmpty, cancelUpload, retryUpload, removeMedia; No single Element Plus root target. Official Select / Button / Tooltip props live under ogToolbar; Dialog / Input / Checkbox / Button props live in ogLinkDialog, ogMediaDialog, and ogSourceDialog groups; expose uses OgEditorHandle without the raw Tiptap editor.
|
|
33
31
|
- Avoid: Unsanitized HTML persistence or direct DOM insertion.
|
|
34
32
|
- Consumer skill and call guidance: [use-og-editor](../../use-og-editor/SKILL.md).
|
|
@@ -36,12 +34,10 @@ evidence. A component with no recorded use is available but not currently used.
|
|
|
36
34
|
|
|
37
35
|
## editor-viewer
|
|
38
36
|
|
|
39
|
-
- Package and version: `@origen-ui/editor` 3.0.1.
|
|
40
37
|
- Public import: `OgEditorViewer` from `@origen-ui/editor`.
|
|
41
38
|
- Use when: Readonly rich text rendering.
|
|
42
39
|
- Lifecycle status: current.
|
|
43
40
|
- API summary: props: ogContent, ogEmptyText, ogLocale, ogSanitize, ogSsrMode, ogServerSanitize.
|
|
44
|
-
- Admin usage: Available; no recorded use in this Admin project.
|
|
45
41
|
- Extension boundary: owned props: ogContent, ogEmptyText, ogLocale, ogSanitize, ogSsrMode, ogServerSanitize; Use the underlying Tiptap renderer directly when DOM-level rendering control is required.
|
|
46
42
|
- Avoid: Rendering untrusted HTML without server sanitization.
|
|
47
43
|
- Consumer skill and call guidance: [use-og-editor](../../use-og-editor/SKILL.md).
|
|
@@ -49,12 +45,10 @@ evidence. A component with no recorded use is available but not currently used.
|
|
|
49
45
|
|
|
50
46
|
## form
|
|
51
47
|
|
|
52
|
-
- Package and version: `@origen-ui/form` 3.0.1.
|
|
53
48
|
- Public import: `OgForm` from `@origen-ui/form`.
|
|
54
49
|
- Use when: Schema-driven create, edit, or readonly forms.
|
|
55
50
|
- Lifecycle status: current.
|
|
56
51
|
- API summary: props: modelValue, ogSchema, ogSectionVariant, ogAnchor, ogScrollToFirstError, ogReadonly, ogColumns, ogResponsiveColumns, ogBaselineKey, ogModelTransform, ogDirtyModelTransform, ogLocale, ogOperationContext, ogOptionsPolicy, ogSubmitOnEnter, ogPermissions, ogRendererRegistry; events: fieldChange, dirtyError, optionsError, operationError, validate, update:modelValue, submit, submitInvalid; slots: actions, *; exposes: validate, validateResult, validateField, clearValidate, focusField, getFieldMeta, getDirtyFields, getModel, getSubmitModel, isDirty, markClean, reset, resetField, clearFields, clearField, setFields, setFieldValue, getFieldValue, refreshOptions, refreshOptionsResult, formRef.
|
|
57
|
-
- Admin usage: direct: [src/views/system/user/components/UserEditorForm.vue](../../../../src/views/system/user/components/UserEditorForm.vue) (OgForm); [src/views/system/menu/components/MenuEditorForm.vue](../../../../src/views/system/menu/components/MenuEditorForm.vue) (OgForm); [src/views/system/dept/components/DepartmentEditorForm.vue](../../../../src/views/system/dept/components/DepartmentEditorForm.vue) (OgForm); [src/views/system/dict/components/DictionaryTypeEditorForm.vue](../../../../src/views/system/dict/components/DictionaryTypeEditorForm.vue) (OgForm); [src/views/system/dict/components/DictionaryDataEditorForm.vue](../../../../src/views/system/dict/components/DictionaryDataEditorForm.vue) (OgForm).
|
|
58
52
|
- Extension boundary: owned props: modelValue, ogSchema, ogSectionVariant, ogAnchor, ogScrollToFirstError, ogReadonly, ogColumns, ogResponsiveColumns, ogBaselineKey, ogModelTransform, ogDirtyModelTransform, ogLocale, ogOperationContext, ogOptionsPolicy, ogSubmitOnEnter, ogPermissions, ogRendererRegistry; owned events: fieldChange, dirtyError, optionsError, operationError, validate, update:modelValue, submit, submitInvalid; owned slots: actions, *; exposes: validate, validateResult, validateField, clearValidate, focusField, getFieldMeta, getDirtyFields, getModel, getSubmitModel, isDirty, markClean, reset, resetField, clearFields, clearField, setFields, setFieldValue, getFieldValue, refreshOptions, refreshOptionsResult; Direct top-level ElForm props; model and rules are bound by OgForm. Field targets use ogControl and ogFormItem groups; formRef exposes the native FormInstance.
|
|
59
53
|
- Avoid: Element Plus ElForm or removed legacy APIs.
|
|
60
54
|
- Consumer skill and call guidance: [use-og-form](../../use-og-form/SKILL.md).
|
|
@@ -62,12 +56,10 @@ evidence. A component with no recorded use is available but not currently used.
|
|
|
62
56
|
|
|
63
57
|
## form-table
|
|
64
58
|
|
|
65
|
-
- Package and version: `@origen-ui/form-table` 3.0.1.
|
|
66
59
|
- Public import: `OgFormTable, createOgFormTableField` from `@origen-ui/form-table`.
|
|
67
60
|
- Use when: Editable array fields and line-item forms.
|
|
68
61
|
- Lifecycle status: current.
|
|
69
62
|
- API summary: props: modelValue, rowKey, ogColumns, ogConfig, ogEditMode, ogTableEvents, ogTableSlots, ogReadonly, ogRenderDisabledGridCells, ogQueryDefaults, ogLocal, ogEditableHint, ogEditableHintText, ogShowEditModeButton, ogRowDisabled, ogDisabledHintText, ogLocale, ogFormTableLocale, ogRendererRegistry, selectionTooltip; events: update:modelValue, loadSuccess, loadError, pluginError, selectionChange, selectionScopeChange, batchJobChange, transactionConflict, sortChange, search, searchOptionsError, cellChange, filterOptionsError, rowAdd, rowRemove, operationError, update:ogEditMode; slots: search, empty, error, expand, beforeActions, actions, afterActions, overflowActions, beforeToolbar, afterToolbar, beforeTable, tableEmpty, tableAppend; exposes: getElTable, addRow, removeRow, validate, validateRows, refresh, reset, getSelectedRows, clearSelection, toggleRowSelection, toggleRowExpansion, getExpandedRows, resetColumnWidths, scrollTo, getState, applyState.
|
|
70
|
-
- Admin usage: Available; no recorded use in this Admin project.
|
|
71
63
|
- Extension boundary: owned props: modelValue, rowKey, ogColumns, ogConfig, ogEditMode, ogTableEvents, ogTableSlots, ogReadonly, ogRenderDisabledGridCells, ogQueryDefaults, ogLocal, ogEditableHint, ogEditableHintText, ogShowEditModeButton, ogRowDisabled, ogDisabledHintText, ogLocale, ogFormTableLocale, ogRendererRegistry, selectionTooltip; owned events: update:modelValue, loadSuccess, loadError, pluginError, selectionChange, selectionScopeChange, batchJobChange, transactionConflict, sortChange, search, searchOptionsError, cellChange, filterOptionsError, rowAdd, rowRemove, operationError, update:ogEditMode; owned slots: search, empty, error, expand, beforeActions, actions, afterActions, overflowActions, beforeToolbar, afterToolbar, beforeTable, tableEmpty, tableAppend; exposes: addRow, removeRow, validate, validateRows; Direct ElTable or ElTableV2 props filtered by the active ogConfig.virtual surface; ogTableEvents / ogTableSlots bridge supported native events and slots; getElTable.
|
|
72
64
|
- Avoid: Mutating parent form arrays or duplicate remote table fetching.
|
|
73
65
|
- Consumer skill and call guidance: [use-og-form-table](../../use-og-form-table/SKILL.md).
|
|
@@ -75,12 +67,10 @@ evidence. A component with no recorded use is available but not currently used.
|
|
|
75
67
|
|
|
76
68
|
## search
|
|
77
69
|
|
|
78
|
-
- Package and version: `@origen-ui/search` 3.0.1.
|
|
79
70
|
- Public import: `OgSearch` from `@origen-ui/search`.
|
|
80
71
|
- Use when: Standalone query/filter panels.
|
|
81
72
|
- Lifecycle status: current.
|
|
82
73
|
- API summary: props: modelValue, ogKeyword, ogExpanded, ogConfig, ogLoading, ogRendererRegistry, ogReset, inline, labelPosition, labelSuffix, showMessage, size, disabled, inlineMessage, statusIcon, ogPermissions, ogSubmitOnEnter, ogShowReset, ogShowToggle, ogLabelPlacement, ogControlLabelWidth, ogControlLabelStyle; events: update:modelValue, update:ogKeyword, update:ogExpanded, search, reset, validate, fieldChange, optionsError; slots: *; exposes: formRef, validate, submit, reset, getModel, getSubmitParams, setFieldValue, setFields, refreshOptions, cancelOptions, focus, getFieldError, clearErrors, isDirty, getDirtyFields.
|
|
83
|
-
- Admin usage: Available; no recorded use in this Admin project.
|
|
84
74
|
- Extension boundary: owned props: modelValue, ogKeyword, ogExpanded, ogConfig, ogRendererRegistry, ogReset, ogLoading, ogPermissions, ogSubmitOnEnter, ogShowReset, ogShowToggle, ogLabelPlacement, ogControlLabelWidth, ogControlLabelStyle; owned events: update:modelValue, update:ogKeyword, update:ogExpanded, search, reset, validate, fieldChange, optionsError; owned slots: *; exposes: submit, validate, reset, getModel, getSubmitParams, setFieldValue, setFields, refreshOptions, cancelOptions, focus, getFieldError, clearErrors, isDirty, getDirtyFields; Direct top-level ElForm props except the model bound by OgSearch; fields use ogControl: { ogType, ...nativeProps, ogEvents, ogSlots }, with field-level ogFormItem and ogFormItemSlots; omit ogControl for input, explicit controls require ogType; instance ogRendererRegistry supports custom:name without widening built-in props; custom remains the field slot; unknown renderers throw; formRef.
|
|
85
75
|
- Avoid: Owning list loading or pagination.
|
|
86
76
|
- Consumer skill and call guidance: [use-og-search](../../use-og-search/SKILL.md).
|
|
@@ -88,12 +78,10 @@ evidence. A component with no recorded use is available but not currently used.
|
|
|
88
78
|
|
|
89
79
|
## table
|
|
90
80
|
|
|
91
|
-
- Package and version: `@origen-ui/table` 3.0.1.
|
|
92
81
|
- Public import: `OgTable` from `@origen-ui/table`.
|
|
93
82
|
- Use when: Typed local or remote data tables.
|
|
94
83
|
- Lifecycle status: current.
|
|
95
84
|
- API summary: props: rowKey, ogColumns, ogDataSource, ogConfig, ogQueryDefaults, ogTableEvents, ogTableSlots, ogReadonly, ogRenderDisabledGridCells, ogOnVisibleColumnsChange, selectionTooltip; events: selectionChange, loadSuccess, loadError, operationError, pluginError, selectionScopeChange, batchJobChange, transactionConflict, sortChange, search, searchOptionsError, cellChange, filterOptionsError; slots: search, empty, error, expand, editor, beforeActions, actions, afterActions, overflowActions, beforeToolbar, afterToolbar, beforeTable, tableEmpty, tableAppend; exposes: getElTable, refresh, reset, refreshRow, clearFilterMemory, getSelectedRows, getChanges, hasChanges, discardChanges, commitChanges, clearSelection, toggleRowSelection, toggleRowExpansion, getExpandedRows, resetColumnWidths, scrollTo, getState, applyState.
|
|
96
|
-
- Admin usage: direct: [src/views/system/dict/data/pages/index.vue](../../../../src/views/system/dict/data/pages/index.vue) (OgTable).
|
|
97
85
|
- Extension boundary: owned props: rowKey, ogColumns, ogDataSource, ogConfig, ogQueryDefaults, ogTableEvents, ogTableSlots, ogReadonly, ogRenderDisabledGridCells, ogOnVisibleColumnsChange, selectionTooltip; owned events: selectionChange, loadSuccess, loadError, operationError, pluginError, selectionScopeChange, batchJobChange, transactionConflict, sortChange, search, searchOptionsError, cellChange, filterOptionsError; owned slots: search, empty, error, expand, editor, beforeActions, actions, afterActions, overflowActions, beforeToolbar, afterToolbar, beforeTable, tableEmpty, tableAppend; exposes: refresh, reset, refreshRow, clearFilterMemory, getSelectedRows, getChanges, hasChanges, discardChanges, commitChanges, clearSelection, toggleRowSelection, toggleRowExpansion, getExpandedRows, resetColumnWidths, scrollTo, getState, applyState; Direct ElTable or ElTableV2 props filtered by ogConfig.virtual.enabled; ogTableEvents / ogTableSlots bridge supported native events and slots; getElTable.
|
|
98
86
|
- Avoid: Legacy fetch/searchSchema APIs or ElTable.
|
|
99
87
|
- Consumer skill and call guidance: [use-og-table](../../use-og-table/SKILL.md).
|
|
@@ -101,12 +89,10 @@ evidence. A component with no recorded use is available but not currently used.
|
|
|
101
89
|
|
|
102
90
|
## table-local
|
|
103
91
|
|
|
104
|
-
- Package and version: `@origen-ui/table` 3.0.1.
|
|
105
92
|
- Public import: `OgTableLocal` from `@origen-ui/table`.
|
|
106
93
|
- Use when: Editable local tables embedded in a form or workflow.
|
|
107
94
|
- Lifecycle status: current.
|
|
108
95
|
- API summary: props: modelValue, rowKey, ogColumns, ogConfig, ogLocal, ogReadonly, ogTableEvents, ogTableSlots, ogRenderDisabledGridCells, ogQueryDefaults, ogOnVisibleColumnsChange, selectionTooltip; events: update:modelValue, loadSuccess, loadError, operationError, pluginError, selectionChange, selectionScopeChange, batchJobChange, transactionConflict, sortChange, search, searchOptionsError, cellChange, filterOptionsError, rowAdd, rowRemove; slots: search, empty, error, expand, editor, beforeActions, actions, afterActions, overflowActions, beforeToolbar, afterToolbar, beforeTable, tableEmpty, tableAppend; exposes: getElTable, addRow, removeRow, refresh, reset, getSelectedRows, clearSelection, toggleRowSelection, toggleRowExpansion, getExpandedRows, resetColumnWidths, scrollTo, getState, applyState.
|
|
109
|
-
- Admin usage: Available; no recorded use in this Admin project.
|
|
110
96
|
- Extension boundary: owned props: modelValue, rowKey, ogColumns, ogConfig, ogLocal, ogReadonly, ogTableEvents, ogTableSlots, ogRenderDisabledGridCells, ogQueryDefaults, ogOnVisibleColumnsChange, selectionTooltip; owned events: update:modelValue, loadSuccess, loadError, operationError, pluginError, selectionChange, selectionScopeChange, batchJobChange, transactionConflict, sortChange, search, searchOptionsError, cellChange, filterOptionsError, rowAdd, rowRemove; owned slots: search, empty, error, expand, editor, beforeActions, actions, afterActions, overflowActions, beforeToolbar, afterToolbar, beforeTable, tableEmpty, tableAppend; exposes: addRow, removeRow, refresh, reset, getSelectedRows, clearSelection, toggleRowSelection, toggleRowExpansion, getExpandedRows, resetColumnWidths, scrollTo, getState, applyState; Direct ElTable or ElTableV2 props filtered by the active ogConfig.virtual surface; ogTableEvents / ogTableSlots bridge supported native events and slots; getElTable.
|
|
111
97
|
- Avoid: Treating local rows as an implicit remote data source.
|
|
112
98
|
- Consumer skill and call guidance: [use-og-table](../../use-og-table/SKILL.md).
|
|
@@ -114,12 +100,10 @@ evidence. A component with no recorded use is available but not currently used.
|
|
|
114
100
|
|
|
115
101
|
## table-with-search
|
|
116
102
|
|
|
117
|
-
- Package and version: `@origen-ui/table-search` 3.0.1.
|
|
118
103
|
- Public import: `OgTableWithSearch` from `@origen-ui/table-search`.
|
|
119
104
|
- Use when: Remote CRUD lists with search and paging.
|
|
120
105
|
- Lifecycle status: current.
|
|
121
106
|
- API summary: props: rowKey, ogColumns, ogDataSource, ogConfig, ogQueryDefaults, ogSearch, selectionTooltip; slots: search-*, beforeActions, actions, afterActions, overflowActions, beforeToolbar, editor, empty, error, expand, afterToolbar, beforeTable, tableEmpty, tableAppend, search; exposes: getElTable, getSearchInstance, refresh, reset, refreshRow, clearFilterMemory, getSelectedRows, getChanges, hasChanges, discardChanges, commitChanges, clearSelection, toggleRowSelection, toggleRowExpansion, getExpandedRows, resetColumnWidths, scrollTo, getState, applyState.
|
|
122
|
-
- Admin usage: direct: [src/views/system/user/pages/index.vue](../../../../src/views/system/user/pages/index.vue) (OgTableWithSearch); [src/views/system/role/pages/index.vue](../../../../src/views/system/role/pages/index.vue) (OgTableWithSearch); [src/views/system/menu/pages/index.vue](../../../../src/views/system/menu/pages/index.vue) (OgTableWithSearch); [src/views/system/dept/pages/index.vue](../../../../src/views/system/dept/pages/index.vue) (OgTableWithSearch); [src/views/system/dict/pages/index.vue](../../../../src/views/system/dict/pages/index.vue) (OgTableWithSearch).
|
|
123
107
|
- Extension boundary: owned props: rowKey, ogColumns, ogDataSource, ogConfig, ogQueryDefaults, ogSearch, selectionTooltip; owned slots: search-*, beforeActions, actions, afterActions, overflowActions, beforeToolbar, editor, empty, error, expand, afterToolbar, beforeTable, tableEmpty, tableAppend, search; exposes: refresh, reset; Direct ElTable or ElTableV2 props filtered by ogConfig.virtual.enabled; ogTableEvents / ogTableSlots bridge table events and slots; ogSearch groups nested search props and events; getElTable / getSearchInstance.
|
|
124
108
|
- Avoid: Separate ad-hoc search and table state.
|
|
125
109
|
- Consumer skill and call guidance: [use-og-table](../../use-og-table/SKILL.md).
|
|
@@ -127,12 +111,10 @@ evidence. A component with no recorded use is available but not currently used.
|
|
|
127
111
|
|
|
128
112
|
## tabs
|
|
129
113
|
|
|
130
|
-
- Package and version: `@origen-ui/tabs` 3.0.1.
|
|
131
114
|
- Public import: `OgTabs` from `@origen-ui/tabs`.
|
|
132
115
|
- Use when: Page-local business tabs.
|
|
133
116
|
- Lifecycle status: current.
|
|
134
117
|
- API summary: props: modelValue, ogItems, ogVariant, ogFeatures, ogContextMenu, ogActionPolicy, ogDensity, ogRenderContent, ogReadonly, ogBusy, ogTabsEvents, ogLocale, ogMinTabWidth, ogMaxTabWidth, ogThemeColor, ogSticky, ogFinderThreshold, ogBeforeAction, ogActionHandler; events: update:modelValue, update:ogItems, actionRequest, closeRequest, refreshRequest, pinChangeRequest, reorderRequest, operationDenied, operationError, tabClick, tabChange, tabRemove; slots: default, label, tabBefore, tabAfter, status, contextMenuTop, contextMenuBottom, header, extra, empty; exposes: getNativeTabs, requestAdd, close, activate, closeScope, pin, unpin, move, moveTop, moveBottom, refresh, scrollTo, getItems.
|
|
135
|
-
- Admin usage: Available; no recorded use in this Admin project.
|
|
136
118
|
- Extension boundary: owned props: modelValue, ogItems, ogVariant, ogFeatures, ogContextMenu, ogActionPolicy, ogDensity, ogRenderContent, ogReadonly, ogBusy, ogTabsEvents, ogLocale, ogMinTabWidth, ogMaxTabWidth, ogThemeColor, ogSticky, ogFinderThreshold, ogBeforeAction, ogActionHandler; owned events: update:modelValue, update:ogItems, actionRequest, closeRequest, refreshRequest, pinChangeRequest, reorderRequest, operationDenied, operationError, tabClick, tabChange, tabRemove; owned slots: default, label, tabBefore, tabAfter, status, contextMenuTop, contextMenuBottom, header, extra, empty; exposes: close, activate, requestAdd, closeScope, pin, unpin, move, moveTop, moveBottom, refresh, scrollTo, getItems; Direct top-level ElTabs props; Og-owned model and workflow attributes are excluded; ogTabsEvents bridges native callbacks; getNativeTabs.
|
|
137
119
|
- Avoid: Using page-local tabs for route workspace state.
|
|
138
120
|
- Consumer skill and call guidance: [use-og-router-tabs](../../use-og-router-tabs/SKILL.md).
|
|
@@ -140,12 +122,10 @@ evidence. A component with no recorded use is available but not currently used.
|
|
|
140
122
|
|
|
141
123
|
## upload
|
|
142
124
|
|
|
143
|
-
- Package and version: `@origen-ui/upload` 3.0.1.
|
|
144
125
|
- Public import: `OgUpload, createXhrUploadAdapter` from `@origen-ui/upload`.
|
|
145
126
|
- Use when: Validated file uploads and URL projection.
|
|
146
127
|
- Lifecycle status: current.
|
|
147
128
|
- API summary: props: modelValue, ogAdapter, ogValueType, ogValueCodec, accept, limit, ogAutoUpload, ogBeforeUpload, ogConcurrency, ogConfirmRemove, ogDuplicate, ogLocale, ogMaxSize, ogResolveResponse, ogRetry, ogText, ogTip, ogUploadEvents, ogVariant; events: operationError, uploadSuccess, update:modelValue, change, exceed, progress, removeSuccess, validationError; slots: default, empty, file, tip; exposes: submit, clearFiles, abort, getFiles, remove, retry, validate.
|
|
148
|
-
- Admin usage: Available; no recorded use in this Admin project.
|
|
149
129
|
- Extension boundary: owned props: modelValue, ogAdapter, ogValueType, ogValueCodec, ogAutoUpload, ogBeforeUpload, ogConcurrency, ogConfirmRemove, ogDuplicate, ogLocale, ogMaxSize, ogResolveResponse, ogRetry, ogText, ogTip, ogUploadEvents, ogVariant; owned events: operationError, uploadSuccess, update:modelValue, change, exceed, progress, removeSuccess, validationError; owned slots: default, empty, file, tip; exposes: submit, clearFiles, abort, getFiles, remove, retry, validate; Allowed Element Plus Upload props use their official names at the root; transport, file-list, and lifecycle props are managed by OgUpload, with limit and showFileList exposed as controlled native options; ogUploadEvents exposes change.
|
|
150
130
|
- Avoid: Package-level transport clients or mutating internal files.
|
|
151
131
|
- Consumer skill and call guidance: [use-og-upload](../../use-og-upload/SKILL.md).
|
|
@@ -153,12 +133,10 @@ evidence. A component with no recorded use is available but not currently used.
|
|
|
153
133
|
|
|
154
134
|
## form-item
|
|
155
135
|
|
|
156
|
-
- Package and version: `@origen-ui/form` 3.0.1.
|
|
157
136
|
- Public import: `OgFormItem` from `@origen-ui/form`.
|
|
158
137
|
- Use when: A single schema-aware field needs to participate in an existing OgForm context.
|
|
159
138
|
- Lifecycle status: current.
|
|
160
139
|
- API summary: props: ogName, ogField, ogReadonly, ogLabelTip; slots: default, *.
|
|
161
|
-
- Admin usage: Available; no recorded use in this Admin project.
|
|
162
140
|
- Extension boundary: owned props: ogName, ogField, ogReadonly, ogLabelTip; owned slots: default, *; Direct top-level ElFormItem props except prop and error, which OgForm owns for field identity and validation.; Use ElFormItem directly for raw Element Plus form-item behavior outside OgForm context.
|
|
163
141
|
- Avoid: Using it as a transparent Element Plus ElFormItem replacement.
|
|
164
142
|
- Consumer skill and call guidance: [use-og-form](../../use-og-form/SKILL.md).
|
|
@@ -166,12 +144,10 @@ evidence. A component with no recorded use is available but not currently used.
|
|
|
166
144
|
|
|
167
145
|
## field-renderer
|
|
168
146
|
|
|
169
|
-
- Package and version: `@origen-ui/form` 3.0.1.
|
|
170
147
|
- Public import: `FieldRenderer` from `@origen-ui/form`.
|
|
171
148
|
- Use when: An advanced integration needs the registered OgForm control renderer.
|
|
172
149
|
- Lifecycle status: current.
|
|
173
150
|
- API summary: props: ogField, ogReadonly, ogA11y; slots: options-error.
|
|
174
|
-
- Admin usage: Available; no recorded use in this Admin project.
|
|
175
151
|
- Extension boundary: owned props: ogField, ogReadonly, ogA11y; owned slots: options-error; Use the required Element Plus control directly when the schema renderer contract is not needed.
|
|
176
152
|
- Avoid: Treating it as a general-purpose Element Plus control wrapper.
|
|
177
153
|
- Consumer skill and call guidance: [use-og-form](../../use-og-form/SKILL.md).
|
|
@@ -179,12 +155,10 @@ evidence. A component with no recorded use is available but not currently used.
|
|
|
179
155
|
|
|
180
156
|
## svg-icon
|
|
181
157
|
|
|
182
|
-
- Package and version: `@origen-ui/icons` 3.0.1.
|
|
183
158
|
- Public import: `SvgIcon` from `@origen-ui/icons`.
|
|
184
159
|
- Use when: Rendering a project SVG sprite icon.
|
|
185
160
|
- Lifecycle status: current.
|
|
186
161
|
- API summary: props: name, size, color, label.
|
|
187
|
-
- Admin usage: Available; no recorded use in this Admin project.
|
|
188
162
|
- Extension boundary: owned props: name, size, color, label.
|
|
189
163
|
- Avoid: Passing untrusted or arbitrary symbol identifiers.
|
|
190
164
|
- Consumer skill and call guidance: [style-og-origen-ui](../../style-og-origen-ui/SKILL.md).
|
|
@@ -192,12 +166,10 @@ evidence. A component with no recorded use is available but not currently used.
|
|
|
192
166
|
|
|
193
167
|
## router-view-host
|
|
194
168
|
|
|
195
|
-
- Package and version: `@origen-ui/router` 3.0.1.
|
|
196
169
|
- Public import: `RouterViewHost` from `@origen-ui/router`.
|
|
197
170
|
- Use when: Rendering a route workspace with keep-alive semantics.
|
|
198
171
|
- Lifecycle status: current.
|
|
199
172
|
- API summary: props: cacheMax.
|
|
200
|
-
- Admin usage: direct: [src/layouts/AdminLayout.vue](../../../../src/layouts/AdminLayout.vue) (RouterViewHost).
|
|
201
173
|
- Extension boundary: owned props: cacheMax; Use vue-router RouterView directly for route slots, props, or transition control not owned by the workspace host.
|
|
202
174
|
- Avoid: Using it as a transparent vue-router RouterView replacement.
|
|
203
175
|
- Consumer skill and call guidance: [use-og-router-tabs](../../use-og-router-tabs/SKILL.md).
|
|
@@ -205,12 +177,10 @@ evidence. A component with no recorded use is available but not currently used.
|
|
|
205
177
|
|
|
206
178
|
## dialog-host
|
|
207
179
|
|
|
208
|
-
- Package and version: `@origen-ui/dialog` 3.0.1.
|
|
209
180
|
- Public import: `OgDialogHost` from `@origen-ui/dialog`.
|
|
210
181
|
- Use when: Mounting manager-owned dialogs once in the application tree.
|
|
211
182
|
- Lifecycle status: current.
|
|
212
183
|
- API summary: props: manager.
|
|
213
|
-
- Admin usage: direct: [src/layouts/AdminLayout.vue](../../../../src/layouts/AdminLayout.vue) (OgDialogHost).
|
|
214
184
|
- Extension boundary: owned props: manager; Mount one host in the app tree after installing createOgDialog(), or pass a DialogManager explicitly.
|
|
215
185
|
- Avoid: Creating a second app or mounting multiple hosts for one manager.
|
|
216
186
|
- Consumer skill and call guidance: [use-og-dialog](../../use-og-dialog/SKILL.md).
|
|
@@ -218,12 +188,10 @@ evidence. A component with no recorded use is available but not currently used.
|
|
|
218
188
|
|
|
219
189
|
## router-breadcrumb
|
|
220
190
|
|
|
221
|
-
- Package and version: `@origen-ui/router` 3.0.1.
|
|
222
191
|
- Public import: `RouterBreadcrumb` from `@origen-ui/router/element-plus`.
|
|
223
192
|
- Use when: Displaying breadcrumbs derived from the active route.
|
|
224
193
|
- Lifecycle status: current.
|
|
225
194
|
- API summary: slots: default.
|
|
226
|
-
- Admin usage: direct: [src/layouts/BreadcrumbBar.vue](../../../../src/layouts/BreadcrumbBar.vue) (RouterBreadcrumb).
|
|
227
195
|
- Extension boundary: owned slots: default; Element Plus Breadcrumb props stay at the root; by default labels and links come from the active router adapter.
|
|
228
196
|
- Avoid: Hard-coding route labels when adapter metadata can provide them.
|
|
229
197
|
- Consumer skill and call guidance: [use-og-router-tabs](../../use-og-router-tabs/SKILL.md).
|
|
@@ -231,12 +199,10 @@ evidence. A component with no recorded use is available but not currently used.
|
|
|
231
199
|
|
|
232
200
|
## router-menu
|
|
233
201
|
|
|
234
|
-
- Package and version: `@origen-ui/router` 3.0.1.
|
|
235
202
|
- Public import: `RouterMenu` from `@origen-ui/router/element-plus`.
|
|
236
203
|
- Use when: Rendering adapter-backed route menus with active selection and icon resolution.
|
|
237
204
|
- Lifecycle status: current.
|
|
238
205
|
- API summary: props: ogResolveIcon, ogMenuEvents, ogNodeProps, ogNodeEvents; slots: default.
|
|
239
|
-
- Admin usage: direct: [src/layouts/SideMenu.vue](../../../../src/layouts/SideMenu.vue) (RouterMenu).
|
|
240
206
|
- Extension boundary: owned props: ogResolveIcon, ogMenuEvents, ogNodeProps, ogNodeEvents; owned slots: default; Element Plus Menu props stay at the root except adapter-owned defaultActive; native callbacks use ogMenuEvents, and per-node props/events use ogNodeProps and ogNodeEvents.
|
|
241
207
|
- Avoid: Trusting backend import paths or duplicating menu authorization in the view.
|
|
242
208
|
- Consumer skill and call guidance: [use-og-router-tabs](../../use-og-router-tabs/SKILL.md).
|
|
@@ -244,12 +210,10 @@ evidence. A component with no recorded use is available but not currently used.
|
|
|
244
210
|
|
|
245
211
|
## router-tabs
|
|
246
212
|
|
|
247
|
-
- Package and version: `@origen-ui/router` 3.0.1.
|
|
248
213
|
- Public import: `RouterTabs` from `@origen-ui/router/tabs`.
|
|
249
214
|
- Use when: Rendering route-backed workspace tabs with route and cache behavior.
|
|
250
215
|
- Lifecycle status: current.
|
|
251
216
|
- API summary: props: ogFeatures, ogLocale, ogAddTab.
|
|
252
|
-
- Admin usage: direct: [src/layouts/WorkspaceTabs.vue](../../../../src/layouts/WorkspaceTabs.vue) (RouterTabs).
|
|
253
217
|
- Extension boundary: owned props: ogFeatures, ogLocale, ogAddTab; Element Plus Tabs props stay at the root; RouterTabs owns route-backed tab identity and activation while ogFeatures and ogAddTab configure workspace behavior.; Do not pass modelValue to control the active workspace tab; RouterTabs derives tab identity and activation from the route workspace.
|
|
254
218
|
- Avoid: Using page-local OgTabs for route workspace state.
|
|
255
219
|
- Consumer skill and call guidance: [use-og-router-tabs](../../use-og-router-tabs/SKILL.md).
|
|
@@ -259,11 +223,9 @@ evidence. A component with no recorded use is available but not currently used.
|
|
|
259
223
|
|
|
260
224
|
### dialog-manager
|
|
261
225
|
|
|
262
|
-
- Package and version: `@origen-ui/dialog` 3.0.1.
|
|
263
226
|
- Public import: `createOgDialog, useDialog` from `@origen-ui/dialog`.
|
|
264
227
|
- Use when: Awaitable or manager-owned dialog workflows.
|
|
265
228
|
- Lifecycle status: current.
|
|
266
|
-
- Admin usage: direct: [src/views/system/user/composables/useUserManagement.ts](../../../../src/views/system/user/composables/useUserManagement.ts) (useDialog); [src/views/system/menu/composables/useMenuManagement.ts](../../../../src/views/system/menu/composables/useMenuManagement.ts) (useDialog).
|
|
267
229
|
- Avoid: createApp or a global fallback manager.
|
|
268
230
|
- Consumer skill and call guidance: [use-og-dialog](../../use-og-dialog/SKILL.md).
|
|
269
231
|
|
|
@@ -2,35 +2,39 @@
|
|
|
2
2
|
|
|
3
3
|
<!-- component-catalog:start -->
|
|
4
4
|
|
|
5
|
+
Package versions are pinned in `component-catalog.v2.json` (`packageVersions`) and intentionally omitted here so this document stays release-independent.
|
|
6
|
+
|
|
7
|
+
Integration examples live under `src/views/**` (pages) and `src/layouts/**` (workspace shell).
|
|
8
|
+
|
|
5
9
|
## UI components
|
|
6
10
|
|
|
7
|
-
| Use case | Public import | Skill |
|
|
8
|
-
| ------------------------------------------------------------------------------ | -------------------------------------------------------------------- | ------------------------------------------------------- |
|
|
9
|
-
| Parent-controlled dialog UI | `OgDialog` from `@origen-ui/dialog` | [use-og-dialog](../../use-og-dialog/SKILL.md) |
|
|
10
|
-
| Rich text authoring | `OgEditor`, `OgEditorSetup` from `@origen-ui/editor` | [use-og-editor](../../use-og-editor/SKILL.md) |
|
|
11
|
-
| Readonly rich text rendering | `OgEditorViewer` from `@origen-ui/editor` | [use-og-editor](../../use-og-editor/SKILL.md) |
|
|
12
|
-
| Schema-driven create, edit, or readonly forms | `OgForm` from `@origen-ui/form` | [use-og-form](../../use-og-form/SKILL.md) |
|
|
13
|
-
| Editable array fields and line-item forms | `OgFormTable`, `createOgFormTableField` from `@origen-ui/form-table` | [use-og-form-table](../../use-og-form-table/SKILL.md) |
|
|
14
|
-
| Standalone query/filter panels | `OgSearch` from `@origen-ui/search` | [use-og-search](../../use-og-search/SKILL.md) |
|
|
15
|
-
| Typed local or remote data tables | `OgTable` from `@origen-ui/table` | [use-og-table](../../use-og-table/SKILL.md) |
|
|
16
|
-
| Editable local tables embedded in a form or workflow | `OgTableLocal` from `@origen-ui/table` | [use-og-table](../../use-og-table/SKILL.md) |
|
|
17
|
-
| Remote CRUD lists with search and paging | `OgTableWithSearch` from `@origen-ui/table-search` | [use-og-table](../../use-og-table/SKILL.md) |
|
|
18
|
-
| Page-local business tabs | `OgTabs` from `@origen-ui/tabs` | [use-og-router-tabs](../../use-og-router-tabs/SKILL.md) |
|
|
19
|
-
| Validated file uploads and URL projection | `OgUpload`, `createXhrUploadAdapter` from `@origen-ui/upload` | [use-og-upload](../../use-og-upload/SKILL.md) |
|
|
20
|
-
| A single schema-aware field needs to participate in an existing OgForm context | `OgFormItem` from `@origen-ui/form` | [use-og-form](../../use-og-form/SKILL.md) |
|
|
21
|
-
| An advanced integration needs the registered OgForm control renderer | `FieldRenderer` from `@origen-ui/form` | [use-og-form](../../use-og-form/SKILL.md) |
|
|
22
|
-
| Rendering a project SVG sprite icon | `SvgIcon` from `@origen-ui/icons` | [style-og-origen-ui](../../style-og-origen-ui/SKILL.md) |
|
|
23
|
-
| Rendering a route workspace with keep-alive semantics | `RouterViewHost` from `@origen-ui/router` | [use-og-router-tabs](../../use-og-router-tabs/SKILL.md) |
|
|
24
|
-
| Mounting manager-owned dialogs once in the application tree | `OgDialogHost` from `@origen-ui/dialog` | [use-og-dialog](../../use-og-dialog/SKILL.md) |
|
|
25
|
-
| Displaying breadcrumbs derived from the active route | `RouterBreadcrumb` from `@origen-ui/router/element-plus` | [use-og-router-tabs](../../use-og-router-tabs/SKILL.md) |
|
|
26
|
-
| Rendering adapter-backed route menus with active selection and icon resolution | `RouterMenu` from `@origen-ui/router/element-plus` | [use-og-router-tabs](../../use-og-router-tabs/SKILL.md) |
|
|
27
|
-
| Rendering route-backed workspace tabs with route and cache behavior | `RouterTabs` from `@origen-ui/router/tabs` | [use-og-router-tabs](../../use-og-router-tabs/SKILL.md) |
|
|
11
|
+
| Use case | Public import | Skill | Extension surface | Avoid | Lifecycle |
|
|
12
|
+
| ------------------------------------------------------------------------------ | -------------------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------- |
|
|
13
|
+
| Parent-controlled dialog UI | `OgDialog` from `@origen-ui/dialog` | [use-og-dialog](../../use-og-dialog/SKILL.md) | owned props: modelValue, ogCloseGuard, ogPresentation, ogMetadata, ogComponent, ogComponentProps, ogContentApi, ogLocale, ogConfirmHandler, ogConfirmLoading, ogLoading, ogProtectUnsaved, ogCancelable, ogErrorFeedback, ogShowFooter, ogFooter, ogDialogEvents, ogDrawerEvents; owned events: confirm, cancel; owned slots: default, header, footer; exposes: open, close, confirm, complete, getPayload, registerContent, requestClose, setLoading, getSurfaceInstance; Direct top-level ElDialog or ElDrawer props selected by ogPresentation.type; ogDialogEvents / ogDrawerEvents bridge non-workflow events; getSurfaceInstance. | Element Plus ElDialog in business features | current |
|
|
14
|
+
| Rich text authoring | `OgEditor`, `OgEditorSetup` from `@origen-ui/editor` | [use-og-editor](../../use-og-editor/SKILL.md) | owned props: ogSetup, ogToolbar, ogReadonly, ogDisabled, ogPlaceholder, ogMinHeight, ogMaxHeight, ogMaxLength, ogAutofocus, ogLocale, ogUpload, ogSanitize, ogVideoResolvers, ogLinkDialog, ogMediaDialog, ogSourceDialog, modelValue; owned events: update:modelValue, change, ready, focus, blur, limit, uploadStart, uploadProgress, uploadSuccess, uploadError, uploadCancel, mediaRemove; owned slots: toolbar-prefix, toolbar-suffix, status; exposes: focus, blur, clear, getHTML, getJSON, getText, setContent, insertContent, undo, redo, isEmpty, cancelUpload, retryUpload, removeMedia; No single Element Plus root target. Official Select / Button / Tooltip props live under ogToolbar; Dialog / Input / Checkbox / Button props live in ogLinkDialog, ogMediaDialog, and ogSourceDialog groups; expose uses OgEditorHandle without the raw Tiptap editor. | Unsanitized HTML persistence or direct DOM insertion | current |
|
|
15
|
+
| Readonly rich text rendering | `OgEditorViewer` from `@origen-ui/editor` | [use-og-editor](../../use-og-editor/SKILL.md) | owned props: ogContent, ogEmptyText, ogLocale, ogSanitize, ogSsrMode, ogServerSanitize; Use the underlying Tiptap renderer directly when DOM-level rendering control is required. | Rendering untrusted HTML without server sanitization | current |
|
|
16
|
+
| Schema-driven create, edit, or readonly forms | `OgForm` from `@origen-ui/form` | [use-og-form](../../use-og-form/SKILL.md) | owned props: modelValue, ogSchema, ogSectionVariant, ogAnchor, ogScrollToFirstError, ogReadonly, ogColumns, ogResponsiveColumns, ogBaselineKey, ogModelTransform, ogDirtyModelTransform, ogLocale, ogOperationContext, ogOptionsPolicy, ogSubmitOnEnter, ogPermissions, ogRendererRegistry; owned events: fieldChange, dirtyError, optionsError, operationError, validate, update:modelValue, submit, submitInvalid; owned slots: actions, *; exposes: validate, validateResult, validateField, clearValidate, focusField, getFieldMeta, getDirtyFields, getModel, getSubmitModel, isDirty, markClean, reset, resetField, clearFields, clearField, setFields, setFieldValue, getFieldValue, refreshOptions, refreshOptionsResult; Direct top-level ElForm props; model and rules are bound by OgForm. Field targets use ogControl and ogFormItem groups; formRef exposes the native FormInstance. | Element Plus ElForm or removed legacy APIs | current |
|
|
17
|
+
| Editable array fields and line-item forms | `OgFormTable`, `createOgFormTableField` from `@origen-ui/form-table` | [use-og-form-table](../../use-og-form-table/SKILL.md) | owned props: modelValue, rowKey, ogColumns, ogConfig, ogEditMode, ogTableEvents, ogTableSlots, ogReadonly, ogRenderDisabledGridCells, ogQueryDefaults, ogLocal, ogEditableHint, ogEditableHintText, ogShowEditModeButton, ogRowDisabled, ogDisabledHintText, ogLocale, ogFormTableLocale, ogRendererRegistry, selectionTooltip; owned events: update:modelValue, loadSuccess, loadError, pluginError, selectionChange, selectionScopeChange, batchJobChange, transactionConflict, sortChange, search, searchOptionsError, cellChange, filterOptionsError, rowAdd, rowRemove, operationError, update:ogEditMode; owned slots: search, empty, error, expand, beforeActions, actions, afterActions, overflowActions, beforeToolbar, afterToolbar, beforeTable, tableEmpty, tableAppend; exposes: addRow, removeRow, validate, validateRows; Direct ElTable or ElTableV2 props filtered by the active ogConfig.virtual surface; ogTableEvents / ogTableSlots bridge supported native events and slots; getElTable. | Mutating parent form arrays or duplicate remote table fetching | current |
|
|
18
|
+
| Standalone query/filter panels | `OgSearch` from `@origen-ui/search` | [use-og-search](../../use-og-search/SKILL.md) | owned props: modelValue, ogKeyword, ogExpanded, ogConfig, ogRendererRegistry, ogReset, ogLoading, ogPermissions, ogSubmitOnEnter, ogShowReset, ogShowToggle, ogLabelPlacement, ogControlLabelWidth, ogControlLabelStyle; owned events: update:modelValue, update:ogKeyword, update:ogExpanded, search, reset, validate, fieldChange, optionsError; owned slots: *; exposes: submit, validate, reset, getModel, getSubmitParams, setFieldValue, setFields, refreshOptions, cancelOptions, focus, getFieldError, clearErrors, isDirty, getDirtyFields; Direct top-level ElForm props except the model bound by OgSearch; fields use ogControl: { ogType, ...nativeProps, ogEvents, ogSlots }, with field-level ogFormItem and ogFormItemSlots; omit ogControl for input, explicit controls require ogType; instance ogRendererRegistry supports custom:name without widening built-in props; custom remains the field slot; unknown renderers throw; formRef. | Owning list loading or pagination | current |
|
|
19
|
+
| Typed local or remote data tables | `OgTable` from `@origen-ui/table` | [use-og-table](../../use-og-table/SKILL.md) | owned props: rowKey, ogColumns, ogDataSource, ogConfig, ogQueryDefaults, ogTableEvents, ogTableSlots, ogReadonly, ogRenderDisabledGridCells, ogOnVisibleColumnsChange, selectionTooltip; owned events: selectionChange, loadSuccess, loadError, operationError, pluginError, selectionScopeChange, batchJobChange, transactionConflict, sortChange, search, searchOptionsError, cellChange, filterOptionsError; owned slots: search, empty, error, expand, editor, beforeActions, actions, afterActions, overflowActions, beforeToolbar, afterToolbar, beforeTable, tableEmpty, tableAppend; exposes: refresh, reset, refreshRow, clearFilterMemory, getSelectedRows, getChanges, hasChanges, discardChanges, commitChanges, clearSelection, toggleRowSelection, toggleRowExpansion, getExpandedRows, resetColumnWidths, scrollTo, getState, applyState; Direct ElTable or ElTableV2 props filtered by ogConfig.virtual.enabled; ogTableEvents / ogTableSlots bridge supported native events and slots; getElTable. | Legacy fetch/searchSchema APIs or ElTable | current |
|
|
20
|
+
| Editable local tables embedded in a form or workflow | `OgTableLocal` from `@origen-ui/table` | [use-og-table](../../use-og-table/SKILL.md) | owned props: modelValue, rowKey, ogColumns, ogConfig, ogLocal, ogReadonly, ogTableEvents, ogTableSlots, ogRenderDisabledGridCells, ogQueryDefaults, ogOnVisibleColumnsChange, selectionTooltip; owned events: update:modelValue, loadSuccess, loadError, operationError, pluginError, selectionChange, selectionScopeChange, batchJobChange, transactionConflict, sortChange, search, searchOptionsError, cellChange, filterOptionsError, rowAdd, rowRemove; owned slots: search, empty, error, expand, editor, beforeActions, actions, afterActions, overflowActions, beforeToolbar, afterToolbar, beforeTable, tableEmpty, tableAppend; exposes: addRow, removeRow, refresh, reset, getSelectedRows, clearSelection, toggleRowSelection, toggleRowExpansion, getExpandedRows, resetColumnWidths, scrollTo, getState, applyState; Direct ElTable or ElTableV2 props filtered by the active ogConfig.virtual surface; ogTableEvents / ogTableSlots bridge supported native events and slots; getElTable. | Treating local rows as an implicit remote data source | current |
|
|
21
|
+
| Remote CRUD lists with search and paging | `OgTableWithSearch` from `@origen-ui/table-search` | [use-og-table](../../use-og-table/SKILL.md) | owned props: rowKey, ogColumns, ogDataSource, ogConfig, ogQueryDefaults, ogSearch, selectionTooltip; owned slots: search-*, beforeActions, actions, afterActions, overflowActions, beforeToolbar, editor, empty, error, expand, afterToolbar, beforeTable, tableEmpty, tableAppend, search; exposes: refresh, reset; Direct ElTable or ElTableV2 props filtered by ogConfig.virtual.enabled; ogTableEvents / ogTableSlots bridge table events and slots; ogSearch groups nested search props and events; getElTable / getSearchInstance. | Separate ad-hoc search and table state | current |
|
|
22
|
+
| Page-local business tabs | `OgTabs` from `@origen-ui/tabs` | [use-og-router-tabs](../../use-og-router-tabs/SKILL.md) | owned props: modelValue, ogItems, ogVariant, ogFeatures, ogContextMenu, ogActionPolicy, ogDensity, ogRenderContent, ogReadonly, ogBusy, ogTabsEvents, ogLocale, ogMinTabWidth, ogMaxTabWidth, ogThemeColor, ogSticky, ogFinderThreshold, ogBeforeAction, ogActionHandler; owned events: update:modelValue, update:ogItems, actionRequest, closeRequest, refreshRequest, pinChangeRequest, reorderRequest, operationDenied, operationError, tabClick, tabChange, tabRemove; owned slots: default, label, tabBefore, tabAfter, status, contextMenuTop, contextMenuBottom, header, extra, empty; exposes: close, activate, requestAdd, closeScope, pin, unpin, move, moveTop, moveBottom, refresh, scrollTo, getItems; Direct top-level ElTabs props; Og-owned model and workflow attributes are excluded; ogTabsEvents bridges native callbacks; getNativeTabs. | Using page-local tabs for route workspace state | current |
|
|
23
|
+
| Validated file uploads and URL projection | `OgUpload`, `createXhrUploadAdapter` from `@origen-ui/upload` | [use-og-upload](../../use-og-upload/SKILL.md) | owned props: modelValue, ogAdapter, ogValueType, ogValueCodec, ogAutoUpload, ogBeforeUpload, ogConcurrency, ogConfirmRemove, ogDuplicate, ogLocale, ogMaxSize, ogResolveResponse, ogRetry, ogText, ogTip, ogUploadEvents, ogVariant; owned events: operationError, uploadSuccess, update:modelValue, change, exceed, progress, removeSuccess, validationError; owned slots: default, empty, file, tip; exposes: submit, clearFiles, abort, getFiles, remove, retry, validate; Allowed Element Plus Upload props use their official names at the root; transport, file-list, and lifecycle props are managed by OgUpload, with limit and showFileList exposed as controlled native options; ogUploadEvents exposes change. | Package-level transport clients or mutating internal files | current |
|
|
24
|
+
| A single schema-aware field needs to participate in an existing OgForm context | `OgFormItem` from `@origen-ui/form` | [use-og-form](../../use-og-form/SKILL.md) | owned props: ogName, ogField, ogReadonly, ogLabelTip; owned slots: default, *; Direct top-level ElFormItem props except prop and error, which OgForm owns for field identity and validation.; Use ElFormItem directly for raw Element Plus form-item behavior outside OgForm context. | Using it as a transparent Element Plus ElFormItem replacement | current |
|
|
25
|
+
| An advanced integration needs the registered OgForm control renderer | `FieldRenderer` from `@origen-ui/form` | [use-og-form](../../use-og-form/SKILL.md) | owned props: ogField, ogReadonly, ogA11y; owned slots: options-error; Use the required Element Plus control directly when the schema renderer contract is not needed. | Treating it as a general-purpose Element Plus control wrapper | current |
|
|
26
|
+
| Rendering a project SVG sprite icon | `SvgIcon` from `@origen-ui/icons` | [style-og-origen-ui](../../style-og-origen-ui/SKILL.md) | owned props: name, size, color, label | Passing untrusted or arbitrary symbol identifiers | current |
|
|
27
|
+
| Rendering a route workspace with keep-alive semantics | `RouterViewHost` from `@origen-ui/router` | [use-og-router-tabs](../../use-og-router-tabs/SKILL.md) | owned props: cacheMax; Use vue-router RouterView directly for route slots, props, or transition control not owned by the workspace host. | Using it as a transparent vue-router RouterView replacement | current |
|
|
28
|
+
| Mounting manager-owned dialogs once in the application tree | `OgDialogHost` from `@origen-ui/dialog` | [use-og-dialog](../../use-og-dialog/SKILL.md) | owned props: manager; Mount one host in the app tree after installing createOgDialog(), or pass a DialogManager explicitly. | Creating a second app or mounting multiple hosts for one manager | current |
|
|
29
|
+
| Displaying breadcrumbs derived from the active route | `RouterBreadcrumb` from `@origen-ui/router/element-plus` | [use-og-router-tabs](../../use-og-router-tabs/SKILL.md) | owned slots: default; Element Plus Breadcrumb props stay at the root; by default labels and links come from the active router adapter. | Hard-coding route labels when adapter metadata can provide them | current |
|
|
30
|
+
| Rendering adapter-backed route menus with active selection and icon resolution | `RouterMenu` from `@origen-ui/router/element-plus` | [use-og-router-tabs](../../use-og-router-tabs/SKILL.md) | owned props: ogResolveIcon, ogMenuEvents, ogNodeProps, ogNodeEvents; owned slots: default; Element Plus Menu props stay at the root except adapter-owned defaultActive; native callbacks use ogMenuEvents, and per-node props/events use ogNodeProps and ogNodeEvents. | Trusting backend import paths or duplicating menu authorization in the view | current |
|
|
31
|
+
| Rendering route-backed workspace tabs with route and cache behavior | `RouterTabs` from `@origen-ui/router/tabs` | [use-og-router-tabs](../../use-og-router-tabs/SKILL.md) | owned props: ogFeatures, ogLocale, ogAddTab; Element Plus Tabs props stay at the root; RouterTabs owns route-backed tab identity and activation while ogFeatures and ogAddTab configure workspace behavior.; Do not pass modelValue to control the active workspace tab; RouterTabs derives tab identity and activation from the route workspace. | Using page-local OgTabs for route workspace state | current |
|
|
28
32
|
|
|
29
33
|
## Companion capabilities
|
|
30
34
|
|
|
31
|
-
| Capability | Public import | Skill |
|
|
32
|
-
| ------------------------------------------- | ---------------------------------------------------- | --------------------------------------------- |
|
|
33
|
-
| Awaitable or manager-owned dialog workflows | `createOgDialog, useDialog` from `@origen-ui/dialog` | [use-og-dialog](../../use-og-dialog/SKILL.md) |
|
|
35
|
+
| Capability | Public import | Skill | Avoid | Lifecycle |
|
|
36
|
+
| ------------------------------------------- | ---------------------------------------------------- | --------------------------------------------- | -------------------------------------- | --------- |
|
|
37
|
+
| Awaitable or manager-owned dialog workflows | `createOgDialog, useDialog` from `@origen-ui/dialog` | [use-og-dialog](../../use-og-dialog/SKILL.md) | createApp or a global fallback manager | current |
|
|
34
38
|
|
|
35
39
|
<!-- component-catalog:end -->
|
|
36
40
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: admin-component-usage
|
|
3
|
-
description: Discover @origen-ui components for Admin work, including
|
|
3
|
+
description: Discover @origen-ui components for Admin work, including import paths, API surfaces, constraints, and supported extension points.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# Admin component usage
|
|
@@ -8,9 +8,8 @@ description: Discover @origen-ui components for Admin work, including current Ad
|
|
|
8
8
|
Use this skill when selecting or integrating an @origen-ui component or
|
|
9
9
|
companion runtime capability in the standalone Admin scaffold. Start with
|
|
10
10
|
`references/component-directory.md` to find the public import, lifecycle state,
|
|
11
|
-
core API, extension boundary
|
|
12
|
-
|
|
13
|
-
Use
|
|
11
|
+
core API, and extension boundary. UI components and non-UI companion
|
|
12
|
+
capabilities are listed in separate sections. Use
|
|
14
13
|
`../build-admin-feature/references/component-selection.md` to compare components
|
|
15
14
|
by task, then read the matching `use-og-*` skill for workflow-specific
|
|
16
15
|
constraints.
|