Skip to content

Commit e890483

Browse files
committed
refactor: rename ThemeToken to SemanticToken & modify comment
1 parent 8b625ad commit e890483

File tree

3 files changed

+32
-15
lines changed

3 files changed

+32
-15
lines changed

packages/bezier-react/src/components/AlphaTokenProvider/TokenProvider.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ import {
1414
} from './TokenProvider.types'
1515

1616
const [TokenContextProvider, useTokenContext] =
17-
// FIXME: (@ed) Change the name to TokenProvider after the migration is done
17+
// FIXME: (@ed) Remove Alpha prefix after the migration is done
1818
createContext<TokenContextValue | null>(null, 'AlphaTokenProvider')
1919

2020
export { useTokenContext as useAlphaTokenContext }

packages/bezier-react/src/components/AlphaTokenProvider/TokenProvider.types.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
import {
22
type GlobalToken,
3+
type SemanticToken,
34
type ThemeName,
4-
type ThemeToken,
55
} from '~/src/types/alpha-tokens'
66

77
export interface ThemeSpecificTokens {
88
global: GlobalToken
9-
theme: ThemeToken
9+
theme: SemanticToken
1010
}
1111

1212
export interface TokenContextValue {

packages/bezier-react/src/types/alpha-tokens.ts

Lines changed: 29 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,14 @@ export type GlobalToken = typeof tokens.global
1313
/**
1414
* FIXME: Separate functional and semantic tokens?
1515
*/
16-
export type ThemeToken = typeof tokens.lightTheme | typeof tokens.darkTheme
16+
export type SemanticToken = typeof tokens.lightTheme | typeof tokens.darkTheme
1717

1818
// NOTE: (@ed) Do not remove alpha- prefix to match CSS variable names
1919
export type FlattenGlobalToken = ExtractKeys<GlobalToken[keyof GlobalToken]>
20-
export type FlattenThemeToken = ExtractKeys<ThemeToken[keyof ThemeToken]>
21-
export type FlattenAllToken = FlattenGlobalToken | FlattenThemeToken
20+
export type FlattenSemanticToken = ExtractKeys<
21+
SemanticToken[keyof SemanticToken]
22+
>
23+
export type FlattenAllToken = FlattenGlobalToken | FlattenSemanticToken
2224

2325
export type GlobalColor = RemovePrefix<
2426
'alpha-color',
@@ -28,13 +30,28 @@ export type GlobalColor = RemovePrefix<
2830
/**
2931
* Functional & Semantic color tokens
3032
*/
31-
export type ThemeColor = RemovePrefix<'alpha-color', keyof ThemeToken['color']>
33+
export type BaseSemanticColor = RemovePrefix<
34+
'alpha-color',
35+
keyof SemanticToken['color']
36+
>
3237

33-
export type BackgroundFunctionalColor = StartsWithPrefix<'bg', ThemeColor>
34-
export type ForegroundFunctionalColor = StartsWithPrefix<'fg', ThemeColor>
35-
export type SurfaceFunctionalColor = StartsWithPrefix<'surface', ThemeColor>
36-
export type ShadowFunctionalColor = StartsWithPrefix<'shadow', ThemeColor>
37-
export type DimFunctionalColor = StartsWithPrefix<'dim', ThemeColor>
38+
export type BackgroundFunctionalColor = StartsWithPrefix<
39+
'bg',
40+
BaseSemanticColor
41+
>
42+
export type ForegroundFunctionalColor = StartsWithPrefix<
43+
'fg',
44+
BaseSemanticColor
45+
>
46+
export type SurfaceFunctionalColor = StartsWithPrefix<
47+
'surface',
48+
BaseSemanticColor
49+
>
50+
export type ShadowFunctionalColor = StartsWithPrefix<
51+
'shadow',
52+
BaseSemanticColor
53+
>
54+
export type DimFunctionalColor = StartsWithPrefix<'dim', BaseSemanticColor>
3855

3956
export type FunctionalColor =
4057
| BackgroundFunctionalColor
@@ -45,7 +62,7 @@ export type FunctionalColor =
4562

4663
export type SemanticColor = StartsWithPrefix<
4764
'primary' | 'critical' | 'warning' | 'accent' | 'success',
48-
ThemeColor
65+
BaseSemanticColor
4966
>
5067

5168
export type Color = GlobalColor | FunctionalColor | SemanticColor
@@ -65,8 +82,8 @@ export type GlobalGradient = RemovePrefix<
6582
keyof GlobalToken['gradient']
6683
>
6784

68-
export type Shadow = RemovePrefix<'alpha-shadow', keyof ThemeToken['shadow']>
85+
export type Shadow = RemovePrefix<'alpha-shadow', keyof SemanticToken['shadow']>
6986
export type FunctionalGradient = RemovePrefix<
7087
'alpha-gradient',
71-
keyof ThemeToken['gradient']
88+
keyof SemanticToken['gradient']
7289
>

0 commit comments

Comments
 (0)