Skip to content

Commit 5fca953

Browse files
AarebeccaAarebecca
committed
refactor: format code and docs
1 parent bf49020 commit 5fca953

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

70 files changed

+996
-761
lines changed

‎.dumi/pages/case/index.en.tsx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
import Case from './index'
21
import React from 'react';
2+
import Case from './index';
33

44
const CaseIndex: React.FC = () => {
5-
return <Case></Case>
5+
return <Case></Case>;
66
};
77

8-
export default CaseIndex
8+
export default CaseIndex;

‎.dumi/pages/case/index.tsx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
import React from 'react';
21
import SEO from '@antv/dumi-theme-antv/dist/common/SEO';
3-
import ShowCase from 'site/components/ShowCase/ShowCase';
4-
import { useIntl, useLocale } from 'dumi';
5-
import { Header } from '@antv/dumi-theme-antv/dist/slots/Header';
62
import { Footer } from '@antv/dumi-theme-antv/dist/slots/Footer';
3+
import { Header } from '@antv/dumi-theme-antv/dist/slots/Header';
4+
import { useIntl, useLocale } from 'dumi';
5+
import React from 'react';
6+
import ShowCase from 'site/components/ShowCase/ShowCase';
77

88
const CaseIndex: React.FC = () => {
99
const locale = useLocale();

‎.dumi/pages/quick/index.en.tsx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
import Case from './index'
21
import React from 'react';
2+
import Case from './index';
33

44
const QuickIssueIndex: React.FC = () => {
5-
return <Case></Case>
5+
return <Case></Case>;
66
};
77

8-
export default QuickIssueIndex
8+
export default QuickIssueIndex;

‎.dumi/pages/quick/index.tsx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
import React from 'react';
21
import SEO from '@antv/dumi-theme-antv/dist/common/SEO';
3-
import { useIntl, useLocale } from 'dumi';
4-
import { Header } from '@antv/dumi-theme-antv/dist/slots/Header';
52
import { Footer } from '@antv/dumi-theme-antv/dist/slots/Footer';
3+
import { Header } from '@antv/dumi-theme-antv/dist/slots/Header';
4+
import { useIntl, useLocale } from 'dumi';
5+
import React from 'react';
66
import QuickIssue from 'site/components/quickIssue/QuickIssue';
77

88
const QuickIssueIndex: React.FC = () => {

‎.dumi/theme/locales/en.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -329,11 +329,11 @@
329329
"邻近顺序色板，均基于分类色板生长而来，为加大辨识度也可使用邻近色相，通过明度或饱和度的渐变，常用来表示同一事物中的数值大小或梯度变化，如排行榜等级变化、一个国家或地区的新增人口数对比、风险等级变化等。": "Adjacent sequential color palette, all based on the growth of the classification color palette, in order to increase the recognition can also use adjacent colors, through the gradual change of brightness or saturation, commonly used to represent the value size or gradient change in the same thing, such as ranking change, comparison of the number of new population in a country or region, risk level change.",
330330
"点再到正向值的连续变化区间，显示相对立的两个值的大小关系，常用于气温的冷热、海拔高低、股票涨跌等。": "The continuous change interval from the point to the positive value shows the size relationship between the two opposite values, which is often used for the cold and hot temperature, altitude, stock rise and fall, etc.",
331331
"柱形图、饼图、关系图、地图、多维表格等260+丰富图表随心选用": "Column、Pie、Graph、Map、Dimensions Table and other 260+ rich chart choice at will.",
332-
332+
333333
"设计语言与研发框架": "Design language and R&D framework",
334334
"资产一览，让你快速搭建网站应用": "Assets list, let you quickly build a website application.",
335335
"Ant Design / AntV 设计负责人": "Ant Design / AntV Design Leader",
336336
"地理空间数据": "For Geospacial Data",
337337
"267 全系 F 版": "F2、6、7",
338338
"蚂蚁企业级数据可视化解决方案，让人们在数据世界里获得视觉化思考能力": "Ant enterprise data visualization solutions, so that people in the data world to get the ability to think visually."
339-
}
339+
}

