使用实例 API

usePtah()

usePtah 是用于获取和操作 ptah 实例的函数，主要用于在 Vue 组件中创建并管理 ptah 实例的生命周期。该函数能够帮助你初始化和配置低代码平台的实例。

参数说明

• id: (必填) 唯一标识 ptah 实例的 ID，通常用来区分不同的应用或页面。每个 ptah 实例都需要一个唯一的 ID。
• isProd: (可选) 用于指定当前环境是否为生产环境。默认为 false，如果设置为 true，则该实例会在生产环境下进行配置。
• schema: (可选) 用于初始化页面的数据，通常是一个 JSON 对象，包含了页面或应用的结构。该参数可以让你直接传入初始数据，从而进行页面渲染。

使用示例

基本用法

import { usePtah } from '@ptahjs/creative-vue';

const ptahInstance = usePtah({
    id: 've1', // 唯一的实例 ID
    isProd: false // 设置为开发环境
    // schema: pageJson  // 可选，传入页面结构数据
});

与 <Provider> 组件一起使用

在 Vue 中，usePtah() 必须和 <Provider> 组件一起使用。<Provider> 组件用于接收和管理 ptah 实例，确保你能在整个应用中使用这个实例。

<template>
    <!-- 将 ptah 实例传递给 Provider 组件 -->
    <Provider :app="ptahInstance">
        <!-- 其他组件或内容 -->
    </Provider>
</template>

<script>
import { usePtah } from '@ptahjs/creative-vue';

// 创建 ptah 实例
const ptahInstance = usePtah({
    id: 'app-1',
    isProd: false // 开发环境
    // schema: pageJson  // 初始化数据
});

// 模拟异步获取数据并更新 schema
setTimeout(() => {
    ptahInstance.schema(pageJson); // 页面结构数据
}, 3000);
</script>

使用场景

• 初始化应用: usePtah 允许你为每个页面或应用实例提供独立的 ID 和配置，帮助你在多页面或多应用的情况下进行管理。
• 环境区分: isProd 参数能根据环境自动配置，方便你在开发和生产环境下切换不同的配置。
• 异步数据处理: 你可以在应用加载后通过 schema 更新页面内容，支持异步加载和动态更新。

注意事项

1. ID 唯一性: 确保每个 ptah 实例的 id 唯一，以避免冲突。
2. Provider 配置: 使用 usePtah 创建实例时，必须确保其包装在 <Provider> 组件中，否则无法正常使用。
3. 异步数据更新: 如果需要动态更新页面结构，可以通过 ptahInstance.schema() 方法来进行异步更新。