Merge remote-tracking branch 'github.com/next' into dev-fix-#2958

antvis · Nov 23, 2024 · b74bae9 · b74bae9
2 parents 08e30e8 + e28baa0
commit b74bae9
Show file tree

Hide file tree

Showing 22 changed files with 120 additions and 26 deletions.
diff --git a/.github/workflows/prerelease-notify.yml b/.github/workflows/prerelease-notify.yml
@@ -19,7 +19,7 @@ jobs:
             ${{ secrets.DING_TALK_GROUP_TOKEN }}
             ${{ secrets.DING_TALK_PUBLIC_TOKEN }}
           notify_title: '🎉 AntV/S2 测试版发布 🎉'
-          notify_body: '![preview](https://mdn.alipayobjects.com/huamei_qa8qxu/afts/img/A*1PTTQLk3j5AAAAAAAAAAAAAADmJ7AQ/original) <hr /> [**查看更新日志**](https://github.com/antvis/S2/releases) <hr />'
+          notify_body: '🎉 AntV/S2 新版本发布啦 🎉 <br/> ![preview](https://mdn.alipayobjects.com/huamei_qa8qxu/afts/img/A*1PTTQLk3j5AAAAAAAAAAAAAADmJ7AQ/original) <hr /> [**点击查看更新日志**](https://github.com/antvis/S2/releases) <hr />'
           notify_footer: '> 该版本为测试版, 请谨慎使用 ([AntV/S2 Releases](https://github.com/antvis/S2/releases))'
           at_all: false
           enable_prerelease: true
diff --git a/.github/workflows/release-notify.yml b/.github/workflows/release-notify.yml
@@ -19,7 +19,7 @@ jobs:
             ${{ secrets.DING_TALK_GROUP_TOKEN }}
             ${{ secrets.DING_TALK_PUBLIC_TOKEN }}
           notify_title: '🎉 AntV/S2 新版本发布啦 🎉'
-          notify_body: '![preview](https://mdn.alipayobjects.com/huamei_qa8qxu/afts/img/A*1PTTQLk3j5AAAAAAAAAAAAAADmJ7AQ/original) <hr /> [**查看更新日志**](https://github.com/antvis/S2/releases) <hr />'
+          notify_body: '🎉 AntV/S2 新版本发布啦 🎉 <br/> ![preview](https://mdn.alipayobjects.com/huamei_qa8qxu/afts/img/A*1PTTQLk3j5AAAAAAAAAAAAAADmJ7AQ/original) <hr /> [**点击查看更新日志**](https://github.com/antvis/S2/releases) <hr />'
           notify_footer: '> [AntV/S2 Releases](https://github.com/antvis/S2/releases)'
           at_all: false
           enable_prerelease: false
diff --git a/package.json b/package.json
@@ -57,7 +57,7 @@
     "build:umd": "pnpm -r --filter './packages/*' --stream build:umd",
     "build:size-limit": "pnpm -r --filter './packages/*' --stream build:size-limit",
     "build:size-limit-json": "pnpm -r --filter './packages/*' --stream build:size-limit-json",
-    "release": "pnpm -r --filter !@antv/s2-site --filter !@antv/s2-react-components --workspace-concurrency=1 exec npx --no-install semantic-release",
+    "release": "pnpm -r --filter !@antv/s2-site --filter !@antv/s2-vue --workspace-concurrency=1 exec npx --no-install semantic-release",
     "release:preview": "pnpm release --dry-run --no-ci",
     "release:bump-version": "node ./scripts/bump-version.js",
     "test": "pnpm -r --filter './packages/*' --stream test",