‎.dumi/theme/locales/zh.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -328,4 +328,4 @@
328328
"地理空间数据": "地理空间数据",
329329
"267 全系 F 版": "267 全系 F 版",
330330
"蚂蚁企业级数据可视化解决方案，让人们在数据世界里获得视觉化思考能力": "蚂蚁企业级数据可视化解决方案，让人们在数据世界里获得视觉化思考能力"
331-
}
331+
}

‎.dumirc.ts

Lines changed: 29 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,33 @@
11
import { defineConfig } from 'dumi';
2-
import { repository, version, homepage } from './package.json';
2+
import { homepage, repository } from './package.json';
33
export default defineConfig({
4-
locales: [{ id: 'zh', name: '中文' }, { id: 'en', name: 'English' }],
5-
favicons: ['https://mdn.alipayobjects.com/huamei_qa8qxu/afts/img/A*7svFR6wkPMoAAAAAAAAAAAAADmJ7AQ/original'], // 网站 favicon
6-
metas: [ // 自定义 meta 标签
4+
locales: [
5+
{ id: 'zh', name: '中文' },
6+
{ id: 'en', name: 'English' },
7+
],
8+
favicons: [
9+
'https://mdn.alipayobjects.com/huamei_qa8qxu/afts/img/A*7svFR6wkPMoAAAAAAAAAAAAADmJ7AQ/original',
10+
], // 网站 favicon
11+
metas: [
12+
// 自定义 meta 标签
713
{ name: 'keywords', content: 'AntV' },
814
{ name: 'description', content: 'Ant Visualization solution' },
915
],
1016
themeConfig: {
1117
title: 'AntV',
1218
description: 'Ant Visualization solution',
13-
defaultLanguage: 'zh', // 默认语言
14-
isAntVSite: true, // 是否是 AntV 的大官网
19+
defaultLanguage: 'zh', // 默认语言
20+
isAntVSite: true, // 是否是 AntV 的大官网
1521
footerTheme: 'light',
16-
siteUrl: homepage, // 官网地址
17-
githubUrl: repository.url, // GitHub 地址
18-
showSearch: true, // 是否显示搜索框
19-
showGithubCorner: true, // 是否显示头部的 GitHub icon
20-
showAntVProductsCard: true, // 是否显示 AntV 产品汇总的卡片
21-
showLanguageSwitcher: true, // 是否显示官网语言切换
22-
showWxQrcode: true, // 是否显示头部菜单的微信公众号
23-
docsearchOptions: { // 头部搜索框配置
22+
siteUrl: homepage, // 官网地址
23+
githubUrl: repository.url, // GitHub 地址
24+
showSearch: true, // 是否显示搜索框
25+
showGithubCorner: true, // 是否显示头部的 GitHub icon
26+
showAntVProductsCard: true, // 是否显示 AntV 产品汇总的卡片
27+
showLanguageSwitcher: true, // 是否显示官网语言切换
28+
showWxQrcode: true, // 是否显示头部菜单的微信公众号
29+
docsearchOptions: {
30+
// 头部搜索框配置
2431
apiKey: '9d1cd586972bb492b7b41b13a949ef30',
2532
indexName: 'antv_g6',
2633
},
@@ -43,12 +50,12 @@ export default defineConfig({
4350
slug: 'quick',
4451
title: {
4552
zh: '提交 Issue',
46-
en: 'Quick Issue'
47-
}
48-
}
53+
en: 'Quick Issue',
54+
},
55+
},
4956
],
50-
ecosystems: [ // 头部的菜单中的「周边生态」
51-
57+
ecosystems: [
58+
// 头部的菜单中的「周边生态」
5259
],
5360
docs: [
5461
{
@@ -118,8 +125,7 @@ export default defineConfig({
118125
order: 1,
119126
},
120127
],
121-
examples: [
122-
],
128+
examples: [],
123129
mdPlayground: {
124130
// 第一个分块的大小
125131
splitPaneMainSize: '62%',
@@ -152,8 +158,6 @@ export default defineConfig({
152158
// 百度统计的 key
153159
// baidu: 'baidu_tongji_key',
154160
},
155-
links: [
156-
],
157-
scripts: [
158-
],
161+
links: [],
162+
scripts: [],
159163
});

‎docs/specification/language/interact.zh.md

Lines changed: 11 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,9 @@ Shneiderman [1] 提出了经典的可视化信息交互策略：概览、缩放
1111

1212
经过业务的实践和沉淀，AntV 从用户视角出发，按照用户的目标和行为对可视化交互进行梳理。我们发现用户在进行可视化数据分析时，通常会经历三个步骤，分别为「看数-分析-洞察」。
1313

14-
**看数：** 主要指用户获取数据并初步可视化加工和阅读查看的行为。
15-
**分析：** 主要指用户对数据进行调整，从更多角度进行看数的行为。
16-
**洞察：** 主要指用户通过交互强化洞见，并对结果进行流转的行为。
14+
**看数：** 主要指用户获取数据并初步可视化加工和阅读查看的行为。 **分析：** 主要指用户对数据进行调整，从更多角度进行看数的行为。 **洞察：** 主要指用户通过交互强化洞见，并对结果进行流转的行为。
1715

18-
基于更多的业务调研和桌面调研，我们总结出常见的24类可视化交互，这是我们从用户视角出发的最全归纳。
16+
基于更多的业务调研和桌面调研，我们总结出常见的 24 类可视化交互，这是我们从用户视角出发的最全归纳。
1917

2018
<img src='https://mdn.alipayobjects.com/huamei_qa8qxu/afts/img/A*7_pEQayJZzYAAAAAAAAAAAAADmJ7AQ/original' alt='' />
2119

@@ -53,24 +51,24 @@ AntV 5.0 的设计价目标是让用户更有信任感、轻松感和意义感
5351

5452
除了少思考和少操作以外，我们建议可以提供类似右键菜单的能力，让用户产生分析意图时即可所见即所得的获取分析工具，并对对象快速进行分析探索。
5553

56-
### 意义感
54+
### 意义感
5755

5856
增强分析的能力，让用户更易洞察。
5957

6058
<img src='https://mdn.alipayobjects.com/huamei_qa8qxu/afts/img/A*BaTcRKwYhTYAAAAAAAAAAAAADmJ7AQ/original' alt='' />
6159

62-
用户在分析探索时，适时的画龙点睛之笔可以让洞察更直观的展现在分析者面前，一条辅助线和一块参考区间便可以快速的将机会点或者风险点清晰的暴露出来。但是如果这个时候如果用户需要填写复杂的表单才能记录自己的洞察，那么在复杂的操作间，灵感可能会稍纵即逝。
63-
我们建议为用户匹配更直观的交互语言，让用户抓住时机，快速沉淀洞察记录观点。如上图：用户在标注辅助线时原需要填写复杂的表单才能完成诉求，如果我们支持用直接长按坐标轴X即可添加辅助线，那么用户将获得更自由的交互体验，洞察也可被更快获取。
60+
用户在分析探索时，适时的画龙点睛之笔可以让洞察更直观的展现在分析者面前，一条辅助线和一块参考区间便可以快速的将机会点或者风险点清晰的暴露出来。但是如果这个时候如果用户需要填写复杂的表单才能记录自己的洞察，那么在复杂的操作间，灵感可能会稍纵即逝。我们建议为用户匹配更直观的交互语言，让用户抓住时机，快速沉淀洞察记录观点。如上图：用户在标注辅助线时原需要填写复杂的表单才能完成诉求，如果我们支持用直接长按坐标轴 X 即可添加辅助线，那么用户将获得更自由的交互体验，洞察也可被更快获取。
6461

6562
&nbsp;
63+
6664
## 03 设计策略
6765

68-
带着上面三个目标，我们对24种常见交互进行了设计迭代，沉淀了9+设计策略和20+设计案例，且会持续更新。
69-
本篇将对每个策略挑选一个案例进行简单说明。
66+
带着上面三个目标，我们对 24 种常见交互进行了设计迭代，沉淀了 9+设计策略和 20+设计案例，且会持续更新。本篇将对每个策略挑选一个案例进行简单说明。
7067

7168
<img src='https://mdn.alipayobjects.com/huamei_qa8qxu/afts/img/A*eyBiQKJ1gNUAAAAAAAAAAAAADmJ7AQ/original' alt='' />
7269

7370
&nbsp;
71+
7472
### 信任感
7573

7674
#### 👀 有前馈
@@ -122,7 +120,7 @@ AntV 5.0 的设计价目标是让用户更有信任感、轻松感和意义感
122120
<img src='https://mdn.alipayobjects.com/huamei_qa8qxu/afts/img/A*ZEPRSb71URgAAAAAAAAAAAAADmJ7AQ/original' alt='' />
123121
&nbsp;
124122

125-
更多设计案例和设计Tips可查看： <a href='https://www.yuque.com/antv/operation/lb0y0d6umtqay0ow'>AntV 交互设计工具箱</a>
123+
更多设计案例和设计 Tips 可查看： <a href='https://www.yuque.com/antv/operation/lb0y0d6umtqay0ow'>AntV 交互设计工具箱</a>
126124

127125
&nbsp;
128126

@@ -146,6 +144,7 @@ AntV 5.0 的设计价目标是让用户更有信任感、轻松感和意义感
146144
</table>
147145

148146
&nbsp;
147+
149148
### 分析
150149

151150
<table style="border: none;">
@@ -176,6 +175,7 @@ AntV 5.0 的设计价目标是让用户更有信任感、轻松感和意义感
176175
</table>
177176

178177
&nbsp;
178+
179179
### 洞察
180180

181181
<table style="border: none;">
@@ -189,9 +189,4 @@ AntV 5.0 的设计价目标是让用户更有信任感、轻松感和意义感
189189

190190
## 参考文献
191191

192-
[1] Schneiderman B. The eyes have it: a task by data type taxonomy forinformation\visualizations[J]. Craft of Information Visualization, 1996:364-371.
193-
[2] Dix, Alan, Ellis, Geoffrey. Starting simple: adding value to static visualisation throughsimple interaction[J]. 1998.
194-
[3]李洪海，齐兵．界面设计中交互行为的分类［J］．艺术与设计：理论，2013（11）：119-121．
195-
[4]Landesberger T V, Fiebig S, Bremm S, et al. Interaction Taxonomy for Tracking of UserActions in Visual Analytics Applications[J]. 2014:653-670.
196-
[5] Gotz D, Zhou M X. Characterizing users' visual analytic activity for insightprovenance[C]// IEEE Symposium on Visual Analytics Science & Technology. 2008.
197-
[6]:Donald A.Norman.《设计心理学1》[M]．
192+
[1] Schneiderman B. The eyes have it: a task by data type taxonomy forinformation\visualizations[J]. Craft of Information Visualization, 1996:364-371. [2] Dix, Alan, Ellis, Geoffrey. Starting simple: adding value to static visualisation throughsimple interaction[J]. 1998. [3]李洪海，齐兵．界面设计中交互行为的分类［J］．艺术与设计：理论，2013（11）：119-121． [4]Landesberger T V, Fiebig S, Bremm S, et al. Interaction Taxonomy for Tracking of UserActions in Visual Analytics Applications[J]. 2014:653-670. [5] Gotz D, Zhou M X. Characterizing users' visual analytic activity for insightprovenance[C]// IEEE Symposium on Visual Analytics Science & Technology. 2008. [6]:Donald A.Norman.《设计心理学 1》[M]．

‎docs/specification/language/media.en.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@ title: Media
33
order: 3
44
---
55

6-
<embed src="./media.zh.md"></embed>
6+
<embed src="./media.zh.md"></embed>

‎docs/specification/language/palette.zh.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -141,18 +141,15 @@ AntV 色板以蚂蚁极客蓝为起始主色，根据不同数据类型、使用
141141

142142
<swatch title="Autumn" colors="#FF6B3B,#626681,#FFC100,#9FB40F,#76523B,#DAD5B5,#0E8E89,#E19348,#F383A2,#247FEA,#2BCB95,#B1ABF4,#1D42C2,#1D9ED1,#D64BC0,#255634,#8C8C47,#8CDAE5,#8E283B,#791DC9" colorNames="Autumn" descriptions="秋日橙色板，适用于橙色调的产品，可按需替换默认色板。|马卡龙色板，颜色明快，适用于较为活泼轻松的产品或蓝紫色调的产品，可按需替换默认色板。|强对比色板，建议用于投屏及讲演等场景。"></swatch>
143143

144-
![秋日橙主题.png](https://mdn.alipayobjects.com/huamei_qa8qxu/afts/img/A*8g3IQLdwuyQAAAAAAAAAAAAADmJ7AQ/original)
145-
![秋日橙.gif](https://gw.alipayobjects.com/mdn/rms_a8a5bf/afts/img/A*4eQ-Q7NX-wIAAAAAAAAAAAAAARQnAQ)
144+
![秋日橙主题.png](https://mdn.alipayobjects.com/huamei_qa8qxu/afts/img/A*8g3IQLdwuyQAAAAAAAAAAAAADmJ7AQ/original) ![秋日橙.gif](https://gw.alipayobjects.com/mdn/rms_a8a5bf/afts/img/A*4eQ-Q7NX-wIAAAAAAAAAAAAAARQnAQ)
146145

147146
### 马卡龙主题
148147

149148
以粉紫色调为主的主题色板，整体基调是马卡龙糖果色，同时适应深浅模式，风格活泼明快，可按需替换默认主题。
150149

151150
<swatch title="Macaron" colors="#025DF4,#DB6BCF,#2498D1,#BBBDE6,#4045B2,#21A97A,#FF745A,#007E99,#FFA8A8,#2391FF,#FFC328,#A0DC2C,#946DFF,#626681,#EB4185,#CD8150,#36BCCB,#327039,#803488,#83BC99" colorNames="Macaron" descriptions="马卡龙色板，颜色明快，适用于较为活泼轻松的产品或蓝紫色调的产品，可按需替换默认色板。"></swatch>
152151

153-
154-
![马卡龙主题.png](https://mdn.alipayobjects.com/huamei_qa8qxu/afts/img/A*Gt1AToxkmZoAAAAAAAAAAAAADmJ7AQ/original)
155-
![马卡龙.gif](https://gw.alipayobjects.com/mdn/rms_a8a5bf/afts/img/A*PhfqRLQmq4QAAAAAAAAAAAAAARQnAQ)
152+
![马卡龙主题.png](https://mdn.alipayobjects.com/huamei_qa8qxu/afts/img/A*Gt1AToxkmZoAAAAAAAAAAAAADmJ7AQ/original) ![马卡龙.gif](https://gw.alipayobjects.com/mdn/rms_a8a5bf/afts/img/A*PhfqRLQmq4QAAAAAAAAAAAAAARQnAQ)
156153

157154
### 强对比主题
158155

‎docs/specification/module/annotation.en.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@ title: Annotation
33
order: 6
44
---
55

6-
<embed src="./annotation.zh.md"></embed>
6+
<embed src="./annotation.zh.md"></embed>

‎docs/specification/module/axis.en.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@ title: Axis
33
order: 3
44
---
55

6-
<embed src="./axis.zh.md"></embed>
6+
<embed src="./axis.zh.md"></embed>

‎docs/specification/module/element.en.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@ title: Element
33
order: 1
44
---
55

6-
<embed src="./element.zh.md"></embed>
6+
<embed src="./element.zh.md"></embed>

0 commit comments

Comments
 (0)