gfwleak/nezha-nezha-fronted
Archived
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: 补充 chartList文档 以及 panelChart文档

Browse Source
This commit is contained in:
zhangyu
2024-05-23 17:18:51 +08:00
parent 53d57759f8
commit 8104762bb2
27 changed files with 33401 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@@ -19,3 +19,4 @@ nezha-fronted/src/components/common/rightBox/tempRoghtBox.vue
nezha-fronted/exportHtml/ nezha-fronted/exportHtml/
nezha-fronted/src/a.txt nezha-fronted/src/a.txt
nezha-fronted/src/components/common/testTopology.vue nezha-fronted/src/components/common/testTopology.vue
nezha-docs/.docs/

1
nezha-docs/.eslintignore Normal file
View File

@@ -0,0 +1 @@
dist

34
nezha-docs/.eslintrc.cjs Normal file
View File

@@ -0,0 +1,34 @@
// @ts-check
const { defineConfig } = require('eslint-define-config');
module.exports = defineConfig({
root: true,
extends: [
'eslint:recommended',
'plugin:node/recommended',
'plugin:@typescript-eslint/recommended',
],
plugins: ['import'],
parser: '@typescript-eslint/parser',
parserOptions: {
sourceType: 'module',
ecmaVersion: 2021,
},
rules: {
'no-debugger': ['error'],
'@typescript-eslint/no-var-requires': 'off',
'node/no-unpublished-require': 'off',
'node/no-extraneous-import': 'off',
'node/no-extraneous-require': 'off',
'node/no-missing-import': 'off',
'node/no-missing-require': 'off',
'no-undef': 'off',
'node/no-unpublished-import': 'off',
'node/no-unsupported-features/es-syntax': 'off',
'no-process-exit': 'off',
'@typescript-eslint/ban-ts-comment': 'off',
'no-constant-condition': 'off',
'@typescript-eslint/no-non-null-assertion': 'off',
'@typescript-eslint/no-explicit-any': 'off',
},
});

7
nezha-docs/.prettierrc.js Normal file
View File

@@ -0,0 +1,7 @@
module.exports = {
semi: true,
singleQuote: true,
tabWidth: 2,
trailingComma: 'all',
printWidth: 80,
};

61
nezha-docs/docs/.vitepress/config.js Normal file
View File

@@ -0,0 +1,61 @@
import { defineConfig } from 'vitepress';
import { applyPlugins } from '@ruabick/md-demo-plugins';
import { genTemp } from '@ruabick/vite-plugin-gen-temp';
import { genApiDoc } from '@ruabick/vite-plugin-gen-api-doc';
import { sidebar } from './sidebar.js';
import { resolve } from 'path';
export default defineConfig({
lang: 'zh-CN',
lastUpdated: true,
base: process.env.NODE_ENV === 'production' ? '/nezha' : '/',
locales: {
'/': {
lang: 'zh-CN',
title: 'nezha',
description: '',
},
'/en/': {
lang: 'en-US',
title: 'nezha',
description: '',
},
},
themeConfig: {
logo: '/logo.svg',
localeLinks: {
text: '',
items: [
{ text: '简体中文', link: '/' },
{ text: 'English', link: '/en/' },
],
},
nav: [{ text: '指南', link: '/guide' }],
sidebar,
algolia: {},
socialLinks: [
{ icon: 'github', link: 'https://github.com//nezha' },
],
},
vue: {},
vite: {
plugins: [genTemp(), genApiDoc()],
resolve: {
alias: {
'nezha': resolve('./src/'),
},
},
},
markdown: {
config: (md) => {
applyPlugins(md);
},
theme: {
light: 'github-light',
dark: 'github-dark',
},
},
buildEnd() {
process.exit(0);
},
});

25
nezha-docs/docs/.vitepress/sidebar.js Normal file
View File

@@ -0,0 +1,25 @@
export const sidebar = {
'/en/': [
{
text: 'Guide',
items: [
{ text: 'Button', link: '/en/' },
],
},
],
'/': [
{
text: '介绍',
items: [
{ text: '简介', link: '/' },
],
},
{
text: '组件',
items: [
{ text: 'chartList', link: '/chartList' },
{ text: 'panelChart', link: '/panelChart' }
],
}
],
};

15
nezha-docs/docs/.vitepress/theme/index.ts Normal file
View File

@@ -0,0 +1,15 @@
import DefaultTheme from 'vitepress/theme';
import DemoBlock from '@ruabick/vitepress-demo-block';
import '@ruabick/vitepress-demo-block/dist/style.css';
import './var.css';
export default {
...DefaultTheme,
enhanceApp({ app, router, siteData }) {
// app is the Vue 3 app instance from `createApp()`.
// router is VitePress' custom router. `siteData` is
// a `ref` of current site-level metadata.
app.component('demo', DemoBlock);
},
};

