Merge pull request #93 from AElf-devops/feature/doc-upload

feat: add icon use basic
AElfProject · Mar 25, 2024 · 04beae4 · 04beae4
2 parents 1362d6a + 2535f66
commit 04beae4
Show file tree

Hide file tree

Showing 7 changed files with 113 additions and 7 deletions.
diff --git a/.dumi/theme/common/styles/Icon.tsx b/.dumi/theme/common/styles/Icon.tsx
@@ -32,7 +32,7 @@ const Icon: React.FC = () => {
           padding: 10px 0 0;
         }
 
-        .anticon {
+        .ant-icon {
           margin: 12px 0 8px;
           font-size: 36px;
           transition: transform 0.3s ease-in-out;
@@ -59,7 +59,7 @@ const Icon: React.FC = () => {
           color: #fff;
           background-color: ${token.colorPrimary};
 
-          .anticon {
+          .ant-icon {
             transform: scale(1.4);
           }
 
@@ -68,20 +68,20 @@ const Icon: React.FC = () => {
           }
         }
 
-        &.CircleFilled .anticon {
+        &.CircleFilled .ant-icon {
           border-radius: 50%;
         }
 
         &.CircleFilled:hover {
           color: #000;
 
-          .anticon {
+          .ant-icon {
             color: #000;
             background-color: #000;
           }
         }
 
-        &.isWhite .anticon {
+        &.isWhite .ant-icon {
           background-color: #000;
         }
 

diff --git a/docs/icon.md b/docs/icon.md
@@ -8,3 +8,17 @@ group:
 ## Icon List
 
 <IconSearch></IconSearch>
+
+## Basic Usage
+
+<code src="./iconDemos/basic.tsx">基本用法</code> <code src="./iconDemos/customColor.tsx">自定义图标颜色</code> <code src="./iconDemos/custom.tsx">自定义图标</code>
+
+## API
+
+| Property    | Description                   | Type            | Default | Version |
+| ----------- | ----------------------------- | --------------- | ------- | ------- |
+| color       | 基础颜色                      | `string`        |         | `1.0.0` |
+| hoverColor  | hover颜色                     | `string`        |         | `1.0.0` |
+| activeColor | 点击颜色                      | `string`        |         | `1.0.0` |
+| style       | 设置图标的样式，例如 fontSize | `CSSProperties` |         | `1.0.0` |
+| className   | 计算后的 svg 类名             | `CSSProperties` |         | `1.0.0` |
diff --git a/docs/iconDemos/basic.tsx b/docs/iconDemos/basic.tsx
@@ -0,0 +1,12 @@
+import React from 'react';
+import { AddCircleOutlined, DownOutlined } from '@aelf-design/internal-icons';
+import { Space } from 'antd';
+
+const App: React.FC = () => (
+  <Space>
+    <DownOutlined />
+    <AddCircleOutlined />
+  </Space>
+);
+
+export default App;
diff --git a/docs/iconDemos/custom.tsx b/docs/iconDemos/custom.tsx
@@ -0,0 +1,68 @@
+import React from 'react';
+import { AddCircleOutlined, AelfIcon } from '@aelf-design/internal-icons';
+import { Space } from 'antd';
+import type { GetProps } from 'antd';
+
+type CustomIconComponentProps = GetProps<typeof AelfIcon>;
+
+const HeartSvg = () => (
+  <svg width="1em" height="1em" fill="currentColor" viewBox="0 0 1024 1024">
+    <path d="M923 283.6c-13.4-31.1-32.6-58.9-56.9-82.8-24.3-23.8-52.5-42.4-84-55.5-32.5-13.5-66.9-20.3-102.4-20.3-49.3 0-97.4 13.5-139.2 39-10 6.1-19.5 12.8-28.5 20.1-9-7.3-18.5-14-28.5-20.1-41.8-25.5-89.9-39-139.2-39-35.5 0-69.9 6.8-102.4 20.3-31.4 13-59.7 31.7-84 55.5-24.4 23.9-43.5 51.7-56.9 82.8-13.9 32.3-21 66.6-21 101.9 0 33.3 6.8 68 20.3 103.3 11.3 29.5 27.5 60.1 48.2 91 32.8 48.9 77.9 99.9 133.9 151.6 92.8 85.7 184.7 144.9 188.6 147.3l23.7 15.2c10.5 6.7 24 6.7 34.5 0l23.7-15.2c3.9-2.5 95.7-61.6 188.6-147.3 56-51.7 101.1-102.7 133.9-151.6 20.7-30.9 37-61.5 48.2-91 13.5-35.3 20.3-70 20.3-103.3 0.1-35.3-7-69.6-20.9-101.9z" />
+  </svg>
+);
+
+const PandaSvg = () => (
+  <svg viewBox="0 0 1024 1024" width="1em" height="1em" fill="currentColor">
+    <path
+      d="M99.096 315.634s-82.58-64.032-82.58-132.13c0-66.064 33.032-165.162 148.646-148.646 83.37 11.91 99.096 165.162 99.096 165.162l-165.162 115.614zM924.906 315.634s82.58-64.032 82.58-132.13c0-66.064-33.032-165.162-148.646-148.646-83.37 11.91-99.096 165.162-99.096 165.162l165.162 115.614z"
+      fill="#6B676E"
+    />
+    <path
+      d="M1024 561.548c0 264.526-229.23 429.42-512.002 429.42S0 826.076 0 561.548 283.96 66.064 512.002 66.064 1024 297.022 1024 561.548z"
+      fill="#FFEBD2"
+    />
+    <path
+      d="M330.324 842.126c0 82.096 81.34 148.646 181.678 148.646s181.678-66.55 181.678-148.646H330.324z"
+      fill="#E9D7C3"
+    />
+    <path
+      d="M644.13 611.098C594.582 528.516 561.55 512 512.002 512c-49.548 0-82.58 16.516-132.13 99.096-42.488 70.814-78.73 211.264-49.548 247.742 66.064 82.58 165.162 33.032 181.678 33.032 16.516 0 115.614 49.548 181.678-33.032 29.18-36.476-7.064-176.93-49.55-247.74z"
+      fill="#FFFFFF"
+    />
+    <path
+      d="M611.098 495.484c0-45.608 36.974-82.58 82.58-82.58 49.548 0 198.194 99.098 198.194 165.162s-79.934 144.904-148.646 99.096c-49.548-33.032-132.128-148.646-132.128-181.678zM412.904 495.484c0-45.608-36.974-82.58-82.58-82.58-49.548 0-198.194 99.098-198.194 165.162s79.934 144.904 148.646 99.096c49.548-33.032 132.128-148.646 132.128-181.678z"
+      fill="#6B676E"
+    />
+    <path
+      d="M512.002 726.622c-30.06 0-115.614 5.668-115.614 33.032 0 49.638 105.484 85.24 115.614 82.58 10.128 2.66 115.614-32.944 115.614-82.58-0.002-27.366-85.556-33.032-115.614-33.032z"
+      fill="#464655"
+    />
+    <path
+      d="M330.324 495.484m-33.032 0a33.032 33.032 0 1 0 66.064 0 33.032 33.032 0 1 0-66.064 0Z"
+      fill="#464655"
+    />
+    <path
+      d="M693.678 495.484m-33.032 0a33.032 33.032 0 1 0 66.064 0 33.032 33.032 0 1 0-66.064 0Z"
+      fill="#464655"
+    />
+  </svg>
+);
+
+const HeartIcon = (props: Partial<CustomIconComponentProps>) => (
+  <AelfIcon component={HeartSvg} {...props} />
+);
+
+const PandaIcon = (props: Partial<CustomIconComponentProps>) => (
+  <AelfIcon component={PandaSvg} {...props} />
+);
+
+const App: React.FC = () => (
+  <Space>
+    <HeartIcon style={{ color: 'hotpink' }} />
+    <PandaIcon style={{ fontSize: '32px' }} />
+    <AelfIcon component={AddCircleOutlined as React.ForwardRefExoticComponent<any>} />
+    <AddCircleOutlined />
+  </Space>
+);
+
+export default App;
diff --git a/docs/iconDemos/customColor.tsx b/docs/iconDemos/customColor.tsx
@@ -0,0 +1,12 @@
+import React from 'react';
+import { AddCircleOutlined, DownOutlined } from '@aelf-design/internal-icons';
+import { Space } from 'antd';
+
+const App: React.FC = () => (
+  <Space>
+    <DownOutlined color="#1370DD" hoverColor="#3689DD" activeColor="#0756BC" />
+    <AddCircleOutlined color="red" hoverColor="blue" activeColor="yellow" />
+  </Space>
+);
+
+export default App;
diff --git a/packages/internal-icons/src/components/DownArrowIcon.tsx b/packages/internal-icons/src/components/DownArrowIcon.tsx
@@ -8,4 +8,4 @@ const componentName = 'DownArrowIcon';
 export const DownArrowIcon = React.forwardRef<HTMLSpanElement, IconProps>((props, ref) => {
   return <AelfIcon component={AelfSVGComponent} ref={ref} {...props} />;
 });
-DownArrowIcon.displayName = 'DownArrowIcon';
+DownArrowIcon.displayName = componentName;
diff --git a/packages/internal-icons/src/components/EyeTwoToneIcon.tsx b/packages/internal-icons/src/components/EyeTwoToneIcon.tsx
@@ -8,4 +8,4 @@ const componentName = 'EyeTwoToneIcon';
 export const EyeTwoToneIcon = React.forwardRef<HTMLSpanElement, IconProps>((props, ref) => {
   return <AelfIcon component={AelfSVGComponent} ref={ref} {...props} />;
 });
-EyeTwoToneIcon.displayName = 'EyeTwoToneIcon';
+EyeTwoToneIcon.displayName = componentName;