ant-design/components/_util/theme/index.tsx

139 lines
3.8 KiB
TypeScript
Raw Normal View History

2022-05-09 22:20:07 +08:00
import type { CSSInterpolation } from '@ant-design/cssinjs';
import { Theme, useCacheToken, useStyleRegister } from '@ant-design/cssinjs';
import type { DeepPartial } from 'antd/es/_util/type';
import React from 'react';
import version from '../../version';
import type {
AliasToken,
DerivativeToken,
GlobalToken,
OverrideToken,
PresetColorType,
SeedToken,
} from './interface';
import { PresetColors } from './interface';
import defaultSeedToken, { derivative as defaultDerivative } from './themes/default';
import { clearFix, operationUnit, resetComponent, resetIcon, roundedArrow } from './util';
import formatToken from './util/alias';
import type { FullToken } from './util/genComponentStyleHook';
import genComponentStyleHook from './util/genComponentStyleHook';
import getArrowStyle from './util/placementArrow';
import statisticToken, { merge as mergeToken, statistic } from './util/statistic';
export {
resetComponent,
resetIcon,
clearFix,
roundedArrow,
getArrowStyle,
operationUnit,
// colors
PresetColors,
// Statistic
statistic,
statisticToken,
mergeToken,
// hooks
useStyleRegister,
genComponentStyleHook,
};
export type {
SeedToken,
AliasToken,
PresetColorType,
// FIXME: Remove this type
AliasToken as DerivativeToken,
FullToken,
};
// ================================ Context =================================
const defaultTheme = new Theme(defaultDerivative);
export const DesignTokenContext = React.createContext<{
token: Partial<SeedToken>;
theme?: Theme<SeedToken, DerivativeToken>;
override?: DeepPartial<OverrideToken>;
hashed?: string | boolean;
}>({
token: defaultSeedToken,
theme: defaultTheme,
});
// ================================== Hook ==================================
// In dev env, we refresh salt per hour to avoid user use this
// Note: Do not modify this to real time update which will make debug harder
const saltPrefix =
process.env.NODE_ENV === 'production' ? version : `${version}-${new Date().getHours()}`;
export function useToken(): [Theme<SeedToken, DerivativeToken>, GlobalToken, string] {
const {
token: rootDesignToken,
theme = defaultTheme,
override,
hashed,
} = React.useContext(DesignTokenContext);
const salt = `${saltPrefix}-${hashed || ''}`;
const [token, hashId] = useCacheToken<GlobalToken, SeedToken>(
theme,
[defaultSeedToken, rootDesignToken],
{
salt,
override,
formatToken,
},
);
2022-02-27 22:17:17 +08:00
return [theme, token, hashed ? hashId : ''];
}
export type UseComponentStyleResult = [(node: React.ReactNode) => React.ReactElement, string];
export type GenerateStyle<
ComponentToken extends object = AliasToken,
ReturnType = CSSInterpolation,
> = (token: ComponentToken) => ReturnType;
export const emptyTheme = new Theme(token => token);
export type CustomTokenOptions<
CustomSeedToken extends Record<string, any>,
CustomAliasToken extends Record<string, any> = {},
> = {
/** The original tokens, which may affect other tokens. */
seedToken?: CustomSeedToken;
/** Generate token based on seedToken. */
formatToken?: (
mergedToken: AliasToken & CustomSeedToken,
) => AliasToken & CustomSeedToken & CustomAliasToken;
};
/**
* Generate custom tokens with tokens of ant-design.
*/
export function useCustomToken<
CustomSeedToken extends Record<string, any>,
CustomAliasToken extends Record<string, any> = {},
>({
seedToken,
formatToken: customFormatToken,
}: CustomTokenOptions<CustomSeedToken, CustomAliasToken>): {
token: AliasToken & CustomSeedToken & CustomAliasToken;
hashId: string;
} {
const [, antdToken, hashed] = useToken();
const salt = `${saltPrefix}-${hashed || ''}`;
const [token, hashId] = useCacheToken(emptyTheme, [antdToken, seedToken ?? {}], {
salt,
formatToken: customFormatToken,
});
return {
token,
hashId: hashed ? hashId : '',
};
}