mirror of
https://github.com/NetEase/tango.git
synced 2026-09-01 04:19:05 +08:00
Compare commits
41 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 6e273ae06e | |||
| a6758c905f | |||
| 704672399d | |||
| 439e0f0299 | |||
| 7f95dfe4ab | |||
| 63dca2a9b7 | |||
| eaff3604f3 | |||
| 5b121939e6 | |||
| 62b39daf7e | |||
| 32962d47fb | |||
| d5e42c93bb | |||
| fc93f4424a | |||
| d6a08eecd2 | |||
| 181bfee2d2 | |||
| 8fd085d4fd | |||
| 35e258b32a | |||
| 62d403f80a | |||
| 73aded3672 | |||
| 8c07821d93 | |||
| 765ea07cd5 | |||
| a27c241d9c | |||
| 4d6b67eecd | |||
| 6fc889a161 | |||
| c07b554360 | |||
| 149002dddd | |||
| 45b0d856c1 | |||
| 6fc0498901 | |||
| f2919c1aa0 | |||
| 5dd5ab62a8 | |||
| 5e7e285452 | |||
| b3a458a914 | |||
| 1acfa6864b | |||
| baf071f130 | |||
| 6b1d55a11f | |||
| a8357f45b8 | |||
| 9db6358588 | |||
| 5bc2fb2d5a | |||
| 05a0f8f490 | |||
| c884712331 | |||
| e35ff792a0 | |||
| 138cbe9b20 |
@@ -0,0 +1,49 @@
|
||||
name: CI
|
||||
# Event设置为main分支的pull request事件,
|
||||
# 这里的main分支相当于master分支,github项目新建是把main设置为默认分支,我懒得改了所以就保持这样吧
|
||||
on:
|
||||
pull_request:
|
||||
branches: main
|
||||
jobs:
|
||||
# 只需要定义一个job并命名为CI
|
||||
CI:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
# 拉取项目代码
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v2
|
||||
# 给当前环境下载node
|
||||
- name: Use Node.js
|
||||
uses: actions/setup-node@v3
|
||||
with:
|
||||
node-version: '18.x'
|
||||
# 检查缓存
|
||||
# 如果key命中缓存则直接将缓存的文件还原到 path 目录,从而减少流水线运行时间
|
||||
# 若 key 没命中缓存时,在当前Job成功完成时将自动创建一个新缓存
|
||||
- name: Cache
|
||||
# 缓存命中结果会存储在steps.[id].outputs.cache-hit里,该变量在继后的step中可读
|
||||
id: cache-dependencies
|
||||
uses: actions/cache@v3
|
||||
with:
|
||||
# 缓存文件目录的路径
|
||||
path: |
|
||||
**/node_modules
|
||||
# key中定义缓存标志位的生成方式。runner.OS指当前环境的系统。外加对yarn.lock内容生成哈希码作为key值,如果yarn.lock改变则代表依赖有变化。
|
||||
# 这里用yarn.lock而不是package.json是因为package.json中还有version和description之类的描述项目但和依赖无关的属性
|
||||
key: ${{runner.OS}}-${{hashFiles('**/yarn.lock')}}
|
||||
# 安装依赖
|
||||
- name: Installing Dependencies
|
||||
# 如果缓存标志位没命中,则执行该step。否则就跳过该step
|
||||
if: steps.cache-dependencies.outputs.cache-hit != 'true'
|
||||
run: yarn install
|
||||
# 预构建
|
||||
- name: Prebuild
|
||||
run: yarn build
|
||||
# 运行代码扫描
|
||||
- name: Running Lint
|
||||
# 通过前面章节定义的命令行执行代码扫描
|
||||
run: yarn eslint
|
||||
# 运行自动化测试
|
||||
- name: Running Test
|
||||
# 通过前面章节定义的命令行执行自动化测试
|
||||
run: yarn test
|
||||
@@ -0,0 +1,53 @@
|
||||
# Simple workflow for deploying static content to GitHub Pages
|
||||
name: Deploy static content to Pages
|
||||
|
||||
on:
|
||||
# Runs on pushes targeting the default branch
|
||||
push:
|
||||
branches: ['main', 'chore/typedoc']
|
||||
|
||||
# Allows you to run this workflow manually from the Actions tab
|
||||
workflow_dispatch:
|
||||
|
||||
# Sets the GITHUB_TOKEN permissions to allow deployment to GitHub Pages
|
||||
permissions:
|
||||
contents: read
|
||||
pages: write
|
||||
id-token: write
|
||||
|
||||
# Allow one concurrent deployment
|
||||
concurrency:
|
||||
group: 'pages'
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
# Single deploy job since we're just deploying
|
||||
deploy:
|
||||
environment:
|
||||
name: github-pages
|
||||
url: ${{ steps.deployment.outputs.page_url }}
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
- name: Set up Node
|
||||
uses: actions/setup-node@v3
|
||||
with:
|
||||
node-version: 18
|
||||
cache: 'npm'
|
||||
- name: Install dependencies
|
||||
run: yarn install
|
||||
- name: Build
|
||||
run: yarn build
|
||||
- name: Build docs
|
||||
run: yarn typedoc
|
||||
- name: Setup Pages
|
||||
uses: actions/configure-pages@v3
|
||||
- name: Upload artifact
|
||||
uses: actions/upload-pages-artifact@v2
|
||||
with:
|
||||
# Upload dist repository
|
||||
path: './docs'
|
||||
- name: Deploy to GitHub Pages
|
||||
id: deployment
|
||||
uses: actions/deploy-pages@v2
|
||||
@@ -31,32 +31,34 @@ You can view the detailed usage guide through the following links:
|
||||
- Out-of-the-box front-end low-code designer, providing flexible and easy-to-use designer React components
|
||||
- Developed using TypeScript, providing complete type definition files
|
||||
|
||||
## 🌐 Compatibility
|
||||
|
||||
- Modern browsers(Chrome >= 80, Edge >= 80, last 2 safari versions, last 2 firefox versions)
|
||||
|
||||
## 🎯 Milestone
|
||||
|
||||
```mermaid
|
||||
gantt
|
||||
dateFormat YYYY-MM-DD
|
||||
title Tango Release Milestone
|
||||
title Tango 1.0 Milestones
|
||||
excludes weekends
|
||||
%% (`excludes` accepts specific dates in YYYY-MM-DD format, days of the week ("sunday") or "weekends", but not the word "weekdays".)
|
||||
|
||||
section Builder Release
|
||||
Alpha version :active, m1, 2023-08-10, 2023-08-30
|
||||
Beta version : m2, 2023-09-01, 2023-09-30
|
||||
1.0 RC : m3, 2023-10-01, 2023-12-15
|
||||
1.0 version : m4, after m3, 10d
|
||||
1.0 Alpha : m1, 2023-10-01, 2024-01-31
|
||||
1.0 RC : m2, 2024-02-01, 2024-04-30
|
||||
1.0 Stable : m3, 2024-04-30, 2024-12-31
|
||||
```
|
||||
|
||||
> [!NOTE]
|
||||
> Alpha versions will continue to optimize some implementation protocols and continuously integrate new features from the internal version of NetEase; RC versions will provide a stable parsing protocol and implementation; The 1.0 official version is planned to be released in Q2 2024. After the release of the 1.0 official version, we will continue to iterate on versions and gradually incorporate core capabilities such as process design, component library, and AIGC from the internal version.
|
||||
|
||||
## 🌐 Compatibility
|
||||
|
||||
- Modern browsers(Chrome >= 80, Edge >= 80, last 2 safari versions, last 2 firefox versions)
|
||||
|
||||
## 💻 Development
|
||||
|
||||
### Recommended Development Environment
|
||||
### Environment
|
||||
|
||||
- Node.js >= 16.0.0
|
||||
- Yarn >= 1.22.0
|
||||
- Node `>= 18`
|
||||
- Yarn `>= 1.22 && < 2`
|
||||
|
||||
### Development Quick Start
|
||||
|
||||
|
||||
+13
-11
@@ -31,32 +31,34 @@
|
||||
- 开箱即用的前端低代码设计器,提供灵活易用的设计器 React 组件
|
||||
- 使用 TypeScript 开发,提供完整的类型定义文件
|
||||
|
||||
## 🌐 兼容环境
|
||||
|
||||
- 现代浏览器(Chrome >= 80, Edge >= 80, last 2 safari versions, last 2 firefox versions)
|
||||
|
||||
## 🎯 里程碑
|
||||
|
||||
```mermaid
|
||||
gantt
|
||||
dateFormat YYYY-MM-DD
|
||||
title Tango Release Milestone
|
||||
title Tango 1.0 Milestones
|
||||
excludes weekends
|
||||
%% (`excludes` accepts specific dates in YYYY-MM-DD format, days of the week ("sunday") or "weekends", but not the word "weekdays".)
|
||||
|
||||
section Builder Release
|
||||
Alpha version :active, m1, 2023-08-10, 2023-08-30
|
||||
Beta version : m2, 2023-09-01, 2023-09-30
|
||||
1.0 RC : m3, 2023-10-01, 2023-12-15
|
||||
1.0 version : m4, after m3, 10d
|
||||
1.0 Alpha : m1, 2023-10-01, 2024-01-31
|
||||
1.0 RC : m2, 2024-02-01, 2024-04-30
|
||||
1.0 Stable : m3, 2024-04-30, 2024-12-31
|
||||
```
|
||||
|
||||
> [!NOTE]
|
||||
> Alpha 版本会持续对一些实现协议进行优化,并持续融合网易内网版本中的新增特性;RC 版本将会提供基本稳定的解析协议和实现;1.0 正式版本计划在 2024 年Q2发布。1.0 正式版发布后我们将会持续进行版本迭代,并逐步融入内网版本中的流程设计、组件库、AIGC 等核心基础能力。
|
||||
|
||||
## 🌐 兼容环境
|
||||
|
||||
- 现代浏览器(Chrome >= 80, Edge >= 80, last 2 safari versions, last 2 firefox versions)
|
||||
|
||||
## 💻 开发
|
||||
|
||||
### 推荐开发环境
|
||||
|
||||
- Node.js >= 16.0.0
|
||||
- Yarn >= 1.22.0
|
||||
- Node `>= 18`
|
||||
- Yarn `>= 1.22 && < 2`
|
||||
|
||||
### 本地开发调试方法
|
||||
|
||||
|
||||
@@ -1,2 +0,0 @@
|
||||
PORT=6006
|
||||
HOST=local.netease.com
|
||||
@@ -0,0 +1,9 @@
|
||||
/node_modules
|
||||
/.env.local
|
||||
/.umirc.local.ts
|
||||
/config/config.local.ts
|
||||
/src/.umi
|
||||
/src/.umi-production
|
||||
/src/.umi-test
|
||||
/dist
|
||||
.swc
|
||||
@@ -1,33 +1,17 @@
|
||||
import path from 'path';
|
||||
import { defineConfig } from 'umi';
|
||||
|
||||
const resolvePackageIndex = (relativeEntry: string) =>
|
||||
path.resolve(__dirname, '../../../packages/', relativeEntry);
|
||||
path.resolve(__dirname, '../../packages/', relativeEntry);
|
||||
|
||||
export default {
|
||||
export default defineConfig({
|
||||
routes: [
|
||||
{
|
||||
exact: true,
|
||||
path: '/',
|
||||
component: 'index',
|
||||
name: '首页',
|
||||
},
|
||||
{ path: '/', component: 'index' },
|
||||
{ path: '/docs', component: 'docs' },
|
||||
],
|
||||
devServer: {
|
||||
host: 'local.netease.com',
|
||||
port: 8008,
|
||||
https: {
|
||||
key: path.resolve(__dirname, 'local.netease.com-key.pem'),
|
||||
cert: path.resolve(__dirname, 'local.netease.com.pem'),
|
||||
},
|
||||
headers: { 'Origin-Agent-Cluster': '?0' },
|
||||
},
|
||||
targets: {
|
||||
chrome: 79,
|
||||
firefox: false,
|
||||
safari: false,
|
||||
edge: false,
|
||||
ios: false,
|
||||
},
|
||||
npmClient: 'yarn',
|
||||
mfsu: false,
|
||||
codeSplitting: false,
|
||||
alias: {
|
||||
'@music163/tango-helpers': resolvePackageIndex('helpers/src/index.ts'),
|
||||
'@music163/tango-core': resolvePackageIndex('core/src/index.ts'),
|
||||
@@ -44,6 +28,21 @@ export default {
|
||||
moment: 'moment',
|
||||
antd: 'antd',
|
||||
},
|
||||
headScripts: [
|
||||
'https://cdn.jsdelivr.net/npm/react@18.2.0/umd/react.development.js',
|
||||
'https://cdn.jsdelivr.net/npm/react-dom@18.2.0/umd/react-dom.development.js',
|
||||
'https://cdn.jsdelivr.net/npm/react-is@18.2.0/umd/react-is.production.min.js',
|
||||
'https://cdn.jsdelivr.net/npm/moment/min/moment-with-locales.js',
|
||||
'https://cdn.jsdelivr.net/npm/styled-components@5.3.11/dist/styled-components.js',
|
||||
'https://cdn.jsdelivr.net/npm/antd@4.24.13/dist/antd-with-locales.min.js',
|
||||
'https://cdn.jsdelivr.net/npm/prettier@2.6.0/standalone.js',
|
||||
'https://cdn.jsdelivr.net/npm/prettier@2.6.0/parser-babel.js',
|
||||
],
|
||||
https: {
|
||||
key: path.resolve(__dirname, 'local.netease.com-key.pem'),
|
||||
cert: path.resolve(__dirname, 'local.netease.com.pem'),
|
||||
http2: false,
|
||||
},
|
||||
chainWebpack: (config: any) => {
|
||||
// @see https://github.com/graphql/graphql-js/issues/1272#issuecomment-393903706
|
||||
config.module
|
||||
@@ -61,4 +60,5 @@ export default {
|
||||
config.module.rule('js').include.add(resolvePackageIndex('ui/src'));
|
||||
return config;
|
||||
},
|
||||
};
|
||||
monorepoRedirect: {},
|
||||
});
|
||||
@@ -1,5 +0,0 @@
|
||||
# `playground`
|
||||
|
||||
搭建平台演示示例
|
||||
|
||||
## 说明
|
||||
@@ -2,24 +2,23 @@
|
||||
"name": "playground",
|
||||
"version": "0.0.0",
|
||||
"private": true,
|
||||
"description": "playground of tango-apps",
|
||||
"license": "MIT",
|
||||
"author": "wwsun <ww.sun@outlook.com>",
|
||||
"files": [
|
||||
"lib"
|
||||
],
|
||||
"author": "Wells <ww.sun@outlook.com>",
|
||||
"scripts": {
|
||||
"build": "COMPRESS=none umi build",
|
||||
"start": "umi dev"
|
||||
"dev": "HOST=local.netease.com PORT=8001 umi dev",
|
||||
"build": "umi build",
|
||||
"postinstall": "umi setup",
|
||||
"setup": "umi setup",
|
||||
"start": "npm run dev"
|
||||
},
|
||||
"dependencies": {
|
||||
"@ant-design/icons": "^4.8.0",
|
||||
"@music163/tango-designer": "*",
|
||||
"@music163/tango-helpers": "*",
|
||||
"antd": "^4.24.2",
|
||||
"coral-system": "^1.0.5"
|
||||
"coral-system": "^1.0.5",
|
||||
"umi": "^4.0.89"
|
||||
},
|
||||
"devDependencies": {
|
||||
"umi": "^3.5.24"
|
||||
"@types/react": "^18.0.33",
|
||||
"@types/react-dom": "^18.0.11",
|
||||
"typescript": "^5.0.3"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,10 @@
|
||||
import type { IApi } from 'umi';
|
||||
|
||||
export default (api: IApi) => {
|
||||
api.addMiddlewares(() => {
|
||||
return (req, res, next) => {
|
||||
res.setHeader('Origin-Agent-Cluster', '?0');
|
||||
next();
|
||||
};
|
||||
});
|
||||
};
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 177 KiB |
@@ -3,32 +3,33 @@ import { Box, Group } from 'coral-system';
|
||||
import { Avatar, Space, Switch } from 'antd';
|
||||
import { BranchesOutlined, MenuOutlined, QuestionCircleOutlined } from '@ant-design/icons';
|
||||
import { registerSetter } from '@music163/tango-designer';
|
||||
import type { ComponentPrototypeType } from '@music163/tango-helpers';
|
||||
import type { ComponentPrototypeType, IVariableTreeNode } from '@music163/tango-helpers';
|
||||
import { FooSetter } from '../components';
|
||||
|
||||
export const bootHelperVariables = [
|
||||
export * from './mock-files';
|
||||
|
||||
export const bootHelperVariables: IVariableTreeNode[] = [
|
||||
{
|
||||
key: '$helpers',
|
||||
title: '工具函数',
|
||||
children: [
|
||||
{
|
||||
title: 'setStoreValue',
|
||||
title: '设置变量值',
|
||||
key: '() => tango.setStoreValue("variableName", "variableValue")',
|
||||
type: 'function',
|
||||
help: '设置状态值,tango.setStoreValue("variableName", "variableValue")',
|
||||
},
|
||||
{
|
||||
title: 'getStoreValue',
|
||||
title: '获取变量值',
|
||||
key: '() => tango.getStoreValue("variableName")',
|
||||
type: 'function',
|
||||
help: '获取状态值',
|
||||
},
|
||||
{ title: 'openModal', key: '() => tango.openModal("")', type: 'function' },
|
||||
{ title: 'closeModal', key: '() => tango.closeModal("")', type: 'function' },
|
||||
{ title: 'navigateTo', key: '() => tango.navigateTo("/")', type: 'function' },
|
||||
{ title: 'showToast', key: '() => tango.showToast("hello")', type: 'function' },
|
||||
{ title: 'formatDate', key: '() => tango.formatDate("2022-12-12")', type: 'function' },
|
||||
{ title: 'formatNumber', key: '() => tango.formatDate(9999)', type: 'function' },
|
||||
{ title: '打开弹窗', key: '() => tango.openModal("")', type: 'function' },
|
||||
{ title: '关闭弹窗', key: '() => tango.closeModal("")', type: 'function' },
|
||||
{ title: '切换路由', key: '() => tango.navigateTo("/")', type: 'function' },
|
||||
{
|
||||
title: 'copyToClipboard',
|
||||
title: '拷贝到剪贴板',
|
||||
key: '() => tango.copyToClipboard("hello")',
|
||||
type: 'function',
|
||||
},
|
||||
@@ -75,6 +75,18 @@ const tangoConfigJson = {
|
||||
},
|
||||
};
|
||||
|
||||
const helperCode = `
|
||||
export function registerComponentPrototype(proto) {
|
||||
if (!proto) return;
|
||||
if (!window.localTangoComponentPrototypes) {
|
||||
window.localTangoComponentPrototypes = {};
|
||||
}
|
||||
if (proto.name) {
|
||||
window.localTangoComponentPrototypes[proto.name] = proto;
|
||||
}
|
||||
}
|
||||
`;
|
||||
|
||||
const routesCode = `
|
||||
import Index from "./pages/list";
|
||||
|
||||
@@ -143,6 +155,8 @@ import {
|
||||
FormilyForm,
|
||||
} from "@music163/antd";
|
||||
import { Space } from '@music163/antd';
|
||||
import { LocalButton } from '../components';
|
||||
|
||||
class App extends React.Component {
|
||||
render() {
|
||||
return (
|
||||
@@ -151,6 +165,7 @@ class App extends React.Component {
|
||||
</Section>
|
||||
<Section>
|
||||
<Space>
|
||||
<LocalButton />
|
||||
<Button>button</Button>
|
||||
<Input />
|
||||
</Space>
|
||||
@@ -159,9 +174,53 @@ class App extends React.Component {
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
export default definePage(App);
|
||||
`;
|
||||
|
||||
const componentsButtonCode = `
|
||||
import React from 'react';
|
||||
import { registerComponentPrototype } from '../utils';
|
||||
|
||||
export default function MyButton(props) {
|
||||
return <button {...props}>my button</button>
|
||||
}
|
||||
|
||||
registerComponentPrototype({
|
||||
name: 'LocalButton',
|
||||
title: 'Local Button',
|
||||
exportType: 'namedExport',
|
||||
package: '/src/components',
|
||||
props: [
|
||||
{ name: 'background', title: '背景色', setter: 'colorSetter' },
|
||||
],
|
||||
});
|
||||
`;
|
||||
|
||||
const componentsInputCode = `
|
||||
import React from 'react';
|
||||
import { registerComponentPrototype } from '../utils';
|
||||
|
||||
export default function MyInput(props) {
|
||||
return <input {...props} />;
|
||||
}
|
||||
|
||||
registerComponentPrototype({
|
||||
name: 'LocalInput',
|
||||
title: 'Local Input',
|
||||
exportType: 'namedExport',
|
||||
package: '/src/components',
|
||||
props: [
|
||||
{ name: 'color', title: '文本色', setter: 'colorSetter' },
|
||||
],
|
||||
});
|
||||
`;
|
||||
|
||||
const componentsEntryCode = `
|
||||
export { default as LocalButton } from './button';
|
||||
export { default as LocalInput } from './input';
|
||||
`;
|
||||
|
||||
const storeApp = `
|
||||
import { defineStore } from '@music163/tango-boot';
|
||||
|
||||
@@ -170,6 +229,35 @@ export default defineStore({
|
||||
title: 'Page Title',
|
||||
|
||||
array: [1, 2, 3],
|
||||
|
||||
test: function() {
|
||||
console.log('test');
|
||||
console.log('test');
|
||||
console.log('test');
|
||||
console.log('test');
|
||||
console.log('test');
|
||||
console.log('test');
|
||||
console.log('test');
|
||||
console.log('test');
|
||||
console.log('test');
|
||||
console.log('test');
|
||||
console.log('test');
|
||||
console.log('test');
|
||||
console.log('test');
|
||||
console.log('test');
|
||||
console.log('test');
|
||||
console.log('test');
|
||||
console.log('test');
|
||||
console.log('test');
|
||||
console.log('test');
|
||||
console.log('test');
|
||||
console.log('test');
|
||||
console.log('test');
|
||||
console.log('test');
|
||||
console.log('test');
|
||||
console.log('test');
|
||||
console.log('test');
|
||||
}
|
||||
}, 'app');
|
||||
`;
|
||||
|
||||
@@ -246,13 +334,16 @@ export const sampleFiles = [
|
||||
{ filename: '/src/style.css', code: cssCode },
|
||||
{ filename: '/src/index.js', code: entryCode },
|
||||
{ filename: '/src/pages/list.js', code: viewHomeCode },
|
||||
{ filename: '/src/components/button.js', code: componentsButtonCode },
|
||||
{ filename: '/src/components/input.js', code: componentsInputCode },
|
||||
{ filename: '/src/components/index.js', code: componentsEntryCode },
|
||||
{ filename: '/src/routes.js', code: routesCode },
|
||||
{ filename: '/src/stores/index.js', code: storeIndexCode },
|
||||
{ filename: '/src/stores/app.js', code: storeApp },
|
||||
{ filename: '/src/stores/counter.js', code: storeCounter },
|
||||
{ filename: '/src/services/index.js', code: serviceCode },
|
||||
{ filename: '/src/services/sub.js', code: subServiceCode },
|
||||
{ filename: '/src/utils/index.js', code: `export function foo() {}` },
|
||||
{ filename: '/src/utils/index.js', code: helperCode },
|
||||
];
|
||||
|
||||
export const genDefaultPage = (index: number) => ({
|
||||
@@ -2,4 +2,5 @@
|
||||
@import '~antd/dist/antd.less'; // 引入官方提供的 less 样式入口文件
|
||||
|
||||
@primary-color: #2f54eb;
|
||||
@border-radius-base: 2px;
|
||||
@border-radius-base: 2px;
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
import React from 'react';
|
||||
import { Outlet } from 'umi';
|
||||
import './index.less';
|
||||
|
||||
export default function Layout() {
|
||||
return (
|
||||
<div>
|
||||
<Outlet />
|
||||
</div>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,9 @@
|
||||
const DocsPage = () => {
|
||||
return (
|
||||
<div>
|
||||
<p>This is umi docs.</p>
|
||||
</div>
|
||||
);
|
||||
};
|
||||
|
||||
export default DocsPage;
|
||||
@@ -1,21 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8" />
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>Tango Playground</title>
|
||||
</head>
|
||||
<body>
|
||||
<div id="root"></div>
|
||||
<script src="https://cdn.jsdelivr.net/npm/react@16.14.0/umd/react.development.js"></script>
|
||||
<script src="https://cdn.jsdelivr.net/npm/react-dom@16.14.0/umd/react-dom.development.js"></script>
|
||||
<script src="https://cdn.jsdelivr.net/npm/react-is@16.13.1/umd/react-is.production.min.js"></script>
|
||||
<script src="https://cdn.jsdelivr.net/npm/moment/min/moment-with-locales.js"></script>
|
||||
<script src="https://cdn.jsdelivr.net/npm/styled-components@5.3.11/dist/styled-components.js"></script>
|
||||
<script src="https://cdn.jsdelivr.net/npm/@babel/standalone@7.15.6/babel.js"></script>
|
||||
<script src="https://cdn.jsdelivr.net/npm/prettier@2.6.0/standalone.js"></script>
|
||||
<script src="https://cdn.jsdelivr.net/npm/prettier@2.6.0/parser-babel.js"></script>
|
||||
<script src="https://cdn.jsdelivr.net/npm/antd@4.24.13/dist/antd-with-locales.min.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -15,15 +15,14 @@ import {
|
||||
themeLight,
|
||||
} from '@music163/tango-designer';
|
||||
import { createEngine, Workspace } from '@music163/tango-core';
|
||||
import { Logo, ProjectDetail, bootHelperVariables } from './share';
|
||||
import { sampleFiles } from '../mock/project';
|
||||
import './index.less';
|
||||
import { Logo, ProjectDetail, bootHelperVariables, sampleFiles } from '../helpers';
|
||||
import {
|
||||
ApiOutlined,
|
||||
AppstoreAddOutlined,
|
||||
BuildOutlined,
|
||||
ClusterOutlined,
|
||||
FunctionOutlined,
|
||||
createFromIconfontCN,
|
||||
} from '@ant-design/icons';
|
||||
|
||||
// 1. 实例化工作区
|
||||
@@ -35,18 +34,23 @@ const workspace = new Workspace({
|
||||
// 2. 引擎初始化
|
||||
const engine = createEngine({
|
||||
workspace,
|
||||
defaultActiveSidebarPanel: 'outline',
|
||||
});
|
||||
|
||||
// @ts-ignore
|
||||
window.__workspace__ = workspace;
|
||||
|
||||
// 3. 沙箱初始化
|
||||
const sandboxQuery = new DndQuery({
|
||||
context: 'iframe',
|
||||
});
|
||||
|
||||
// 4. 图标库初始化(物料面板和组件树使用了 iconfont 里的图标)
|
||||
createFromIconfontCN({
|
||||
scriptUrl: '//at.alicdn.com/t/c/font_2891794_lzc7rtwuzf.js',
|
||||
});
|
||||
|
||||
/**
|
||||
* 3. 平台初始化,访问 https://local.netease.com:6006/
|
||||
* 5. 平台初始化,访问 https://local.netease.com:6006/
|
||||
*/
|
||||
export default function App() {
|
||||
const [menuLoading, setMenuLoading] = useState(true);
|
||||
@@ -68,6 +72,7 @@ export default function App() {
|
||||
<Box px="l">
|
||||
<Toolbar>
|
||||
<Toolbar.Item key="routeSwitch" placement="left" />
|
||||
<Toolbar.Item key="history" placement="left" />
|
||||
<Toolbar.Item key="preview" placement="left" />
|
||||
<Toolbar.Item key="modeSwitch" placement="right" />
|
||||
<Toolbar.Item key="togglePanel" placement="right" />
|
||||
@@ -122,9 +127,13 @@ export default function App() {
|
||||
workspace.setComponentPrototypes(sandboxWindow.TangoAntd.prototypes);
|
||||
}
|
||||
}
|
||||
if (sandboxWindow.localTangoComponentPrototypes) {
|
||||
workspace.setComponentPrototypes(sandboxWindow.localTangoComponentPrototypes);
|
||||
}
|
||||
setMenuLoading(false);
|
||||
}
|
||||
}}
|
||||
navigatorExtra={<Button size="small">hello world</Button>}
|
||||
/>
|
||||
</WorkspaceView>
|
||||
<WorkspaceView mode="code">
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
{
|
||||
"extends": "../../tsconfig.json"
|
||||
"extends": "./src/.umi/tsconfig.json"
|
||||
}
|
||||
|
||||
Vendored
+1
@@ -0,0 +1 @@
|
||||
import 'umi/typings';
|
||||
@@ -16,8 +16,8 @@
|
||||
"dependencies": {
|
||||
"@music163/tango-setting-form": "*",
|
||||
"@music163/tango-ui": "*",
|
||||
"mobx": "6.9.0",
|
||||
"mobx-react-lite": "4.0.2"
|
||||
"mobx": "6.12.0",
|
||||
"mobx-react-lite": "4.0.5"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@storybook/addon-actions": "^6.5.14",
|
||||
|
||||
@@ -1,58 +1,21 @@
|
||||
import React, { useState } from 'react';
|
||||
import { EditableVariableTree, FormModel, SettingForm } from '@music163/tango-setting-form';
|
||||
import { ComponentPrototypeType, getValue } from '@music163/tango-helpers';
|
||||
import { createServices } from '@music163/request';
|
||||
import React from 'react';
|
||||
import { FormModel, SettingForm, register } from '@music163/tango-setting-form';
|
||||
import { ComponentPrototypeType } from '@music163/tango-helpers';
|
||||
import { BorderSetter } from '@music163/tango-designer/src/setters/style-setter';
|
||||
import { Box } from 'coral-system';
|
||||
import { JsonView } from '@music163/tango-ui';
|
||||
import { toJS } from 'mobx';
|
||||
import { observer } from 'mobx-react-lite';
|
||||
import { Card } from 'antd';
|
||||
|
||||
export default {
|
||||
title: 'SettingForm/ Setters',
|
||||
};
|
||||
register({
|
||||
name: 'borderSetter',
|
||||
component: BorderSetter,
|
||||
});
|
||||
|
||||
const modelVariables = [
|
||||
{
|
||||
title: 'stores',
|
||||
key: 'stores',
|
||||
selectable: false,
|
||||
children: [
|
||||
{
|
||||
title: 'app',
|
||||
key: 'stores.app',
|
||||
selectable: false,
|
||||
children: [
|
||||
{ title: 'app.title', key: 'stores.app.title', raw: '"hello"' },
|
||||
{ title: 'app.age', key: 'stores.app.age', raw: '20' },
|
||||
{ title: 'app.detail', key: 'stores.app.detail', raw: '{ foo: "foo" }' },
|
||||
{ title: 'app.list', key: 'stores.app.list', type: 'function', raw: '() => {}' },
|
||||
],
|
||||
},
|
||||
{
|
||||
title: 'user',
|
||||
key: 'stores.user',
|
||||
selectable: false,
|
||||
children: [
|
||||
{ title: 'name', key: 'stores.user.name' },
|
||||
{ title: 'age', key: 'stores.user.age' },
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
title: 'services',
|
||||
key: 'services',
|
||||
selectable: false,
|
||||
children: [
|
||||
{
|
||||
title: 'listUsers',
|
||||
key: 'services.listUsers',
|
||||
type: 'function',
|
||||
},
|
||||
],
|
||||
},
|
||||
];
|
||||
export default {
|
||||
title: 'SettingForm',
|
||||
};
|
||||
|
||||
const prototype: ComponentPrototypeType = {
|
||||
name: 'Test',
|
||||
@@ -69,6 +32,11 @@ const prototype: ComponentPrototypeType = {
|
||||
title: 'textSetter',
|
||||
setter: 'textSetter',
|
||||
},
|
||||
{
|
||||
name: 'border',
|
||||
title: 'borderSetter',
|
||||
setter: 'borderSetter',
|
||||
},
|
||||
{
|
||||
name: 'router',
|
||||
title: 'routerSetter',
|
||||
@@ -257,47 +225,6 @@ const prototype: ComponentPrototypeType = {
|
||||
],
|
||||
};
|
||||
|
||||
const deerService = createServices(
|
||||
{
|
||||
listMy: {
|
||||
url: '/my/upload/list',
|
||||
},
|
||||
listFav: {
|
||||
url: '/my/star/list',
|
||||
},
|
||||
listPub: {
|
||||
url: '/list',
|
||||
},
|
||||
},
|
||||
{
|
||||
baseURL: 'https://febase-openapi.fn.netease.com/deer/api/deer/pic',
|
||||
withCredentials: false, // 解决跨域时必须非*问题
|
||||
headers: {
|
||||
'Febase-Auth': 'dskPVkIRnQ2dEn1DbyxURmUj4rl4BsCh53xFAsJnvVs=',
|
||||
},
|
||||
},
|
||||
);
|
||||
|
||||
const context = {
|
||||
stores: {
|
||||
app: {
|
||||
title: 'Sample App',
|
||||
age: 20,
|
||||
detail: {
|
||||
foo: 'foo',
|
||||
bar: 'bar',
|
||||
biz: {
|
||||
x: 'xxx',
|
||||
},
|
||||
},
|
||||
newKey: 'xxx',
|
||||
},
|
||||
foo: {
|
||||
test: 'test string',
|
||||
},
|
||||
},
|
||||
};
|
||||
|
||||
/**
|
||||
* 表单值预览
|
||||
*/
|
||||
@@ -310,9 +237,7 @@ export function Basic() {
|
||||
const model = new FormModel(
|
||||
{
|
||||
router: 'www.163.com',
|
||||
expression: {
|
||||
foo: 'foo',
|
||||
},
|
||||
expression: `{ foo: 'foo' }`,
|
||||
object: {
|
||||
name: 'Alice',
|
||||
},
|
||||
@@ -324,19 +249,7 @@ export function Basic() {
|
||||
|
||||
return (
|
||||
<Box display="flex">
|
||||
<SettingForm
|
||||
model={model}
|
||||
remoteServices={{
|
||||
ImageService: deerService as any,
|
||||
}}
|
||||
prototype={prototype}
|
||||
evaluateContext={{
|
||||
tango: context,
|
||||
__UNSAFE_TANGO_CURRENT_PAGE_RENDER_RUNTIME__: { routeData: { params: {}, query: {} } },
|
||||
}}
|
||||
modelVariables={modelVariables}
|
||||
expressionVariables={modelVariables}
|
||||
/>
|
||||
<SettingForm model={model} prototype={prototype} />
|
||||
<Box position="relative">
|
||||
<Card title="表单状态预览" style={{ position: 'sticky', top: 0 }}>
|
||||
<FormValuePreview model={model} />
|
||||
@@ -346,6 +259,20 @@ export function Basic() {
|
||||
);
|
||||
}
|
||||
|
||||
export function Lite() {
|
||||
return (
|
||||
<Box width={320} border="solid">
|
||||
<SettingForm
|
||||
showSearch={false}
|
||||
showGroups={false}
|
||||
showItemSubtitle={false}
|
||||
prototype={prototype}
|
||||
disableSwitchExpressionSetter
|
||||
/>
|
||||
</Box>
|
||||
);
|
||||
}
|
||||
|
||||
export function NoExpressionSwitch() {
|
||||
const model = new FormModel({});
|
||||
return (
|
||||
@@ -354,30 +281,3 @@ export function NoExpressionSwitch() {
|
||||
</Box>
|
||||
);
|
||||
}
|
||||
|
||||
export function Binding() {
|
||||
const [data, setData] = useState<any>({});
|
||||
return (
|
||||
<Box>
|
||||
<Box as="code" bg="highlight" color="white" fontSize="24px">
|
||||
selected: {data?.key}
|
||||
</Box>
|
||||
<EditableVariableTree
|
||||
dataSource={modelVariables as any}
|
||||
getPreviewValue={(node) => {
|
||||
if (!node || !node.key) {
|
||||
return;
|
||||
}
|
||||
if (node.type === 'function') {
|
||||
return node.raw;
|
||||
}
|
||||
const keyPath = node.key.replaceAll('?', '');
|
||||
return getValue(context, keyPath);
|
||||
}}
|
||||
onSelect={setData}
|
||||
onAddVariable={console.log}
|
||||
onSave={console.log}
|
||||
/>
|
||||
</Box>
|
||||
);
|
||||
}
|
||||
|
||||
@@ -28,6 +28,41 @@ export function Basic() {
|
||||
);
|
||||
}
|
||||
|
||||
const code = `
|
||||
function foo() {
|
||||
console.log("test");
|
||||
console.log("test");
|
||||
console.log("test");
|
||||
console.log("test");
|
||||
console.log("test");
|
||||
console.log("test");
|
||||
console.log("test");
|
||||
console.log("test");
|
||||
console.log("test");
|
||||
console.log("test");
|
||||
console.log("test");
|
||||
console.log("test");
|
||||
console.log("test");
|
||||
console.log("test");
|
||||
console.log("test");
|
||||
console.log("test");
|
||||
console.log("test");
|
||||
console.log("test");
|
||||
console.log("test");
|
||||
console.log("test");
|
||||
console.log("test");
|
||||
console.log("test");
|
||||
console.log("test");
|
||||
console.log("test");
|
||||
console.log("test");
|
||||
console.log("test");
|
||||
}
|
||||
`;
|
||||
|
||||
export function Readonly() {
|
||||
return <InputCode shape="inset" readOnly value={code} />;
|
||||
}
|
||||
|
||||
export function Inset() {
|
||||
return <InputCode shape="inset" />;
|
||||
}
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
import React from 'react';
|
||||
import { ToggleButton, IconFont } from '@music163/tango-ui';
|
||||
import { Box, Flex } from 'coral-system';
|
||||
import { ToggleButton, UndoOutlined, RedoOutlined } from '@music163/tango-ui';
|
||||
import { Box, Group, Flex } from 'coral-system';
|
||||
|
||||
export default {
|
||||
title: 'UI/ToggleButton',
|
||||
@@ -9,28 +9,73 @@ export default {
|
||||
export function Basic() {
|
||||
return (
|
||||
<Box>
|
||||
<Flex gap="l" bg="#efefef" p="l">
|
||||
<Box display="flex" columnGap="l" p="l">
|
||||
<ToggleButton>
|
||||
<IconFont type="icon-undo" />
|
||||
<UndoOutlined />
|
||||
</ToggleButton>
|
||||
<ToggleButton selected>
|
||||
<IconFont type="icon-redo" />
|
||||
<RedoOutlined />
|
||||
</ToggleButton>
|
||||
<ToggleButton disabled>
|
||||
<IconFont type="icon-redo" />
|
||||
<RedoOutlined />
|
||||
</ToggleButton>
|
||||
</Box>
|
||||
<Box display="flex" columnGap="l" p="l">
|
||||
<ToggleButton type="primary">
|
||||
<UndoOutlined />
|
||||
</ToggleButton>
|
||||
<ToggleButton type="primary" selected>
|
||||
<RedoOutlined />
|
||||
</ToggleButton>
|
||||
<ToggleButton type="primary" disabled>
|
||||
<RedoOutlined />
|
||||
</ToggleButton>
|
||||
</Box>
|
||||
</Box>
|
||||
);
|
||||
}
|
||||
|
||||
export function DarkMode() {
|
||||
return (
|
||||
<Box>
|
||||
<Flex gap="l" bg="#222" p="l">
|
||||
<ToggleButton shape="ghost">
|
||||
<UndoOutlined />
|
||||
</ToggleButton>
|
||||
<ToggleButton shape="ghost" selected>
|
||||
<RedoOutlined />
|
||||
</ToggleButton>
|
||||
<ToggleButton shape="ghost" disabled>
|
||||
<UndoOutlined />
|
||||
</ToggleButton>
|
||||
</Flex>
|
||||
<Flex gap="l" bg="#222" p="l">
|
||||
<ToggleButton shape="ghost">
|
||||
<IconFont type="icon-undo" />
|
||||
<ToggleButton shape="text">
|
||||
<UndoOutlined />
|
||||
</ToggleButton>
|
||||
<ToggleButton shape="ghost" selected>
|
||||
<IconFont type="icon-redo" />
|
||||
<ToggleButton shape="text" selected>
|
||||
<RedoOutlined />
|
||||
</ToggleButton>
|
||||
<ToggleButton shape="ghost" disabled>
|
||||
<IconFont type="icon-undo" />
|
||||
<ToggleButton shape="text" disabled>
|
||||
<RedoOutlined />
|
||||
</ToggleButton>
|
||||
</Flex>
|
||||
</Box>
|
||||
);
|
||||
}
|
||||
|
||||
export function ButtonGroup() {
|
||||
return (
|
||||
<Group attached>
|
||||
<ToggleButton>
|
||||
<UndoOutlined />
|
||||
</ToggleButton>
|
||||
<ToggleButton selected>
|
||||
<RedoOutlined />
|
||||
</ToggleButton>
|
||||
<ToggleButton disabled>
|
||||
<RedoOutlined />
|
||||
</ToggleButton>
|
||||
</Group>
|
||||
);
|
||||
}
|
||||
|
||||
@@ -0,0 +1,72 @@
|
||||
import React from 'react';
|
||||
import { VariableTree } from '@music163/tango-designer/src/components';
|
||||
import { Box } from 'coral-system';
|
||||
|
||||
export default {
|
||||
title: 'Designer/VariableTree',
|
||||
};
|
||||
|
||||
const data = [
|
||||
{
|
||||
title: 'Stores',
|
||||
key: 'stores',
|
||||
selectable: false,
|
||||
children: [
|
||||
{
|
||||
title: 'user',
|
||||
key: 'stores.user',
|
||||
children: [
|
||||
{
|
||||
title: 'name',
|
||||
key: 'stores.user.name',
|
||||
raw: '"Tom"',
|
||||
},
|
||||
{
|
||||
title: 'age',
|
||||
key: 'stores.user.age',
|
||||
raw: '18',
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
title: 'book',
|
||||
key: 'stores.book',
|
||||
children: [
|
||||
{
|
||||
title: 'name',
|
||||
key: 'stores.book.name',
|
||||
raw: '"JavaScript 高级程序设计"',
|
||||
},
|
||||
{
|
||||
title: 'price',
|
||||
key: 'stores.book.price',
|
||||
raw: '99.99',
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
title: 'Services',
|
||||
key: 'services',
|
||||
selectable: false,
|
||||
children: [
|
||||
{
|
||||
title: 'add',
|
||||
key: 'services.add',
|
||||
},
|
||||
{
|
||||
title: 'multiply',
|
||||
key: 'services.multiply',
|
||||
},
|
||||
],
|
||||
},
|
||||
];
|
||||
|
||||
export function Basic() {
|
||||
return (
|
||||
<Box width={600} border="solid">
|
||||
<VariableTree dataSource={data} />
|
||||
</Box>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,135 @@
|
||||
# 组件库自定义
|
||||
|
||||
Tango 提供了基于源码的低代码开发能力,默认不提供私有的内置组件库,仅提供了一个简单的示例用于说明如何将只有组件库接入到 Tango 中。
|
||||
|
||||
:::tip
|
||||
**组件库接入**意味着开发者可以将自己的组件库接入到 Tango 中,以便于在设计器中使用自己的组件,包括拖拽、配置、生成等行为。
|
||||
:::
|
||||
|
||||
## 基本的目录结构
|
||||
|
||||
基本的组件库目录结构如下:
|
||||
|
||||
```text
|
||||
+ src
|
||||
+ button
|
||||
- view.tsx // 默认视图文件
|
||||
- index.ts // 渲染视图入口文件
|
||||
- designer.ts // 设计器视图入口文件
|
||||
- prototype.ts // 【新增】组件描述文件
|
||||
+ date-picker
|
||||
- index.ts // 组件包默认入口文件
|
||||
- designer.ts // 【新增】组件包设计器视图入口文件
|
||||
```
|
||||
|
||||
可以发现,相比正常的组件代码,Tango 对于接入的组件库要求提供 2 个全新的文件 `designer.ts` 和 `prototype.ts`。其中 `designer.ts` 为设计视图文件,用来实现在 Tango 设计器中的辅助搭建行为,如果无需定制,可以直接保持 `designer.ts` 文件和 `index.ts` 文件一致。而 `prototype.ts` 文件则是用来描述组件的属性和行为的,用于在设计器中渲染组件的配置项,和控制组件的拖拽行为等。
|
||||
|
||||
一个可供参考的示例代码是 <https://github.com/NetEase/tango-components/tree/main/packages/antd/src>
|
||||
|
||||
### designer.ts
|
||||
|
||||
在 `designer.ts` 文件中,相比原有的组件库入口文件,还需要导出 `menuData` 和 `prototypes` 两个模块。
|
||||
|
||||
```jsx
|
||||
export * from './button';
|
||||
export * from './card';
|
||||
//...
|
||||
|
||||
// 组件的配置描述列表
|
||||
export const prototypes = [
|
||||
{
|
||||
title: '按钮',
|
||||
name: 'Button',
|
||||
props: [
|
||||
{
|
||||
name: 'size',
|
||||
setter: 'textSetter',
|
||||
},
|
||||
//...
|
||||
],
|
||||
},
|
||||
//...
|
||||
];
|
||||
|
||||
export const menuData = {
|
||||
// 常用组件
|
||||
common: [
|
||||
{
|
||||
title: '基本',
|
||||
items: ['Button'],
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
其中 `menuData` 的 `key` 可选列表如下:
|
||||
|
||||
| key | 说明 |
|
||||
| ------- | -------- |
|
||||
| common | 常用组件 |
|
||||
| atom | 原子组件 |
|
||||
| snippet | 代码片段 |
|
||||
|
||||
### prototype.ts
|
||||
|
||||
组件的配置描述文件。
|
||||
|
||||
## 组件配置描述
|
||||
|
||||
### ComponentPrototypeType
|
||||
|
||||
组件的配置描述。
|
||||
|
||||
| 属性 | 说明 | 类型 | 默认值 |
|
||||
| -------------- | ----------------------------------------------- | ---------------------------------------------------------------------------- | ------ |
|
||||
| childrenName | 子组件的名称 | `string` | - |
|
||||
| docs | 组件的文档地址 | `string` | - |
|
||||
| exportType | 组件的导出类型 `defaultExport` \| `namedExport` | `string` | - |
|
||||
| hasChildren | 是否有子组件 | `boolean` | - |
|
||||
| help | 组件的帮助文档 | `string` | - |
|
||||
| icon | 组件的图标,图片地址或 iconfont 图标名 | string | - |
|
||||
| name | 组件的名称 | `string` | - |
|
||||
| package | 组件的包名,或引入路径 | `string` | - |
|
||||
| props | 组件的属性描述 | `ComponentPropType[]` | - |
|
||||
| relatedImports | 组件的相关引入 | `string[]` | - |
|
||||
| rules | 组件的规则 | `ComponentDndRulesType` | - |
|
||||
| title | 组件的标题 | `string` | - |
|
||||
| type | 组件的类型 | "page" \| "container" \| "placeholder" \| "element" \| "snippet" \| "block"` | - |
|
||||
| usage | 组件的使用说明 | `string` | - |
|
||||
|
||||
### ComponentPropType
|
||||
|
||||
组件的属性描述。
|
||||
|
||||
| 属性 | 说明 | 类型 | 默认值 |
|
||||
| --------------------- | -------------------------------------------- | ------------------------------------------- | ------ |
|
||||
| autoCompleteOptions | 自动补全的提示值,仅对 ExpressionSetter 有效 | `string[]` | - |
|
||||
| autoInitValue | 如果没提供 initValue, 是否自动初始化值 | `boolean` | - |
|
||||
| defaultValue | 组件的内置默认值 | `any` | - |
|
||||
| disableVariableSetter | 是否禁用变量设置器 | `boolean` | - |
|
||||
| docs | 属性的文档地址 | `string` | - |
|
||||
| getProp | 动态设置属性,覆盖已有的 prop 对象 | `(form) => any` | - |
|
||||
| getSetterProps | 动态设置属性,覆盖已有的 setterProps 对象 | `(form) => any` | - |
|
||||
| getVisible | 动态设置表单项是否展示 | `(form) => boolean` | - |
|
||||
| group | 属性的分组 | `basic` \| `event` \| `style` \| `advanced` | - |
|
||||
| initValue | 首次拖拽后用来初始化组件的属性值 | `any` | - |
|
||||
| name | 属性的名称 | `string` | - |
|
||||
| options | 属性的选项 | `any[]` | - |
|
||||
| placeholder | 属性的占位符 | `string` | - |
|
||||
| props | 如果是对象属性,这里声明子属性列表 | `ComponentPropType[]` | - |
|
||||
| setter | 属性的设置器 | `string` | - |
|
||||
| setterProps | 设置器的属性设置 | `any` | - |
|
||||
| tips | 属性的提示 | `string` | - |
|
||||
| title | 属性的标题 | `string` | - |
|
||||
|
||||
### ComponentDndRulesType
|
||||
|
||||
组件拖拽规则类型
|
||||
|
||||
| 属性 | 说明 | 类型 | 默认值 |
|
||||
| ------------------------- | ---------------------------------------------------------------------------- | --------------------------- | ------ |
|
||||
| canDrag | 当前组件是否可以被拖拽 | `() => boolean` | - |
|
||||
| canDrop | 当前节点是否可以拖拽到目标节点中 | `(targetName) => boolean` | - |
|
||||
| canMoveIn | 进来的节点是否可以落进来,仅适用于容器节点 | `(incomingName) => boolean` | - |
|
||||
| canMoveOut | 被拖拽的节点是否可以被拖离当前节点,仅适用于容器节点 | `(outgoingName) => boolean` | - |
|
||||
| childrenContainerSelector | 子节点的容器选择器,用于快速定位子节点容器,适合组件存在多个可搭建区域时使用 | `string` | - |
|
||||
@@ -0,0 +1,5 @@
|
||||
# 编辑器自定义
|
||||
|
||||
:::tip
|
||||
正在编写中,敬请期待。
|
||||
:::
|
||||
@@ -0,0 +1,72 @@
|
||||
# 面板自定义
|
||||
|
||||
Tango 设计器由多个可自定义的面板组成,默认提供了一个标准的低代码设计器布局,可以根据实际需求进行自定义。如下图所示,可以对设计器的多个区域进行自定义,包括工具栏、侧边栏、配置面板、选择工具栏等等。
|
||||
|
||||

|
||||
|
||||
- 工具栏(Toolbar):设计器的顶部区域,通常用来放置一些全局信息和操作按钮,例如项目信息,顶部工具栏、发布按钮等等。
|
||||
- 侧边栏(Sidebar):设计器的左侧区域,通常用来放置一些核心功能的入口,例如k组件库、页面列表、变量配置、数据源配置等。
|
||||
- 配置面板(Properties):设计器的右侧区域,通常用来放置一些配置项,例如组件属性配置、页面属性配置等。
|
||||
- 选择工具栏(SelectionMenu):设计器的底部区域,通常用来放置一些选择工具,例如复制、删除、定位等。
|
||||
|
||||
除了使用预定义的设计器布局组件,Tango 支持完全使用开发者自行开发的组件进行替换。
|
||||
|
||||
## 内置设计器布局组件介绍
|
||||
|
||||
内置的设计器布局组件包括:
|
||||
|
||||
- Designer:设计器的状态容器,用来提供设计器核心状态的上下文容器,包括主题、引擎状态、沙箱状态等。
|
||||
- DesignerPanel:设计器的主框架,提供了核心的布局容器,便于开发者进行后续的自定义。
|
||||
- Toolbar:工具栏容器组件,提供了默认的工具栏的布局设置,可以通过 `Toolbar.Item` 进行快捷的定义工具栏的子项。
|
||||
- Sidebar:侧边栏容器组件,提供了默认的侧边栏的布局设置,可以通过 `Sidebar.Item` 进行快捷的定义侧边栏的子项。
|
||||
- WorkspacePanel:工作区容器组件,设计器中央的区域,包括画布和编辑等用户核心工作区,提供了默认的工作区的布局配置。
|
||||
- WorkspaceView:工作区的视图组件,用于快捷定制工作区的多种视图模式,可以实例化多个工作区视图,但同一时间只能由一个工作区视图处于激活状态。
|
||||
- SettingPanel:配置面板组件,提供了默认的属性配置能力。
|
||||
|
||||
## 基本的设计器布局
|
||||
|
||||
一个基本的的设计器布局示例如下图所示:
|
||||
|
||||
```jsx
|
||||
export default function App() {
|
||||
return (
|
||||
<Designer theme={themeLight} engine={engine} sandboxQuery={sandboxQuery}>
|
||||
<DesignerPanel
|
||||
logo={<Logo />}
|
||||
description={<ProjectDetail />}
|
||||
actions={
|
||||
<Box px="l">
|
||||
<Toolbar>
|
||||
<Toolbar.Item key="routeSwitch" placement="left" />
|
||||
<Toolbar.Item key="history" placement="left" />
|
||||
<Toolbar.Item key="preview" placement="left" />
|
||||
<Toolbar.Item key="modeSwitch" placement="right" />
|
||||
<Toolbar.Item key="togglePanel" placement="right" />
|
||||
<Toolbar.Separator />
|
||||
<Toolbar.Item placement="right">
|
||||
<Space>
|
||||
<Button type="primary">发布</Button>
|
||||
</Space>
|
||||
</Toolbar.Item>
|
||||
</Toolbar>
|
||||
</Box>
|
||||
}
|
||||
>
|
||||
<Sidebar>
|
||||
<Sidebar.Item key="components" label="组件" icon={<AppstoreAddOutlined />} />
|
||||
<Sidebar.Item key="outline" label="结构" icon={<BuildOutlined />} />
|
||||
</Sidebar>
|
||||
<WorkspacePanel>
|
||||
<WorkspaceView mode="design">
|
||||
<CustomDesignView />
|
||||
</WorkspaceView>
|
||||
<WorkspaceView mode="code">
|
||||
<CustomSourceCodeView />
|
||||
</WorkspaceView>
|
||||
</WorkspacePanel>
|
||||
<SettingPanel />
|
||||
</DesignerPanel>
|
||||
</Designer>
|
||||
);
|
||||
}
|
||||
```
|
||||
@@ -0,0 +1,4 @@
|
||||
# 选择器自定义
|
||||
|
||||
提供设计器视图中用户选中某个区域后展示的快捷工具。
|
||||
|
||||
+18
-4
@@ -1,7 +1,24 @@
|
||||
# 属性设置器
|
||||
# 设置器自定义
|
||||
|
||||
属性设置器用于在配置面板中展示特定配置项的配置逻辑。Tango 内置了多种标准的属性设置器,对于一些特殊场景,内置的属性设置器可能无法满足你的需要,此时开发者可以扩展自己的属性设置。
|
||||
|
||||
## 设置器组件
|
||||
|
||||
### SettingPanel
|
||||
|
||||
| 属性 | 说明 | 类型 | 默认值 |
|
||||
| ---------------- | -------------------------------------- | ---------------------------- | ------ |
|
||||
| title | 面板标题 | string | - |
|
||||
| defaultValue | 默认值 | object | - |
|
||||
| groupOptions | 分组选项 | object | - |
|
||||
| model | 表单状态管理实例 | FormModel | - |
|
||||
| onChange | 值变化回调 | (name, value, field) => void | - |
|
||||
| prototype | 组件的可配置描述 | ComponentPrototype | - |
|
||||
| renderItemExtra | 自定义渲染表单项的额外内容(标签右侧) | (props) => ReactNode | - |
|
||||
| showGroups | 是否展示分组 | boolean | - |
|
||||
| showItemSubtitle | 是否展示表单项的副标题 | boolean | - |
|
||||
| showSearch | 是否展示搜索框 | boolean | - |
|
||||
|
||||
## 内置属性设置器
|
||||
|
||||
| 设置器名 | 接收值类型 | 设置器说明 | 可配置项 |
|
||||
@@ -19,8 +36,6 @@
|
||||
| expressionSetter | expression | 表达式设置器 | |
|
||||
| jsonSetter | json expression | JSON 表达式设置器 | |
|
||||
| jsxSetter | jsx expression | JSX 设置器 | |
|
||||
| iconSetter | string | Icon 组件设置器 | |
|
||||
| iconTypeSetter | string | Icon 组件类型设置器 | |
|
||||
| numberSetter | number | 数字类型设置器 | |
|
||||
| textSetter | string | 文本设置器 | |
|
||||
| textAreaSetter | string | 文本域设置器 | |
|
||||
@@ -29,7 +44,6 @@
|
||||
| sliderSetter | number | 滑块设置器 | |
|
||||
| listSetter | `object[]` | 列表值设置器 | |
|
||||
| renderPropsSetter | Function | render props 设置器 | |
|
||||
| imageSetter | string | 云鹿图片设置器 | |
|
||||
|
||||
## 注册自定义属性设置器
|
||||
|
||||
@@ -0,0 +1,53 @@
|
||||
# 侧边栏自定义
|
||||
|
||||
提供了默认的设计器左侧边栏的布局设置。
|
||||
|
||||
## 侧边栏组件
|
||||
|
||||
### Sidebar
|
||||
|
||||
侧边栏容器组件。
|
||||
|
||||
### Sidebar.Item
|
||||
|
||||
侧边栏子项
|
||||
|
||||
| 属性 | 说明 | 类型 | 默认值 |
|
||||
| ----------- | ------------------------------------------------ | ------------------------------------------------- | ------ |
|
||||
| key | 子项的唯一标识 | `string` | - |
|
||||
| label | 子项的描述文本,推荐不超过2个字 | `string` | - |
|
||||
| icon | 图标 | `ReactNode` | - |
|
||||
| showBadge | 是否显示角标 | `boolean` \| `{ count?: number; dot?: boolean; }` | - |
|
||||
| title | 展开面板的标题 | `string` | - |
|
||||
| width | 展开面板的宽度 | `number` | - |
|
||||
| isFloat | 展开面板是否为浮动面板,浮动面板不压缩工作区宽度 | `boolean` | - |
|
||||
| widgetProps | 子项的属性 | `object` | - |
|
||||
| children | 子项的展开面板内容 | `ReactNode` | - |
|
||||
|
||||
## 内置的工具栏组件
|
||||
|
||||
设计器内置了一些基本的侧边栏组件,当子项的 `key` 使用了特定的值时,会自动的进行渲染。
|
||||
|
||||
| key | 组件 |
|
||||
| ---------- | ---------- |
|
||||
| components | 组件列表 |
|
||||
| outline | 结构 |
|
||||
| dependency | 依赖管理 |
|
||||
| variables | 变量管理 |
|
||||
| dataSource | 数据源管理 |
|
||||
|
||||
例如,下面的代码会自动渲染一个结构面板:
|
||||
|
||||
```jsx
|
||||
<Sidebar.Item key="outline" label="结构" icon={<BuildOutlined />} />
|
||||
```
|
||||
|
||||
## 自定义侧边栏子项
|
||||
|
||||
可以直接在 `Sidebar.Item` 的子节点传入自定义的内容来渲染需要的结果,例如:
|
||||
|
||||
```jsx
|
||||
<Sidebar.Item key="custom" label="自定义" icon={<SmileOutlined />}>
|
||||
<div>展开的内容部分</div>
|
||||
</Sidebar.Item>
|
||||
```
|
||||
@@ -0,0 +1,53 @@
|
||||
# 工具栏自定义
|
||||
|
||||
提供了默认的设计器工具栏的布局设置。
|
||||
|
||||
## 工具栏组件
|
||||
|
||||
### Toolbar
|
||||
|
||||
工具栏列表容器
|
||||
|
||||
### Toolbar.Item
|
||||
|
||||
工具栏子项
|
||||
|
||||
| 属性 | 说明 | 类型 | 默认值 |
|
||||
| ----------- | -------------- | --------------------------- | ------- |
|
||||
| key | 子项的唯一标识 | `string` | - |
|
||||
| placement | 放置的位置 | `left` \| `right` \| `left` | `right` |
|
||||
| widgetProps | 子项的属性 | `object` | - |
|
||||
|
||||
### Toolbar.Separator
|
||||
|
||||
工具栏分隔线,用来对工具栏子项进行分组展示。
|
||||
|
||||
## 内置的工具栏组件
|
||||
|
||||
设计器内置了一些基本的工具栏组件,当工具栏子项使用了特定的 `key` 值时,会自动的进行渲染。
|
||||
|
||||
| key | 组件 |
|
||||
| ----------- | ------------------------------------ |
|
||||
| routeSwitch | 路由切换 |
|
||||
| history | 历史记录 |
|
||||
| preview | 沙箱预览 |
|
||||
| modeSwitch | 工作区模式切换,在源码和设计模式切换 |
|
||||
| togglePanel | 切换布局面板的显示和隐藏 |
|
||||
|
||||
例如,下面的代码会自动渲染为一个路由切换的工具项。
|
||||
|
||||
```jsx
|
||||
<Toolbar.Item key="routeSwitch" />
|
||||
```
|
||||
|
||||
## 自定义工具栏项
|
||||
|
||||
可以直接在 `Toolbar.Item` 的子节点传入自定义的工具栏项,例如:
|
||||
|
||||
```jsx
|
||||
<Toolbar.Item placement="right">
|
||||
<Space>
|
||||
<Button type="primary">发布</Button>
|
||||
</Space>
|
||||
</Toolbar.Item>
|
||||
```
|
||||
@@ -0,0 +1,18 @@
|
||||
# 设计器接入
|
||||
|
||||
设计器为用户提供应用搭建的可视化界面。有两种方式初始化低代码设计器:
|
||||
|
||||
1. clone 官方示例代码,按照文档说明直接启动项目。
|
||||
2. 手工引入设计器的 npm 包,自定义配置、启动、运行。
|
||||
|
||||
## 方法1: 通过示例代码启动设计器
|
||||
|
||||
WIP
|
||||
|
||||
:::tip
|
||||
官方示例是一个包含了低代码设计器前后端低完整项目,可以直接启动。对于后端部分,作为示例而言,仅提供了最基本的逻辑,用户需要按照需求自行扩展。
|
||||
:::
|
||||
|
||||
## 方法2: 手工引入设计器的 npm 包
|
||||
|
||||
WIP
|
||||
@@ -0,0 +1,19 @@
|
||||
# 低代码沙箱接入
|
||||
|
||||
沙箱是搭建产物(对于 Tango 主要是源码)的运行环境,它是一个独立的环境,可以在其中运行搭建产物,以便于开发者可以在不影响生产环境的情况下进行调试和测试。
|
||||
|
||||
Tango 沙箱由三个部分构成,包括低代码沙箱前端组件、在线打包器、沙箱后端服务,如下图所示。
|
||||
|
||||

|
||||
|
||||
- 沙箱前端组件:一个开箱即用的沙箱组件,只需要传入代码和配置就可以完成应用的渲染。
|
||||
- 在线打包器:提供搭建产物的浏览器端构建能力,类似于一个浏览器版本的 webpack,此部分逻辑主要来自于 [sandpack](https://sandpack.codesandbox.io/) 项目。
|
||||
- 沙箱后端服务:对依赖的资源进行预构建,以及提供资源合并等服务,用来加速沙箱内部的构建打包过程。
|
||||
|
||||
## 沙箱的前端组件接入
|
||||
|
||||
WIP
|
||||
|
||||
## 沙箱的后端服务接入
|
||||
|
||||
WIP
|
||||
@@ -0,0 +1,7 @@
|
||||
# 服务端接入
|
||||
|
||||
介绍一个基本的服务端实现,以及如何接入。
|
||||
|
||||
:::tip
|
||||
正在编写中,敬请期待。
|
||||
:::
|
||||
@@ -0,0 +1,5 @@
|
||||
# 文件系统
|
||||
|
||||
:::tip
|
||||
正在编写中,敬请期待。
|
||||
:::
|
||||
@@ -0,0 +1,112 @@
|
||||
# 技术架构概览
|
||||
|
||||
我们在 2023年8月底[正式开源了 Tango 低代码引擎](https://juejin.cn/post/7273051203562749971)。Tango 是一个基于源码的低代码设计器框架,支持直接基于项目源码提供低代码可视化开发能力,可以无缝的与既有的本地开发工作流进行集成,从而提供渐进式的低代码开发能力。
|
||||
|
||||

|
||||
|
||||
按照计划,我们在 2023年9月底[发布了 1.0 alpha 版本](https://github.com/NetEase/tango/releases),在此版本中我们遵循 **“最小内核”** 的原则对 Tango 的核心实现进行了大幅的重构,剥离了大量冗余的代码实现。
|
||||
|
||||
为了帮助大家更近一步的了解 Tango 开源版本的核心构成与代码实现,本文将会详细揭秘 Tango 低代码引擎的设计思考与实现过程。
|
||||
|
||||
- Github 仓库:<https://github.com/NetEase/tango>
|
||||
- 发行历史:<https://github.com/NetEase/tango/releases>
|
||||
- 文档站点:<https://netease.github.io/tango/>
|
||||
|
||||
## 低代码可视化搭建之殇
|
||||
|
||||
从实现上看,低代码搭建能力的核心是 UI 可视化编程。借助 UI 可视化编程,可以大大的弱化使用者对于代码编程的感知,但在真实的业务需求场景中,我们面临着大量的复杂的应用逻辑,使用者很难借助 UI 操作表达功能逻辑。例如下图中的合同管理,资金结算等页面。如果借助于传统的低代码方案,通常会发现,很容易一条路走到黑,没有回头路。所以,经常会有开发者抱怨,稍微复杂的场景下,低代码的效率甚至不如写代码。
|
||||
|
||||

|
||||
|
||||
## 传统低代码方案的问题
|
||||
|
||||
我们不妨先简单分析一下传统的低代码方案的问题。传统的低代码搭建方案往往采用定义私有 Schema 协议来可视化表达视图逻辑,也就是将代码逻辑转换为私有的描述,大致的原理可以参考下面这张图。
|
||||
|
||||

|
||||
|
||||
这类方案很容易面临不断膨胀的私有 JSON 协议。并且,私有协议扩展性和灵活性差,难以达到图灵完备状态。例如在我们的实际开发过程中,传统的低代码方案会面临各种各样的扩展性卡点。此外,开发能力往往受限于内置的组件和模板。且难以复用现有的前端资产,例如组件和代码等等。对于开发者而言,私有协议也导致问题定位难,调试难。
|
||||
|
||||
借助于私有协议的搭建方案通常适合于轻业务逻辑的简单类表单,营销类的活动页面等等,很难用于复杂的业务逻辑搭建场景,因为私有协议难以有效的应对这类场景的复杂性和灵活性需求。虽然,有些方案提供了协议转代码的能力,但通常只实现了单向转码,可视化开发和代码开发是两条完全割裂的路径。
|
||||
|
||||
**在此基础上,我们就需要重新思考低代码搭建协议的设计问题。**
|
||||
|
||||
## 从私有搭建协议到公有协议
|
||||
|
||||
那么,我们能否不使用私有协议,而是采用公有协议?
|
||||
|
||||
答案是,可以的 规范作为主流的处理 JavaScript 源代码的标准社区协议,被广泛用于浏览器 JavaScript Parser 的实现。借助于 ESTree 协议,可以完美的实现对源码逻辑的描述,并且社区有大量的工具可以帮助我们完成这个过程。
|
||||
|
||||

|
||||
|
||||
因此,我们尝试使用 ESTree 规范来实现低代码搭建过程。借助于 ESTree 规范,我们无需定义私有的渲染描述协议,并且可以低成本的实现代码到协议,协议到代码到互转。借助于双向转码的能力,我们获得全新的低代码开发体验。
|
||||
|
||||
## Tango 低代码引擎实现原理
|
||||
|
||||
基于这个思路,我们设计了基于 ESTree 规范的低代码引擎方案 -- Tango。可以通过下面这张图来简单的描述下实现逻辑:
|
||||
|
||||

|
||||
|
||||
首先将源代码解析为 AST。用户的拖拉拽等操作则映射为对 AST 的遍历和修改。最后将新的 AST 重新生成代码,交给设计器沙箱去渲染执行。而对 AST 的解析、遍历、修改、生成,则可以借助大量的社区工具,这里我们选择的是 babel!
|
||||
|
||||
> AST 的全称是抽象语法树,是一种分层的程序表达,根据编程语言的语法呈现源代码的结构。
|
||||
|
||||

|
||||
|
||||
其实,数量众多的前端工具库都是基于 AST 操纵实现的。我们可以发现,在任意的前端项目中的 package.json 里的 devDependencies 里的很多工具包是基于 AST 解析操纵实现的,例如 JS 的转译,代码压缩,ESLint 等等,我们可以阅读这些工具的源码来进一步的学习。
|
||||
|
||||

|
||||
|
||||
如图所示,将源代码转为 AST 描述的基本过程包括词法分析和句法分析两个阶段:
|
||||
|
||||
- 词法分析:借助词法分析器将代码字符串分割为标记列表。
|
||||
- 句法分析:借助句法分析器将标记数据转为 AST 描述。
|
||||
|
||||
最后,我们可以获得源代码的结构化描述树。有很多工具可以帮我们来实现这个过程,例如 babel -- 它可以帮助我们轻松的实现代码到 ast,ast 遍历修改,ast 到代码的过程。
|
||||
|
||||
## 基于 AST 实现搭建的基本过程
|
||||
|
||||
我们来看一下使用 ast 实现搭建逻辑的基本过程。
|
||||
|
||||
看一个具体的例子:通过修改 AST,在 Page 中插入一个 Section 节点。
|
||||
|
||||

|
||||
|
||||
中间这段代码,展示了核心的逻辑,通过遍历整个 AST 中的所有 JSXElement 节点,找到第一个 Page 元素,然后在 Page 元素的 children 里插入新的 Section 节点。这只是一段演示代码,具体的过程比这个要复杂的多,因为有很多的边际逻辑要处理。最后,我们可以将 ast 重新生成为代码,得到我们想要的结果。
|
||||
|
||||
## Tango 的数据变更流程设计
|
||||
|
||||
了解了基本的实现原理后,我们来看一下低代码引擎的数据变更流程设计。
|
||||
|
||||

|
||||
|
||||
首先是引擎初始化。源码文件会被引擎内核解析进行状态初始化。接下来,对于用户的操作,会触发浏览器事件,引擎接收到相应的事件,触发内核中的状态变更,更新 AST。
|
||||
|
||||
然后,内核会基于新的 AST 的同步生成代码,由引擎将代码同步给渲染沙箱。渲染沙箱感知到代码变化后,会触发页面重新渲染,也就是沙箱的 HMR 过程。
|
||||
|
||||
## 基于源码的在线渲染沙箱设计
|
||||
|
||||
接下来,我们需要考虑的是如何在浏览器中执行 JavaScript 源码工程?有很多方案可以选择,我们选择的方案是 [sandpack](https://sandpack.codesandbox.io/),它是由 CodeSandbox 开源的可以在浏览器中实时运行 JavaScript 项目的的工具库。在具体实现上,[我们对 sandpack 进行了一系列的改造](https://juejin.cn/post/7102243774985666596),以满足低代码生产环境的需要。
|
||||
|
||||
基于 sandpack 的在线渲染沙箱方案如下图图所示。
|
||||
|
||||

|
||||
|
||||
在实现上,主要包括 3 个部分,分别是:
|
||||
|
||||
- 低代码沙箱:它是一个开箱即用的前端组件,只需要传入源代码和构建配置信息即可完成前端项目的构建和执行。
|
||||
- 在线 Bundler:是低代码沙箱的核心,用来在浏览器上构建和执行源代码,本质上是一个在浏览器端运行的简化版 webpack。
|
||||
- 打包服务:是一个 node 服务,用来对 npm 包执行预构建和资源合并。
|
||||
|
||||
从沙箱执行流程来看,首先 Sandbox 组件将项目的源代码和 compile 指令使用 postMessage 传递给在线 Bundler,在线 Bundler 在接收到 compile 指令后,bundler 会从 packager 打包服务加载项目的 npm 依赖,然后编译和执行代码,最后发送 success 消息给低代码沙箱。
|
||||
|
||||
## Tango 低代码引擎的构成
|
||||
|
||||
结合上面的介绍,在构成上,Tango 低代码引擎主要包括 3 个核心组成部分,分别是:
|
||||
|
||||
- 引擎内核:扶额建立文件,节点模型,提供输入输出能力。
|
||||
- 拖拽引擎和可视化面板:提供可视化开发能力
|
||||
- 渲染沙箱:提供源码在浏览器上的编译执行能力。
|
||||
|
||||

|
||||
|
||||
借助于 Tango 低代码引擎,我们可以为开发者提供全新的在线开发体验,支持源码级的自定义能力。对可视化开发而言,可视化配置会触发 AST 的修改,进而会重新生成对应的源码。而对源码开发而言,修改源码后会同步更新 AST。
|
||||
@@ -0,0 +1,5 @@
|
||||
# 沙箱实现
|
||||
|
||||
:::tip
|
||||
正在编写中,敬请期待。
|
||||
:::
|
||||
@@ -1,58 +0,0 @@
|
||||
# 设计器扩展概览
|
||||
|
||||
主要介绍如何扩展 tango 设计器。tango 设计器提供了三个部位的自定义扩展能力,分别是标题栏,工具栏,和侧边栏。可以通过下面这张图进行简要的了解:
|
||||
|
||||
<img src="https://p5.music.126.net/obj/wonDlsKUwrLClGjCm8Kx/13359732115/c5ca/c5ae/bbd4/852daf849ac39162baf3bc3a985de6de.png" />
|
||||
|
||||
## 标题栏扩展
|
||||
|
||||
`DesignerPanel` 提供了 logo, description, actions 三个扩展点,分别对应于 平台标识、应用描述、行动点区域,开发者可以按照需求进行扩展。例如:
|
||||
|
||||
```jsx
|
||||
<DesignerPanel logo={<Logo />} description={<ProjectDetail />} actions={<Box>新版沙箱</Box>}>
|
||||
</SidebarPanel>
|
||||
```
|
||||
|
||||
## 工具栏扩展
|
||||
|
||||
工具栏面板支持任意组合和设置渲染的位置,开发者可以通过 `ToolbarPanel.Item` 添加自定义的工具栏选项,例如下面的代码扩展了一个 newPage 按钮,用于支持在设计器中创建新页面的需求。
|
||||
|
||||
```jsx
|
||||
<ToolbarPanel>
|
||||
<ToolbarPanel.Item key="history" />
|
||||
<ToolbarPanel.Item key="viewportRefresh" />
|
||||
<ToolbarPanel.Item key="preview" />
|
||||
<ToolbarPanel.Item key="routeSwitch" />
|
||||
<ToolbarPanel.Item key="newPage">
|
||||
<Button
|
||||
onClick={() => {
|
||||
const { name, code } = genDefaultPage(index);
|
||||
engine.workspace.addViewPage(`${name}${index++}`, code);
|
||||
message.success('页面新建成功');
|
||||
}}
|
||||
>
|
||||
添加新页面
|
||||
</Button>
|
||||
</ToolbarPanel.Item>
|
||||
<ToolbarPanel.Item key="modeSwitch" placement="center" />
|
||||
<ToolbarPanel.Item key="viewportSwitch" placement="right" />
|
||||
</ToolbarPanel>
|
||||
```
|
||||
|
||||
## 侧边栏扩展
|
||||
|
||||
侧边栏面板支持任意组合和调换顺序,用户可以通过 `SidebarPanel.Item` 组件进行自定义扩展,默认情况下根据一些内置的 key 标识,设计器会自动渲染对应的面板,用户也可以根据自己的需求采用自定义渲染子节点的方案进行扩展。
|
||||
例如,下面的示例代码中扩展了一个 “自定义面板”。
|
||||
|
||||
```jsx
|
||||
<SidebarPanel>
|
||||
<SidebarPanel.Item key="components" />
|
||||
<SidebarPanel.Item key="outline" />
|
||||
<SidebarPanel.Item key="dataSource" />
|
||||
<SidebarPanel.Item key="dependency" />
|
||||
<SidebarPanel.Item key="history" />
|
||||
<SidebarPanel.Item key="custom" title="自定义面板" icon={<BulbOutlined />}>
|
||||
<Box p="m">这里是一个自定义的面板,你可以任意添加</Box>
|
||||
</SidebarPanel.Item>
|
||||
</SidebarPanel>
|
||||
```
|
||||
@@ -1,67 +0,0 @@
|
||||
# 外部数据源
|
||||
|
||||
如果您的扩展部件需要使用外部数据源,可以参考本文的做法。
|
||||
|
||||
## 存在部件共享
|
||||
|
||||
如果数据源需要在多个扩展部件中共享,我们推荐您借助 tango 的 `remoteServices` 规范进行接口的实现。
|
||||
|
||||
### 外部数据源定义
|
||||
|
||||
例如,我们需要调用一组图片素材的接口,此时我们可以定义一个 `ImageService`,如下:
|
||||
|
||||
```tsx
|
||||
import { createServices } from '@music/request';
|
||||
|
||||
export const remoteServices = {
|
||||
ImageService: createServices(
|
||||
{
|
||||
listMy: {
|
||||
url: '/my/upload/list',
|
||||
},
|
||||
listFav: {
|
||||
url: '/my/star/list',
|
||||
},
|
||||
listPub: {
|
||||
url: '/list',
|
||||
},
|
||||
},
|
||||
{
|
||||
baseURL: 'https://febase-openapi.fn.netease.com/deer/api/deer/pic',
|
||||
withCredentials: false, // 解决跨域时必须非*问题
|
||||
}
|
||||
),
|
||||
};
|
||||
```
|
||||
|
||||
### 外部数据源引入
|
||||
|
||||
我们在设计器初始化的时候可以通过 `remoteServices` 属性进行外部数据源的传入。
|
||||
|
||||
```tsx
|
||||
<Designer remoteServices={remoteServices}></Designer>
|
||||
```
|
||||
|
||||
### 在设计器扩展中使用定义的外部数据源
|
||||
|
||||
```tsx
|
||||
import { useRemoteServices } from '@music163/tango-designer';
|
||||
|
||||
export function CustomWidget() {
|
||||
const remoteServices = useRemoteServices();
|
||||
}
|
||||
```
|
||||
|
||||
## 仅在单个组件
|
||||
|
||||
如果您的外部数据服务没有额外的共享需求,您也可以直接在组件内部进行数据服务的发起。
|
||||
|
||||
```tsx
|
||||
import request from '@music/request';
|
||||
|
||||
export function CustomWidget() {
|
||||
useEffect(() => {
|
||||
request('//some.domain/get');
|
||||
}, []);
|
||||
}
|
||||
```
|
||||
@@ -1,141 +0,0 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
# 物料接入
|
||||
|
||||
Tango 提供了低成本的物料接入方式,支持直接复用现有的组件体系。只需要在现有组件包基础上简单的提供配置说明问题,即可轻松接入到 Tango 低代码生态体系中。
|
||||
|
||||
import Link from '@docusaurus/Link';
|
||||
|
||||
## 预览视图和设计器视图
|
||||
|
||||
- 预览视图:是组件默认的渲染模式,通常我们只需要关注此视图行为。
|
||||
- 设计器视图:为低代码平台定制的渲染视图,当我们需要自定义组件在 Tango 设计器中的部分渲染行为时,可以通过修改设计器视图的渲染逻辑实现。
|
||||
|
||||
### 设计器视图和 `withDnd`
|
||||
|
||||
通常情况下我们不需要太关注于设计器视图,只需通过 `withDnd` 简单的进行包装即可。例如:
|
||||
|
||||
```jsx
|
||||
// 将 antd Button 包装一层提供设计器视图
|
||||
export Button = withDnd({
|
||||
name: 'Button', // 必须,组件的名字,用来正确设置组件的 displayName
|
||||
isFunctionComponent: true, // 可选,如果包裹的组件为函数组件,可以在此设置
|
||||
overrideProps: {}, // 可选,覆盖掉包裹组件的默认属性值
|
||||
})(AntButton);
|
||||
```
|
||||
|
||||
默认情况下 withDnd 会在组件外层包裹一层 dnd 容器,以便于组件能够在设计器中被拖拽:
|
||||
|
||||
- draggable 属性表示该区域可以被拖拽
|
||||
- data-dnd 用来追踪渲染的 dom 元素
|
||||
|
||||
```jsx
|
||||
<div className="dnd-wrapper" draggable data-dnd="button:123">
|
||||
<button>hello</button>
|
||||
</div>
|
||||
```
|
||||
|
||||
### 自定义拖拽容器
|
||||
|
||||
由于默认情况下拖拽容器是一个 `div` 节点,为[块级元素](https://www.w3schools.com/cssref/pr_class_display.asp)。部分情况下,你可能期望它渲染为一个[行内容器](https://www.w3schools.com/cssref/pr_class_display.asp),此时可以通过如下方式配置:
|
||||
|
||||
```jsx
|
||||
export Button = withDnd({
|
||||
name: 'Button',
|
||||
display: 'inline-block', // 将 dnd 容器渲染为行内元素
|
||||
wrapperStyle: {}, // 传入 dnd 容器的自定义样式
|
||||
})(AntButton);
|
||||
```
|
||||
|
||||
|
||||
|
||||
### 禁用拖拽容器
|
||||
|
||||
某些情况下,你的组件可能会检查子节点的有效性,此时你可能不期望组件被包装额外的容器节点,此时你可以关闭拖拽容器,但你需要保证你的组件能够接收父级元素传入的属性信息并附加到组件的跟节点上,否则将无法正确的设置组件的 dnd 信息。
|
||||
|
||||
```jsx
|
||||
export Button = withDnd({
|
||||
name: 'Button',
|
||||
hasWrapper: false, // 禁用拖拽容器
|
||||
})(MyButton);
|
||||
|
||||
const MyButton = (props) => {
|
||||
const { children, ...rest } = props;
|
||||
// 此时,需要保证你的组件能够正确的将多余的属性透传到组件的根节点上
|
||||
return <button {...rest}>{children}</button>
|
||||
}
|
||||
```
|
||||
|
||||
## 组件包接入
|
||||
|
||||
组件包一般包含多个组件导出,例如 `@music163/antd` 就是典型的组件包,它面向中后台场景提供统一的物料层解决方案。组件包接入 Tango 体系,无需修改现有的代码实现,只需要在此基础上提供额外的配置文件即可。如下所示:
|
||||
|
||||
```
|
||||
- src
|
||||
- button
|
||||
- designer.tsx # 设计器视图,可以不提供
|
||||
- index.ts # 默认视图出口
|
||||
- prototype.ts # 组件可配置描述协议
|
||||
- index.ts
|
||||
- prototypes.ts
|
||||
- designer.ts
|
||||
```
|
||||
|
||||
参考示例:https://g.hz.netease.com/NeteaseMusicUI/music-one/-/tree/master/packages/components/src/action
|
||||
|
||||
### 设计器视图的实现
|
||||
|
||||
对大部分组件而言,都不需要提供特定的设计器视图,只需要使用 tango 提供的 dnd hoc 进行简单的包裹导出即可。
|
||||
|
||||
```tsx
|
||||
import { Button as Base, ButtonProps } from 'antd';
|
||||
import { withDnd } from '@music/tango-apps-shared';
|
||||
|
||||
export const Button = withDnd<HTMLDivElement, ButtonProps<any>>({
|
||||
name: 'Button',
|
||||
})(Base);
|
||||
```
|
||||
|
||||
### 编写 prototypes 文件
|
||||
|
||||
可以参考 <Link to="/docs/protocol/material-protocol">物料协议</Link> 编写该文档
|
||||
|
||||
### 属性设置器选择
|
||||
|
||||
参考属性设置器文档进行选择。
|
||||
|
||||
### 可配置项的验证
|
||||
|
||||
TangoApps 提供了 SettingFormPlayground 组件用来测试组件的可配置能力,可以直接在组件文档中加入可配置测试示例,例如在 storybook 中进行测试。
|
||||
|
||||
```jsx
|
||||
import React from 'react';
|
||||
import { SettingFormPlayground } from '@music/tango-apps-setting-form';
|
||||
import { Input, prototypes } from '@music163/antd';
|
||||
|
||||
export default {
|
||||
title: 'Prototype/Input',
|
||||
};
|
||||
|
||||
export function Basic() {
|
||||
return (
|
||||
<SettingFormPlayground prototype={prototypes.Input}>
|
||||
<Input />
|
||||
</SettingFormPlayground>
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
SettingFormPlayground 组件支持实时预览配置结果,预览效果如下:
|
||||
|
||||
<img src="https://p6.music.126.net/obj/wonDlsKUwrLClGjCm8Kx/13140796879/edbb/5dad/a330/013a98940e487956b605e1e533f54371.png" />
|
||||
|
||||
## 单个业务组件接入
|
||||
|
||||
单个组件接入可以参考组件包的接入方案。
|
||||
|
||||
:::info
|
||||
考虑到单组件形态的特点,在云音乐业务场景中,TangoStudio 将会与红石物料中心对接,提供业务组件的自动化接入能力,目前该能力正在开发过程中。
|
||||
:::
|
||||
@@ -1,9 +0,0 @@
|
||||
# DesignerPanel 设计器布局容器
|
||||
|
||||
设计器的主框架提供了一个基本的低代码设计器的布局容器,你可以很轻松的通过此布局容器来实现自己的设计器布局。
|
||||
|
||||
## 属性列表
|
||||
|
||||
import TypesTable from '@site/src/components/TypesTable';
|
||||
|
||||
<TypesTable name="DesignerPanelProps" />
|
||||
@@ -1,56 +0,0 @@
|
||||
# Designer 设计器容器
|
||||
|
||||
设计器根节点,注入全局状态。
|
||||
|
||||
## 属性列表
|
||||
|
||||
import TypesTable from '@site/src/components/TypesTable';
|
||||
|
||||
<TypesTable name="DesignerProps" />
|
||||
|
||||
## 设计器初始化
|
||||
|
||||
```jsx
|
||||
<Designer engine={engine} sandboxQuery={sandboxQuery} remoteServices={remoteServices}></Designer>
|
||||
```
|
||||
|
||||
## engine
|
||||
|
||||
设计器引擎实例,用于管理设计器的核心状态。
|
||||
|
||||
### 基本的初始化方式
|
||||
|
||||
```js
|
||||
const engine = createEngine({
|
||||
entry: '/src/index.js',
|
||||
files: sampleFiles,
|
||||
componentPrototypes: prototypes as any,
|
||||
});
|
||||
```
|
||||
|
||||
### 自定义 workspace 的初始化方式
|
||||
|
||||
默认情况下,引擎采用的是源码解析模式,即将源码解析为 ast 树,后续的搭建逻辑转为对 ast 树的操作。如果你想自定义搭建逻辑,可以通过自定义 workspace 的方式来实现。
|
||||
|
||||
引擎在 2.0 本本中提供了新的 JsonWorkspace 来支持自定义搭建逻辑,JsonWorkspace 采用的是 json 格式的数据结构,你可以通过自定义 json 来实现自定义搭建逻辑。
|
||||
|
||||
```js
|
||||
const engine = createEngine({
|
||||
workspace: new JsonWorkspace({
|
||||
prototypes: prototypes as any,
|
||||
files: schemaFiles,
|
||||
}),
|
||||
});
|
||||
```
|
||||
|
||||
:::tip
|
||||
按照这种方式,你可以自定义自己的 Workspace 实现。具体可以参考 Workspace 的实现标准。
|
||||
:::
|
||||
|
||||
## sandboxQuery
|
||||
|
||||
沙箱的查询实例,用于向沙箱注册 dom 查询能力。
|
||||
|
||||
## remoteServices
|
||||
|
||||
远程服务实例,用于注册全局共享的数据服务实例。
|
||||
@@ -1,27 +0,0 @@
|
||||
# Hooks 钩子方法
|
||||
|
||||
设计器提供了一组 Hooks 用于快速获取设计器的各种状态。
|
||||
|
||||
import TypesTable from '@site/src/components/TypesTable';
|
||||
|
||||
## useWorkspace
|
||||
|
||||
获取工作区状态。
|
||||
|
||||
```js
|
||||
// App 需要放置在 Designer 容器中
|
||||
function App() {
|
||||
const workspace = useWorkspace();
|
||||
// do what you want
|
||||
}
|
||||
```
|
||||
|
||||
## useDesigner
|
||||
|
||||
```js
|
||||
// App 需要放置在 Designer 容器中
|
||||
function App() {
|
||||
const designer = useDesigner();
|
||||
// do what you want
|
||||
}
|
||||
```
|
||||
@@ -1,9 +0,0 @@
|
||||
# Sandbox 沙箱
|
||||
|
||||
设计器的运行时沙箱,用来执行代码,渲染页面。
|
||||
|
||||
import TypesTable from '@site/src/components/TypesTable';
|
||||
|
||||
默认沙箱是一个基于 CodeSandbox 的沙箱实例,可以直接在浏览器端执行代码。
|
||||
|
||||
<TypesTable name="SandboxProps" />
|
||||
@@ -1,9 +0,0 @@
|
||||
# SettingPanel 属性设置面板
|
||||
|
||||
属性设置器用于在配置面板中展示特定配置项的配置逻辑。
|
||||
|
||||
## 属性列表
|
||||
|
||||
import TypesTable from '@site/src/components/TypesTable';
|
||||
|
||||
<TypesTable name="SettingPanelProps" />
|
||||
@@ -1,38 +0,0 @@
|
||||
# SidebarPanel 侧边栏面板
|
||||
|
||||
侧边栏面板提供了一个简单易用的主操作面板,可以将一些高频操作和核心部件放置到侧边栏面板中,方便用户快速操作。
|
||||
|
||||
## 属性列表
|
||||
|
||||
import TypesTable from '@site/src/components/TypesTable';
|
||||
|
||||
<TypesTable name="SidebarPanelProps" />
|
||||
|
||||
## 创建浮动面板
|
||||
|
||||
借助 `isFloat` 和 `width` 属性可以创建浮动自定义宽度面板,脱离框架对侧边栏的宽度限制。
|
||||
|
||||
```jsx
|
||||
<SidebarPanel.Item key="history" isFloat width="40vw" />
|
||||
```
|
||||
|
||||
## 徽标提示
|
||||
|
||||
`showBadge` 属性可以设置工具栏是否显示徽标提示,用于某些面板需要对外展现需要被用户注意的时机。
|
||||
|
||||
<img
|
||||
alt="img"
|
||||
src="https://p6.music.126.net/obj/wonDlsKUwrLClGjCm8Kx/18224398190/2847/b86d/df55/c817e86a0b1b3a6b08f7cc98362caec5.png"
|
||||
width="300px"
|
||||
/>
|
||||
|
||||
```jsx
|
||||
<SidebarPanel.Item
|
||||
key="info"
|
||||
label="消息"
|
||||
title="消息列表"
|
||||
icon={<NotificationOutlined />}
|
||||
showBadge={{ count: 2 }}>
|
||||
<Box>info panel</Box>
|
||||
</SidebarPanel.Item>
|
||||
```
|
||||
@@ -1,10 +0,0 @@
|
||||
# ViewPanel 主视图面板
|
||||
|
||||
设计器的主视图面板,用来放置设计器的主视图,包括:沙箱,编辑器,预览等。主视图可以放置多个,但只有一个会在激活状态。
|
||||
|
||||
## 属性列表
|
||||
|
||||
import TypesTable from '@site/src/components/TypesTable';
|
||||
|
||||
<TypesTable name="ViewPanelProps" />
|
||||
|
||||
@@ -1,3 +0,0 @@
|
||||
# WorkspacePanel 工作区面板
|
||||
|
||||
主工作区的布局容器,用于放置工作区的多重视图。
|
||||
@@ -64,7 +64,7 @@ const config = {
|
||||
image: 'img/social-card.png',
|
||||
announcementBar: {
|
||||
id: 'notion_alert',
|
||||
content: '🏗 当前版本为测试版,请暂时不要用于生产环境,正式版将于2023年Q4发布!',
|
||||
content: '🏗 当前版本为 alpha 版本,相关文档正在编写之中,敬请期待!',
|
||||
backgroundColor: 'var(--ifm-color-primary-contrast-background)',
|
||||
textColor: 'var(--ifm-color-primary-contrast-foreground)',
|
||||
isCloseable: false,
|
||||
@@ -88,12 +88,6 @@ const config = {
|
||||
position: 'left',
|
||||
label: '应用框架',
|
||||
},
|
||||
{
|
||||
type: 'docSidebar',
|
||||
sidebarId: 'protocol',
|
||||
position: 'left',
|
||||
label: '协议',
|
||||
},
|
||||
{ to: '/blog', label: '博客', position: 'left' },
|
||||
{
|
||||
type: 'html',
|
||||
@@ -127,8 +121,8 @@ const config = {
|
||||
title: '社区',
|
||||
items: [
|
||||
{
|
||||
label: 'Stack Overflow',
|
||||
href: 'https://stackoverflow.com/questions/tagged/netease-tango',
|
||||
label: 'Discussions',
|
||||
href: 'https://github.com/NetEase/tango/discussions',
|
||||
},
|
||||
{
|
||||
label: 'Discord',
|
||||
|
||||
+26
-23
@@ -20,28 +20,31 @@ const sidebars = {
|
||||
designer: [
|
||||
'intro',
|
||||
'designer/quick-start',
|
||||
// {
|
||||
// type: 'category',
|
||||
// label: '模块',
|
||||
// items: [
|
||||
// 'designer/modules/designer',
|
||||
// 'designer/modules/designer-panel',
|
||||
// 'designer/modules/sidebar-panel',
|
||||
// 'designer/modules/setting-panel',
|
||||
// 'designer/modules/workspace-panel',
|
||||
// 'designer/modules/view-panel',
|
||||
// 'designer/modules/sandbox',
|
||||
// 'designer/modules/hooks',
|
||||
// ],
|
||||
// collapsible: false,
|
||||
// },
|
||||
// {
|
||||
// type: 'category',
|
||||
// label: '扩展',
|
||||
// items: ['designer/extend/overview', 'designer/extend/remote-service'],
|
||||
// collapsible: false,
|
||||
// },
|
||||
// 'designer/setters',
|
||||
{
|
||||
type: 'category',
|
||||
label: '接入指南',
|
||||
items: ['designer/deploy/designer', 'designer/deploy/sandbox', 'designer/deploy/server'],
|
||||
collapsed: false,
|
||||
},
|
||||
{
|
||||
type: 'category',
|
||||
label: '设计器自定义',
|
||||
items: [
|
||||
'designer/customize/panels',
|
||||
'designer/customize/tools',
|
||||
'designer/customize/sidebar',
|
||||
'designer/customize/setters',
|
||||
'designer/customize/editor',
|
||||
'designer/customize/components',
|
||||
],
|
||||
collapsed: false,
|
||||
},
|
||||
{
|
||||
type: 'category',
|
||||
label: '设计原理',
|
||||
items: ['designer/design/overview', 'designer/design/filesystem', 'designer/design/sandbox'],
|
||||
collapsed: false,
|
||||
},
|
||||
],
|
||||
|
||||
boot: [
|
||||
@@ -59,7 +62,7 @@ const sidebars = {
|
||||
// 'boot/i18n',
|
||||
],
|
||||
|
||||
protocol: ['protocol/material-protocol', 'protocol/material-package-spec'],
|
||||
// protocol: ['protocol/material-protocol', 'protocol/material-package-spec'],
|
||||
};
|
||||
|
||||
module.exports = sidebars;
|
||||
|
||||
@@ -6,37 +6,28 @@ const timelines = [
|
||||
{
|
||||
icon: null,
|
||||
title: 'Alpha',
|
||||
date: '2023.08.30',
|
||||
date: '2024.01.31',
|
||||
description: translate({
|
||||
id: 'homepage.timeline.alpha',
|
||||
message: '开源仓库和文档站点上线,发布 alpha 演示版本。',
|
||||
}),
|
||||
},
|
||||
{
|
||||
icon: null,
|
||||
title: 'Beta',
|
||||
date: '2023.09.30',
|
||||
description: translate({
|
||||
id: 'homepage.timeline.beta',
|
||||
message: '核心 API 面向社区场景重构和优化,发布 Beta 测试版本。',
|
||||
message: '核心 API 重构完成,文档内容优化',
|
||||
}),
|
||||
},
|
||||
{
|
||||
icon: null,
|
||||
title: '1.0 RC',
|
||||
date: '2023.11.30',
|
||||
date: '2024.04.30',
|
||||
description: translate({
|
||||
id: 'homepage.timeline.rc',
|
||||
message: '核心 API 基本稳定,不再发生 BR,发布 1.0 RC 版本。',
|
||||
message: '核心 API 基本稳定,能力完善。',
|
||||
}),
|
||||
},
|
||||
{
|
||||
icon: null,
|
||||
title: '1.0',
|
||||
date: 'Before 2023.12.29',
|
||||
date: 'Before 2024.12.31',
|
||||
description: translate({
|
||||
id: 'homepage.timeline.stable',
|
||||
message: 'API 完全稳定,提供良好的社区支持,可用于生产环境。',
|
||||
message: '1.0 正式版常规迭代',
|
||||
}),
|
||||
},
|
||||
];
|
||||
|
||||
@@ -24,30 +24,18 @@ function HomepageHeader() {
|
||||
{translate({ id: 'homepage.hero.tagline', message: siteConfig.tagline })}
|
||||
</p>
|
||||
<div className={styles.buttons}>
|
||||
<Link className="button button--primary button--lg" to="/docs/intro">
|
||||
{translate({
|
||||
id: 'homepage.hero.button.document',
|
||||
message: '快速开始',
|
||||
})}
|
||||
</Link>
|
||||
<Link
|
||||
className="button button--primary button--lg"
|
||||
className="button button--secondary button--lg"
|
||||
to="https://tango-demo.musicfe.com/designer/"
|
||||
>
|
||||
{translate({ id: 'homepage.hero.button.playground', message: '演示应用' })}
|
||||
</Link>
|
||||
<Link className="button button--secondary button--lg" to="/docs/intro">
|
||||
{translate({
|
||||
id: 'homepage.hero.button.document',
|
||||
message: '使用文档',
|
||||
})}
|
||||
</Link>
|
||||
<a
|
||||
href="https://www.producthunt.com/posts/tango-b8474917-fbce-4180-9fac-4ac7d7a6fa7d?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-tango-b8474917-fbce-4180-9fac-4ac7d7a6fa7d"
|
||||
target="_blank"
|
||||
rel="noreferrer"
|
||||
>
|
||||
<img
|
||||
src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=412854&theme=light"
|
||||
alt="Tango - A source code based low-code builder | Product Hunt"
|
||||
width="250px"
|
||||
height="54px"
|
||||
/>
|
||||
</a>
|
||||
</div>
|
||||
<div className={styles.heroImageBox}>
|
||||
<img
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
{
|
||||
"$schema": "node_modules/lerna/schemas/lerna-schema.json",
|
||||
"useWorkspaces": true,
|
||||
"version": "independent",
|
||||
"packages": ["packages/*"],
|
||||
"npmClient": "yarn",
|
||||
|
||||
+23
-19
@@ -6,30 +6,31 @@
|
||||
"apps/*"
|
||||
],
|
||||
"scripts": {
|
||||
"start": "yarn workspace playground start",
|
||||
"start": "yarn workspace playground dev",
|
||||
"start:docs": "yarn workspace storybook storybook",
|
||||
"start:site": "yarn workspace website start",
|
||||
"deploy:site": "yarn workspace website deploy",
|
||||
"build": "lerna run build",
|
||||
"build:site": "yarn workspace website build",
|
||||
"typedoc": "typedoc --options typedoc.json",
|
||||
"typedoc": "typedoc",
|
||||
"docs": "yarn typedoc && open docs/index.html",
|
||||
"test": "jest",
|
||||
"test:watch": "jest --watch",
|
||||
"eslint": "eslint packages/**/src/*.{ts,tsx} --cache",
|
||||
"publish": "lerna publish",
|
||||
"ver": "lerna version --no-private --conventional-commits",
|
||||
"release": "yarn eslint && yarn build && yarn run ver && lerna publish from-git",
|
||||
"ver": "lerna version --no-private",
|
||||
"release": "yarn eslint && yarn build && lerna version --no-private --conventional-commits && lerna publish from-git",
|
||||
"release:npm": "yarn eslint && yarn build && yarn run ver && lerna publish from-git",
|
||||
"release:beta": "yarn eslint && yarn build && yarn run ver && lerna publish from-package --dist-tag beta",
|
||||
"up": "yarn upgrade-interactive --latest",
|
||||
"prepare": "husky install"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@babel/preset-env": "^7.23.2",
|
||||
"@babel/preset-react": "^7.22.15",
|
||||
"@babel/preset-typescript": "^7.23.2",
|
||||
"@commitlint/cli": "^17.5.0",
|
||||
"@commitlint/config-conventional": "^17.3.0",
|
||||
"@babel/preset-env": "^7.23.6",
|
||||
"@babel/preset-react": "^7.23.3",
|
||||
"@babel/preset-typescript": "^7.23.3",
|
||||
"@commitlint/cli": "^18.4.3",
|
||||
"@commitlint/config-conventional": "^18.4.3",
|
||||
"@types/jest": "^29.5.7",
|
||||
"@types/lodash-es": "^4.17.10",
|
||||
"@types/lodash.get": "^4.4.8",
|
||||
@@ -38,13 +39,13 @@
|
||||
"@types/react": "^18.2.34",
|
||||
"@types/react-dom": "^18.2.14",
|
||||
"@types/styled-components": "^5.1.29",
|
||||
"@typescript-eslint/eslint-plugin": "^6.9.1",
|
||||
"@typescript-eslint/parser": "^6.9.1",
|
||||
"conventional-changelog-cli": "^2.2.2",
|
||||
"@typescript-eslint/eslint-plugin": "^6.13.2",
|
||||
"@typescript-eslint/parser": "^6.13.2",
|
||||
"conventional-changelog-cli": "^4.1.0",
|
||||
"copyfiles": "^2.4.1",
|
||||
"eslint": "^8.52.0",
|
||||
"eslint": "^8.55.0",
|
||||
"eslint-config-ali": "^14.0.2",
|
||||
"eslint-config-prettier": "^9.0.0",
|
||||
"eslint-config-prettier": "^9.1.0",
|
||||
"eslint-import-resolver-typescript": "^3.6.1",
|
||||
"eslint-plugin-import": "^2.29.0",
|
||||
"eslint-plugin-react": "^7.33.2",
|
||||
@@ -53,14 +54,17 @@
|
||||
"husky": "^8.0.3",
|
||||
"jest": "^29.7.0",
|
||||
"jest-environment-jsdom": "^29.7.0",
|
||||
"lerna": "^6.6.1",
|
||||
"lint-staged": "^14.0.1",
|
||||
"prettier": "^2.8.7",
|
||||
"lerna": "^8.0.0",
|
||||
"lint-staged": "^15.2.0",
|
||||
"prettier": "^3.1.0",
|
||||
"react": "^17.0.0",
|
||||
"react-dom": "^17.0.0",
|
||||
"styled-components": "^5.3.6",
|
||||
"typedoc": "^0.25.3",
|
||||
"typescript": "^5.2.2"
|
||||
"typedoc": "^0.25.4",
|
||||
"typescript": "^5.3.3"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=18"
|
||||
},
|
||||
"lint-staged": {
|
||||
"*.{js,jsx,ts,tsx}": [
|
||||
|
||||
@@ -3,6 +3,36 @@
|
||||
All notable changes to this project will be documented in this file.
|
||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||
|
||||
# [1.0.0-alpha.6](https://github.com/netease/tango/compare/@music163/tango-context@1.0.0-alpha.5...@music163/tango-context@1.0.0-alpha.6) (2024-01-16)
|
||||
|
||||
**Note:** Version bump only for package @music163/tango-context
|
||||
|
||||
# [1.0.0-alpha.5](https://github.com/netease/tango/compare/@music163/tango-context@1.0.0-alpha.4...@music163/tango-context@1.0.0-alpha.5) (2023-12-29)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
- refactor VariableTree & Workspace ([#83](https://github.com/netease/tango/issues/83)) ([8c07821](https://github.com/netease/tango/commit/8c07821d93cea4dfc43f81ca948b845176821184))
|
||||
|
||||
# [1.0.0-alpha.4](https://github.com/netease/tango/compare/@music163/tango-context@1.0.0-alpha.3...@music163/tango-context@1.0.0-alpha.4) (2023-12-26)
|
||||
|
||||
**Note:** Version bump only for package @music163/tango-context
|
||||
|
||||
# [1.0.0-alpha.3](https://github.com/netease/tango/compare/@music163/tango-context@1.0.0-alpha.2...@music163/tango-context@1.0.0-alpha.3) (2023-12-25)
|
||||
|
||||
**Note:** Version bump only for package @music163/tango-context
|
||||
|
||||
# [1.0.0-alpha.1](https://github.com/netease/tango/compare/@music163/tango-context@0.2.12...@music163/tango-context@1.0.0-alpha.1) (2023-12-12)
|
||||
|
||||
**Note:** Version bump only for package @music163/tango-context
|
||||
|
||||
## [0.2.12](https://github.com/netease/tango/compare/@music163/tango-context@0.2.11...@music163/tango-context@0.2.12) (2023-12-04)
|
||||
|
||||
**Note:** Version bump only for package @music163/tango-context
|
||||
|
||||
## [0.2.11](https://github.com/netease/tango/compare/@music163/tango-context@0.2.10...@music163/tango-context@0.2.11) (2023-12-04)
|
||||
|
||||
**Note:** Version bump only for package @music163/tango-context
|
||||
|
||||
## [0.2.10](https://github.com/netease/tango/compare/@music163/tango-context@0.2.9...@music163/tango-context@0.2.10) (2023-11-30)
|
||||
|
||||
**Note:** Version bump only for package @music163/tango-context
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@music163/tango-context",
|
||||
"version": "0.2.10",
|
||||
"version": "1.0.0-alpha.6",
|
||||
"description": "react context for tango-apps",
|
||||
"keywords": [
|
||||
"react",
|
||||
@@ -31,9 +31,9 @@
|
||||
"react": ">= 16.8"
|
||||
},
|
||||
"dependencies": {
|
||||
"@music163/tango-core": "^0.2.9",
|
||||
"@music163/tango-helpers": "^0.1.8",
|
||||
"mobx-react-lite": "4.0.2"
|
||||
"@music163/tango-core": "^1.0.0-alpha.6",
|
||||
"@music163/tango-helpers": "^1.0.0-alpha.2",
|
||||
"mobx-react-lite": "4.0.5"
|
||||
},
|
||||
"publishConfig": {
|
||||
"access": "public",
|
||||
|
||||
@@ -1,12 +1,5 @@
|
||||
import type { Engine } from '@music163/tango-core';
|
||||
import { createContext } from '@music163/tango-helpers';
|
||||
|
||||
interface CustomVariableData {
|
||||
key: string;
|
||||
title: string;
|
||||
children?: CustomVariableData[];
|
||||
[key: string]: any;
|
||||
}
|
||||
import { IVariableTreeNode, createContext } from '@music163/tango-helpers';
|
||||
|
||||
export interface ITangoEngineContext {
|
||||
/**
|
||||
@@ -17,8 +10,8 @@ export interface ITangoEngineContext {
|
||||
* 自定义配置数据
|
||||
*/
|
||||
config?: {
|
||||
customActionVariables?: CustomVariableData[];
|
||||
customExpressionVariables?: CustomVariableData[];
|
||||
customActionVariables?: IVariableTreeNode[];
|
||||
customExpressionVariables?: IVariableTreeNode[];
|
||||
};
|
||||
}
|
||||
|
||||
@@ -39,23 +32,25 @@ export const useDesigner = () => {
|
||||
export const useWorkspaceData = () => {
|
||||
const ctx = useTangoEngine();
|
||||
const workspace = useWorkspace();
|
||||
const modelVariables: any[] = []; // 绑定变量列表
|
||||
const storeActionVariables: any[] = []; // 模型中的所有 actions
|
||||
const storeVariables: any[] = []; // 模型中的所有变量
|
||||
const serviceVariables: any[] = []; // 服务中的所有变量
|
||||
const modelVariables: IVariableTreeNode[] = []; // 绑定变量列表
|
||||
const storeActionVariables: IVariableTreeNode[] = []; // 模型中的所有 actions
|
||||
const storeVariables: IVariableTreeNode[] = []; // 模型中的所有变量
|
||||
const serviceVariables: IVariableTreeNode[] = []; // 服务中的所有变量
|
||||
|
||||
Object.values(workspace.storeModules).forEach((file) => {
|
||||
const prefix = `stores.${file.name}`;
|
||||
const states = file.states.map((item) => ({
|
||||
const states: IVariableTreeNode[] = file.states.map((item) => ({
|
||||
title: item.name,
|
||||
key: `${prefix}.${item.name}`,
|
||||
raw: item.code,
|
||||
showRemoveButton: true,
|
||||
}));
|
||||
const actions = file.actions.map((item) => ({
|
||||
const actions: IVariableTreeNode[] = file.actions.map((item) => ({
|
||||
title: item.name,
|
||||
key: `${prefix}.${item.name}`,
|
||||
type: 'function',
|
||||
raw: item.code,
|
||||
showRemoveButton: true,
|
||||
}));
|
||||
|
||||
modelVariables.push({
|
||||
@@ -63,6 +58,7 @@ export const useWorkspaceData = () => {
|
||||
key: prefix,
|
||||
selectable: false,
|
||||
children: states,
|
||||
showAddButton: true,
|
||||
});
|
||||
|
||||
storeActionVariables.push({
|
||||
@@ -77,8 +73,7 @@ export const useWorkspaceData = () => {
|
||||
key: prefix,
|
||||
selectable: false,
|
||||
children: [...states, ...actions],
|
||||
showAddChildIcon: true,
|
||||
showRemoveIcon: true,
|
||||
showAddButton: true,
|
||||
});
|
||||
});
|
||||
|
||||
@@ -88,10 +83,12 @@ export const useWorkspaceData = () => {
|
||||
title: file.name,
|
||||
key: prefix,
|
||||
selectable: false,
|
||||
showAddButton: true,
|
||||
children: Object.keys(file.serviceFunctions || {}).map((key) => ({
|
||||
title: key,
|
||||
key: [prefix, key].join('.'),
|
||||
type: 'function',
|
||||
showRemoveButton: true,
|
||||
})),
|
||||
});
|
||||
});
|
||||
@@ -102,7 +99,7 @@ export const useWorkspaceData = () => {
|
||||
value: item.path,
|
||||
}));
|
||||
|
||||
let actionVariables: CustomVariableData[] = [
|
||||
let actionVariables: IVariableTreeNode[] = [
|
||||
buildVariableOptions('数据模型', '$stores', storeActionVariables),
|
||||
buildVariableOptions('服务函数', '$services', serviceVariables),
|
||||
];
|
||||
@@ -111,7 +108,7 @@ export const useWorkspaceData = () => {
|
||||
actionVariables = actionVariables.concat(ctx.config?.customActionVariables);
|
||||
}
|
||||
|
||||
let expressionVariables: CustomVariableData[] = [
|
||||
let expressionVariables: IVariableTreeNode[] = [
|
||||
buildVariableOptions('数据模型', '$stores', storeVariables),
|
||||
buildVariableOptions('服务函数', '$services', serviceVariables),
|
||||
];
|
||||
@@ -129,7 +126,7 @@ export const useWorkspaceData = () => {
|
||||
};
|
||||
};
|
||||
|
||||
function buildVariableOptions(title: string, key: string, children: any[]) {
|
||||
function buildVariableOptions(title: string, key: string, children: IVariableTreeNode[]) {
|
||||
return {
|
||||
key,
|
||||
title,
|
||||
|
||||
@@ -3,6 +3,47 @@
|
||||
All notable changes to this project will be documented in this file.
|
||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||
|
||||
# [1.0.0-alpha.6](https://github.com/netease/tango/compare/@music163/tango-core@1.0.0-alpha.5...@music163/tango-core@1.0.0-alpha.6) (2024-01-16)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
- 优化变量树实现 ([#90](https://github.com/netease/tango/issues/90)) ([62d403f](https://github.com/netease/tango/commit/62d403f80a5ad08c216bc0c035ffc12c2cf329d2))
|
||||
|
||||
# [1.0.0-alpha.5](https://github.com/netease/tango/compare/@music163/tango-core@1.0.0-alpha.4...@music163/tango-core@1.0.0-alpha.5) (2023-12-29)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
- check if store value is valid ([765ea07](https://github.com/netease/tango/commit/765ea07cd5be6528e3b326e4ecb163647774d9e5))
|
||||
- refactor VariableTree & Workspace ([#83](https://github.com/netease/tango/issues/83)) ([8c07821](https://github.com/netease/tango/commit/8c07821d93cea4dfc43f81ca948b845176821184))
|
||||
|
||||
# [1.0.0-alpha.4](https://github.com/netease/tango/compare/@music163/tango-core@1.0.0-alpha.3...@music163/tango-core@1.0.0-alpha.4) (2023-12-26)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
- list overflow in expSetter ([4d6b67e](https://github.com/netease/tango/commit/4d6b67eecd02b31f01d1bc896c6eeb83f6b34b35))
|
||||
|
||||
# [1.0.0-alpha.3](https://github.com/netease/tango/compare/@music163/tango-core@1.0.0-alpha.2...@music163/tango-core@1.0.0-alpha.3) (2023-12-25)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
- export componentEntry module ([149002d](https://github.com/netease/tango/commit/149002ddddaee859333469f65c054d811bde2f7f))
|
||||
|
||||
# [1.0.0-alpha.1](https://github.com/netease/tango/compare/@music163/tango-core@0.2.11...@music163/tango-core@1.0.0-alpha.1) (2023-12-12)
|
||||
|
||||
**Note:** Version bump only for package @music163/tango-core
|
||||
|
||||
## [0.2.11](https://github.com/netease/tango/compare/@music163/tango-core@0.2.10...@music163/tango-core@0.2.11) (2023-12-04)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
- update FileType ([c884712](https://github.com/netease/tango/commit/c8847123312bc47ea06575f4e714dfd596893e39))
|
||||
|
||||
## [0.2.10](https://github.com/netease/tango/compare/@music163/tango-core@0.2.9...@music163/tango-core@0.2.10) (2023-12-04)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
- add filesFormatter to sandbox & fix update props with imports ([#71](https://github.com/netease/tango/issues/71)) ([138cbe9](https://github.com/netease/tango/commit/138cbe9b203b370aff42c1ae8086d69edacf35e9))
|
||||
|
||||
## [0.2.9](https://github.com/netease/tango/compare/@music163/tango-core@0.2.8...@music163/tango-core@0.2.9) (2023-11-30)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@music163/tango-core",
|
||||
"version": "0.2.9",
|
||||
"version": "1.0.0-alpha.6",
|
||||
"description": "tango core",
|
||||
"author": "wwsun <ww.sun@outlook.com>",
|
||||
"homepage": "",
|
||||
@@ -24,14 +24,14 @@
|
||||
"prepublishOnly": "yarn build"
|
||||
},
|
||||
"dependencies": {
|
||||
"@babel/generator": "^7.23.0",
|
||||
"@babel/parser": "^7.23.0",
|
||||
"@babel/traverse": "^7.23.2",
|
||||
"@babel/types": "^7.23.0",
|
||||
"@music163/tango-helpers": "^0.1.8",
|
||||
"@types/babel__generator": "^7.6.6",
|
||||
"@types/babel__traverse": "^7.20.3",
|
||||
"mobx": "6.9.0",
|
||||
"@babel/generator": "^7.23.5",
|
||||
"@babel/parser": "^7.23.5",
|
||||
"@babel/traverse": "^7.23.5",
|
||||
"@babel/types": "^7.23.5",
|
||||
"@music163/tango-helpers": "^1.0.0-alpha.2",
|
||||
"@types/babel__generator": "^7.6.7",
|
||||
"@types/babel__traverse": "^7.20.4",
|
||||
"mobx": "6.12.0",
|
||||
"path-browserify": "^1.0.1"
|
||||
},
|
||||
"peerDependencies": {
|
||||
|
||||
@@ -44,6 +44,11 @@ export function isValidCode(code: string) {
|
||||
/**
|
||||
* 检测代码是否是合法的表达式代码
|
||||
* 表达式是一组代码的集合,它返回一个值;每一个合法的表达式都能计算成某个值
|
||||
* 只要你输入这段代码,可以形成一个值,就算是表达式
|
||||
* @example x = 1; // 1
|
||||
* @example 1=1
|
||||
* @example 'hello'
|
||||
* @example { foo: 'bar' }
|
||||
* @param code
|
||||
* @returns
|
||||
*/
|
||||
|
||||
@@ -22,16 +22,16 @@ import {
|
||||
code2expression,
|
||||
object2node,
|
||||
} from './parse';
|
||||
import { isValidComponentName } from '../string';
|
||||
import { getFullPath, isValidComponentName } from '../string';
|
||||
import { isDefineService, isDefineStore, isTangoVariable } from '../assert';
|
||||
import type {
|
||||
IRouteData,
|
||||
IStorePropertyData,
|
||||
ITangoViewNodeData,
|
||||
IImportDeclarationPayload,
|
||||
IServiceFunctionPayload,
|
||||
InsertChildPositionType,
|
||||
IImportSpecifierData,
|
||||
IExportSpecifierData,
|
||||
} from '../../types';
|
||||
import { IdGenerator } from '../id-generator';
|
||||
|
||||
@@ -997,7 +997,7 @@ export function deleteServiceConfigFromServiceFile(ast: t.File, serviceFunctionN
|
||||
* @param payload
|
||||
* @returns
|
||||
*/
|
||||
export function serviceConfig2Node(payload: IServiceFunctionPayload) {
|
||||
export function serviceConfig2Node(payload: object) {
|
||||
return object2node(payload, (value, key) => {
|
||||
if (key === 'formatter' && value) {
|
||||
return code2expression(value);
|
||||
@@ -1006,10 +1006,7 @@ export function serviceConfig2Node(payload: IServiceFunctionPayload) {
|
||||
});
|
||||
}
|
||||
|
||||
export function updateServiceConfigToServiceFile(
|
||||
ast: t.File,
|
||||
config: { [key: string]: IServiceFunctionPayload },
|
||||
) {
|
||||
export function updateServiceConfigToServiceFile(ast: t.File, config: Dict<object>) {
|
||||
traverse(ast, {
|
||||
CallExpression(path) {
|
||||
const calleeName = keyNode2value(path.node.callee) as string;
|
||||
@@ -1330,6 +1327,33 @@ export function traverseViewFile(ast: t.File, idGenerator: IdGenerator) {
|
||||
};
|
||||
}
|
||||
|
||||
export function traverseComponentsEntryFile(ast: t.File, baseDir?: string) {
|
||||
const exportMap: Record<string, IExportSpecifierData> = {};
|
||||
traverse(ast, {
|
||||
ExportNamedDeclaration(path) {
|
||||
const node = path.node;
|
||||
let source = node2value(node.source);
|
||||
if (baseDir) {
|
||||
// fix relative source path
|
||||
source = getFullPath(baseDir, source);
|
||||
}
|
||||
node.specifiers.forEach((specifier) => {
|
||||
if (t.isExportSpecifier(specifier)) {
|
||||
const name = keyNode2value(specifier.exported) as string;
|
||||
if (name) {
|
||||
exportMap[name] = {
|
||||
source,
|
||||
exportedName: name,
|
||||
};
|
||||
}
|
||||
}
|
||||
});
|
||||
},
|
||||
});
|
||||
|
||||
return { ast, exportMap };
|
||||
}
|
||||
|
||||
/**
|
||||
* 解析导入语句
|
||||
*/
|
||||
|
||||
@@ -33,6 +33,10 @@ export function inferFileType(filename: string): FileType {
|
||||
return FileType.JsonViewModule;
|
||||
}
|
||||
|
||||
if (/\/(blocks|components)\/index\.js/.test(filename)) {
|
||||
return FileType.ComponentsEntryModule;
|
||||
}
|
||||
|
||||
if (/\/services\/.+\.js$/.test(filename)) {
|
||||
return FileType.ServiceModule;
|
||||
}
|
||||
@@ -49,10 +53,6 @@ export function inferFileType(filename: string): FileType {
|
||||
return FileType.StoreModule;
|
||||
}
|
||||
|
||||
if (/\/blocks\/[\w-]+\/index\.js/.test(filename)) {
|
||||
return FileType.BlockEntryModule;
|
||||
}
|
||||
|
||||
if (/\.jsx?$/.test(filename)) {
|
||||
return FileType.Module;
|
||||
}
|
||||
@@ -170,24 +170,35 @@ export function getBlockNameByFilename(filename: string) {
|
||||
}
|
||||
|
||||
/**
|
||||
* FIXME: 有问题,需要优化下
|
||||
* 基于 from 文件的地址计算 to 文件的相对引用路径
|
||||
* @param from
|
||||
* @param to
|
||||
* 合并两个路径
|
||||
* @param root
|
||||
* @param filename
|
||||
* @returns
|
||||
*/
|
||||
export function getRelativePath(from: string, to: string) {
|
||||
const fromFolder = path.dirname(from);
|
||||
return path.relative(fromFolder, to);
|
||||
export function getFullPath(root: string, filename: string) {
|
||||
return path.join(root, filename);
|
||||
}
|
||||
|
||||
/**
|
||||
* 计算 targetFile 在 sourceFile 中的相对引用路径
|
||||
* @param sourceFile
|
||||
* @param targetFile
|
||||
* @returns
|
||||
*/
|
||||
export function getRelativePath(sourceFile: string, targetFile: string) {
|
||||
sourceFile = path.dirname(sourceFile);
|
||||
return path.relative(sourceFile, targetFile);
|
||||
}
|
||||
|
||||
/**
|
||||
* 判断给定字符串是否是文件路径
|
||||
* @example ./pages/index.js -- yes
|
||||
* @example ../pages/index.js -- yes
|
||||
* @example ../components -- yes
|
||||
* @example /src/pages/index.js -- yes
|
||||
* @example @music163/tango-designer -- no
|
||||
* @param str
|
||||
*/
|
||||
export function isFilepath(str: string) {
|
||||
return /^(\.\.?\/|\/).*\.[a-z]+$/.test(str);
|
||||
return /^(\.\.?\/|\/).*(\.[a-z]+)?$/.test(str);
|
||||
}
|
||||
|
||||
@@ -4,5 +4,5 @@ export * from './helpers';
|
||||
export * from './types';
|
||||
|
||||
export { default as generator } from '@babel/generator';
|
||||
export { default as traverse } from '@babel/types';
|
||||
export { default as traverse } from '@babel/traverse';
|
||||
export * from '@babel/parser';
|
||||
|
||||
@@ -0,0 +1,40 @@
|
||||
import path from 'path';
|
||||
import { action, computed, makeObservable, observable } from 'mobx';
|
||||
import { TangoModule } from './module';
|
||||
import { IWorkspace } from './interfaces';
|
||||
import { IExportSpecifierData, IFileConfig } from '../types';
|
||||
import { traverseComponentsEntryFile } from '../helpers';
|
||||
|
||||
/**
|
||||
* 本地组件目录的入口文件,例如 '/components/index.js' 或 `/blocks/index.js`
|
||||
*/
|
||||
export class TangoComponentsEntryModule extends TangoModule {
|
||||
exportList: Record<string, IExportSpecifierData>;
|
||||
|
||||
constructor(workspace: IWorkspace, props: IFileConfig) {
|
||||
super(workspace, props, false);
|
||||
this.update(props.code, false, false);
|
||||
makeObservable(this, {
|
||||
_code: observable,
|
||||
_cleanCode: observable,
|
||||
exportList: observable,
|
||||
code: computed,
|
||||
cleanCode: computed,
|
||||
update: action,
|
||||
});
|
||||
}
|
||||
|
||||
_analysisAst() {
|
||||
const baseDir = path.dirname(this.filename);
|
||||
const { exportMap } = traverseComponentsEntryFile(this.ast, baseDir);
|
||||
this.exportList = exportMap;
|
||||
Object.keys(this.exportList).forEach((key) => {
|
||||
this.workspace.componentPrototypes.set(key, {
|
||||
name: key,
|
||||
exportType: 'namedExport',
|
||||
package: baseDir,
|
||||
type: 'element',
|
||||
});
|
||||
});
|
||||
}
|
||||
}
|
||||
@@ -11,5 +11,6 @@ export * from './route-module';
|
||||
export * from './service-module';
|
||||
export * from './store-module';
|
||||
export * from './view-module';
|
||||
export * from './component-module';
|
||||
export * from './node';
|
||||
export * from './interfaces';
|
||||
|
||||
@@ -8,7 +8,6 @@ import {
|
||||
InsertChildPositionType,
|
||||
ITangoConfigPackages,
|
||||
IPageConfigData,
|
||||
IServiceFunctionPayload,
|
||||
IImportSpecifierSourceData,
|
||||
IImportSpecifierData,
|
||||
} from '../types';
|
||||
@@ -204,20 +203,23 @@ export interface IWorkspace {
|
||||
|
||||
// ----------------- 服务函数文件操作 -----------------
|
||||
|
||||
getServiceFunction?: (serviceKey: string) => object;
|
||||
listServiceFunctions?: () => Record<string, object>;
|
||||
removeServiceFunction?: (serviceName: string, modName?: string) => void;
|
||||
addServiceFunction?: (
|
||||
payload: IServiceFunctionPayload | IServiceFunctionPayload[],
|
||||
modName?: string,
|
||||
) => void;
|
||||
updateServiceFunction?: (payload: IServiceFunctionPayload, modName?: string) => void;
|
||||
updateServiceBaseConfig?: (IServiceFunctionPayload: object, modName?: string) => void;
|
||||
getServiceFunction?: (serviceKey: string) => {
|
||||
name: string;
|
||||
moduleName: string;
|
||||
config: Dict<object>;
|
||||
};
|
||||
listServiceFunctions?: () => Dict<object>;
|
||||
removeServiceFunction?: (serviceKey: string) => void;
|
||||
addServiceFunction?: (serviceName: string, config: Dict, modName?: string) => void;
|
||||
addServiceFunctions?: (configs: Dict<object>, modName?: string) => void;
|
||||
updateServiceFunction?: (serviceName: string, payload: Dict, modName?: string) => void;
|
||||
updateServiceBaseConfig?: (config: Dict, modName?: string) => void;
|
||||
|
||||
// ----------------- 状态管理文件操作 -----------------
|
||||
addStoreState?: (storeName: string, stateName: string, initValue: string) => void;
|
||||
removeStoreState?: (storeName: string, stateName: string) => void;
|
||||
removeStoreModule?: (storeName: string) => void;
|
||||
removeStoreVariable?: (variablePath: string) => void;
|
||||
updateStoreVariable?: (variablePath: string, code: string) => void;
|
||||
|
||||
// ----------------- 视图文件操作 -----------------
|
||||
|
||||
@@ -256,15 +258,11 @@ export interface IWorkspace {
|
||||
|
||||
removeBizComp?: (name: string) => void;
|
||||
|
||||
// ----------------- 其他操作 -----------------
|
||||
|
||||
updateModuleCodeByVariablePath?: (variablePath: string, code: string) => void;
|
||||
|
||||
// ----------------- getter -----------------
|
||||
|
||||
get activeViewModule(): IViewFile;
|
||||
get pages(): any[];
|
||||
get bizComps(): string[];
|
||||
get baseComps(): string[];
|
||||
get blocks(): any[];
|
||||
get localComps(): string[];
|
||||
}
|
||||
|
||||
@@ -22,9 +22,9 @@ export class TangoModule extends TangoFile {
|
||||
ast: t.File;
|
||||
|
||||
/**
|
||||
* 导入语句
|
||||
* 导入的依赖列表
|
||||
*/
|
||||
imports: ImportDeclarationDataType;
|
||||
importList: ImportDeclarationDataType;
|
||||
|
||||
constructor(workspace: IWorkspace, props: IFileConfig, isSyncCode = true) {
|
||||
super(workspace, props, isSyncCode);
|
||||
@@ -95,7 +95,7 @@ export class TangoModule extends TangoFile {
|
||||
|
||||
_analysisAst() {
|
||||
const { imports } = traverseFile(this.ast);
|
||||
this.imports = imports;
|
||||
this.importList = imports;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ import {
|
||||
deleteServiceConfigFromServiceFile,
|
||||
updateBaseConfigToServiceFile,
|
||||
} from '../helpers';
|
||||
import { IFileConfig, IServiceFunctionPayload } from '../types';
|
||||
import { IFileConfig } from '../types';
|
||||
import { IWorkspace } from './interfaces';
|
||||
import { TangoModule } from './module';
|
||||
|
||||
@@ -59,7 +59,7 @@ export class TangoServiceModule extends TangoModule {
|
||||
|
||||
_analysisAst() {
|
||||
const { imports, services, baseConfig } = traverseServiceFile(this.ast);
|
||||
this.imports = imports;
|
||||
this.importList = imports;
|
||||
this._serviceFunctions = services;
|
||||
this._baseConfig = baseConfig;
|
||||
if (baseConfig.namespace) {
|
||||
@@ -67,25 +67,23 @@ export class TangoServiceModule extends TangoModule {
|
||||
}
|
||||
}
|
||||
|
||||
addServiceFunction(payload: IServiceFunctionPayload) {
|
||||
const { name, ...rest } = payload;
|
||||
this.ast = updateServiceConfigToServiceFile(this.ast, { [name]: clone(rest, false) });
|
||||
addServiceFunction(name: string, config: object) {
|
||||
this.ast = updateServiceConfigToServiceFile(this.ast, { [name]: clone(config, false) });
|
||||
return this;
|
||||
}
|
||||
|
||||
addServiceFunctions(payloads: IServiceFunctionPayload[]) {
|
||||
const config = payloads.reduce((acc, cur) => {
|
||||
const { name, ...rest } = cur;
|
||||
acc[name] = clone(rest, false);
|
||||
return acc;
|
||||
}, {});
|
||||
this.ast = updateServiceConfigToServiceFile(this.ast, config);
|
||||
/**
|
||||
* 批量添加服务函数
|
||||
* @param configs { [name: string]: object }
|
||||
* @returns
|
||||
*/
|
||||
addServiceFunctions(configs: Dict<object>) {
|
||||
this.ast = updateServiceConfigToServiceFile(this.ast, configs);
|
||||
return this;
|
||||
}
|
||||
|
||||
updateServiceFunction(payload: IServiceFunctionPayload) {
|
||||
const { name, ...rest } = payload;
|
||||
this.ast = updateServiceConfigToServiceFile(this.ast, { [name]: clone(rest, false) });
|
||||
updateServiceFunction(name: string, payload: object) {
|
||||
this.ast = updateServiceConfigToServiceFile(this.ast, { [name]: clone(payload, false) });
|
||||
return this;
|
||||
}
|
||||
|
||||
|
||||
@@ -159,7 +159,7 @@ export class TangoViewModule extends TangoModule implements IViewFile {
|
||||
this._cleanCode = ast2code(cleanAst);
|
||||
|
||||
this._importedModules = importedModules;
|
||||
this.imports = imports;
|
||||
this.importList = imports;
|
||||
this.importMap = buildImportMap(imports);
|
||||
this.variables = variables;
|
||||
|
||||
@@ -180,7 +180,7 @@ export class TangoViewModule extends TangoModule implements IViewFile {
|
||||
* 依赖列表
|
||||
*/
|
||||
listImportSources() {
|
||||
return Object.keys(this.imports);
|
||||
return Object.keys(this.importList);
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -227,7 +227,7 @@ export class TangoViewModule extends TangoModule implements IViewFile {
|
||||
* @returns
|
||||
*/
|
||||
addImportSpecifiers(source: string, newSpecifiers: IImportSpecifierData[]) {
|
||||
const existSpecifiers = this.imports[source];
|
||||
const existSpecifiers = this.importList[source];
|
||||
if (existSpecifiers) {
|
||||
const insertedSpecifiers = newSpecifiers.filter((item) => {
|
||||
return !existSpecifiers.find((existItem) => existItem.localName === item.localName);
|
||||
@@ -307,10 +307,24 @@ export class TangoViewModule extends TangoModule implements IViewFile {
|
||||
updateNodeAttributes(nodeId: string, config: Record<string, any>, relatedImports?: string[]) {
|
||||
if (relatedImports && relatedImports.length) {
|
||||
// 导入依赖的组件
|
||||
relatedImports.forEach((name: string) => {
|
||||
const newImportData = relatedImports.reduce((prev, name) => {
|
||||
const proto = this.workspace.getPrototype(name);
|
||||
const { source, specifiers } = prototype2importDeclarationData(proto, this.filename);
|
||||
this.addImportSpecifiers(source, specifiers);
|
||||
const existSpecifiers: IImportSpecifierData[] = prev[source];
|
||||
if (existSpecifiers) {
|
||||
// merge specifiers
|
||||
specifiers.forEach((item) => {
|
||||
if (!existSpecifiers.find((existItem) => existItem.localName === item.localName)) {
|
||||
existSpecifiers.push(item);
|
||||
}
|
||||
});
|
||||
} else {
|
||||
prev[source] = specifiers;
|
||||
}
|
||||
return prev;
|
||||
}, {});
|
||||
Object.keys(newImportData).forEach((source) => {
|
||||
this.addImportSpecifiers(source, newImportData[source]);
|
||||
});
|
||||
}
|
||||
this.ast = updateJSXAttributes(this.ast, nodeId, config);
|
||||
|
||||
@@ -2,9 +2,13 @@ import { action, computed, makeObservable, observable } from 'mobx';
|
||||
import { JSXElement } from '@babel/types';
|
||||
import {
|
||||
ComponentPrototypeType,
|
||||
Dict,
|
||||
hasFileExtension,
|
||||
isStoreVariablePath,
|
||||
isString,
|
||||
logger,
|
||||
parseServiceVariablePath,
|
||||
parseStoreVariablePath,
|
||||
uniq,
|
||||
} from '@music163/tango-helpers';
|
||||
import {
|
||||
@@ -14,7 +18,6 @@ import {
|
||||
isPathnameMatchRoute,
|
||||
getJSXElementChildrenNames,
|
||||
namesToImportDeclarations,
|
||||
getBlockNameByFilename,
|
||||
prototype2importDeclarationData,
|
||||
} from '../helpers';
|
||||
import { DropMethod } from './drop-target';
|
||||
@@ -23,19 +26,14 @@ import { TangoNode } from './node';
|
||||
import { TangoJsModule } from './module';
|
||||
import { TangoFile, TangoJsonFile, TangoLessFile } from './file';
|
||||
import { IWorkspace } from './interfaces';
|
||||
import {
|
||||
IFileConfig,
|
||||
FileType,
|
||||
ITangoConfigPackages,
|
||||
IPageConfigData,
|
||||
IServiceFunctionPayload,
|
||||
} from '../types';
|
||||
import { IFileConfig, FileType, ITangoConfigPackages, IPageConfigData } from '../types';
|
||||
import { SelectSource } from './select-source';
|
||||
import { DragSource } from './drag-source';
|
||||
import { TangoRouteModule } from './route-module';
|
||||
import { TangoStoreEntryModule, TangoStoreModule } from './store-module';
|
||||
import { TangoServiceModule } from './service-module';
|
||||
import { TangoViewModule } from './view-module';
|
||||
import { TangoComponentsEntryModule } from './component-module';
|
||||
|
||||
export interface IWorkspaceOptions {
|
||||
/**
|
||||
@@ -73,8 +71,14 @@ export class Workspace extends EventTarget implements IWorkspace {
|
||||
*/
|
||||
files: Map<string, TangoFile>;
|
||||
|
||||
/**
|
||||
* 组件配置
|
||||
*/
|
||||
componentPrototypes: Map<string, ComponentPrototypeType>;
|
||||
|
||||
/**
|
||||
* 入口文件
|
||||
*/
|
||||
entry: string;
|
||||
|
||||
/**
|
||||
@@ -92,12 +96,6 @@ export class Workspace extends EventTarget implements IWorkspace {
|
||||
*/
|
||||
activeViewFile: string;
|
||||
|
||||
/**
|
||||
* 本地区块 { [blockName]: filePath }
|
||||
* FIXME: 修正类型 Record<string, TangoBlockModule>
|
||||
*/
|
||||
localBlocks: Record<string, string>;
|
||||
|
||||
/**
|
||||
* 路由配置模块
|
||||
*/
|
||||
@@ -112,6 +110,8 @@ export class Workspace extends EventTarget implements IWorkspace {
|
||||
|
||||
serviceModules: Record<string, TangoServiceModule> = {};
|
||||
|
||||
componentsEntryModule: TangoComponentsEntryModule;
|
||||
|
||||
/**
|
||||
* package.json 文件
|
||||
*/
|
||||
@@ -197,8 +197,8 @@ export class Workspace extends EventTarget implements IWorkspace {
|
||||
return list;
|
||||
}
|
||||
|
||||
get blocks() {
|
||||
return Object.keys(this.localBlocks);
|
||||
get localComps(): string[] {
|
||||
return Object.keys(this.componentsEntryModule?.exportList || {});
|
||||
}
|
||||
|
||||
constructor(options?: IWorkspaceOptions) {
|
||||
@@ -207,7 +207,6 @@ export class Workspace extends EventTarget implements IWorkspace {
|
||||
this.selectSource = new SelectSource(this);
|
||||
this.dragSource = new DragSource(this);
|
||||
this.componentPrototypes = new Map();
|
||||
this.localBlocks = {};
|
||||
this.entry = options?.entry;
|
||||
this.activeRoute = options?.defaultActiveRoute || '/';
|
||||
this.activeFile = options?.entry;
|
||||
@@ -233,8 +232,6 @@ export class Workspace extends EventTarget implements IWorkspace {
|
||||
activeRoute: observable,
|
||||
activeFile: observable,
|
||||
activeViewFile: observable,
|
||||
localBlocks: observable,
|
||||
blocks: computed,
|
||||
pages: computed,
|
||||
bizComps: computed,
|
||||
setActiveRoute: action,
|
||||
@@ -330,6 +327,10 @@ export class Workspace extends EventTarget implements IWorkspace {
|
||||
module = new TangoStoreEntryModule(this, props);
|
||||
this.storeEntryModule = module;
|
||||
break;
|
||||
case FileType.ComponentsEntryModule:
|
||||
module = new TangoComponentsEntryModule(this, props);
|
||||
this.componentsEntryModule = module;
|
||||
break;
|
||||
case FileType.RouteModule: {
|
||||
module = new TangoRouteModule(this, props);
|
||||
this.routeModule = module;
|
||||
@@ -351,19 +352,6 @@ export class Workspace extends EventTarget implements IWorkspace {
|
||||
module = new TangoStoreModule(this, props);
|
||||
this.storeModules[module.name] = module;
|
||||
break;
|
||||
case FileType.BlockEntryModule: {
|
||||
const blockName = getBlockNameByFilename(props.filename);
|
||||
const prototype: ComponentPrototypeType = {
|
||||
name: blockName,
|
||||
exportType: 'defaultExport',
|
||||
package: props.filename,
|
||||
type: 'block',
|
||||
};
|
||||
this.localBlocks[blockName] = props.filename;
|
||||
this.componentPrototypes.set(blockName, prototype);
|
||||
module = new TangoViewModule(this, props);
|
||||
break;
|
||||
}
|
||||
case FileType.Module:
|
||||
module = new TangoJsModule(this, props);
|
||||
break;
|
||||
@@ -404,8 +392,22 @@ export class Workspace extends EventTarget implements IWorkspace {
|
||||
this.storeEntryModule.addStore(storeName).update();
|
||||
}
|
||||
|
||||
/**
|
||||
* 添加视图文件
|
||||
* @param viewName 文件名
|
||||
* @param code 代码
|
||||
*/
|
||||
addViewFile(viewName: string, code: string) {
|
||||
// TODO: implement it
|
||||
const viewRoute = viewName.startsWith('/') ? viewName : `/${viewName}`;
|
||||
const filename = `/src/pages/${viewName}.js`;
|
||||
this.addFile(filename, code);
|
||||
this.addRoute(
|
||||
{
|
||||
name: viewName,
|
||||
path: viewRoute,
|
||||
},
|
||||
filename,
|
||||
);
|
||||
}
|
||||
|
||||
updateFile(filename: string, code: string, shouldFormatCode = false) {
|
||||
@@ -504,27 +506,6 @@ export class Workspace extends EventTarget implements IWorkspace {
|
||||
this.removeFile(filename);
|
||||
}
|
||||
|
||||
/**
|
||||
* 添加新的视图文件
|
||||
* @deprecated 使用 addViewFile 代替
|
||||
* FIXME: 重构这个逻辑
|
||||
* @param route 视图名
|
||||
* @param code 视图代码
|
||||
*/
|
||||
addViewPage(routeConfig: string | IPageConfigData, code: string) {
|
||||
const config =
|
||||
typeof routeConfig === 'string'
|
||||
? {
|
||||
name: routeConfig,
|
||||
path: routeConfig.startsWith('/') ? routeConfig : `/${routeConfig}`,
|
||||
}
|
||||
: routeConfig;
|
||||
|
||||
const filename = getFilepath(config.path, '/src/pages', '.js');
|
||||
this.addFile(filename, code);
|
||||
this.addRoute(config, filename);
|
||||
}
|
||||
|
||||
/**
|
||||
* 添加新的路由
|
||||
*/
|
||||
@@ -616,15 +597,23 @@ export class Workspace extends EventTarget implements IWorkspace {
|
||||
}
|
||||
|
||||
/**
|
||||
* 根据变量路径更新模块内容
|
||||
* TODO: 改名,不直观
|
||||
* 根据变量路径删除状态变量
|
||||
* @param variablePath
|
||||
*/
|
||||
removeStoreVariable(variablePath: string) {
|
||||
const { storeName, variableName } = parseStoreVariablePath(variablePath);
|
||||
this.removeStoreState(storeName, variableName);
|
||||
}
|
||||
|
||||
/**
|
||||
* 根据变量路径更新状态变量的值
|
||||
* @param variablePath 变量路径
|
||||
* @param code 变量代码
|
||||
*/
|
||||
updateModuleCodeByVariablePath(variablePath: string, code: string) {
|
||||
if (/^stores\.\w+\.\w+$/.test(variablePath)) {
|
||||
const [, storeName, stateName] = variablePath.split('.');
|
||||
this.storeModules[storeName]?.updateState(stateName, code).update();
|
||||
updateStoreVariable(variablePath: string, code: string) {
|
||||
if (isStoreVariablePath(variablePath)) {
|
||||
const { storeName, variableName } = parseStoreVariablePath(variablePath);
|
||||
this.storeModules[storeName]?.updateState(variableName, code).update();
|
||||
}
|
||||
}
|
||||
|
||||
@@ -635,7 +624,7 @@ export class Workspace extends EventTarget implements IWorkspace {
|
||||
* @returns
|
||||
*/
|
||||
getServiceFunction(serviceKey: string) {
|
||||
const { name, moduleName } = this.parseServiceKey(serviceKey);
|
||||
const { name, moduleName } = parseServiceVariablePath(serviceKey);
|
||||
if (!name) {
|
||||
return;
|
||||
}
|
||||
@@ -649,9 +638,10 @@ export class Workspace extends EventTarget implements IWorkspace {
|
||||
|
||||
/**
|
||||
* 获取服务函数的列表
|
||||
* @returns 返回服务函数的列表 { [serviceKey: string]: Dict }
|
||||
*/
|
||||
listServiceFunctions() {
|
||||
const ret: Record<string, object> = {};
|
||||
const ret: Record<string, Dict> = {};
|
||||
Object.keys(this.serviceModules).forEach((moduleName) => {
|
||||
const module = this.serviceModules[moduleName];
|
||||
Object.keys(module.serviceFunctions).forEach((name) => {
|
||||
@@ -665,36 +655,34 @@ export class Workspace extends EventTarget implements IWorkspace {
|
||||
/**
|
||||
* 更新服务函数
|
||||
*/
|
||||
updateServiceFunction(payload: IServiceFunctionPayload, moduleName = 'index') {
|
||||
this.serviceModules[moduleName].updateServiceFunction(payload).update();
|
||||
updateServiceFunction(serviceName: string, payload: Dict, moduleName = 'index') {
|
||||
this.serviceModules[moduleName].updateServiceFunction(serviceName, payload).update();
|
||||
}
|
||||
|
||||
/**
|
||||
* 新增服务函数,支持批量添加
|
||||
*/
|
||||
addServiceFunction(
|
||||
payload: IServiceFunctionPayload | IServiceFunctionPayload[],
|
||||
moduleName = 'index',
|
||||
) {
|
||||
if (Array.isArray(payload)) {
|
||||
this.serviceModules[moduleName]?.addServiceFunctions(payload).update();
|
||||
} else {
|
||||
this.serviceModules[moduleName]?.addServiceFunction(payload).update();
|
||||
}
|
||||
addServiceFunction(name: string, config: Dict, moduleName = 'index') {
|
||||
this.serviceModules[moduleName]?.addServiceFunction(name, config).update();
|
||||
}
|
||||
|
||||
addServiceFunctions(configs: Dict<Dict>, modName = 'index') {
|
||||
this.serviceModules[modName]?.addServiceFunctions(configs).update();
|
||||
}
|
||||
|
||||
/**
|
||||
* 删除服务函数
|
||||
* @param name
|
||||
*/
|
||||
removeServiceFunction(name: string, moduleName = 'index') {
|
||||
removeServiceFunction(serviceKey: string) {
|
||||
const { moduleName, name } = parseServiceVariablePath(serviceKey);
|
||||
this.serviceModules[moduleName]?.deleteServiceFunction(name).update();
|
||||
}
|
||||
|
||||
/**
|
||||
* 更新服务的基础配置
|
||||
*/
|
||||
updateServiceBaseConfig(config: object, moduleName = 'index') {
|
||||
updateServiceBaseConfig(config: Dict, moduleName = 'index') {
|
||||
this.serviceModules[moduleName]?.updateBaseConfig(config).update();
|
||||
}
|
||||
|
||||
@@ -1226,40 +1214,4 @@ export class Workspace extends EventTarget implements IWorkspace {
|
||||
logger.error('copyFiles failed, source: %s, target: %s', sourceFilePath, targetFilePath);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 解析 serviceKey
|
||||
* @param serviceKey
|
||||
* @returns
|
||||
*
|
||||
* @example services.list => { moduleName: 'index', name: 'list' }
|
||||
* @example services.sub.list => { moduleName: 'sub', name: 'list' }
|
||||
* @example foo => undefined
|
||||
*/
|
||||
private parseServiceKey(serviceKey: string) {
|
||||
const parts = serviceKey.split('.');
|
||||
if (parts[0] !== 'services') {
|
||||
return {};
|
||||
}
|
||||
|
||||
let moduleName = 'index';
|
||||
let name = '';
|
||||
switch (parts.length) {
|
||||
case 2: {
|
||||
name = parts[1];
|
||||
break;
|
||||
}
|
||||
case 3: {
|
||||
moduleName = parts[1];
|
||||
name = parts[2];
|
||||
break;
|
||||
}
|
||||
default:
|
||||
break;
|
||||
}
|
||||
return {
|
||||
moduleName,
|
||||
name,
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
+33
-12
@@ -10,11 +10,25 @@ export enum FileType {
|
||||
Module = 'module',
|
||||
StoreEntryModule = 'storeEntryModule',
|
||||
RouteModule = 'routeModule',
|
||||
BlockEntryModule = 'blockEntryModule',
|
||||
ServiceModule = 'serviceModule',
|
||||
StoreModule = 'storeModule',
|
||||
|
||||
// 组件配置文件
|
||||
ComponentPrototypeModule = 'componentPrototypeModule',
|
||||
// 组件运行调试入口文件,一般为 `/app.js`
|
||||
ComponentDemoEntryModule = 'componentDemoEntryModule',
|
||||
/**
|
||||
* 本地组件目录的入口文件
|
||||
*/
|
||||
ComponentsEntryModule = 'componentsEntryModule',
|
||||
/**
|
||||
* @deprecated 已废弃
|
||||
*/
|
||||
BlockEntryModule = 'blockEntryModule',
|
||||
|
||||
// jsx 类型视图文件
|
||||
JsxViewModule = 'jsxViewModule',
|
||||
// json 类型视图文件
|
||||
JsonViewModule = 'jsonViewModule',
|
||||
|
||||
// 非 js 文件
|
||||
@@ -72,6 +86,24 @@ export interface ITangoViewNodeData<T = JSXElement> {
|
||||
children?: Array<ITangoViewNodeData<T>>;
|
||||
}
|
||||
|
||||
/**
|
||||
* 导出变量数据
|
||||
*/
|
||||
export interface IExportSpecifierData {
|
||||
/**
|
||||
* 来源
|
||||
*/
|
||||
source: string;
|
||||
/**
|
||||
* exported name
|
||||
*/
|
||||
exportedName: string;
|
||||
/**
|
||||
* local name
|
||||
*/
|
||||
localName?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* 导入变量的来源
|
||||
*/
|
||||
@@ -113,17 +145,6 @@ export interface IImportDeclarationPayload {
|
||||
sourcePath: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* 服务函数参数类型
|
||||
*/
|
||||
export interface IServiceFunctionPayload {
|
||||
[key: string]: any;
|
||||
/**
|
||||
* 服务函数名
|
||||
*/
|
||||
name: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Store 属性类型
|
||||
*/
|
||||
|
||||
@@ -15,6 +15,8 @@ describe('ast helpers', () => {
|
||||
it('isValidExpression', () => {
|
||||
expect(isValidExpressionCode('() => { }')).toBeTruthy();
|
||||
expect(isValidExpressionCode('1')).toBeTruthy();
|
||||
expect(isValidExpressionCode('a = 1')).toBeTruthy();
|
||||
expect(isValidExpressionCode('1 + 1')).toBeTruthy();
|
||||
expect(isValidExpressionCode('"hello"')).toBeTruthy();
|
||||
expect(isValidExpressionCode('false')).toBeTruthy();
|
||||
expect(isValidExpressionCode('{ bizId: "vip", type: "category" }')).toBeTruthy();
|
||||
|
||||
@@ -129,8 +129,10 @@ describe('string helpers', () => {
|
||||
expect(getRelativePath('/src/pages/index.js', '/src/blocks/sample-block/index.js')).toEqual(
|
||||
'../blocks/sample-block/index.js',
|
||||
);
|
||||
// TODO: fix me
|
||||
// expect(getRelativePath('/src/pages/', '/src/pages/index.js')).toEqual('./index.js');
|
||||
expect(getRelativePath('/src/pages/index.js', '/src/components')).toEqual('../components');
|
||||
expect(getRelativePath('/src/pages/index.js', '/src/components/input.js')).toEqual(
|
||||
'../components/input.js',
|
||||
);
|
||||
});
|
||||
|
||||
it('getFilepath', () => {
|
||||
@@ -143,7 +145,9 @@ describe('string helpers', () => {
|
||||
expect(isFilepath('./pages/index.js')).toBeTruthy();
|
||||
expect(isFilepath('../pages/index.js')).toBeTruthy();
|
||||
expect(isFilepath('./pages/index.css')).toBeTruthy();
|
||||
expect(isFilepath('/src/pages/index.js')).toBeTruthy();
|
||||
expect(isFilepath('./src/pages/index.js')).toBeTruthy();
|
||||
expect(isFilepath('./src/components')).toBeTruthy();
|
||||
expect(isFilepath('../src/components')).toBeTruthy();
|
||||
expect(isFilepath('path')).toBeFalsy();
|
||||
expect(isFilepath('path-browserify')).toBeFalsy();
|
||||
expect(isFilepath('@music/one')).toBeFalsy();
|
||||
|
||||
@@ -3,6 +3,74 @@
|
||||
All notable changes to this project will be documented in this file.
|
||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||
|
||||
# [1.0.0-alpha.11](https://github.com/netease/tango/compare/@music163/tango-designer@1.0.0-alpha.10...@music163/tango-designer@1.0.0-alpha.11) (2024-02-02)
|
||||
|
||||
### Features
|
||||
|
||||
- allow add extra node to sandbox navigator ([#100](https://github.com/netease/tango/issues/100)) ([5b12193](https://github.com/netease/tango/commit/5b121939e6712c912610014f7bbad3074403fc3f))
|
||||
|
||||
# [1.0.0-alpha.10](https://github.com/netease/tango/compare/@music163/tango-designer@1.0.0-alpha.9...@music163/tango-designer@1.0.0-alpha.10) (2024-01-29)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
- remove load iconfont ([#97](https://github.com/netease/tango/issues/97)) ([d5e42c9](https://github.com/netease/tango/commit/d5e42c93bb79362dd5f15d5cd2147952dee681bf))
|
||||
|
||||
# [1.0.0-alpha.9](https://github.com/netease/tango/compare/@music163/tango-designer@1.0.0-alpha.8...@music163/tango-designer@1.0.0-alpha.9) (2024-01-24)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
- update service preview panel ([#94](https://github.com/netease/tango/issues/94)) ([d6a08ee](https://github.com/netease/tango/commit/d6a08eecd2521e9699bee1ff3ffebb651a2a620d))
|
||||
|
||||
# [1.0.0-alpha.8](https://github.com/netease/tango/compare/@music163/tango-designer@1.0.0-alpha.7...@music163/tango-designer@1.0.0-alpha.8) (2024-01-23)
|
||||
|
||||
**Note:** Version bump only for package @music163/tango-designer
|
||||
|
||||
# [1.0.0-alpha.7](https://github.com/netease/tango/compare/@music163/tango-designer@1.0.0-alpha.6...@music163/tango-designer@1.0.0-alpha.7) (2024-01-16)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
- 优化变量树实现 ([#90](https://github.com/netease/tango/issues/90)) ([62d403f](https://github.com/netease/tango/commit/62d403f80a5ad08c216bc0c035ffc12c2cf329d2))
|
||||
|
||||
# [1.0.0-alpha.6](https://github.com/netease/tango/compare/@music163/tango-designer@1.0.0-alpha.5...@music163/tango-designer@1.0.0-alpha.6) (2023-12-29)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
- check if store value is valid ([765ea07](https://github.com/netease/tango/commit/765ea07cd5be6528e3b326e4ecb163647774d9e5))
|
||||
- refactor VariableTree & Workspace ([#83](https://github.com/netease/tango/issues/83)) ([8c07821](https://github.com/netease/tango/commit/8c07821d93cea4dfc43f81ca948b845176821184))
|
||||
|
||||
# [1.0.0-alpha.5](https://github.com/netease/tango/compare/@music163/tango-designer@1.0.0-alpha.4...@music163/tango-designer@1.0.0-alpha.5) (2023-12-26)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
- list overflow in expSetter ([4d6b67e](https://github.com/netease/tango/commit/4d6b67eecd02b31f01d1bc896c6eeb83f6b34b35))
|
||||
|
||||
# [1.0.0-alpha.4](https://github.com/netease/tango/compare/@music163/tango-designer@1.0.0-alpha.3...@music163/tango-designer@1.0.0-alpha.4) (2023-12-25)
|
||||
|
||||
**Note:** Version bump only for package @music163/tango-designer
|
||||
|
||||
# [1.0.0-alpha.2](https://github.com/netease/tango/compare/@music163/tango-designer@1.0.0-alpha.1...@music163/tango-designer@1.0.0-alpha.2) (2023-12-13)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
- update variable tree with help messages and styling & add tangoConfig schema ([5e7e285](https://github.com/netease/tango/commit/5e7e285452b46888b447991b0e8548b6392acb3a))
|
||||
|
||||
# [1.0.0-alpha.1](https://github.com/netease/tango/compare/@music163/tango-designer@0.5.14...@music163/tango-designer@1.0.0-alpha.1) (2023-12-12)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
- add showSearch and showGroups to SettingForm & update internal icons ([#73](https://github.com/netease/tango/issues/73)) ([a8357f4](https://github.com/netease/tango/commit/a8357f45b8b0c1f2b91a856918f6bdecdc65aa73))
|
||||
- render form item without setter & enhance tools ([#76](https://github.com/netease/tango/issues/76)) ([1acfa68](https://github.com/netease/tango/commit/1acfa6864b1faad1a441facc426d8d94b6b090b5))
|
||||
|
||||
## [0.5.14](https://github.com/netease/tango/compare/@music163/tango-designer@0.5.13...@music163/tango-designer@0.5.14) (2023-12-04)
|
||||
|
||||
**Note:** Version bump only for package @music163/tango-designer
|
||||
|
||||
## [0.5.13](https://github.com/netease/tango/compare/@music163/tango-designer@0.5.12...@music163/tango-designer@0.5.13) (2023-12-04)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
- add filesFormatter to sandbox & fix update props with imports ([#71](https://github.com/netease/tango/issues/71)) ([138cbe9](https://github.com/netease/tango/commit/138cbe9b203b370aff42c1ae8086d69edacf35e9))
|
||||
|
||||
## [0.5.12](https://github.com/netease/tango/compare/@music163/tango-designer@0.5.11...@music163/tango-designer@0.5.12) (2023-11-30)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@music163/tango-designer",
|
||||
"version": "0.5.12",
|
||||
"version": "1.0.0-alpha.11",
|
||||
"description": "lowcode designer",
|
||||
"keywords": [
|
||||
"react"
|
||||
@@ -33,12 +33,12 @@
|
||||
"dependencies": {
|
||||
"@ant-design/icons": "^4.8.0",
|
||||
"@music163/request": "^0.1.2",
|
||||
"@music163/tango-context": "^0.2.10",
|
||||
"@music163/tango-core": "^0.2.9",
|
||||
"@music163/tango-helpers": "^0.1.8",
|
||||
"@music163/tango-sandbox": "^0.1.14",
|
||||
"@music163/tango-setting-form": "^0.2.14",
|
||||
"@music163/tango-ui": "^0.1.12",
|
||||
"@music163/tango-context": "^1.0.0-alpha.6",
|
||||
"@music163/tango-core": "^1.0.0-alpha.6",
|
||||
"@music163/tango-helpers": "^1.0.0-alpha.2",
|
||||
"@music163/tango-sandbox": "^1.0.0-alpha.6",
|
||||
"@music163/tango-setting-form": "^1.0.0-alpha.9",
|
||||
"@music163/tango-ui": "^1.0.0-alpha.7",
|
||||
"antd": "^4.24.2",
|
||||
"cash-dom": "^8.1.2",
|
||||
"classnames": "^2.3.2",
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
export * from './drag-box';
|
||||
export * from './input-kv';
|
||||
export * from './variable-tree';
|
||||
export * from './variable-tree-modal';
|
||||
|
||||
@@ -0,0 +1,45 @@
|
||||
import React, { useState } from 'react';
|
||||
import { ModalProps, Modal } from 'antd';
|
||||
import { Box } from 'coral-system';
|
||||
import { IVariableTreeNode, noop, useBoolean } from '@music163/tango-helpers';
|
||||
import { VariableTree, VariableTreeProps } from './variable-tree';
|
||||
|
||||
interface VariableTreeModalProps extends VariableTreeProps {
|
||||
trigger?: React.ReactElement;
|
||||
title?: ModalProps['title'];
|
||||
modalProps?: ModalProps;
|
||||
}
|
||||
|
||||
export function VariableTreeModal({
|
||||
trigger,
|
||||
title,
|
||||
modalProps,
|
||||
onSelect = noop,
|
||||
...rest
|
||||
}: VariableTreeModalProps) {
|
||||
const [node, setNode] = useState<IVariableTreeNode>();
|
||||
const [visible, { on, off }] = useBoolean(false);
|
||||
return (
|
||||
<Box>
|
||||
{React.cloneElement(trigger, { onClick: on })}
|
||||
<Modal
|
||||
title={title}
|
||||
open={visible}
|
||||
onCancel={off}
|
||||
okButtonProps={{
|
||||
disabled: !node,
|
||||
}}
|
||||
onOk={() => {
|
||||
if (node) {
|
||||
onSelect(node);
|
||||
off();
|
||||
}
|
||||
}}
|
||||
width="60%"
|
||||
{...modalProps}
|
||||
>
|
||||
<VariableTree height={400} onSelect={setNode} {...rest} />
|
||||
</Modal>
|
||||
</Box>
|
||||
);
|
||||
}
|
||||
@@ -1,635 +0,0 @@
|
||||
import React, { useMemo, useState } from 'react';
|
||||
import {
|
||||
Tree,
|
||||
Button,
|
||||
Form,
|
||||
Input,
|
||||
Space,
|
||||
ModalProps,
|
||||
Modal,
|
||||
Radio,
|
||||
Empty,
|
||||
Popconfirm,
|
||||
Tooltip,
|
||||
} from 'antd';
|
||||
import { Box, Text, css } from 'coral-system';
|
||||
import {
|
||||
PlusOutlined,
|
||||
FunctionOutlined,
|
||||
DeleteOutlined,
|
||||
CopyOutlined,
|
||||
EyeOutlined,
|
||||
} from '@ant-design/icons';
|
||||
import {
|
||||
filterTreeData,
|
||||
isFunction,
|
||||
isNil,
|
||||
isString,
|
||||
noop,
|
||||
useBoolean,
|
||||
} from '@music163/tango-helpers';
|
||||
import {
|
||||
Panel,
|
||||
InputCode,
|
||||
Search,
|
||||
JsonView,
|
||||
JsonViewProps,
|
||||
CopyClipboard,
|
||||
} from '@music163/tango-ui';
|
||||
import { isValidExpressionCode } from '@music163/tango-core';
|
||||
|
||||
export interface IVariableTreeNode {
|
||||
/**
|
||||
* 唯一标识符
|
||||
*/
|
||||
key: string;
|
||||
/**
|
||||
* 标题
|
||||
*/
|
||||
title?: string;
|
||||
/**
|
||||
* 是否可选中
|
||||
*/
|
||||
selectable?: boolean;
|
||||
/**
|
||||
* 展示添加子节点的图标
|
||||
*/
|
||||
showAddChildIcon?: boolean;
|
||||
/**
|
||||
* 展示删除删除图标
|
||||
*/
|
||||
showDeleteIcon?: boolean;
|
||||
/**
|
||||
* 结点类型,用来展示图标
|
||||
*/
|
||||
type?: 'function' | 'property';
|
||||
/**
|
||||
* 定义的原始值
|
||||
*/
|
||||
raw?: any;
|
||||
/**
|
||||
* 子结点
|
||||
*/
|
||||
children?: IVariableTreeNode[];
|
||||
[key: string]: any;
|
||||
}
|
||||
|
||||
type VariableModelType = 'preview' | 'define' | 'add';
|
||||
|
||||
export interface EditableVariableTreeProps {
|
||||
/**
|
||||
* 允许的变量面板
|
||||
*/
|
||||
modes?: VariableModelType[];
|
||||
/**
|
||||
* 默认的变量面板
|
||||
*/
|
||||
defaultMode?: VariableModelType;
|
||||
/**
|
||||
* 数据源
|
||||
*/
|
||||
dataSource?: VariableTreeProps['dataSource'];
|
||||
/**
|
||||
* 点击添加变量的回调
|
||||
*/
|
||||
onAddVariable?: AddNodeFormProps['onSubmit'];
|
||||
/**
|
||||
* 预览值取值函数
|
||||
*/
|
||||
getPreviewValue?: (node: IVariableTreeNode) => unknown;
|
||||
/**
|
||||
* 选择列表项时的回调
|
||||
*/
|
||||
onSelect?: (data: IVariableTreeNode) => void;
|
||||
/**
|
||||
* 保存结点定义的回调
|
||||
*/
|
||||
onSave?: NodeDefineProps['onSave'];
|
||||
/**
|
||||
* 删除结点定义的回调
|
||||
*/
|
||||
onDeleteVariable?: (storeName: string, stateName: string) => void;
|
||||
/**
|
||||
* 删除模型时的回调
|
||||
*/
|
||||
onDeleteStore?: (storeName: string) => void;
|
||||
/**
|
||||
* 高度
|
||||
*/
|
||||
height?: number | string;
|
||||
/**
|
||||
* 搜索框的样式
|
||||
*/
|
||||
searchStyle?: React.CSSProperties;
|
||||
/**
|
||||
* 搜索框的后置结点
|
||||
*/
|
||||
searchAddonAfter?: React.ReactNode;
|
||||
}
|
||||
|
||||
const previewOptions = [
|
||||
{ label: '运行时', value: 'preview' },
|
||||
{ label: '定义', value: 'define' },
|
||||
];
|
||||
|
||||
export function EditableVariableTree({
|
||||
height,
|
||||
searchAddonAfter,
|
||||
searchStyle,
|
||||
dataSource,
|
||||
onAddVariable = noop,
|
||||
onDeleteVariable = noop,
|
||||
onDeleteStore = noop,
|
||||
getPreviewValue = noop,
|
||||
onSelect = noop,
|
||||
onSave = noop,
|
||||
modes = ['add', 'preview', 'define'],
|
||||
defaultMode = 'preview',
|
||||
}: EditableVariableTreeProps) {
|
||||
const [keyword, setKeyword] = useState('');
|
||||
const [node, setNode] = useState<IVariableTreeNode>();
|
||||
const [mode, setMode] = useState<EditableVariableTreeProps['defaultMode']>(defaultMode);
|
||||
const hasPanelSwitch = modes.includes('define') && modes.includes('preview');
|
||||
|
||||
const treeData = useMemo(() => {
|
||||
const pattern = new RegExp(keyword, 'ig');
|
||||
return keyword
|
||||
? filterTreeData(dataSource, (leaf) => pattern.test(leaf.title), 'children', true)
|
||||
: dataSource;
|
||||
}, [keyword, dataSource]);
|
||||
|
||||
return (
|
||||
<Box
|
||||
className="EditableVariableTree"
|
||||
display="flex"
|
||||
overflow="auto"
|
||||
height={height}
|
||||
position="relative"
|
||||
>
|
||||
<Box p="l" width="40%" borderRight="solid" borderColor="line.normal">
|
||||
<Box mb="m" position="sticky" top="0" bg="white" zIndex={2}>
|
||||
<Input.Group compact>
|
||||
<Search
|
||||
placeholder="请输入变量名"
|
||||
onChange={(val) => setKeyword(val?.trim())}
|
||||
style={searchStyle}
|
||||
/>
|
||||
{searchAddonAfter}
|
||||
</Input.Group>
|
||||
</Box>
|
||||
<VariableTree
|
||||
dataSource={treeData}
|
||||
showViewIcon
|
||||
onSelect={(item) => {
|
||||
setNode(item);
|
||||
mode === 'add' && setMode(defaultMode);
|
||||
onSelect(item);
|
||||
}}
|
||||
onView={(item) => {
|
||||
setNode(item);
|
||||
mode === 'add' && setMode(defaultMode);
|
||||
}}
|
||||
onAdd={(item) => {
|
||||
setNode(item);
|
||||
setMode('add');
|
||||
}}
|
||||
onRemove={(item) => {
|
||||
const [type, storeName] = item.key.split('.');
|
||||
setNode(null);
|
||||
onDeleteStore(storeName);
|
||||
}}
|
||||
/>
|
||||
</Box>
|
||||
{node ? (
|
||||
<Panel
|
||||
title={
|
||||
{
|
||||
preview: '变量值预览',
|
||||
add: '添加变量',
|
||||
define: '变量定义',
|
||||
}[mode]
|
||||
}
|
||||
extra={
|
||||
hasPanelSwitch && mode !== 'add' ? (
|
||||
<Radio.Group
|
||||
optionType="button"
|
||||
buttonStyle="solid"
|
||||
size="small"
|
||||
value={mode}
|
||||
onChange={(e) => setMode(e.target.value)}
|
||||
options={previewOptions}
|
||||
/>
|
||||
) : null
|
||||
}
|
||||
width="60%"
|
||||
borderRadius="m"
|
||||
position="sticky"
|
||||
top="0"
|
||||
bodyProps={{ px: 'm' }}
|
||||
>
|
||||
{mode === 'preview' && (
|
||||
<ValuePreview
|
||||
value={getPreviewValue(node)}
|
||||
onSelect={(valuePath) => {
|
||||
return ['tango', node.key.replaceAll('.', '?.'), valuePath].join('.');
|
||||
}}
|
||||
/>
|
||||
)}
|
||||
{mode === 'define' && (
|
||||
<NodeDefineForm
|
||||
node={node}
|
||||
onSave={onSave}
|
||||
onDelete={(item) => {
|
||||
const [type, storeName, stateName] = item.key.split('.');
|
||||
onDeleteVariable(storeName, stateName);
|
||||
setNode(null);
|
||||
}}
|
||||
/>
|
||||
)}
|
||||
{mode === 'add' && (
|
||||
<AddNodeForm
|
||||
parentNode={node}
|
||||
onCancel={() => {
|
||||
setMode(defaultMode);
|
||||
setNode(null);
|
||||
}}
|
||||
onSubmit={(storeName, data) => {
|
||||
onAddVariable(storeName, data);
|
||||
setMode(defaultMode);
|
||||
setNode(null);
|
||||
}}
|
||||
/>
|
||||
)}
|
||||
</Panel>
|
||||
) : (
|
||||
<Panel title="提示" flex="1" position="sticky" top="0">
|
||||
<Empty image={Empty.PRESENTED_IMAGE_SIMPLE} description="请从左侧列表中选择一个变量" />
|
||||
</Panel>
|
||||
)}
|
||||
</Box>
|
||||
);
|
||||
}
|
||||
|
||||
interface EditableVariableTreeModalProps extends EditableVariableTreeProps {
|
||||
trigger?: React.ReactElement;
|
||||
title?: ModalProps['title'];
|
||||
modalProps?: ModalProps;
|
||||
}
|
||||
|
||||
export function EditableVariableTreeModal({
|
||||
trigger,
|
||||
title,
|
||||
modalProps,
|
||||
onSelect = noop,
|
||||
...rest
|
||||
}: EditableVariableTreeModalProps) {
|
||||
const [node, setNode] = useState<IVariableTreeNode>();
|
||||
const [visible, { on, off }] = useBoolean(false);
|
||||
return (
|
||||
<Box>
|
||||
{React.cloneElement(trigger, { onClick: on })}
|
||||
<Modal
|
||||
title={title}
|
||||
open={visible}
|
||||
onCancel={off}
|
||||
okButtonProps={{
|
||||
disabled: !node,
|
||||
}}
|
||||
onOk={() => {
|
||||
if (node) {
|
||||
onSelect(node);
|
||||
off();
|
||||
}
|
||||
}}
|
||||
width="60%"
|
||||
{...modalProps}
|
||||
>
|
||||
<EditableVariableTree height={480} onSelect={setNode} {...rest} />
|
||||
</Modal>
|
||||
</Box>
|
||||
);
|
||||
}
|
||||
|
||||
const varTreeStyle = css`
|
||||
overflow: auto;
|
||||
|
||||
.ant-tree {
|
||||
font-family: Consolas, Menlo, Courier, monospace;
|
||||
}
|
||||
|
||||
.ant-tree-node-content-wrapper.ant-tree-node-content-wrapper-normal {
|
||||
width: calc(100% - 50px);
|
||||
}
|
||||
|
||||
.ant-tree .ant-tree-treenode {
|
||||
padding: 0;
|
||||
}
|
||||
.ant-tree.ant-tree-directory .ant-tree-treenode::before {
|
||||
bottom: 0;
|
||||
}
|
||||
|
||||
.ant-tree-indent-unit {
|
||||
width: 12px;
|
||||
}
|
||||
|
||||
.anticon-function {
|
||||
margin-left: 4px;
|
||||
color: var(--tango-colors-text2);
|
||||
}
|
||||
`;
|
||||
|
||||
interface VariableTreeProps {
|
||||
dataSource?: IVariableTreeNode[];
|
||||
onSelect?: (data: IVariableTreeNode) => void;
|
||||
onAdd?: (data: IVariableTreeNode) => void;
|
||||
onRemove?: (data: IVariableTreeNode) => void;
|
||||
onCopy?: (data: IVariableTreeNode) => void;
|
||||
onView?: (data: IVariableTreeNode) => void;
|
||||
showDeleteIcon?: boolean;
|
||||
showViewIcon?: boolean;
|
||||
}
|
||||
|
||||
export function VariableTree({
|
||||
dataSource = [],
|
||||
onSelect = noop,
|
||||
onAdd = noop,
|
||||
onRemove = noop,
|
||||
onCopy = noop,
|
||||
onView = noop,
|
||||
showDeleteIcon = false,
|
||||
showViewIcon = false,
|
||||
}: VariableTreeProps) {
|
||||
return (
|
||||
<Box className="VariableTree" css={varTreeStyle}>
|
||||
<Tree
|
||||
blockNode
|
||||
showIcon={false}
|
||||
defaultExpandAll
|
||||
treeData={dataSource}
|
||||
onSelect={(keys, detail) => {
|
||||
onSelect(detail.node);
|
||||
}}
|
||||
titleRender={(node) => {
|
||||
const isLeaf = !node.children;
|
||||
|
||||
if (isLeaf) {
|
||||
const isDeletable = node.showDeleteIcon ?? showDeleteIcon;
|
||||
return (
|
||||
<Box display="flex" justifyContent="space-between" alignItems="center">
|
||||
<Text flex="1" truncated>
|
||||
{node.title}
|
||||
{node.type === 'function' && <FunctionOutlined />}
|
||||
</Text>
|
||||
<Box flex="0 0 72px" textAlign="right">
|
||||
{isDeletable && (
|
||||
<Popconfirm
|
||||
title="确认删除吗?该操作会导致引用此模型的代码报错,请谨慎操作!"
|
||||
onConfirm={() => onRemove(node)}
|
||||
>
|
||||
<Button
|
||||
type="text"
|
||||
size="small"
|
||||
icon={<DeleteOutlined />}
|
||||
onClick={(e) => {
|
||||
e.stopPropagation();
|
||||
}}
|
||||
/>
|
||||
</Popconfirm>
|
||||
)}
|
||||
<CopyClipboard text={`tango.${node.key.replaceAll('.', '?.')}`}>
|
||||
{({ copied, onClick }) => {
|
||||
const label = copied ? '已复制' : '复制变量路径';
|
||||
return (
|
||||
<Tooltip title={label}>
|
||||
<Button
|
||||
type="text"
|
||||
size="small"
|
||||
icon={<CopyOutlined />}
|
||||
onClick={(e) => {
|
||||
e.stopPropagation();
|
||||
onClick();
|
||||
onCopy(node);
|
||||
}}
|
||||
/>
|
||||
</Tooltip>
|
||||
);
|
||||
}}
|
||||
</CopyClipboard>
|
||||
{showViewIcon && (
|
||||
<Tooltip title="查看变量详情">
|
||||
<Button
|
||||
type="text"
|
||||
size="small"
|
||||
icon={<EyeOutlined />}
|
||||
onClick={(e) => {
|
||||
e.stopPropagation();
|
||||
onView(node);
|
||||
}}
|
||||
/>
|
||||
</Tooltip>
|
||||
)}
|
||||
</Box>
|
||||
</Box>
|
||||
);
|
||||
}
|
||||
|
||||
return (
|
||||
<Box display="flex" alignItems="center" justifyContent="space-between">
|
||||
<Text mr="m">{node.title}</Text>
|
||||
<Box>
|
||||
{node.showAddChildIcon && (
|
||||
<Tooltip title={`向 ${node.title} 中添加变量`}>
|
||||
<Button
|
||||
type="text"
|
||||
size="small"
|
||||
icon={<PlusOutlined />}
|
||||
onClick={(e) => {
|
||||
e.stopPropagation();
|
||||
onAdd(node);
|
||||
}}
|
||||
/>
|
||||
</Tooltip>
|
||||
)}
|
||||
</Box>
|
||||
</Box>
|
||||
);
|
||||
}}
|
||||
/>
|
||||
</Box>
|
||||
);
|
||||
}
|
||||
|
||||
interface NodePreviewProps {
|
||||
value?: unknown;
|
||||
/**
|
||||
* 选择预览结点的回调
|
||||
*/
|
||||
onSelect?: JsonViewProps['onCopy'];
|
||||
}
|
||||
|
||||
export function ValuePreview({ value, onSelect }: NodePreviewProps) {
|
||||
if (isNil(value)) {
|
||||
return <span>暂时没有可预览的数据</span>;
|
||||
}
|
||||
|
||||
if (isFunction(value)) {
|
||||
return <span>暂不支持预览函数</span>;
|
||||
}
|
||||
|
||||
if (typeof value === 'object') {
|
||||
return <JsonView src={value} enableCopy onCopy={onSelect} />;
|
||||
}
|
||||
|
||||
return (
|
||||
<InputCode
|
||||
shape="inset"
|
||||
value={isString(value) ? `"${value}"` : String(value)}
|
||||
editable={false}
|
||||
/>
|
||||
);
|
||||
}
|
||||
|
||||
interface NodeDefineProps {
|
||||
node: IVariableTreeNode;
|
||||
onSave?: (code: string, node: IVariableTreeNode) => void;
|
||||
onDelete?: (node: IVariableTreeNode) => void;
|
||||
}
|
||||
|
||||
/**
|
||||
* 变量值定义面板
|
||||
*/
|
||||
function NodeDefineForm({ node, onSave = noop, onDelete = noop }: NodeDefineProps) {
|
||||
const [value, setValue] = useState('');
|
||||
const [error, setError] = useState('');
|
||||
const [editable, { on, off }] = useBoolean();
|
||||
if (isNil(node.raw)) {
|
||||
return <Empty description="缺失定义数据" />;
|
||||
}
|
||||
return (
|
||||
<Box>
|
||||
<InputCode
|
||||
shape="inset"
|
||||
value={node.raw}
|
||||
onChange={(nextValue) => setValue(nextValue)}
|
||||
editable={editable}
|
||||
onBlur={() => {
|
||||
if (!isValidExpressionCode(value)) {
|
||||
setError('代码格式错误,请检查代码语法!');
|
||||
} else {
|
||||
setError('');
|
||||
}
|
||||
}}
|
||||
/>
|
||||
<Box color="red" my="m">
|
||||
{error}
|
||||
</Box>
|
||||
<Box mt="l">
|
||||
{editable ? (
|
||||
<Space>
|
||||
<Button
|
||||
onClick={() => {
|
||||
off();
|
||||
setError('');
|
||||
}}
|
||||
>
|
||||
取消
|
||||
</Button>
|
||||
<Button
|
||||
type="primary"
|
||||
onClick={() => {
|
||||
if (error) {
|
||||
return;
|
||||
}
|
||||
|
||||
onSave(value, node);
|
||||
off();
|
||||
}}
|
||||
>
|
||||
保存
|
||||
</Button>
|
||||
</Space>
|
||||
) : (
|
||||
<Space>
|
||||
<Button onClick={on}>编辑</Button>
|
||||
<Popconfirm
|
||||
title="确认删除此变量吗?该操作会导致引用该变量的代码报错!"
|
||||
onConfirm={() => {
|
||||
onDelete(node);
|
||||
}}
|
||||
>
|
||||
<Button danger>删除</Button>
|
||||
</Popconfirm>
|
||||
</Space>
|
||||
)}
|
||||
</Box>
|
||||
</Box>
|
||||
);
|
||||
}
|
||||
|
||||
interface AddNodeFormProps {
|
||||
parentNode: IVariableTreeNode;
|
||||
onCancel?: React.MouseEventHandler<HTMLButtonElement>;
|
||||
onSubmit?: (storeName: string, data: { name: string; initialValue: string }) => void;
|
||||
}
|
||||
|
||||
function AddNodeForm({ parentNode, onCancel, onSubmit }: AddNodeFormProps) {
|
||||
return (
|
||||
<Form
|
||||
layout="vertical"
|
||||
autoComplete="off"
|
||||
validateTrigger="onBlur"
|
||||
onFinish={(values) => {
|
||||
if (onSubmit && parentNode) {
|
||||
const [type, storeName] = parentNode.key.split('.');
|
||||
onSubmit(storeName, values);
|
||||
}
|
||||
}}
|
||||
>
|
||||
<Form.Item label="所属模型">
|
||||
<Input value={parentNode?.key} disabled />
|
||||
</Form.Item>
|
||||
<Form.Item
|
||||
label="变量名"
|
||||
name="name"
|
||||
rules={[
|
||||
{ required: true },
|
||||
{ pattern: /^\w+$/, message: '非法的变量标识符' },
|
||||
{
|
||||
validator(_, value) {
|
||||
const found = parentNode.children.find((item) => item.title === value);
|
||||
return found
|
||||
? Promise.reject(new Error('和已有变量名冲突,请换一个名字!'))
|
||||
: Promise.resolve();
|
||||
},
|
||||
},
|
||||
]}
|
||||
>
|
||||
<Input placeholder="请输入变量名" />
|
||||
</Form.Item>
|
||||
<Form.Item
|
||||
label="初值"
|
||||
name="initialValue"
|
||||
rules={[
|
||||
{ required: true },
|
||||
{
|
||||
validator(_, value) {
|
||||
return isValidExpressionCode(value)
|
||||
? Promise.resolve()
|
||||
: Promise.reject(new Error('代码存在语法错误,请输入合法的代码片段!'));
|
||||
},
|
||||
},
|
||||
]}
|
||||
>
|
||||
<InputCode shape="inset" placeholder="请输入初值" />
|
||||
</Form.Item>
|
||||
<Form.Item>
|
||||
<Space>
|
||||
<Button onClick={onCancel}>取消</Button>
|
||||
<Button type="primary" htmlType="submit">
|
||||
保存
|
||||
</Button>
|
||||
</Space>
|
||||
</Form.Item>
|
||||
</Form>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,183 @@
|
||||
import { isValidFunctionCode, url2serviceName } from '@music163/tango-helpers';
|
||||
import { InputCode } from '@music163/tango-ui';
|
||||
import { Button, Dropdown, Form, FormProps, Input, Select, Space } from 'antd';
|
||||
import { Box } from 'coral-system';
|
||||
import React, { useState } from 'react';
|
||||
|
||||
interface AddServiceFormProps extends FormProps {
|
||||
initialValues?: object;
|
||||
onSubmit: (values: object) => void;
|
||||
onCancel: () => void;
|
||||
serviceModules: object[];
|
||||
serviceNames: string[];
|
||||
}
|
||||
|
||||
export function AddServiceForm({
|
||||
initialValues,
|
||||
onSubmit,
|
||||
onCancel,
|
||||
serviceModules,
|
||||
serviceNames,
|
||||
...formProps
|
||||
}: AddServiceFormProps) {
|
||||
const isModifyMode = !!initialValues?.['name']; // 是否为更新模式
|
||||
const [disabled, setDisabled] = useState(isModifyMode);
|
||||
const [form] = Form.useForm();
|
||||
|
||||
return (
|
||||
<Form
|
||||
form={form}
|
||||
labelCol={{ span: 6 }}
|
||||
wrapperCol={{ span: 17 }}
|
||||
colon={false}
|
||||
layout="horizontal"
|
||||
initialValues={initialValues}
|
||||
onFinish={(values) => {
|
||||
setDisabled(true);
|
||||
onSubmit(values);
|
||||
}}
|
||||
{...formProps}
|
||||
>
|
||||
<Form.Item
|
||||
label="命名空间"
|
||||
name="moduleName"
|
||||
rules={[
|
||||
{
|
||||
required: true,
|
||||
},
|
||||
]}
|
||||
>
|
||||
<Select options={serviceModules} disabled={disabled || isModifyMode} />
|
||||
</Form.Item>
|
||||
<Form.Item
|
||||
label="方法名"
|
||||
name="name"
|
||||
rules={[
|
||||
{ required: true },
|
||||
{ pattern: /^[a-z]\w+$/, message: '请输入合法的方法名称' },
|
||||
!isModifyMode && {
|
||||
validator(_, value) {
|
||||
const isExist = serviceNames.includes(value);
|
||||
return isExist
|
||||
? Promise.reject(new Error('重复的方法名,请换一个!'))
|
||||
: Promise.resolve();
|
||||
},
|
||||
},
|
||||
]}
|
||||
extra={
|
||||
!disabled && (
|
||||
<Box>
|
||||
<Button
|
||||
type="link"
|
||||
size="small"
|
||||
onClick={() => {
|
||||
const url = form.getFieldValue('url');
|
||||
if (!url) {
|
||||
return;
|
||||
}
|
||||
|
||||
const funcName = url2serviceName(url);
|
||||
form.setFieldValue('name', funcName);
|
||||
}}
|
||||
>
|
||||
基于接口路径自动生成
|
||||
</Button>
|
||||
</Box>
|
||||
)
|
||||
}
|
||||
>
|
||||
<Input placeholder="请输入数据服务调用名称" disabled={disabled || isModifyMode} />
|
||||
</Form.Item>
|
||||
<Form.Item label="路径" name="url" rules={[{ required: true, type: 'url' }]}>
|
||||
<Input placeholder="请输入数据服务调用名称" disabled={disabled || isModifyMode} />
|
||||
</Form.Item>
|
||||
<Form.Item label="方法" name="method">
|
||||
<Select
|
||||
options={[
|
||||
{ label: 'GET', value: 'get' },
|
||||
{ label: 'POST', value: 'post' },
|
||||
]}
|
||||
placeholder="请选择 HTTP 请求方法"
|
||||
disabled={disabled}
|
||||
/>
|
||||
</Form.Item>
|
||||
<Form.Item
|
||||
label="格式化响应"
|
||||
name="formatter"
|
||||
tooltip="提供格式化函数,对结果进行格式化"
|
||||
validateTrigger="onBlur"
|
||||
rules={[
|
||||
{
|
||||
validator(_, value) {
|
||||
if (!value) {
|
||||
return Promise.resolve();
|
||||
}
|
||||
|
||||
return isValidFunctionCode(value)
|
||||
? Promise.resolve()
|
||||
: Promise.reject(new Error('请提供合法的函数代码!'));
|
||||
},
|
||||
},
|
||||
]}
|
||||
extra={
|
||||
!disabled && (
|
||||
<Box>
|
||||
<Dropdown
|
||||
menu={{
|
||||
items: [
|
||||
{ label: '直接返回(默认)', key: 'res => res' },
|
||||
{ label: '返回数据部分(云音乐标准规范)', key: 'res => res.data' },
|
||||
],
|
||||
onClick: ({ key }) => {
|
||||
form.setFieldValue('formatter', key);
|
||||
},
|
||||
}}
|
||||
>
|
||||
<Button type="link" size="small">
|
||||
使用模板函数
|
||||
</Button>
|
||||
</Dropdown>
|
||||
</Box>
|
||||
)
|
||||
}
|
||||
>
|
||||
<InputCode showLineNumbers placeholder="res => res" editable={!disabled} />
|
||||
</Form.Item>
|
||||
<Form.Item wrapperCol={{ offset: 6, span: 18 }}>
|
||||
{isModifyMode ? (
|
||||
<Space>
|
||||
{!disabled ? (
|
||||
<>
|
||||
<Button
|
||||
onClick={() => {
|
||||
setDisabled(true);
|
||||
}}
|
||||
>
|
||||
取消
|
||||
</Button>
|
||||
<Button type="primary" htmlType="submit">
|
||||
修改
|
||||
</Button>
|
||||
</>
|
||||
) : (
|
||||
<Button
|
||||
onClick={() => {
|
||||
setDisabled(false);
|
||||
}}
|
||||
>
|
||||
编辑
|
||||
</Button>
|
||||
)}
|
||||
</Space>
|
||||
) : (
|
||||
<Space>
|
||||
<Button onClick={onCancel}>取消</Button>
|
||||
<Button type="primary" htmlType="submit">
|
||||
创建
|
||||
</Button>
|
||||
</Space>
|
||||
)}
|
||||
</Form.Item>
|
||||
</Form>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,124 @@
|
||||
import React from 'react';
|
||||
import { Button, Form, Input, Space } from 'antd';
|
||||
import { isValidExpressionCode } from '@music163/tango-core';
|
||||
import { InputCode, Panel } from '@music163/tango-ui';
|
||||
import { IVariableTreeNode } from '@music163/tango-helpers';
|
||||
|
||||
export interface AddStoreVariableFormProps {
|
||||
parentNode: IVariableTreeNode;
|
||||
onCancel?: React.MouseEventHandler<HTMLButtonElement>;
|
||||
onSubmit?: (storeName: string, data: { name: string; initialValue: string }) => void;
|
||||
}
|
||||
|
||||
export function AddStoreVariableForm({
|
||||
parentNode,
|
||||
onCancel,
|
||||
onSubmit,
|
||||
}: AddStoreVariableFormProps) {
|
||||
return (
|
||||
<Form
|
||||
layout="vertical"
|
||||
autoComplete="off"
|
||||
validateTrigger="onBlur"
|
||||
onFinish={(values) => {
|
||||
if (onSubmit && parentNode) {
|
||||
const [type, storeName] = parentNode.key.split('.');
|
||||
onSubmit(storeName, values);
|
||||
}
|
||||
}}
|
||||
>
|
||||
<Form.Item label="所属模型">
|
||||
<Input value={parentNode?.key} disabled />
|
||||
</Form.Item>
|
||||
<Form.Item
|
||||
label="变量名"
|
||||
name="name"
|
||||
rules={[
|
||||
{ required: true },
|
||||
{ pattern: /^\w+$/, message: '非法的变量标识符' },
|
||||
{
|
||||
validator(_, value) {
|
||||
const found = parentNode.children.find((item) => item.title === value);
|
||||
return found
|
||||
? Promise.reject(new Error('和已有变量名冲突,请换一个名字!'))
|
||||
: Promise.resolve();
|
||||
},
|
||||
},
|
||||
]}
|
||||
>
|
||||
<Input placeholder="请输入变量名" />
|
||||
</Form.Item>
|
||||
<Form.Item
|
||||
label="初值"
|
||||
name="initialValue"
|
||||
rules={[
|
||||
{ required: true },
|
||||
{
|
||||
validator(_, value) {
|
||||
return value && isValidExpressionCode(value)
|
||||
? Promise.resolve()
|
||||
: Promise.reject(new Error('代码存在语法错误,请输入合法的代码片段!'));
|
||||
},
|
||||
},
|
||||
]}
|
||||
>
|
||||
<InputCode shape="inset" placeholder="请输入初值" />
|
||||
</Form.Item>
|
||||
<Form.Item>
|
||||
<Space>
|
||||
<Button onClick={onCancel}>取消</Button>
|
||||
<Button type="primary" htmlType="submit">
|
||||
保存
|
||||
</Button>
|
||||
</Space>
|
||||
</Form.Item>
|
||||
</Form>
|
||||
);
|
||||
}
|
||||
|
||||
export interface AddStoreFormProps {
|
||||
storeNames?: string[];
|
||||
onCancel?: () => void;
|
||||
onSubmit?: (data: { name: string }) => void;
|
||||
}
|
||||
|
||||
export function AddStoreForm({ storeNames = [], onCancel, onSubmit }: AddStoreFormProps) {
|
||||
return (
|
||||
<Panel title="添加模型" subTitle="模型可以用来组织一组变量" bodyProps={{ p: 'l' }}>
|
||||
<Form
|
||||
autoComplete="off"
|
||||
colon={false}
|
||||
onFinish={(values) => {
|
||||
onSubmit && onSubmit(values);
|
||||
}}
|
||||
>
|
||||
<Form.Item
|
||||
label="模型名称"
|
||||
name="name"
|
||||
rules={[
|
||||
{ required: true },
|
||||
{ pattern: /^[a-z]\w+$/, message: '非法的变量标识符' },
|
||||
{
|
||||
validator(_, value) {
|
||||
const found = storeNames.includes(value);
|
||||
return found
|
||||
? Promise.reject(new Error('已存在该模型名,请换一个!'))
|
||||
: Promise.resolve();
|
||||
},
|
||||
},
|
||||
]}
|
||||
>
|
||||
<Input placeholder="请输入模型名称" />
|
||||
</Form.Item>
|
||||
<Form.Item label=" ">
|
||||
<Space>
|
||||
<Button onClick={onCancel}>取消</Button>
|
||||
<Button type="primary" htmlType="submit">
|
||||
保存
|
||||
</Button>
|
||||
</Space>
|
||||
</Form.Item>
|
||||
</Form>
|
||||
</Panel>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,418 @@
|
||||
import React, { useCallback, useMemo, useState } from 'react';
|
||||
import {
|
||||
IVariableTreeNode,
|
||||
filterTreeData,
|
||||
isServiceVariablePath,
|
||||
isStoreVariablePath,
|
||||
noop,
|
||||
parseServiceVariablePath,
|
||||
} from '@music163/tango-helpers';
|
||||
import { css, Box, Text } from 'coral-system';
|
||||
import { Button, Popconfirm, Tooltip, Tree } from 'antd';
|
||||
import {
|
||||
CopyOutlined,
|
||||
DeleteOutlined,
|
||||
EyeOutlined,
|
||||
FunctionOutlined,
|
||||
PlusOutlined,
|
||||
} from '@ant-design/icons';
|
||||
import { CopyClipboard, Panel, Search } from '@music163/tango-ui';
|
||||
import { AddStoreForm, AddStoreVariableForm } from './add-store';
|
||||
import { AddServiceForm } from './add-service';
|
||||
import {
|
||||
NodeCommonDetail,
|
||||
ValueDefine,
|
||||
ValueDefineProps,
|
||||
ValueDetail,
|
||||
ValueDetailProps,
|
||||
} from './value-detail';
|
||||
import { ValuePreview } from './value-preview';
|
||||
import { ServicePreview } from './service-preview';
|
||||
|
||||
const varTreeStyle = css`
|
||||
overflow: auto;
|
||||
position: relative;
|
||||
|
||||
.ant-tree {
|
||||
font-family: Consolas, Menlo, Courier, monospace;
|
||||
}
|
||||
|
||||
.ant-tree-node-content-wrapper.ant-tree-node-content-wrapper-normal {
|
||||
width: calc(100% - 50px);
|
||||
}
|
||||
|
||||
.ant-tree .ant-tree-treenode {
|
||||
padding: 0;
|
||||
}
|
||||
.ant-tree.ant-tree-directory .ant-tree-treenode::before {
|
||||
bottom: 0;
|
||||
}
|
||||
|
||||
.ant-tree-indent-unit {
|
||||
width: 12px;
|
||||
}
|
||||
`;
|
||||
|
||||
type SelectNodeCallback = (data: IVariableTreeNode) => void;
|
||||
|
||||
type DetailModeType =
|
||||
| 'detail'
|
||||
| 'storeVariableDetail'
|
||||
| 'serviceDetail'
|
||||
| 'addVariable'
|
||||
| 'addStore'
|
||||
| 'addService';
|
||||
|
||||
interface IVariableTreeRenderDetailState {
|
||||
mode: DetailModeType;
|
||||
setMode: (mode: DetailModeType) => void;
|
||||
activeNode: IVariableTreeNode;
|
||||
clear: () => void;
|
||||
}
|
||||
|
||||
export interface VariableTreeProps {
|
||||
defaultValueDetailMode?: ValueDetailProps['defaultMode'];
|
||||
dataSource: IVariableTreeNode[];
|
||||
appContext?: object;
|
||||
serviceModules?: any[];
|
||||
getPreviewValue?: (node: IVariableTreeNode) => unknown;
|
||||
getServiceData?: (serviceKey: string) => object;
|
||||
getServiceNames?: (moduleName: string) => string[];
|
||||
getStoreNames?: () => string[];
|
||||
onSelect?: SelectNodeCallback;
|
||||
onAddStoreVariable?: (storeName: string, data: any) => void;
|
||||
onUpdateStoreVariable?: ValueDefineProps['onSave'];
|
||||
onRemoveStoreVariable?: (variableKey: string) => void;
|
||||
onAddStore?: (newStoreName: string) => void;
|
||||
onAddService?: (data: object) => void;
|
||||
onUpdateService?: (data: object) => void;
|
||||
onRemoveService?: (variableKey: string) => void;
|
||||
onCopy?: (data: IVariableTreeNode) => void;
|
||||
onView?: SelectNodeCallback;
|
||||
height?: number | string;
|
||||
showViewButton?: boolean;
|
||||
/**
|
||||
* 自定义头部
|
||||
*/
|
||||
renderHeaderExtra?: (
|
||||
props: VariableTreeProps,
|
||||
state: IVariableTreeRenderDetailState,
|
||||
) => React.ReactNode;
|
||||
/**
|
||||
* 自定义变量详情渲染
|
||||
* @param props
|
||||
* @param state
|
||||
* @returns
|
||||
*/
|
||||
renderDetail?: (
|
||||
props: VariableTreeProps,
|
||||
state: IVariableTreeRenderDetailState,
|
||||
) => React.ReactNode;
|
||||
}
|
||||
|
||||
export function VariableTree(props: VariableTreeProps) {
|
||||
const {
|
||||
dataSource = [],
|
||||
serviceModules = [],
|
||||
appContext = {},
|
||||
defaultValueDetailMode,
|
||||
onSelect = noop,
|
||||
onAddStoreVariable = noop,
|
||||
onAddStore = noop,
|
||||
onAddService = noop,
|
||||
onUpdateStoreVariable = noop,
|
||||
onUpdateService = noop,
|
||||
onRemoveStoreVariable,
|
||||
onRemoveService,
|
||||
onCopy = noop,
|
||||
onView = noop,
|
||||
getServiceData,
|
||||
getServiceNames,
|
||||
getStoreNames,
|
||||
getPreviewValue = noop,
|
||||
showViewButton,
|
||||
renderHeaderExtra,
|
||||
renderDetail: renderDetailProp,
|
||||
...rest
|
||||
} = props;
|
||||
const [keyword, setKeyword] = useState('');
|
||||
const [activeNode, setActiveNode] = useState<IVariableTreeNode>();
|
||||
const [mode, setMode] = useState<DetailModeType>();
|
||||
const clear = useCallback(() => {
|
||||
setActiveNode(null);
|
||||
setMode(null);
|
||||
}, []);
|
||||
|
||||
const selectNode = useCallback((node: IVariableTreeNode, callback?: SelectNodeCallback) => {
|
||||
if (isStoreVariablePath(node.key)) {
|
||||
setMode('storeVariableDetail');
|
||||
} else if (isServiceVariablePath(node.key)) {
|
||||
setMode('serviceDetail');
|
||||
} else {
|
||||
setMode('detail');
|
||||
}
|
||||
setActiveNode(node);
|
||||
callback?.(node);
|
||||
}, []);
|
||||
|
||||
const treeData = useMemo(() => {
|
||||
const pattern = new RegExp(keyword, 'ig');
|
||||
return keyword
|
||||
? filterTreeData(dataSource, (leaf) => pattern.test(leaf.title), 'children', true)
|
||||
: dataSource;
|
||||
}, [keyword, dataSource]);
|
||||
|
||||
const state = { activeNode, mode, setMode, clear };
|
||||
|
||||
return (
|
||||
<Box display="flex" columnGap="l" className="VariableTree" css={varTreeStyle} {...rest}>
|
||||
<Box className="VariableList" width="40%">
|
||||
{renderHeaderExtra?.(props, state)}
|
||||
<Box mb="m" position="sticky" top="0" bg="white" zIndex={2}>
|
||||
<Search placeholder="请输入变量名" onChange={(val) => setKeyword(val?.trim())} />
|
||||
</Box>
|
||||
<Tree
|
||||
blockNode
|
||||
showIcon={false}
|
||||
defaultExpandAll
|
||||
treeData={treeData}
|
||||
onSelect={(keys, detail) => {
|
||||
selectNode(detail.node, onSelect);
|
||||
}}
|
||||
titleRender={(node) => {
|
||||
const isLeaf = !node.children;
|
||||
|
||||
if (isLeaf) {
|
||||
const showView = node.showViewButton ?? showViewButton;
|
||||
return (
|
||||
<Box display="flex" justifyContent="space-between" alignItems="center">
|
||||
<Text flex="1" truncated>
|
||||
{node.title}
|
||||
{node.type === 'function' && (
|
||||
<Text color="text3" ml="m">
|
||||
<FunctionOutlined />
|
||||
</Text>
|
||||
)}
|
||||
</Text>
|
||||
<Box flex="0 0 72px" textAlign="right">
|
||||
{node.showRemoveButton && (
|
||||
<Popconfirm
|
||||
title={`确认删除吗 ${node.title}?该操作会导致引用此模型的代码报错,请谨慎操作!`}
|
||||
onConfirm={() => {
|
||||
if (isStoreVariablePath(node.key)) {
|
||||
onRemoveStoreVariable(node.key);
|
||||
} else {
|
||||
onRemoveService(node.key);
|
||||
}
|
||||
}}
|
||||
>
|
||||
<Button
|
||||
type="text"
|
||||
size="small"
|
||||
icon={<DeleteOutlined />}
|
||||
onClick={(e) => {
|
||||
e.stopPropagation();
|
||||
}}
|
||||
/>
|
||||
</Popconfirm>
|
||||
)}
|
||||
<CopyClipboard text={`tango.${node.key.replaceAll('.', '?.')}`}>
|
||||
{({ copied, onClick }) => {
|
||||
const label = copied ? '已复制' : '复制变量路径';
|
||||
return (
|
||||
<Tooltip title={label}>
|
||||
<Button
|
||||
type="text"
|
||||
size="small"
|
||||
icon={<CopyOutlined />}
|
||||
onClick={(e) => {
|
||||
e.stopPropagation();
|
||||
onClick();
|
||||
onCopy(node);
|
||||
}}
|
||||
/>
|
||||
</Tooltip>
|
||||
);
|
||||
}}
|
||||
</CopyClipboard>
|
||||
{showView && (
|
||||
<Tooltip title="查看变量详情">
|
||||
<Button
|
||||
type="text"
|
||||
size="small"
|
||||
icon={<EyeOutlined />}
|
||||
onClick={(e) => {
|
||||
e.stopPropagation();
|
||||
selectNode(node, onView);
|
||||
}}
|
||||
/>
|
||||
</Tooltip>
|
||||
)}
|
||||
</Box>
|
||||
</Box>
|
||||
);
|
||||
}
|
||||
|
||||
return (
|
||||
<Box display="flex" alignItems="center" justifyContent="space-between">
|
||||
<Text mr="m">{node.title}</Text>
|
||||
<Box>
|
||||
{/^\$?stores$/.test(node.key) && (
|
||||
<Tooltip title="新建数据模型">
|
||||
<Button
|
||||
type="text"
|
||||
size="small"
|
||||
icon={<PlusOutlined />}
|
||||
onClick={(e) => {
|
||||
e.stopPropagation();
|
||||
setMode('addStore');
|
||||
}}
|
||||
/>
|
||||
</Tooltip>
|
||||
)}
|
||||
{node.showAddButton && /^stores\.[a-zA-Z0-9]+$/.test(node.key) && (
|
||||
<Tooltip title={`向 ${node.title} 中添加变量`}>
|
||||
<Button
|
||||
type="text"
|
||||
size="small"
|
||||
icon={<PlusOutlined />}
|
||||
onClick={(e) => {
|
||||
e.stopPropagation();
|
||||
setActiveNode(node);
|
||||
setMode('addVariable');
|
||||
}}
|
||||
/>
|
||||
</Tooltip>
|
||||
)}
|
||||
{/^services(\.[a-zA-Z0-9]+)?$/.test(node.key) && (
|
||||
<Tooltip title={`向 ${node.title} 中添加服务函数`}>
|
||||
<Button
|
||||
type="text"
|
||||
size="small"
|
||||
icon={<PlusOutlined />}
|
||||
onClick={(e) => {
|
||||
e.stopPropagation();
|
||||
setActiveNode(node);
|
||||
setMode('addService');
|
||||
}}
|
||||
/>
|
||||
</Tooltip>
|
||||
)}
|
||||
</Box>
|
||||
</Box>
|
||||
);
|
||||
}}
|
||||
/>
|
||||
</Box>
|
||||
<Box className="VariableDetail" flex="1" position="sticky" top="0" overflow="auto">
|
||||
{(function renderDetail() {
|
||||
const customRenderer = renderDetailProp?.(props, state);
|
||||
if (customRenderer) {
|
||||
return customRenderer;
|
||||
}
|
||||
|
||||
if (mode === 'detail') {
|
||||
return <NodeCommonDetail data={activeNode} />;
|
||||
}
|
||||
if (mode === 'storeVariableDetail') {
|
||||
return (
|
||||
<ValueDetail key={activeNode.key} defaultMode={defaultValueDetailMode}>
|
||||
{(previewMode) =>
|
||||
previewMode === 'runtime' ? (
|
||||
<ValuePreview
|
||||
value={getPreviewValue(activeNode)}
|
||||
onCopy={(valuePath) => {
|
||||
return ['tango', activeNode.key.replaceAll('.', '?.'), valuePath].join('.');
|
||||
}}
|
||||
/>
|
||||
) : (
|
||||
<ValueDefine data={activeNode} onSave={onUpdateStoreVariable} />
|
||||
)
|
||||
}
|
||||
</ValueDetail>
|
||||
);
|
||||
}
|
||||
if (mode === 'serviceDetail') {
|
||||
return (
|
||||
<>
|
||||
<Panel shape="solid" title="服务函数配置">
|
||||
<AddServiceForm
|
||||
key={activeNode.key}
|
||||
serviceModules={serviceModules}
|
||||
serviceNames={(function () {
|
||||
const { moduleName } = parseServiceVariablePath(activeNode.key);
|
||||
return getServiceNames?.(moduleName) || [];
|
||||
})()}
|
||||
initialValues={{
|
||||
...getServiceData?.(activeNode.key),
|
||||
}}
|
||||
onCancel={clear}
|
||||
onSubmit={(values) => {
|
||||
onUpdateService(values);
|
||||
}}
|
||||
/>
|
||||
</Panel>
|
||||
<Panel shape="solid" title="服务函数预览" mt="l">
|
||||
<ServicePreview
|
||||
key={activeNode.key}
|
||||
appContext={appContext}
|
||||
functionKey={activeNode.key}
|
||||
/>
|
||||
</Panel>
|
||||
</>
|
||||
);
|
||||
}
|
||||
if (mode === 'addVariable') {
|
||||
return (
|
||||
<AddStoreVariableForm
|
||||
parentNode={activeNode}
|
||||
onSubmit={(storeName, data) => {
|
||||
onAddStoreVariable(storeName, data);
|
||||
clear();
|
||||
}}
|
||||
onCancel={() => {
|
||||
clear();
|
||||
}}
|
||||
/>
|
||||
);
|
||||
}
|
||||
if (mode === 'addStore') {
|
||||
return (
|
||||
<AddStoreForm
|
||||
storeNames={getStoreNames?.() || []}
|
||||
onSubmit={({ name }) => {
|
||||
onAddStore(name);
|
||||
clear();
|
||||
}}
|
||||
onCancel={() => {
|
||||
clear();
|
||||
}}
|
||||
/>
|
||||
);
|
||||
}
|
||||
if (mode === 'addService') {
|
||||
return (
|
||||
<Panel shape="solid" title="创建服务函数">
|
||||
<AddServiceForm
|
||||
key={activeNode.key}
|
||||
serviceModules={serviceModules}
|
||||
serviceNames={activeNode.children?.map((item) => item.title) || []}
|
||||
initialValues={{
|
||||
moduleName: activeNode.title,
|
||||
}}
|
||||
onCancel={() => {
|
||||
clear();
|
||||
}}
|
||||
onSubmit={(values) => {
|
||||
onAddService(values);
|
||||
clear();
|
||||
}}
|
||||
/>
|
||||
</Panel>
|
||||
);
|
||||
}
|
||||
})()}
|
||||
</Box>
|
||||
</Box>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,93 @@
|
||||
import React, { useState } from 'react';
|
||||
import { Box } from 'coral-system';
|
||||
import { Button, Empty } from 'antd';
|
||||
import { PlayCircleOutlined } from '@ant-design/icons';
|
||||
import { InputCode, Panel, JsonView } from '@music163/tango-ui';
|
||||
import { isNil, logger, code2object, getValue } from '@music163/tango-helpers';
|
||||
|
||||
export interface ServicePreviewProps {
|
||||
appContext?: any;
|
||||
functionKey?: string;
|
||||
}
|
||||
|
||||
export function ServicePreview({ appContext, functionKey }: ServicePreviewProps) {
|
||||
const [payload, setPayload] = useState({});
|
||||
const [result, setResult] = useState<any>();
|
||||
const [error, setError] = useState('');
|
||||
return (
|
||||
<Box>
|
||||
<Panel title="请求参数" bodyProps={{ px: 'l' }}>
|
||||
<InputCode
|
||||
placeholder={'添加请求参数,对象格式,如 { key: value }'}
|
||||
editable
|
||||
showLineNumbers
|
||||
onChange={(value: string) => {
|
||||
const obj = code2object(value);
|
||||
setPayload(obj);
|
||||
}}
|
||||
/>
|
||||
<Button
|
||||
block
|
||||
type="primary"
|
||||
style={{ margin: '8px 0' }}
|
||||
disabled={!appContext}
|
||||
onClick={() => {
|
||||
if (!appContext) {
|
||||
setError('执行上下文未准备好,请关闭面板重试');
|
||||
return;
|
||||
}
|
||||
try {
|
||||
const fn = getValue(appContext, functionKey);
|
||||
fn(payload).then((data: any) => {
|
||||
setError('');
|
||||
setResult(data);
|
||||
});
|
||||
} catch (err) {
|
||||
setError('接口调用失败,请检查参数是否正确');
|
||||
logger.error(err);
|
||||
}
|
||||
}}
|
||||
icon={<PlayCircleOutlined />}
|
||||
>
|
||||
预览
|
||||
</Button>
|
||||
</Panel>
|
||||
<Panel title="请求响应" bodyProps={{ px: 'l' }}>
|
||||
{error || (result ? <ResponseDataPreview data={result} /> : '点击预览按钮测试接口返回值')}
|
||||
</Panel>
|
||||
</Box>
|
||||
);
|
||||
}
|
||||
|
||||
interface ResponseDataPreviewProps {
|
||||
data?: object;
|
||||
}
|
||||
|
||||
function ResponseDataPreview({ data }: ResponseDataPreviewProps) {
|
||||
let ret: React.ReactNode;
|
||||
|
||||
if (!isNil(data)) {
|
||||
switch (typeof data) {
|
||||
case 'object':
|
||||
ret = <JsonView src={data as object} />;
|
||||
break;
|
||||
default:
|
||||
ret = String(data);
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
const initialRet = <Empty image={Empty.PRESENTED_IMAGE_SIMPLE} />;
|
||||
|
||||
return (
|
||||
<Box
|
||||
className="ResponseDataPreview"
|
||||
overflow="auto"
|
||||
height="auto"
|
||||
minHeight={260}
|
||||
marginTop={10}
|
||||
>
|
||||
{ret || initialRet}
|
||||
</Box>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,122 @@
|
||||
import React, { useState } from 'react';
|
||||
import { IVariableTreeNode, isNil, noop, useBoolean } from '@music163/tango-helpers';
|
||||
import { Empty, Space, Button, Radio, Alert } from 'antd';
|
||||
import { Box } from 'coral-system';
|
||||
import { InputCode, Panel } from '@music163/tango-ui';
|
||||
import { isValidExpressionCode } from '@music163/tango-core';
|
||||
|
||||
const previewOptions = [
|
||||
{ label: '运行时', value: 'runtime' },
|
||||
{ label: '定义', value: 'define' },
|
||||
];
|
||||
|
||||
export type ValueDetailModeType = 'runtime' | 'define';
|
||||
|
||||
export interface ValueDetailProps {
|
||||
defaultMode?: ValueDetailModeType;
|
||||
children: (mode: ValueDetailModeType) => React.ReactNode;
|
||||
}
|
||||
|
||||
export function ValueDetail({ defaultMode = 'runtime', children }: ValueDetailProps) {
|
||||
const [mode, setMode] = useState<ValueDetailModeType>(defaultMode);
|
||||
return (
|
||||
<Panel
|
||||
title="变量详情"
|
||||
shape="solid"
|
||||
extra={
|
||||
<Radio.Group
|
||||
optionType="button"
|
||||
buttonStyle="solid"
|
||||
size="small"
|
||||
value={mode}
|
||||
onChange={(e) => {
|
||||
setMode(e.target.value);
|
||||
}}
|
||||
options={previewOptions}
|
||||
/>
|
||||
}
|
||||
>
|
||||
{children(mode)}
|
||||
</Panel>
|
||||
);
|
||||
}
|
||||
|
||||
export interface ValueDefineProps {
|
||||
data: IVariableTreeNode;
|
||||
onSave?: (variableKey: string, code: string) => void;
|
||||
}
|
||||
|
||||
/**
|
||||
* 变量值定义面板
|
||||
*/
|
||||
export function ValueDefine({ data, onSave = noop }: ValueDefineProps) {
|
||||
const [value, setValue] = useState(data.raw);
|
||||
const [error, setError] = useState('');
|
||||
const [editable, { on, off }] = useBoolean();
|
||||
if (isNil(data.raw)) {
|
||||
return <Empty image={Empty.PRESENTED_IMAGE_SIMPLE} description="缺失定义数据" />;
|
||||
}
|
||||
return (
|
||||
<Box>
|
||||
<InputCode
|
||||
shape="inset"
|
||||
value={value}
|
||||
onChange={(nextValue) => setValue(nextValue)}
|
||||
readOnly={!editable}
|
||||
onBlur={() => {
|
||||
if (!value) {
|
||||
setError('输入内容不可为空!');
|
||||
} else if (value && !isValidExpressionCode(`foo = ${value}`)) {
|
||||
// 这里先保证输入是一个合法的表达式
|
||||
setError('代码格式错误,请检查代码语法!');
|
||||
} else {
|
||||
setError('');
|
||||
}
|
||||
}}
|
||||
/>
|
||||
<Box color="red" my="m">
|
||||
{error}
|
||||
</Box>
|
||||
<Box mt="l">
|
||||
{editable ? (
|
||||
<Space>
|
||||
<Button
|
||||
onClick={() => {
|
||||
off();
|
||||
setError('');
|
||||
}}
|
||||
>
|
||||
取消
|
||||
</Button>
|
||||
<Button
|
||||
type="primary"
|
||||
onClick={() => {
|
||||
if (error) {
|
||||
return;
|
||||
}
|
||||
|
||||
onSave(data.key, value);
|
||||
off();
|
||||
}}
|
||||
>
|
||||
保存
|
||||
</Button>
|
||||
</Space>
|
||||
) : (
|
||||
<Button onClick={on}>编辑</Button>
|
||||
)}
|
||||
</Box>
|
||||
</Box>
|
||||
);
|
||||
}
|
||||
|
||||
export interface NodeCommonDetailProps {
|
||||
data: IVariableTreeNode;
|
||||
}
|
||||
|
||||
export function NodeCommonDetail({ data }: NodeCommonDetailProps) {
|
||||
if (!data?.help) {
|
||||
return <div />;
|
||||
}
|
||||
return <Alert type="info" message={`使用说明:${data.help}`} closable />;
|
||||
}
|
||||
@@ -0,0 +1,34 @@
|
||||
import React from 'react';
|
||||
import { isFunction, isNil, isString } from '@music163/tango-helpers';
|
||||
import { InputCode, JsonView, JsonViewProps } from '@music163/tango-ui';
|
||||
import { Empty } from 'antd';
|
||||
|
||||
interface ValuePreviewProps {
|
||||
value?: unknown;
|
||||
/**
|
||||
* 选择预览结点的回调
|
||||
*/
|
||||
onCopy?: JsonViewProps['onCopy'];
|
||||
}
|
||||
|
||||
export function ValuePreview({ value, onCopy }: ValuePreviewProps) {
|
||||
if (isNil(value)) {
|
||||
return <Empty image={Empty.PRESENTED_IMAGE_SIMPLE} description="暂时没有可预览的数据" />;
|
||||
}
|
||||
|
||||
if (isFunction(value)) {
|
||||
return <Empty image={Empty.PRESENTED_IMAGE_SIMPLE} description="暂不支持预览函数" />;
|
||||
}
|
||||
|
||||
if (typeof value === 'object') {
|
||||
return <JsonView src={value} enableCopy onCopy={onCopy} />;
|
||||
}
|
||||
|
||||
return (
|
||||
<InputCode
|
||||
shape="inset"
|
||||
value={isString(value) ? `"${value}"` : String(value)}
|
||||
editable={false}
|
||||
/>
|
||||
);
|
||||
}
|
||||
@@ -1,8 +1,7 @@
|
||||
import React, { useEffect, useMemo } from 'react';
|
||||
import React, { useMemo } from 'react';
|
||||
import { SystemProvider, extendTheme } from 'coral-system';
|
||||
import { ConfigProvider } from 'antd';
|
||||
import { TangoEngineProvider, ITangoEngineContext } from '@music163/tango-context';
|
||||
import { createFromIconfontCN } from '@ant-design/icons';
|
||||
import zhCN from 'antd/lib/locale/zh_CN';
|
||||
import { DesignerProvider, IDesignerContext } from './context';
|
||||
import defaultTheme from './themes/default';
|
||||
@@ -12,10 +11,6 @@ export interface DesignerProps extends IDesignerContext, ITangoEngineContext {
|
||||
* 主题包
|
||||
*/
|
||||
theme?: any;
|
||||
/**
|
||||
* 自定义图表库svg脚本地址
|
||||
*/
|
||||
iconfontScriptUrl?: string;
|
||||
children?: React.ReactNode;
|
||||
}
|
||||
|
||||
@@ -25,21 +20,8 @@ export interface DesignerProps extends IDesignerContext, ITangoEngineContext {
|
||||
* @returns
|
||||
*/
|
||||
export function Designer(props: DesignerProps) {
|
||||
const {
|
||||
engine,
|
||||
config,
|
||||
theme: themeProp,
|
||||
sandboxQuery,
|
||||
remoteServices = {},
|
||||
iconfontScriptUrl = '//at.alicdn.com/t/c/font_2891794_lzc7rtwuzf.js',
|
||||
children,
|
||||
} = props;
|
||||
const { engine, config, theme: themeProp, sandboxQuery, remoteServices = {}, children } = props;
|
||||
const theme = useMemo(() => extendTheme(themeProp, defaultTheme), [themeProp]);
|
||||
useEffect(() => {
|
||||
createFromIconfontCN({
|
||||
scriptUrl: iconfontScriptUrl,
|
||||
});
|
||||
}, [iconfontScriptUrl]);
|
||||
return (
|
||||
<SystemProvider theme={theme} prefix="--tango">
|
||||
<ConfigProvider locale={zhCN}>
|
||||
|
||||
@@ -72,7 +72,6 @@ export function getElementData(
|
||||
const bounding = getElementBoundingData(element, relativeContainer);
|
||||
const data = getElementDataProps(element);
|
||||
const dnd = parseDndId(data.dnd);
|
||||
// FIXME: 是否改为按需执行,仅 dropTarget 需要 display 信息,且目前 display 信息并不准确
|
||||
const display = getElementCSSDisplay(element);
|
||||
return {
|
||||
id: dnd.id,
|
||||
|
||||
@@ -1 +1,2 @@
|
||||
export * from './dom';
|
||||
export * from './template';
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
const newStoreTemplate = `
|
||||
import { defineStore } from '@music163/tango-boot';
|
||||
export default defineStore({
|
||||
});
|
||||
`;
|
||||
|
||||
export const CODE_TEMPLATES = {
|
||||
newStoreTemplate,
|
||||
};
|
||||
@@ -13,6 +13,7 @@ export * from './toolbar';
|
||||
export * from './selection-menu';
|
||||
export * from './widgets';
|
||||
export * from './themes';
|
||||
export * from './components';
|
||||
|
||||
export { register as registerSetter } from '@music163/tango-setting-form';
|
||||
|
||||
|
||||
@@ -33,6 +33,10 @@ interface NavigatorProps {
|
||||
onForward?: () => void;
|
||||
onRefresh?: () => void;
|
||||
onInputEnter?: (text: string, e: React.KeyboardEvent<HTMLInputElement>) => void;
|
||||
/**
|
||||
* 附加信息
|
||||
*/
|
||||
extra?: React.ReactNode;
|
||||
}
|
||||
|
||||
interface NavigatorState {
|
||||
@@ -68,7 +72,7 @@ export class Navigator extends React.Component<NavigatorProps, NavigatorState> {
|
||||
};
|
||||
|
||||
render() {
|
||||
const { disabled, onBack, onForward, onRefresh } = this.props;
|
||||
const { disabled, onBack, onForward, onRefresh, extra } = this.props;
|
||||
return (
|
||||
<Box
|
||||
className="navigator"
|
||||
@@ -93,6 +97,7 @@ export class Navigator extends React.Component<NavigatorProps, NavigatorState> {
|
||||
disabled={disabled}
|
||||
/>
|
||||
<ViewportSwitch />
|
||||
{extra}
|
||||
</Box>
|
||||
);
|
||||
}
|
||||
|
||||
@@ -23,12 +23,22 @@ export type SandboxProps = Omit<CodeSandboxProps, 'files' | 'eventHandlers' | 'o
|
||||
* tangoConfigJson 处理器
|
||||
*/
|
||||
configFormatter?: IMergeTangoConfigJsonConfig['formatter'];
|
||||
/**
|
||||
* 文件格式化器
|
||||
* @param files 沙箱文件列表
|
||||
* @returns 修改后的文件列表
|
||||
*/
|
||||
filesFormatter?: (files: CodeSandboxProps['files']) => CodeSandboxProps['files'];
|
||||
sandboxType?: 'design' | 'preview';
|
||||
mode?: 'single' | 'combined';
|
||||
injectScript?: string;
|
||||
onViewChange?: (data: any, config?: ISandboxEventHandlerConfig) => void;
|
||||
onMessage?: (data: any, config?: ISandboxEventHandlerConfig) => void;
|
||||
onLoad?: (config?: ISandboxEventHandlerConfig) => void;
|
||||
/**
|
||||
* 沙箱导航栏扩展
|
||||
*/
|
||||
navigatorExtra?: React.ReactNode;
|
||||
};
|
||||
|
||||
export interface CombinedSandboxRef {
|
||||
@@ -41,6 +51,7 @@ const LANDING_PAGE_PATH = '/__background_landing_page__';
|
||||
function useSandbox({
|
||||
isPreview: isPreviewProp,
|
||||
configFormatter,
|
||||
filesFormatter,
|
||||
onViewChange,
|
||||
onMessage: onMessageProp,
|
||||
onLoad: onLoadProp,
|
||||
@@ -79,7 +90,12 @@ function useSandbox({
|
||||
prev[filename] = { code };
|
||||
return prev;
|
||||
}, {});
|
||||
|
||||
files = fixSandboxFiles(files, workspace.entry);
|
||||
if (filesFormatter) {
|
||||
// 支持用户对传入的文件进行修改
|
||||
files = filesFormatter(files);
|
||||
}
|
||||
|
||||
const onMessage = (data: any) => onMessageProp && onMessageProp(data, getSandboxConfig());
|
||||
const onLoad = () => onLoadProp && onLoadProp(getSandboxConfig());
|
||||
@@ -284,6 +300,7 @@ export const Sandbox = observer(
|
||||
selectionTools,
|
||||
bundlerURL,
|
||||
mode = 'combined',
|
||||
navigatorExtra,
|
||||
...props
|
||||
}: SandboxProps) => {
|
||||
const bundlerUrl = bundlerURL ?? 'https://codesandbox.fn.netease.com';
|
||||
@@ -350,6 +367,7 @@ export const Sandbox = observer(
|
||||
}
|
||||
workspace.selectSource.clear();
|
||||
}}
|
||||
extra={navigatorExtra}
|
||||
/>
|
||||
<Simulator>
|
||||
<Viewport selectionTools={selectionTools}>
|
||||
@@ -413,6 +431,7 @@ function fixSandboxFiles(files: Record<string, { code: string }>, entry = '/src/
|
||||
`,
|
||||
};
|
||||
}
|
||||
|
||||
return files;
|
||||
}
|
||||
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
import React from 'react';
|
||||
import { Radio, RadioProps, Tooltip } from 'antd';
|
||||
import { IconFont } from '@music163/tango-ui';
|
||||
import type { OptionType } from '@music163/tango-helpers';
|
||||
import { FormItemComponentProps } from '@music163/tango-setting-form';
|
||||
|
||||
@@ -11,15 +10,9 @@ interface ChoiceSetterProps {
|
||||
|
||||
export function ChoiceSetter({
|
||||
options,
|
||||
mode = 'text',
|
||||
onChange,
|
||||
...props
|
||||
}: FormItemComponentProps<string> & ChoiceSetterProps) {
|
||||
const renderLabel =
|
||||
mode === 'text'
|
||||
? (item: OptionType) => item.label
|
||||
: (item: OptionType) => <IconFont type={item.icon} />;
|
||||
|
||||
return (
|
||||
<Radio.Group
|
||||
optionType="button"
|
||||
@@ -31,7 +24,7 @@ export function ChoiceSetter({
|
||||
>
|
||||
{options.map((item) => (
|
||||
<RadioButton tip={item.tip} key={item.value} value={item.value}>
|
||||
{renderLabel(item)}
|
||||
{item.label}
|
||||
</RadioButton>
|
||||
))}
|
||||
</Radio.Group>
|
||||
|
||||
@@ -6,13 +6,21 @@ import {
|
||||
isWrappedByExpressionContainer,
|
||||
value2expressionCode,
|
||||
} from '@music163/tango-core';
|
||||
import { getVariableContent, noop, useBoolean, getValue } from '@music163/tango-helpers';
|
||||
import {
|
||||
getVariableContent,
|
||||
noop,
|
||||
useBoolean,
|
||||
getValue,
|
||||
IVariableTreeNode,
|
||||
} from '@music163/tango-helpers';
|
||||
import { CloseCircleFilled, ExpandAltOutlined } from '@ant-design/icons';
|
||||
import { IconButton, Panel, InputCode } from '@music163/tango-ui';
|
||||
import { FormItemComponentProps } from '@music163/tango-setting-form';
|
||||
import { useWorkspace, useWorkspaceData } from '@music163/tango-context';
|
||||
import { EditableVariableTree, IVariableTreeNode } from '../components';
|
||||
import { VariableTree } from '../components';
|
||||
import { useSandboxQuery } from '../context';
|
||||
import { CODE_TEMPLATES } from '../helpers';
|
||||
import { shapeServiceValues } from '../sidebar/datasource-panel/interface-config';
|
||||
|
||||
export const expressionValueValidate = (value: string) => {
|
||||
if (isWrappedByExpressionContainer(value)) {
|
||||
@@ -77,6 +85,7 @@ export function ExpressionSetter(props: ExpressionSetterProps) {
|
||||
value: valueProp,
|
||||
status,
|
||||
allowClear = true,
|
||||
newStoreTemplate,
|
||||
} = props;
|
||||
const [visible, { on, off }] = useBoolean();
|
||||
const [inputValue, setInputValue] = useState(() => {
|
||||
@@ -143,6 +152,7 @@ export function ExpressionSetter(props: ExpressionSetterProps) {
|
||||
subTitle={modalTip}
|
||||
placeholder={placeholder}
|
||||
autoCompleteOptions={autoCompleteOptions}
|
||||
newStoreTemplate={newStoreTemplate}
|
||||
visible={visible}
|
||||
value={inputValue}
|
||||
onCancel={() => off()}
|
||||
@@ -166,6 +176,10 @@ export interface ExpressionModalProps {
|
||||
onOk?: (value: string) => void;
|
||||
dataSource?: IVariableTreeNode[];
|
||||
autoCompleteOptions?: string[];
|
||||
/**
|
||||
* 新建 store 的模板代码
|
||||
*/
|
||||
newStoreTemplate?: string;
|
||||
}
|
||||
|
||||
export function ExpressionModal({
|
||||
@@ -179,18 +193,19 @@ export function ExpressionModal({
|
||||
value,
|
||||
dataSource,
|
||||
autoCompleteOptions,
|
||||
newStoreTemplate = CODE_TEMPLATES.newStoreTemplate,
|
||||
}: ExpressionModalProps) {
|
||||
const [exp, setExp] = useState(value ?? defaultValue);
|
||||
const [error, setError] = useState('');
|
||||
const workspace = useWorkspace();
|
||||
const onAction = useCallback(
|
||||
(action: string, args: unknown[]) => {
|
||||
workspace[action]?.(...args);
|
||||
},
|
||||
[workspace],
|
||||
);
|
||||
const sandbox = useSandboxQuery();
|
||||
|
||||
const { expressionVariables } = useWorkspaceData();
|
||||
const serviceModules = Object.keys(workspace.serviceModules).map((key) => ({
|
||||
label: key === 'index' ? '默认模块' : key,
|
||||
value: key,
|
||||
}));
|
||||
|
||||
const sandbox = useSandboxQuery();
|
||||
const evaluateContext = sandbox.window;
|
||||
|
||||
const handleExpInputChange = (val: string) => {
|
||||
@@ -231,10 +246,29 @@ export function ExpressionModal({
|
||||
/>
|
||||
{error ? <Text color="red">输入的表达式存在语法错误,请修改后再提交!</Text> : null}
|
||||
</Panel>
|
||||
<Panel title="从变量列表中选中" shape="solid" borderTop="0">
|
||||
<EditableVariableTree
|
||||
<Panel
|
||||
title="从变量列表中选中"
|
||||
shape="solid"
|
||||
borderTop="0"
|
||||
overflow="hidden"
|
||||
bodyProps={{ overflow: 'hidden' }}
|
||||
>
|
||||
<VariableTree
|
||||
height={380}
|
||||
showViewButton
|
||||
dataSource={dataSource || expressionVariables}
|
||||
appContext={sandbox?.window['tango']}
|
||||
getStoreNames={() => Object.keys(workspace.storeModules)}
|
||||
serviceModules={serviceModules}
|
||||
getServiceData={(serviceKey) => {
|
||||
const data = workspace.getServiceFunction(serviceKey);
|
||||
return {
|
||||
name: data.name,
|
||||
moduleName: data.moduleName,
|
||||
method: 'get',
|
||||
...data.config,
|
||||
};
|
||||
}}
|
||||
onSelect={(node) => {
|
||||
if (!node.key) {
|
||||
return;
|
||||
@@ -250,17 +284,28 @@ export function ExpressionModal({
|
||||
}
|
||||
setExp(str);
|
||||
}}
|
||||
onAddVariable={(storeName, data) => {
|
||||
onAction('addStoreState', [storeName, data.name, data.initialValue]);
|
||||
onAddStoreVariable={(storeName, data) => {
|
||||
workspace.addStoreState(storeName, data.name, data.initialValue);
|
||||
}}
|
||||
onDeleteVariable={(storeName, stateName) => {
|
||||
onAction('removeStoreState', [storeName, stateName]);
|
||||
onUpdateStoreVariable={(variableKey, code) => {
|
||||
workspace.updateStoreVariable(variableKey, code);
|
||||
}}
|
||||
onDeleteStore={(storeName) => {
|
||||
onAction('removeStoreModule', [storeName]);
|
||||
onAddStore={(storeName) => {
|
||||
workspace.addStoreFile(storeName, newStoreTemplate);
|
||||
}}
|
||||
onSave={(code, node) => {
|
||||
onAction('updateModuleCodeByVariablePath', [node.key, code]);
|
||||
onRemoveStoreVariable={(variableKey) => {
|
||||
workspace.removeStoreVariable(variableKey);
|
||||
}}
|
||||
onRemoveService={(serviceKey) => {
|
||||
workspace.removeServiceFunction(serviceKey);
|
||||
}}
|
||||
onAddService={(data) => {
|
||||
const { name, moduleName, ...payload } = shapeServiceValues(data);
|
||||
workspace.addServiceFunction(name, payload, moduleName);
|
||||
}}
|
||||
onUpdateService={(data) => {
|
||||
const { name, moduleName, ...payload } = shapeServiceValues(data);
|
||||
workspace.updateServiceFunction(name, payload, moduleName);
|
||||
}}
|
||||
getPreviewValue={(node) => {
|
||||
if (!node || !node.key) {
|
||||
@@ -268,7 +313,7 @@ export function ExpressionModal({
|
||||
}
|
||||
|
||||
if (node.type === 'function') {
|
||||
return node.raw;
|
||||
return;
|
||||
}
|
||||
|
||||
return getValue(evaluateContext['tango'], node.key);
|
||||
|
||||
@@ -168,4 +168,6 @@ const setters: IFormItemCreateOptions[] = [
|
||||
{ name: 'borderSetter', component: BorderSetter },
|
||||
];
|
||||
|
||||
setters.forEach(register);
|
||||
export function registerBuiltinSetters() {
|
||||
setters.forEach(register);
|
||||
}
|
||||
|
||||
@@ -5,8 +5,9 @@ import { getValue, isFunction } from '@music163/tango-helpers';
|
||||
import { FormItemComponentProps } from '@music163/tango-setting-form';
|
||||
import { MenuOutlined } from '@ant-design/icons';
|
||||
import { useWorkspace, useWorkspaceData } from '@music163/tango-context';
|
||||
import { EditableVariableTreeModal } from '../components';
|
||||
import { VariableTreeModal } from '../components';
|
||||
import { useSandboxQuery } from '../context';
|
||||
import { CODE_TEMPLATES } from '../helpers';
|
||||
|
||||
function object2treeData(
|
||||
val: any,
|
||||
@@ -52,43 +53,40 @@ function traverseTreeData(val: any, callback: (val: any) => void) {
|
||||
}
|
||||
}
|
||||
|
||||
export function ModelSetter({ value, onChange }: FormItemComponentProps) {
|
||||
export function ModelSetter({
|
||||
value,
|
||||
onChange,
|
||||
newStoreTemplate = CODE_TEMPLATES.newStoreTemplate,
|
||||
}: FormItemComponentProps) {
|
||||
const [inputValue, setInputValue] = useState(value);
|
||||
const { modelVariables } = useWorkspaceData();
|
||||
const evaluateContext = useSandboxQuery().window || {};
|
||||
const workspace = useWorkspace();
|
||||
const onAction = useCallback(
|
||||
(action: string, args: unknown[]) => {
|
||||
workspace[action]?.(...args);
|
||||
},
|
||||
[workspace],
|
||||
);
|
||||
const definedVariables = useMemo(() => {
|
||||
const map = new Map();
|
||||
const list: string[] = [];
|
||||
traverseTreeData(modelVariables, (node) => {
|
||||
if (node.key.split('.').length > 1) {
|
||||
map.set(node.key, node);
|
||||
list.push(node.key);
|
||||
}
|
||||
});
|
||||
return map;
|
||||
return list;
|
||||
}, [modelVariables]);
|
||||
|
||||
const variables = evaluateContext['tango']?.stores
|
||||
? [
|
||||
object2treeData(evaluateContext['tango']?.stores, 'stores', 0, 1, (keyPath, val) => {
|
||||
if (keyPath.split('.').length === 2 && definedVariables.has(keyPath)) {
|
||||
return {
|
||||
showAddChildIcon: true,
|
||||
showRemoveIcon: true,
|
||||
};
|
||||
}
|
||||
const ret: any = {};
|
||||
if (isFunction(val)) {
|
||||
// 不可以同步给函数类型变量
|
||||
return {
|
||||
disabled: true,
|
||||
type: 'function',
|
||||
};
|
||||
ret.disabled = true;
|
||||
ret.type = 'function';
|
||||
}
|
||||
|
||||
if (!definedVariables.includes(keyPath)) {
|
||||
ret.showAddButton = false;
|
||||
ret.showRemoveButton = false;
|
||||
}
|
||||
|
||||
return ret;
|
||||
}),
|
||||
]
|
||||
: modelVariables;
|
||||
@@ -122,31 +120,34 @@ export function ModelSetter({ value, onChange }: FormItemComponentProps) {
|
||||
onChange={onInputChange}
|
||||
onBlur={onInputBlur}
|
||||
suffix={
|
||||
<EditableVariableTreeModal
|
||||
<VariableTreeModal
|
||||
title="同步到的变量"
|
||||
trigger={
|
||||
<Tooltip title="从模型列表选择" placement="topRight">
|
||||
<MenuOutlined />
|
||||
</Tooltip>
|
||||
}
|
||||
modes={['preview']}
|
||||
dataSource={variables as any[]}
|
||||
onSelect={(node) => {
|
||||
const modelPath = node.key.split('.').slice(1).join('.');
|
||||
onChange(modelPath);
|
||||
}}
|
||||
onAddVariable={(storeName, data) => {
|
||||
onAction('addStoreState', [storeName, data.name, data.initialValue]);
|
||||
onAddStoreVariable={(storeName, data) => {
|
||||
workspace.addStoreState(storeName, data.name, data.initialValue);
|
||||
}}
|
||||
onDeleteVariable={(storeName, stateName) => {
|
||||
onAction('removeStoreState', [storeName, stateName]);
|
||||
onUpdateStoreVariable={(variableKey, code) => {
|
||||
workspace.updateStoreVariable(variableKey, code);
|
||||
}}
|
||||
onDeleteStore={(storeName) => {
|
||||
onAction('removeStoreModule', [storeName]);
|
||||
onAddStore={(storeName) => {
|
||||
workspace.addStoreFile(storeName, newStoreTemplate);
|
||||
}}
|
||||
onSave={(code, node) => {
|
||||
onAction('updateModuleCodeByVariablePath', [node.key, code]);
|
||||
onRemoveStoreVariable={(variablePath) => {
|
||||
workspace.removeStoreVariable(variablePath);
|
||||
}}
|
||||
onRemoveService={(serviceKey) => {
|
||||
workspace.removeServiceFunction(serviceKey);
|
||||
}}
|
||||
getStoreNames={() => Object.keys(workspace.storeModules)}
|
||||
getPreviewValue={(node) => {
|
||||
if (!node || !node.key) {
|
||||
return;
|
||||
|
||||
@@ -3,8 +3,8 @@ import { Box, Grid, HTMLCoralProps } from 'coral-system';
|
||||
import { InputNumber, Dropdown, Input, Radio, Popover, Button } from 'antd';
|
||||
import { SketchPicker } from 'react-color';
|
||||
import Color from 'color';
|
||||
import { BgColorsOutlined, FileImageOutlined } from '@ant-design/icons';
|
||||
import { SingleMonacoEditor, IconFont } from '@music163/tango-ui';
|
||||
import { BgColorsOutlined, EyeInvisibleOutlined, FileImageOutlined } from '@ant-design/icons';
|
||||
import { SingleMonacoEditor, LineSolidOutlined, LineDashedOutlined } from '@music163/tango-ui';
|
||||
import { FormItemComponentProps } from '@music163/tango-setting-form';
|
||||
import { ChoiceSetter } from './choice-setter';
|
||||
import { TextSetter } from './text-setter';
|
||||
@@ -34,7 +34,7 @@ export function CssCodeSetter({ value, onChange }: FormItemComponentProps<string
|
||||
value={contentValue}
|
||||
onBlur={(newCode) => {
|
||||
if (newCode != contentValue) {
|
||||
onChange('{css`' + newCode + '`}', {
|
||||
onChange(`{css\`${newCode}\`}`, {
|
||||
// relatedImports: ['']
|
||||
});
|
||||
}
|
||||
@@ -258,7 +258,7 @@ export function SpacingSetter({ value, onChange }: FormItemComponentProps<string
|
||||
return (val: string) => {
|
||||
tempRef.current[index] = `${val}`;
|
||||
const str2px = tempRef.current.map((it) => {
|
||||
return it + 'px';
|
||||
return `${it}px`;
|
||||
});
|
||||
onChange(str2px.join(' '));
|
||||
};
|
||||
@@ -388,15 +388,16 @@ export function BorderSetter({ value, onChange }: FormItemComponentProps<string>
|
||||
setStyle(e.target.value);
|
||||
handleChange('style', e.target.value);
|
||||
}}
|
||||
buttonStyle="solid"
|
||||
>
|
||||
<Radio.Button value="none">
|
||||
<IconFont type="icon-display-none" title="none" />
|
||||
<EyeInvisibleOutlined />
|
||||
</Radio.Button>
|
||||
<Radio.Button value="solid">
|
||||
<IconFont type="icon-fengexian" title="solid" />
|
||||
<LineSolidOutlined />
|
||||
</Radio.Button>
|
||||
<Radio.Button value="dashed">
|
||||
<IconFont type="icon-line-dashed" title="dashed" />
|
||||
<LineDashedOutlined />
|
||||
</Radio.Button>
|
||||
</Radio.Group>
|
||||
</Label>
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user