64
nezha-docs/docs/.vitepress/theme/var.css Normal file
View File

@@ -0,0 +1,64 @@
:root {
--vp-code-block-bg: #f9fafb;
/* --vp-code-block-bg: var(--vp-c-bg-alt); */
--vp-code-line-highlight-color: rgba(0, 0, 0, 0.5);
--vp-code-line-number-color: var(--vp-c-text-dark-3);
--vp-code-copy-code-hover-bg: rgba(255, 255, 255, 0.05);
--vp-code-copy-code-active-text: var(--vp-c-bg-alt);
--demi-border-color: #ebedf1;
}
.dark {
--vp-code-block-bg: var(--vp-c-bg-alt);
}
.vp-doc [class*='language-']:before {
color: var(--vp-c-text-2);
}
@media (min-width: 640px) {
.vp-doc div[class*='language-'] {
border-radius: 4px;
margin: 16px 0;
}
}
@media (max-width: 639px) {
.vp-doc div[class*='language-'] {
border-radius: 4px;
}
}
.vp-doc table {
display: table;
width: 100%;
font-size: 15px;
}
.vp-doc tr {
border-top: 1px solid var(--demi-border-color);
}
.vp-doc tr:nth-child(2n) {
background-color: unset;
}
.vp-doc th,
.vp-doc td {
border: 1px solid var(--demi-border-color);
padding: 10px 20px;
}
.vp-doc th {
font-size: 15px;
font-weight: 600;
background-color: var(--vp-c-white-soft);
}
.vp-doc table td:first-child {
font-size: 15px;
font-weight: 600;
}

19
nezha-docs/docs/public/logo.svg Normal file
View File

@@ -0,0 +1,19 @@
<?xml version="1.0" standalone="no"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd"><svg t="1659323377213"
class="icon" viewBox="0 0 1024 1024" version="1.1" xmlns="http://www.w3.org/2000/svg" p-id="1327"
xmlns:xlink="http://www.w3.org/1999/xlink" width="200" height="200">
<defs>
<style type="text/css">
@font-face {
font-family: feedback-iconfont;
src: url("//at.alicdn.com/t/font_1031158_u69w8yhxdu.woff2?t=1630033759944") format("woff2"), url("//at.alicdn.com/t/font_1031158_u69w8yhxdu.woff?t=1630033759944") format("woff"), url("//at.alicdn.com/t/font_1031158_u69w8yhxdu.ttf?t=1630033759944") format("truetype");
}
</style>
</defs>
<path
d="M167 607v250h251v72H155C122.194 929 95.538 902.672 95.008 869.992L95 869V607h72z m762 0v262c0 33.137-26.863 60-60 60H604v-72h253V607h72zM869 98c33.137 0 60 26.863 60 60v263h-72V170H604V98zM418 98v72H167v251H95V158C95 125.194 121.328 98.538 154.008 98.008L155 98h263z"
fill="#213547" p-id="1328"></path>
<path d="M339.5 416.5m-57.5 0a57.5 57.5 0 1 0 115 0 57.5 57.5 0 1 0-115 0Z" fill="#213547" p-id="1329"></path>
<path d="M684.5 416.5m-57.5 0a57.5 57.5 0 1 0 115 0 57.5 57.5 0 1 0-115 0Z" fill="#213547" p-id="1330"></path>
<path d="M397 589c0 63.513 51.711 115 115.5 115S628 652.513 628 589" fill="#213547" p-id="1331"></path>
</svg>
Side by Side

After

Width:  |  Height:  |  Size: 1.4 KiB

32815
nezha-docs/package-lock.json generated Normal file
View File

File diff suppressed because it is too large Load Diff

55
nezha-docs/package.json Normal file
View File