diff --git a/packages/s2-react-components/CHANGELOG.md b/packages/s2-react-components/CHANGELOG.md
@@ -1,3 +1,10 @@
+# [@antv/s2-react-components-v2.0.1](https://github.com/antvis/S2/compare/@antv/s2-react-components-v2.0.0...@antv/s2-react-components-v2.0.1) (2024-11-21)
+
+
+### Bug Fixes
+
+* 修改包 peerDependencies 版本和样式依赖问题 ([11df5d5](https://github.com/antvis/S2/commit/11df5d511515817047b09d6e3dd37000f7b189f2))
+
 # [@antv/s2-react-components-v2.0.0](#) (2024-11-21)
 
 * 2.0 正式版已发布，请查看 [升级指南](https://s2.antv.antgroup.com/manual/migration-v2)

diff --git a/packages/s2-react-components/package.json b/packages/s2-react-components/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@antv/s2-react-components",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "private": false,
   "description": "React components for S2",
   "keywords": [
@@ -87,7 +87,7 @@
   },
   "peerDependencies": {
     "@ant-design/icons": ">=4.7.0",
-    "@antv/s2": "^2.0.0-next.1",
+    "@antv/s2": "^2.0.0",
     "antd": ">=4.16.13",
     "react": ">=16.9.0",
     "react-dom": ">=16.9.0"

diff --git a/packages/s2-react-components/src/components/common/radio-group/index.less b/packages/s2-react-components/src/components/common/radio-group/index.less
@@ -1,4 +1,4 @@
-@import '@antv/s2/src/styles/variables.less';
+@import '@antv/s2/esm/styles/variables.less';
 
 .@{s2-cls-prefix}-radio-group {
   color: #3572f9;

diff --git a/packages/s2-react-components/src/components/common/reset-button/index.less b/packages/s2-react-components/src/components/common/reset-button/index.less
@@ -1,4 +1,4 @@
-@import '@antv/s2/src/styles/variables.less';
+@import '@antv/s2/esm/styles/variables.less';
 
 .@{s2-cls-prefix}-reset-btn {
   color: #3572f9;

diff --git a/packages/s2-react-components/src/components/common/reset-group/index.less b/packages/s2-react-components/src/components/common/reset-group/index.less
@@ -1,4 +1,4 @@
-@import '@antv/s2/src/styles/variables.less';
+@import '@antv/s2/esm/styles/variables.less';
 
 .@{s2-cls-prefix}-reset-group {
   width: 340px;

diff --git a/packages/s2-react-components/src/components/text-align-panel/index.less b/packages/s2-react-components/src/components/text-align-panel/index.less
@@ -1,4 +1,4 @@
-@import '@antv/s2/src/styles/variables.less';
+@import '@antv/s2/esm/styles/variables.less';
 
 .@{s2-cls-prefix}-theme-panel-custom-color {
   display: flex;

diff --git a/packages/s2-react-components/src/components/theme-panel/color-box/index.less b/packages/s2-react-components/src/components/theme-panel/color-box/index.less
@@ -1,4 +1,4 @@
-@import '@antv/s2/src/styles/variables.less';
+@import '@antv/s2/esm/styles/variables.less';
 
 .@{s2-cls-prefix}-color-box {
   display: inline-flex;

diff --git a/packages/s2-react-components/src/components/theme-panel/color-picker-panel/index.less b/packages/s2-react-components/src/components/theme-panel/color-picker-panel/index.less
@@ -1,4 +1,4 @@
-@import '@antv/s2/src/styles/variables.less';
+@import '@antv/s2/esm/styles/variables.less';
 
 @cls-prefix: ~'@{s2-cls-prefix}-color-picker-panel';
 

diff --git a/packages/s2-react-components/src/components/theme-panel/index.less b/packages/s2-react-components/src/components/theme-panel/index.less
@@ -1,4 +1,4 @@
-@import '@antv/s2/src/styles/variables.less';
+@import '@antv/s2/esm/styles/variables.less';
 
 .@{s2-cls-prefix}-theme-panel-custom-color {
   display: flex;

diff --git a/packages/s2-react/CHANGELOG.md b/packages/s2-react/CHANGELOG.md
@@ -1,3 +1,10 @@
+# [@antv/s2-react-v2.0.1](https://github.com/antvis/S2/compare/@antv/s2-react-v2.0.0...@antv/s2-react-v2.0.1) (2024-11-21)
+
+
+### Bug Fixes
+
+* 修改包 peerDependencies 版本和样式依赖问题 ([11df5d5](https://github.com/antvis/S2/commit/11df5d511515817047b09d6e3dd37000f7b189f2))
+
 # [@antv/s2-react-v2.0.0](#) (2024-11-21)
 
 * 2.0 正式版已发布，请查看 [升级指南](https://s2.antv.antgroup.com/manual/migration-v2)

diff --git a/packages/s2-react/package.json b/packages/s2-react/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@antv/s2-react",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "private": false,
   "description": "use S2 with react",
   "keywords": [
@@ -83,7 +83,7 @@
     "vite-plugin-svgr": "^2.2.2"
   },
   "peerDependencies": {
-    "@antv/s2": "^2.0.0-next.1",
+    "@antv/s2": "^2.0.0",
     "react": ">=16.9.0",
     "react-dom": ">=16.9.0"
   },

diff --git a/packages/s2-react/playground/components/Header/index.less b/packages/s2-react/playground/components/Header/index.less
@@ -1,4 +1,4 @@
-@import '@antv/s2/src/styles/variables.less';
+@import '@antv/s2/esm/styles/variables.less';
 
 .sheet-header {
   padding: 0;

diff --git a/packages/s2-vue/package.json b/packages/s2-vue/package.json
@@ -69,7 +69,7 @@
     "vue-tsc": "^2.1.6"
   },
   "peerDependencies": {
-    "@antv/s2": "^2.0.0-next.1",
+    "@antv/s2": "^2.0.0",
     "ant-design-vue": "^3.2.0",
     "vue": ">=3.x"
   },

diff --git a/s2-site/.dumi/global.ts b/s2-site/.dumi/global.ts
@@ -16,9 +16,9 @@ if (window) {
   (
     window as any
   ).gPluginRoughCanvasRenderer = require('@antv/g-plugin-rough-canvas-renderer');
-  
+
   (window as any).g2 = require('@antv/g2');
-  
+
   (window as any).s2 = require('@antv/s2');
   (window as any)._extends = require('@antv/s2/extends');
 
@@ -55,7 +55,7 @@ if (window) {
     },
     {
       package: '@antv/s2-react-components',
-      version: (window as any).s2React?.version || 'development',
+      version: (window as any).s2ReactComponents?.version || 'development',
     },
     {
       package: 'react',

diff --git a/s2-site/docs/common/install.en.md b/s2-site/docs/common/install.en.md
@@ -0,0 +1,36 @@
+### Using the Basic Version <Badge>@antv/s2</Badge>
+
+> Install using npm or yarn or pnpm
+
+```bash
+# npm
+$ npm install @antv/s2 --save
+
+# yarn
+$ yarn add @antv/s2
+
+# pnpm
+$ pnpm add @antv/s2
+```
+
+### Using the React Version <Badge>@antv/s2-react</Badge>
+
+```bash
+npm install @antv/s2 @antv/s2-react --save
+```
+
+### Using React Analysis Components <Badge>@antv/s2-react-components</Badge>
+
+```bash
+npm install @antv/s2 @antv/s2-react-components antd @ant-design/icons --save
+```
+
+### Using Vue3 Version <Badge type="success">@antv/s2-vue</Badge> <Badge type="error">Maintenance Discontinued</Badge>
+
+:::warning{title="Note"}
+`@antv/s2-vue` has been discontinued. Due to limited resources and considering factors such as maintenance costs and package download volume, updates will no longer be provided after version `2.0.0`. Please create your own wrapper based on `@antv/s2`, or fork the repository to develop a community version.
+:::
+
+```bash
+npm install @antv/s2 @antv/s2-vue [email protected] --save
+```
diff --git a/s2-site/docs/common/install.zh.md b/s2-site/docs/common/install.zh.md
@@ -35,3 +35,4 @@ npm install @antv/s2 @antv/s2-react-components antd @ant-design/icons --save
 
 ```bash
 npm install @antv/s2 @antv/s2-vue [email protected] --save
+```
diff --git a/s2-site/docs/common/packages.en.md b/s2-site/docs/common/packages.en.md
@@ -3,9 +3,52 @@ title: Packages
 order: 5
 ---
 
-| Package  | Latest  | Size   | Download     |
-| -------- | ------ | ----------  | ------ |
-| [@antv/s2](https://github.com/antvis/S2/tree/next/packages/s2-core)        | ![latest](https://img.shields.io/npm/v/@antv/s2/latest.svg?logo=npm)  | ![size](https://img.badgesize.io/https:/unpkg.com/@antv/s2@latest/dist/index.min.js?label=gzip%20size&compression=gzip)       | ![download](https://img.shields.io/npm/dm/@antv/s2.svg?logo=npm)       |
+:::info{title="Note"}
+
+There are three ways to create an `S2` table: the basic version `@antv/s2` and the `React` and `Vue3` versions wrapped based on `@antv/s2`:
+
+1. Basic version `@antv/s2`: Developed based on `Canvas` and [AntV/G 6.0](https://g.antv.antgroup.com), providing basic table display/interaction capabilities.
+
+Dependencies: None
+
+2. React version `@antv/s2-react`: Wrapped based on `React 18` and `@antv/s2`, compatible with `React 16/17` versions, and provides supporting [analysis components (`@antv/s2-react-components`)](/manual/advanced/analysis/introduction).
+
+Dependencies:
+
+```json
+"peerDependencies": {
+  "@antv/s2": "^2.0.0",
+  "react": ">=16.9.0",
+  "react-dom": ">=16.9.0"
+}
+```
+
+3. Vue version `@antv/s2-vue`: Wrapped based on `Vue3`, `@antv/s2`, and `[email protected]`. <Badge type="error">Maintenance Discontinued</Badge>
+
+Dependencies:
+
+```json
+"peerDependencies": {
+  "@antv/s2": "^2.0.0",
+  "ant-design-vue": "^3.2.0",
+  "vue": ">=3.x"
+}
+```
+
+**In other words**, `@antv/s2` is **framework-agnostic** with **no additional dependencies**. You can use it in any framework like `Vue`, `Angular`, etc.
+:::
+
+| Package Name | Stable Version | Package Size | Downloads |
+| -------- | ------ | --------- | ------ |
+| [@antv/s2](https://github.com/antvis/S2/tree/next/packages/s2-core) | ![latest](https://img.shields.io/npm/v/@antv/s2/latest.svg?logo=npm) | ![size](https://img.badgesize.io/https:/unpkg.com/@antv/s2@latest/dist/index.min.js?label=gzip%20size&compression=gzip) | ![download](https://img.shields.io/npm/dm/@antv/s2.svg?logo=npm) |
 | [@antv/s2-react](https://github.com/antvis/S2/tree/next/packages/s2-react) | ![latest](https://img.shields.io/npm/v/@antv/s2-react/latest.svg?logo=npm) | ![size](https://img.badgesize.io/https:/unpkg.com/@antv/s2-react@latest/dist/index.min.js?label=gzip%20size&compression=gzip) | ![download](https://img.shields.io/npm/dm/@antv/s2-react.svg?logo=npm) |
 | [@antv/s2-react-components](https://github.com/antvis/S2/tree/next/packages/s2-react-components) | ![latest](https://img.shields.io/npm/v/@antv/s2-react-components/latest.svg?logo=npm) | ![size](https://img.badgesize.io/https:/unpkg.com/@antv/s2-react-components@latest/dist/index.min.js?label=gzip%20size&compression=gzip) | ![download](https://img.shields.io/npm/dm/@antv/s2-react-components.svg?logo=npm) |
-| [@antv/s2-vue](https://github.com/antvis/S2/tree/next/packages/s2-vue)     | ![latest](https://img.shields.io/npm/v/@antv/s2-vue/latest.svg?logo=npm) | ![size](https://img.badgesize.io/https:/unpkg.com/@antv/s2-vue@latest/dist/index.min.js?label=gzip%20size&compression=gzip)   | ![download](https://img.shields.io/npm/dm/@antv/s2-vue.svg?logo=npm)   |
+| [@antv/s2-vue](https://github.com/antvis/S2/tree/next/packages/s2-vue) (Discontinued) | ![latest](https://img.shields.io/npm/v/@antv/s2-vue/latest.svg?logo=npm) | ![size](https://img.badgesize.io/https:/unpkg.com/@antv/s2-vue@latest/dist/index.min.js?label=gzip%20size&compression=gzip) | ![download](https://img.shields.io/npm/dm/@antv/s2-vue.svg?logo=npm) |
+
+:::info{title='How to get notifications for new version releases?'}
+
+- Subscribe to: [https://github.com/antvis/S2/releases.atom](https://github.com/antvis/S2/releases.atom) to receive notifications of new version releases.
+- `Watch` the [S2 repository](https://github.com/antvis/S2), select `Custom - Releases` to receive push notifications.
+
+![preview](https://mdn.alipayobjects.com/huamei_qa8qxu/afts/img/A*NKYFSKFV_scAAAAAAAAAAAAADmJ7AQ/original)
+:::
diff --git a/s2-site/docs/manual/migration-v2.en.md b/s2-site/docs/manual/migration-v2.en.md
@@ -46,9 +46,9 @@ If you are using the beta version `2.0.0-next.x`, pay attention to these additio
 
 ## 📦 Installation
 
-<embed src="@/docs/common/install.zh.md"></embed>
+<embed src="@/docs/common/install.en.md"></embed>
 
-<embed src="@/docs/common/packages.zh.md"></embed>
+<embed src="@/docs/common/packages.en.md"></embed>
 
 ## ⭐ New Features
 

diff --git a/s2-site/examples/react-component/sheet/demo/chart.tsx b/s2-site/examples/react-component/sheet/demo/chart.tsx
@@ -2,7 +2,7 @@
 import React from 'react';
 import { S2DataConfig, S2Options } from '@antv/s2';
 import { SheetComponent } from '@antv/s2-react';
-import '@antv/s2-react/dist/style.min.css';
+import '@antv/s2-react/dist/s2-react.min.css';
 
 const s2Options: S2Options = {
   width: 1000,