pb-sxp-ui 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 ChatLabs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,111 @@
+<!--
+ * @Author       : haocanweng@chatlabs.cn
+ * @Date         : 2023-08-23 18:25:31
+ * @LastEditors: binruan@chatlabs.com
+ * @LastEditTime: 2023-10-17 17:26:31
+ * @FilePath: \pb-sxp-ui\README.md
+-->
+<h1 align="center">Page Builder UI</h1>
+
+<div align="center">
+React enterprise-class UI components
+</div>
+
+## 📦 安装
+
+```bash
+npm install pb-sxp-ui
+# or
+yarn add pb-sxp-ui
+```
+
+## 🔨 使用
+以 Next.js 框架为例子：
+
+```jsx
+import { GetServerSideProps } from 'next';
+import React, { FC } from 'react'
+import Pagebuilder, { PageView } from 'pb-sxp-ui';
+
+// 初始化 PageBuilder 配置
+Pagebuilder.init({
+  tenantId: 'xxxxxxxxxx',
+  appId: 'xxxxxxxxx',
+  env: 'live' // 可选参数，默认是 live 环境
+});
+
+
+interface IProps {
+  path: string;
+  data: any
+}
+
+const ContentPage: FC<IProps> = ({ data ,path}) => {
+  return (
+    <PageView data={data?.data} isSsr path={path}/>
+  )
+}
+
+export const getServerSideProps: GetServerSideProps<IProps> = async (
+  context
+) => {
+  // 接收传来的路径
+  const path = context.query.path as string;
+  // 获取页面数据
+  const result = await Pagebuilder.getDetail(path)
+  return {
+    props: {
+      path,
+      data: result.data
+    },
+  };
+};
+
+export default ContentPage;
+
+```
+
+## ⌨️ 本地调试
+
+### 运行开发环境
+
+```bash
+$ npm install
+$ npm run start
+```
+
+### 生成本地开发全局链接
+
+```bash
+npm link
+# or
+yarn link
+```
+
+### 在使用该包的项目中安装调试
+
+```bash
+npm link pb-sxp-ui
+# or
+yarn link pb-sxp-ui
+```
+
+## 👾 发布
+
+### 打包线上安装包
+
+```bash
+npm run package
+# or
+yarn package
+```
+
+### 发布 npm
+
+```bash
+$ npm version patch|minor|major
+$ npm publish
+
+# 自动化发布包
+$ npm run pub patch|minor|major|xx.xx.xx
+```