Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: 调整暗黑主题样式的加载方式, 避免样式污染和构建错误 #2988

Merged
merged 2 commits into from
Nov 26, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/prerelease-notify.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ jobs:
${{ secrets.DING_TALK_GROUP_TOKEN }}
${{ secrets.DING_TALK_PUBLIC_TOKEN }}
notify_title: '🎉 AntV/S2 测试版发布 🎉'
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_body: '🎉 **AntV/S2 新版本发布啦** 🎉 <hr /><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
2 changes: 1 addition & 1 deletion .github/workflows/release-notify.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ jobs:
${{ secrets.DING_TALK_GROUP_TOKEN }}
${{ secrets.DING_TALK_PUBLIC_TOKEN }}
notify_title: '🎉 AntV/S2 新版本发布啦 🎉'
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_body: '🎉 **AntV/S2 新版本发布啦** 🎉 <hr /><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
4 changes: 0 additions & 4 deletions build.config.base.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,6 @@ export const getBaseConfig = ({
// 防止开发模式下直接加载 s2-core 中的主题 less
resolve.alias.push(
...[
{
find: /^(.*)\/theme\/(.*)\.less$/,
replacement: '$1/theme/$2.less?inline',
},
{
find: /^@antv\/s2$/,
replacement: path.join(__dirname, './packages/s2-core/src'),
Expand Down
9 changes: 0 additions & 9 deletions packages/s2-core/rollup.config.mjs
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
/* eslint-disable import/no-extraneous-dependencies */
import alias from '@rollup/plugin-alias';
import commonjs from '@rollup/plugin-commonjs';
import resolve from '@rollup/plugin-node-resolve';
import replace from '@rollup/plugin-replace';
Expand Down Expand Up @@ -32,14 +31,6 @@ const output = {

const plugins = [
peerDepsExternal(),
alias({
entries: [
{
find: /^(?<name>.*).less\?inline$/,
replacement: '$1.less',
},
],
}),
replace({
'process.env.NODE_ENV': JSON.stringify('production'),
preventAssignment: true,
Expand Down
5 changes: 1 addition & 4 deletions packages/s2-core/src/common/constant/theme.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,7 @@ export const FONT_FAMILY =

export const INTERVAL_BAR_HEIGHT = 12;

/**
* 注入主题 css 变量的节点名
*/
export const STYLE_ELEMENT_ID = `${S2_PREFIX_CLS}-core-vars`;
export const DARK_THEME_CLS = `${S2_PREFIX_CLS}-dark-theme`;

/**
* 兼容 G2 主题: S2 和 G2 的主题名转换
Expand Down
6 changes: 0 additions & 6 deletions packages/s2-core/src/shared/constant/theme.ts

This file was deleted.

20 changes: 0 additions & 20 deletions packages/s2-core/src/shared/styles/theme/dark.less

This file was deleted.

2 changes: 1 addition & 1 deletion packages/s2-core/src/shared/styles/tooltip/operator.less
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@

&.ant-menu-submenu-selected {
background-color: var(
--antv-s2-tooltip-operator-menu-selected-background,
~'@{css-var-prefix}-tooltip-operator-menu-selected-background',
#e6f4ff
);
}
Expand Down
2 changes: 0 additions & 2 deletions packages/s2-core/src/sheet-type/spread-sheet.ts
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,6 @@ import { clearValueRangeState } from '../utils/condition/state-controller';
import { hideColumnsByThunkGroup } from '../utils/hide-columns';
import { isMobile } from '../utils/is-mobile';
import { customMerge, setupDataConfig, setupOptions } from '../utils/merge';
import { injectThemeVars } from '../utils/theme';
import { getTooltipData, getTooltipOptions } from '../utils/tooltip';
import type { PivotSheet } from './pivot-sheet';
import type { TableSheet } from './table-sheet';
Expand Down Expand Up @@ -548,7 +547,6 @@ export abstract class SpreadSheet extends EE {

this.theme = customMerge(newTheme, theme);
this.setThemeName(themeCfg?.name!);
injectThemeVars(themeCfg?.name);
}

public setTheme(theme: S2Theme) {
Expand Down
20 changes: 19 additions & 1 deletion packages/s2-core/src/styles/theme/dark.less
Original file line number Diff line number Diff line change
@@ -1,9 +1,27 @@
@import '../variables.less';

:root {
.@{s2-cls-prefix}-dark-theme {
@white: #fff;

// container
@{css-var-prefix}-background: #000;
@{css-var-prefix}-tooltip-background: rgba(43, 43, 43, 0.95);
@{css-var-prefix}-tooltip-operator-background: rgba(43, 43, 43, 0.95);
@{css-var-prefix}-tooltip-operator-menu-selected-background: #1677ff;

// container
@{css-var-prefix}-container-background: #191919;
@{css-var-prefix}-block-background: #232323;

// text
@{css-var-prefix}-font: @white;

each(range(19), {
@fadePercent: 100 - @value * 5;
@{css-var-prefix}-font-@{fadePercent}: fade(@white, @fadePercent);
});

// border
@{css-var-prefix}-border: fade(@white, 15);
@{css-var-prefix}-divider: fade(@white, 10);
}
1 change: 1 addition & 0 deletions packages/s2-core/src/ui/tooltip/index.less
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
@import '../../styles/variables.less';
@import '../../styles/theme/dark.less';

.@{tooltip-cls-prefix} {
&-container {
Expand Down
2 changes: 1 addition & 1 deletion packages/s2-core/src/ui/tooltip/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ import {
getAutoAdjustPosition,
setTooltipContainerStyle,
} from '../../utils/tooltip';

import './index.less';

/**
Expand Down Expand Up @@ -73,6 +72,7 @@ export class BaseTooltip<
pointerEvents: 'all',
},
visible: true,
dark: this.spreadsheet.getThemeName() === 'dark',
});
}

Expand Down
15 changes: 1 addition & 14 deletions packages/s2-core/src/utils/theme.ts
Original file line number Diff line number Diff line change
@@ -1,22 +1,9 @@
import { PALETTE_MAP, STYLE_ELEMENT_ID } from '../common/constant';
import { PALETTE_MAP } from '../common/constant';
import type { Palette, ThemeName } from '../common/interface/theme';
import DarkVars from '../styles/theme/dark.less';
import { injectCssText } from './inject-css-text';

/**
* 获取当前的主题色板
*/
export const getPalette = (themeName?: ThemeName): Palette => {
return PALETTE_MAP[themeName!] || PALETTE_MAP['default'];
};

/**
* 根据主题注入组件的 CSS 变量
*/
export const injectThemeVars = (themeName?: ThemeName) => {
// 目前仅 dark 主题需要定制
injectCssText(
STYLE_ELEMENT_ID,
themeName === 'dark' ? (DarkVars as string) : '',
);
};
5 changes: 4 additions & 1 deletion packages/s2-core/src/utils/tooltip.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ import {
} from 'lodash';
import {
CellType,
DARK_THEME_CLS,
EXTRA_FIELD,
PRECISION,
VALUE_FIELD,
Expand Down Expand Up @@ -153,13 +154,14 @@ export const setTooltipContainerStyle = (
visible?: boolean;
style?: CSS.Properties;
className?: string[];
dark?: boolean;
},
) => {
if (!container) {
return;
}

const { style, className = [], visible } = options;
const { style, className = [], visible, dark } = options;

if (style) {
Object.assign(container.style, style);
Expand All @@ -173,6 +175,7 @@ export const setTooltipContainerStyle = (

container.classList.toggle(TOOLTIP_CONTAINER_SHOW_CLS, visible);
container.classList.toggle(TOOLTIP_CONTAINER_HIDE_CLS, !visible);
container.classList.toggle(DARK_THEME_CLS, dark);
};

export const getListItem = (
Expand Down
8 changes: 7 additions & 1 deletion packages/s2-react/playground/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import {
type ThemeCfg,
type TooltipAutoAdjustBoundary,
} from '@antv/s2';
import '@antv/s2/src/styles/theme/dark.less';
import { useUpdateEffect } from 'ahooks';
import {
Button,
Expand All @@ -40,6 +41,7 @@ import {
Tooltip,
type RadioChangeEvent,
} from 'antd';
import cls from 'classnames';
import { debounce, isEmpty, random } from 'lodash';
import React from 'react';
import { ChromePicker } from 'react-color';
Expand Down Expand Up @@ -391,7 +393,11 @@ function MainLayout() {
logHandler,
}}
>
<div className="playground">
<div
className={cls('playground', {
'antv-s2-dark-theme': themeCfg.name === 'dark',
})}
>
<LinkGroup />
<Tabs
defaultActiveKey={localStorage.getItem('debugTabKey') || 'basic'}
Expand Down
6 changes: 1 addition & 5 deletions packages/s2-react/src/components/sheets/base-sheet/index.tsx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { S2_PREFIX_CLS, injectThemeVars } from '@antv/s2';
import { S2_PREFIX_CLS } from '@antv/s2';
import { isFunction } from 'lodash';
import React from 'react';
import { useSpreadSheet } from '../../../hooks/useSpreadSheet';
Expand All @@ -12,10 +12,6 @@ export const BaseSheet: React.FC<SheetComponentProps> = React.memo((props) => {
? props.children({ pagination })
: props.children;

React.useEffect(() => {
injectThemeVars(props.themeCfg?.name);
}, [props.themeCfg?.name]);

return (
<div ref={wrapperRef} className={`${S2_PREFIX_CLS}-wrapper`}>
<div ref={containerRef} className={`${S2_PREFIX_CLS}-container`} />
Expand Down
Loading