@@ -0,0 +1,55 @@
{
"name": "nezha-docs",
"version": "0.0.0",
"description": "",
"type": "module",
"types": "./dist/index.d.ts",
"main": "./dist/nezha.umd.cjs",
"module": "./dist/nezha.js",
"exports": {
".": {
"import": "./dist/nezha.js",
"require": "./dist/nezha.umd.cjs"
},
"./dist/style.css": "./dist/style.css"
},
"scripts": {
"dev": "initial-scan docs && vitepress dev .docs --host",
"build": "vite build",
"site:build": "initial-scan docs && cross-env NODE_ENV=production vitepress build .docs",
"serve": "cross-env NODE_ENV=production vitepress serve .docs --host",
"deploy": "gh-pages -d .docs/.vitepress/dist -t true",
"docs-build-deploy": "yarn docs-build && yarn docs-deploy",
"changelog": "conventional-changelog -p angular -i CHANGELOG.md -s",
"lint": "eslint src/**/*.{vue,js,ts,tsx}",
"lint-fix": "yarn lint -- --fix",
"release": "np"
},
"keywords": [],
"author": "",
"license": "MIT",
"devDependencies": {
"@ruabick/md-demo-plugins": "latest",
"@ruabick/vite-plugin-gen-api-doc": "latest",
"@ruabick/vite-plugin-gen-temp": "latest",
"@ruabick/vitepress-demo-block": "latest",
"@typescript-eslint/eslint-plugin": "^5.33.1",
"@typescript-eslint/parser": "^5.33.1",
"@vitejs/plugin-vue": "^3.0.1",
"cross-env": "^7.0.3",
"eslint": "^8.20.0",
"eslint-define-config": "^1.6.0",
"eslint-plugin-import": "^2.26.0",
"eslint-plugin-node": "^11.1.0",
"gh-pages": "^4.0.0",
"np": "^7.6.2",
"prettier": "^2.7.1",
"vite": "latest",
"vite-plugin-dts": "^1.4.0",
"vitepress": "latest",
"vue": "latest"
},
"dependencies": {
"@arco-design/arco-vue-scripts": "^0.2.9"
}
}

25
nezha-docs/src/__docs__/demo.vue Normal file
View File

@@ -0,0 +1,25 @@
<script setup>
import { ref } from 'vue';
import MyButton from 'nezha';
const count = ref(0);
function onClick() {
count.value++;
}
</script>
<template>
<div>
<p>
<span class="">点击次数:</span>
<span>{{ count }}</span>
</p>
<MyButton @click="onClick">count++</MyButton>
</div>
</template>
<style>
.text {
font-size: 14px;
}
</style>

8
nezha-docs/src/__docs__/index.en-US.md Normal file
View File

@@ -0,0 +1,8 @@
---
map:
path: /
---
## 简介

7
nezha-docs/src/__docs__/index.vue Normal file
View File

@@ -0,0 +1,7 @@
<script lang="ts" setup>
</script>
<template>
<div>
</template>

6
nezha-docs/src/__docs__/index.zh-CN.md Normal file
View File

@@ -0,0 +1,6 @@
---
map:
path: /
---
## 简介

65
nezha-docs/src/chartList/chartList.vue Normal file
View File

@@ -0,0 +1,65 @@
<script lang="ts" setup>
const props = withDefaults(defineProps<{
/**
* dashboard Id 唯一
*/
dashboardId?: string,
/**
* 底部弹窗的相关信息
*/
chartDetailInfo?: Object,
/**
* 时间范围
*/
timeRange?: Array,
/**
* 是否是组
*/
isGroup? : boolean,
/**
* 组相关信息 包括 位置 宽高等
*/
groupInfo?: Object,
/**
* 父页面位置
*/
from?: string,
/**
* 所有组件相关信息
*/
dataList?: Array,
/**
* 是否是快照文件
*/
isExportHtml?: boolean,
/**
* 快照文件相关数据
*/
dataJson?: {},
/**
* 用于判断 dashboard变量是否加载完成
*/
variablesInit?: boolean,
/**
*
*/
showTool?: boolean
}>(), {
dashboardId: '',
chartDetailInfo: {},
timeRange: ['start', 'end', 'type dashboard.vue/timeData'],
isGroup: false,
groupInfo: {},
from: '',
dataList: [],
isExportHtml: false,
dataJson: {},
variablesInit: true,
showTool: true,
})
</script>
<template>
<div>
</div>
</template>

9
nezha-docs/src/chartList/demo.vue Normal file
View File

@@ -0,0 +1,9 @@
<script lang="ts" setup>
</script>
<template>
<div></div>
</template>
<style>
</style>

11
nezha-docs/src/chartList/index.en-US.md Normal file
View File

@@ -0,0 +1,11 @@
---
map:
path: /chartList
---
# 关联组件
1. grid-layout 拖拽组件容器 参考链接 https://jbaysolutions.github.io/vue-grid-layout/zh/
2. grid-item 拖拽组件 该组件以拉取到本地 修改了高度不支持小数的问题
3. panel-chart 图表组件实例
<API src="./chartList.vue" lang="en"></API>

11
nezha-docs/src/chartList/index.zh-CN.md Normal file
View File

@@ -0,0 +1,11 @@
---
map:
path: /chartList
---
# 关联组件
1. grid-layout 拖拽组件容器 参考链接 https://jbaysolutions.github.io/vue-grid-layout/zh/
2. grid-item 拖拽组件 该组件以拉取到本地 修改了高度不支持小数的问题
3. panel-chart 图表组件实例
<API src="./chartList.vue" lang="zh"></API>

