Skip to content

Commit

Permalink
✨ feat: bump to 1.0 (#59)
Browse files Browse the repository at this point in the history 
BREAKING CHANGE: upgrade to 1.0.0
  • Loading branch information
@ModestFun
ModestFun authored Dec 28, 2023
1 parent 3bfd000 commit 674d598
Show file tree
Hide file tree
Showing 4 changed files with 73 additions and 57 deletions.
3 changes: 1 addition & 2 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -86,13 +86,12 @@ const nextConfig = {

```jsx
import { FlowView } from '@ant-design/pro-flow';
import useStyles from './css/index.style';

function App() {
const { styles } = useStyles();

return (
<div className={styles.container}>
<div className={'container'}>
<FlowView nodes={[]} edges={[]} />
</div>
);
Expand Down
1 change: 0 additions & 1 deletion src/FlowEditor/demos/index.tsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ const StringRender: FC = (node: any) => {
type={'target'}
position={Position.Left}
/>

{node.data.title}
<Handle
id={typeof handles?.source === 'string' ? handles?.source : id}
Expand Down
118 changes: 65 additions & 53 deletions src/FlowView/index.zh-CN.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,60 +18,63 @@ description:

### FlowView

| 属性名 | 类型 | 描述 | 默认值 | 必选 |
| --------------- | ------------------------------------------------ | ------ | ---- | -- |
| nodes | `FlowViewNode` | 边数据 | - | - |
| edges | `FlowViewEdge` | 节点数据 | - | - |
| className | `string` | 边数据 | - | - |
| style | `CSSProperties` | 节点数据 | - | - |
| miniMap | `boolean` | 边数据 | - | - |
| autoLayout | `boolean` | 自动布局 | true | - |
| background | `boolean` | 节点数据 | - | - |
| children | `React.ReactNode` | 边数据 | - | - |
| nodeTypes | `Record<string, React.ComponentType<NodeProps>>` | 节点类型 | - | - |
| edgeTypes | `Record<string, React.ComponentType<EdgeProps>>` | 边缘类型 | - | - |
| minZoom | `number` | 最小缩放比例 | - | - |
| maxZoom | `number` | 最大缩放比例 | - | - |
| stepLessZooming | `boolean` | 无级缩放监听 | - | - |
| layoutOptions | `LayoutOptions` | 自动布局参数 | - | - |
| 属性名 | 类型 | 描述 | 默认值 | 必选 |
| ----------------- | ------------------------------------------------ | -------------- | ------ | ---- |
| nodes | `FlowViewNode` | 边数据 | - | - |
| edges | `FlowViewEdge` | 节点数据 | - | - |
| className | `string` | 边数据 | - | - |
| style | `CSSProperties` | 节点数据 | - | - |
| miniMap | `boolean` | 边数据 | - | - |
| autoLayout | `boolean` | 自动布局 | true | - |
| background | `boolean` | 节点数据 | - | - |
| children | `React.ReactNode` | 边数据 | - | - |
| nodeTypes | `Record<string, React.ComponentType<NodeProps>>` | 节点类型 | - | - |
| edgeTypes | `Record<string, React.ComponentType<EdgeProps>>` | 边缘类型 | - | - |
| minZoom | `number` | 最小缩放比例 | - | - |
| maxZoom | `number` | 最大缩放比例 | - | - |
| stepLessZooming | `boolean` | 无级缩放监听 | - | - |
| layoutOptions | `LayoutOptions` | 自动布局参数 | - | - |
| beforeNodesChange | `(changes: NodeChange[]) => boolean` | 节点变化前回调 | - | - |
| beforeEdgesChange | `(changes: EdgeChange[]) => boolean` | 边缘变化前回调 | - | - |
| beforeConnect | `(connection: Connection) => boolean` | 连接前回调 | - | - |

#### LayoutOptions

| 属性名 | 类型 | 描述 | 默认值 | 必选 |
| ------- | ------------------------------ | ------ | --- | -- |
| rankdir | `'TB' \| 'BT' \| 'LR' \| 'RL'` | 无级缩放监听 | - | - |
| align | `'UL' \| 'DL' \| 'UR' \| 'DR'` | 无级缩放监听 | - | - |
| nodesep | `number` | 自动布局参数 | - | - |
| ranksep | `number` | 自动布局参数 | - | - |
| 属性名 | 类型 | 描述 | 默认值 | 必选 |
| ------- | ------------------------------ | ------------ | ------ | ---- |
| rankdir | `'TB' \| 'BT' \| 'LR' \| 'RL'` | 无级缩放监听 | - | - |
| align | `'UL' \| 'DL' \| 'UR' \| 'DR'` | 无级缩放监听 | - | - |
| nodesep | `number` | 自动布局参数 | - | - |
| ranksep | `number` | 自动布局参数 | - | - |

### FlowViewNode

| 属性名 | 类型 | 描述 | 默认值 | 必选 |
| -------- | ------------------------------------------------- | ---- | --- | -- |
| id | `string` | 边数据 | - | - |
| select | `SelectType` | 节点数据 | - | - |
| data | `T` | 边数据 | - | - |
| type | `U = 'BasicNode' \| 'BasicNodeGroup' \| 'string'` | 节点类型 | - | - |
| label | `string` | 边数据 | - | - |
| width | `number` | 节点数据 | - | - |
| height | `number` | 边数据 | - | - |
| position | `{x: number, y: number}` | 边数据 | - | - |
| 属性名 | 类型 | 描述 | 默认值 | 必选 |
| -------- | ------------------------------------------------- | -------- | ------ | ---- |
| id | `string` | 边数据 | - | - |
| select | `SelectType` | 节点数据 | - | - |
| data | `T` | 边数据 | - | - |
| type | `U = 'BasicNode' \| 'BasicNodeGroup' \| 'string'` | 节点类型 | - | - |
| label | `string` | 边数据 | - | - |
| width | `number` | 节点数据 | - | - |
| height | `number` | 边数据 | - | - |
| position | `{x: number, y: number}` | 边数据 | - | - |

#### BasicNodeData

| 属性名 | 类型 | 描述 | 默认值 | 必选 |
| ----------- | ----------------------------------------------------- | ---- | --- | -- |
| title | `string` | 类名 | - | - |
| description | `string` | 描述 | - | - |
| logo | `string` | logo | - | - |
| titleSlot | `{ type: 'left' \| 'right', value: React.ReactNode }` | 插槽 | - | - |
| 属性名 | 类型 | 描述 | 默认值 | 必选 |
| ----------- | ----------------------------------------------------- | ---- | ------ | ---- |
| title | `string` | 类名 | - | - |
| description | `string` | 描述 | - | - |
| logo | `string` | logo | - | - |
| titleSlot | `{ type: 'left' \| 'right', value: React.ReactNode }` | 插槽 | - | - |

#### BasicGroupNodeData

| 属性名 | 类型 | 描述 | 默认值 | 必选 |
| ---- | --------------- | --- | --- | -- |
| id | `string` | 类名 | - | - |
| data | `BasicNodeData` | 子组件 | - | - |
| 属性名 | 类型 | 描述 | 默认值 | 必选 |
| ------ | --------------- | ------ | ------ | ---- |
| id | `string` | 类名 | - | - |
| data | `BasicNodeData` | 子组件 | - | - |

#### SelectType

Expand All @@ -87,16 +90,25 @@ export enum SelectType {
}
```

#### Connection

| 属性名 | 类型 | 描述 | 默认值 | 必选 |
| ------------ | ------- | ----- | -------------------- | ---- | --- |
| source | `string | null` | 来源节点 id | - | - |
| target | `string | null` | 目标节点 id | - | - |
| sourceHandle | `string | null` | 来源节点的 Handle id | - | - |
| targetHandle | `string | null` | 目标节点的 Handle id | - | - |

### FlowViewEdge

| 属性名 | 类型 | 描述 | 默认值 | 必选 |
| ------------ | ------------ | --------------- | --- | -- |
| id | `string` | 唯一 id | - | - |
| source | `string` | 来源节点 id | - | - |
| target | `string` | 目标节点 id | - | - |
| sourceHandle | `string` | 来源节点的 Handle id | - | - |
| targetHandle | `string` | 目标节点的 Handle id | - | - |
| select | `SelectType` | 选中状态 | - | - |
| type | `U` | 边缘类型 | - | - |
| data | `T` | 数据 | - | - |
| animated | `boolean` | 动态效果 | - | - |
| 属性名 | 类型 | 描述 | 默认值 | 必选 |
| ------------ | ------------ | -------------------- | ------ | ---- |
| id | `string` | 唯一 id | - | - |
| source | `string` | 来源节点 id | - | - |
| target | `string` | 目标节点 id | - | - |
| sourceHandle | `string` | 来源节点的 Handle id | - | - |
| targetHandle | `string` | 目标节点的 Handle id | - | - |
| select | `SelectType` | 选中状态 | - | - |
| type | `U` | 边缘类型 | - | - |
| data | `T` | 数据 | - | - |
| animated | `boolean` | 动态效果 | - | - |
8 changes: 7 additions & 1 deletion src/index.ts
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
import {
BaseEdge,
Connection,
EdgeChange,
EdgeLabelRenderer,
EdgeProps,
Handle,
NodeChange,
Position,
getBezierPath,
getSmoothStepPath,
Expand Down Expand Up @@ -33,10 +36,13 @@ export { default as RadiusEdge } from './RadiusEdge';
export * from './constants';
export {
BaseEdge,
Connection,
EdgeChange,
EdgeLabelRenderer,
EdgeProps,
Handle,
NodeChange,
Position,
getBezierPath,
getSmoothStepPath,
type EdgeProps,
};

0 comments on commit 674d598

Please sign in to comment.