@opentiny/genui-sdk-materials-vue-element-plus
v1.3.0
Published
GenUI Vue materials package based on Element Plus
Downloads
937
Maintainers
Readme
@opentiny/genui-sdk-materials-vue-element-plus
A GenUI Vue materials package based on Element Plus, for schema-driven page generation and rendering.
Install
npm install @opentiny/genui-sdk-materials-vue-element-plus element-plus vuePeer dependencies vue and element-plus must also be installed.
Quick Start
Frontend Rendering
Import Element Plus styles at the app entry, and inject materials via ConfigProvider:
import 'element-plus/dist/index.css';
import { GenuiConfigProvider, GenuiChat } from '@opentiny/genui-sdk-vue';
import { materials } from '@opentiny/genui-sdk-materials-vue-element-plus/materials';<GenuiConfigProvider :materials="materials">
<GenuiChat />
</GenuiConfigProvider>Generate LLM Prompt (Server)
import { genPrompt } from '@opentiny/genui-sdk-core';
import { materialsMeta } from '@opentiny/genui-sdk-materials-vue-element-plus/meta';
const systemPrompt = genPrompt('Vue', materialsMeta, customConfig);materialsMeta.wrapperComponent defaults to ElCard.
API
| Export Path | Exports | Description |
|-------------|---------|-------------|
| @opentiny/genui-sdk-materials-vue-element-plus | materials, materialsMeta | Unified entry |
| .../materials | materials | Inject into ConfigProvider for schema rendering |
| .../meta | materialsMeta | For genPrompt() / building the server system prompt |
materials
Component registry mapping Element Plus components, used by the renderer to resolve nodes by componentName.
materialsMeta
Materials metadata, including:
materials: Protocol descriptions for components / blocks / snippetswrapperComponent: Default wrapper component (ElCard)whiteList: Whitelist ofcomponentNamevalues available to the LLMexamples: Prompt example schemas (form / info / table)rules: Extra constraint rules
Component library: element-plus.
More
For package development, local demos, and extending components, see CONTRIBUTING.md.