1
nezha-docs/src/index.ts Normal file
View File

@@ -0,0 +1 @@
export { default } from './__docs__/index.vue';

9
nezha-docs/src/panelChart/demo.vue Normal file
View File

@@ -0,0 +1,9 @@
<script lang="ts" setup>
</script>
<template>
<div></div>
</template>
<style>
</style>

11
nezha-docs/src/panelChart/index.en-US.md Normal file
View File

@@ -0,0 +1,11 @@
---
map:
path: /panelChart
---
# 关联组件
1. chartHeader chart-header相关设置
2. chart 去除头部的组件实例
3. ChartScreenHeader 全屏chart-header相关设置
<API src="./panelChart.vue" lang="zh"></API>

11
nezha-docs/src/panelChart/index.zh-CN.md Normal file
View File

@@ -0,0 +1,11 @@
---
map:
path: /panelChart
---
# 关联组件
1. chartHeader chart-header相关设置
2. chart 去除头部的组件实例
3. ChartScreenHeader 全屏chart-header相关设置
<API src="./panelChart.vue" lang="zh"></API>

47
nezha-docs/src/panelChart/panelChart.vue Normal file
View File

@@ -0,0 +1,47 @@
<script lang="ts" setup>
const props = withDefaults(defineProps<{
/**
* chart详细信息
*/
chartInfo?: {},
/**
* 时间范围
*/
timeRange?: [],
/**
* 是否全屏
*/
isFullscreen?: boolean,
/**
* 是否锁定
*/
panelLock?: boolean,
/**
* header 是否为hover激活
*/
showHeader?: boolean,
/**
* 是否为快照
*/
isExportHtml?: boolean,
/**
* 快照数据
*/
dataJson?: { },
/**
* 隐藏图表的悬浮文字
*/
hiddenText?: string,
/**
* 是否为预览
*/
isPreview?: string,
}>(), {
})
</script>
<template>
<div>
</div>
</template>

48
nezha-docs/tsconfig.json Normal file
View File

@@ -0,0 +1,48 @@
{
"compilerOptions": {
"baseUrl": "./",
"outDir": "dist",
"sourceMap": false,
"target": "ES2022",
"module": "ES2022",
"moduleResolution": "node",
"allowJs": false,
"noUnusedLocals": true,
"strictNullChecks": true,
"noImplicitAny": true,
"noImplicitThis": true,
"experimentalDecorators": true,
"resolveJsonModule": true,
"esModuleInterop": true,
"removeComments": false,
"declaration": true,
"isolatedModules": true,
"jsx": "preserve",
"lib": [
"esnext",
"dom",
],
"types": [],
"skipLibCheck": true,
// "files": "src/index.ts",
"emitDeclarationOnly": true,
"declarationDir": "dist",
"rootDir": ".",
"paths": {
"@/*": [
"src/*"
],
"nezha": [
"src/index.ts"
]
}
},
"include": [
"src/*"
],
"exclude": [
"node_modules",
"dist",
"packages/**/__tests__"
]
}

28
nezha-docs/vite.config.ts Normal file
View File

@@ -0,0 +1,28 @@
import { resolve } from 'path';
import { defineConfig } from 'vite';
import vue from '@vitejs/plugin-vue';
import dts from 'vite-plugin-dts';
import packageJson from './package.json'
export default defineConfig({
plugins: [vue(), dts()],
build: {
lib: {
entry: resolve(__dirname, './src/index.ts'),
name: 'nezha-docs',
// the proper extensions will be added
fileName: 'nezha-docs',
},
rollupOptions: {
// 确保外部化处理那些你不想打包进库的依赖
// @ts-ignore
external: ['vue', ...Object.keys(packageJson.dependencies || {}), ...Object.keys(packageJson.peerDependencies || {})],
output: {
// 在 UMD 构建模式下为这些外部化的依赖提供一个全局变量
globals: {
vue: 'Vue',
},
},
},
},
});

7
nezha-fronted/README.md
View File

@@ -36,3 +36,10 @@ https://docs.geedge.net/pages/viewpage.action?pageId=67209306
dev 正常启动 dev 正常启动
dev:html 导出为html dev:html 导出为html
# 部分组件Api
nezha-docs目录下 运行 npm i && npm run dev 若无法运行 尝试切换不同的node版本
新增 参考其中一个src下任意一个文件夹， 创建对应文件。 或者可以根据项目目录创建
之后再docs sidebar.js 创建相应的目录 link 关联到对应index.md里面的 'path'