@atb-as/theme 11.2.0 → 12.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (198) hide show
  1. package/README.md +81 -79
  2. package/lib/generated/themes/atb-theme/dark.d.ts +697 -374
  3. package/lib/generated/themes/atb-theme/dark.js +692 -369
  4. package/lib/generated/themes/atb-theme/dark.js.map +1 -1
  5. package/lib/generated/themes/atb-theme/light.d.ts +697 -374
  6. package/lib/generated/themes/atb-theme/light.js +692 -369
  7. package/lib/generated/themes/atb-theme/light.js.map +1 -1
  8. package/lib/generated/themes/atb-theme/theme.css +10 -790
  9. package/lib/generated/themes/atb-theme/theme.d.ts +1394 -748
  10. package/lib/generated/themes/farte-theme/dark.d.ts +697 -374
  11. package/lib/generated/themes/farte-theme/dark.js +692 -369
  12. package/lib/generated/themes/farte-theme/dark.js.map +1 -1
  13. package/lib/generated/themes/farte-theme/light.d.ts +697 -374
  14. package/lib/generated/themes/farte-theme/light.js +692 -369
  15. package/lib/generated/themes/farte-theme/light.js.map +1 -1
  16. package/lib/generated/themes/farte-theme/theme.css +10 -790
  17. package/lib/generated/themes/farte-theme/theme.d.ts +1394 -748
  18. package/lib/generated/themes/fram-theme/dark.d.ts +697 -374
  19. package/lib/generated/themes/fram-theme/dark.js +691 -368
  20. package/lib/generated/themes/fram-theme/dark.js.map +1 -1
  21. package/lib/generated/themes/fram-theme/light.d.ts +697 -374
  22. package/lib/generated/themes/fram-theme/light.js +692 -369
  23. package/lib/generated/themes/fram-theme/light.js.map +1 -1
  24. package/lib/generated/themes/fram-theme/theme.css +10 -790
  25. package/lib/generated/themes/fram-theme/theme.d.ts +1394 -748
  26. package/lib/generated/themes/innlandet-theme/dark.d.ts +697 -374
  27. package/lib/generated/themes/innlandet-theme/dark.js +692 -369
  28. package/lib/generated/themes/innlandet-theme/dark.js.map +1 -1
  29. package/lib/generated/themes/innlandet-theme/light.d.ts +697 -374
  30. package/lib/generated/themes/innlandet-theme/light.js +692 -369
  31. package/lib/generated/themes/innlandet-theme/light.js.map +1 -1
  32. package/lib/generated/themes/innlandet-theme/theme.css +10 -790
  33. package/lib/generated/themes/innlandet-theme/theme.d.ts +1394 -748
  34. package/lib/generated/themes/nfk-theme/dark.d.ts +697 -374
  35. package/lib/generated/themes/nfk-theme/dark.js +693 -370
  36. package/lib/generated/themes/nfk-theme/dark.js.map +1 -1
  37. package/lib/generated/themes/nfk-theme/light.d.ts +697 -374
  38. package/lib/generated/themes/nfk-theme/light.js +693 -370
  39. package/lib/generated/themes/nfk-theme/light.js.map +1 -1
  40. package/lib/generated/themes/nfk-theme/theme.css +10 -790
  41. package/lib/generated/themes/nfk-theme/theme.d.ts +1394 -748
  42. package/lib/generated/themes/troms-theme/dark.d.ts +697 -374
  43. package/lib/generated/themes/troms-theme/dark.js +694 -371
  44. package/lib/generated/themes/troms-theme/dark.js.map +1 -1
  45. package/lib/generated/themes/troms-theme/light.d.ts +697 -374
  46. package/lib/generated/themes/troms-theme/light.js +694 -371
  47. package/lib/generated/themes/troms-theme/light.js.map +1 -1
  48. package/lib/generated/themes/troms-theme/theme.css +10 -790
  49. package/lib/generated/themes/troms-theme/theme.d.ts +1394 -748
  50. package/lib/generated/themes/vkt-theme/dark.d.ts +697 -374
  51. package/lib/generated/themes/vkt-theme/dark.js +694 -371
  52. package/lib/generated/themes/vkt-theme/dark.js.map +1 -1
  53. package/lib/generated/themes/vkt-theme/light.d.ts +697 -374
  54. package/lib/generated/themes/vkt-theme/light.js +693 -370
  55. package/lib/generated/themes/vkt-theme/light.js.map +1 -1
  56. package/lib/generated/themes/vkt-theme/theme.css +10 -790
  57. package/lib/generated/themes/vkt-theme/theme.d.ts +1394 -748
  58. package/lib/theme.d.ts +56 -134
  59. package/lib/theme.js +8 -46
  60. package/lib/theme.js.map +1 -1
  61. package/package.json +4 -4
  62. package/lib/generated/themes/atb-theme/theme.module.css +0 -790
  63. package/lib/generated/themes/farte-theme/theme.module.css +0 -790
  64. package/lib/generated/themes/fram-theme/theme.module.css +0 -790
  65. package/lib/generated/themes/innlandet-theme/theme.module.css +0 -790
  66. package/lib/generated/themes/nfk-theme/theme.module.css +0 -790
  67. package/lib/generated/themes/troms-theme/theme.module.css +0 -790
  68. package/lib/generated/themes/vkt-theme/theme.module.css +0 -790
  69. package/lib/generated/themes-fs/atb-theme/dark.d.ts +0 -762
  70. package/lib/generated/themes-fs/atb-theme/dark.js +0 -764
  71. package/lib/generated/themes-fs/atb-theme/dark.js.map +0 -1
  72. package/lib/generated/themes-fs/atb-theme/light.d.ts +0 -762
  73. package/lib/generated/themes-fs/atb-theme/light.js +0 -764
  74. package/lib/generated/themes-fs/atb-theme/light.js.map +0 -1
  75. package/lib/generated/themes-fs/atb-theme/theme.css +0 -10
  76. package/lib/generated/themes-fs/atb-theme/theme.d.ts +0 -1522
  77. package/lib/generated/themes-fs/atb-theme/theme.js +0 -16
  78. package/lib/generated/themes-fs/atb-theme/theme.js.map +0 -1
  79. package/lib/generated/themes-fs/farte-theme/dark.d.ts +0 -762
  80. package/lib/generated/themes-fs/farte-theme/dark.js +0 -764
  81. package/lib/generated/themes-fs/farte-theme/dark.js.map +0 -1
  82. package/lib/generated/themes-fs/farte-theme/light.d.ts +0 -762
  83. package/lib/generated/themes-fs/farte-theme/light.js +0 -764
  84. package/lib/generated/themes-fs/farte-theme/light.js.map +0 -1
  85. package/lib/generated/themes-fs/farte-theme/theme.css +0 -10
  86. package/lib/generated/themes-fs/farte-theme/theme.d.ts +0 -1522
  87. package/lib/generated/themes-fs/farte-theme/theme.js +0 -16
  88. package/lib/generated/themes-fs/farte-theme/theme.js.map +0 -1
  89. package/lib/generated/themes-fs/fram-theme/dark.d.ts +0 -762
  90. package/lib/generated/themes-fs/fram-theme/dark.js +0 -764
  91. package/lib/generated/themes-fs/fram-theme/dark.js.map +0 -1
  92. package/lib/generated/themes-fs/fram-theme/light.d.ts +0 -762
  93. package/lib/generated/themes-fs/fram-theme/light.js +0 -764
  94. package/lib/generated/themes-fs/fram-theme/light.js.map +0 -1
  95. package/lib/generated/themes-fs/fram-theme/theme.css +0 -10
  96. package/lib/generated/themes-fs/fram-theme/theme.d.ts +0 -1522
  97. package/lib/generated/themes-fs/fram-theme/theme.js +0 -16
  98. package/lib/generated/themes-fs/fram-theme/theme.js.map +0 -1
  99. package/lib/generated/themes-fs/index.d.ts +0 -10
  100. package/lib/generated/themes-fs/index.js +0 -24
  101. package/lib/generated/themes-fs/index.js.map +0 -1
  102. package/lib/generated/themes-fs/innlandet-theme/dark.d.ts +0 -762
  103. package/lib/generated/themes-fs/innlandet-theme/dark.js +0 -764
  104. package/lib/generated/themes-fs/innlandet-theme/dark.js.map +0 -1
  105. package/lib/generated/themes-fs/innlandet-theme/light.d.ts +0 -762
  106. package/lib/generated/themes-fs/innlandet-theme/light.js +0 -764
  107. package/lib/generated/themes-fs/innlandet-theme/light.js.map +0 -1
  108. package/lib/generated/themes-fs/innlandet-theme/theme.css +0 -10
  109. package/lib/generated/themes-fs/innlandet-theme/theme.d.ts +0 -1522
  110. package/lib/generated/themes-fs/innlandet-theme/theme.js +0 -16
  111. package/lib/generated/themes-fs/innlandet-theme/theme.js.map +0 -1
  112. package/lib/generated/themes-fs/nfk-theme/dark.d.ts +0 -762
  113. package/lib/generated/themes-fs/nfk-theme/dark.js +0 -764
  114. package/lib/generated/themes-fs/nfk-theme/dark.js.map +0 -1
  115. package/lib/generated/themes-fs/nfk-theme/light.d.ts +0 -762
  116. package/lib/generated/themes-fs/nfk-theme/light.js +0 -764
  117. package/lib/generated/themes-fs/nfk-theme/light.js.map +0 -1
  118. package/lib/generated/themes-fs/nfk-theme/theme.css +0 -10
  119. package/lib/generated/themes-fs/nfk-theme/theme.d.ts +0 -1522
  120. package/lib/generated/themes-fs/nfk-theme/theme.js +0 -16
  121. package/lib/generated/themes-fs/nfk-theme/theme.js.map +0 -1
  122. package/lib/generated/themes-fs/troms-theme/dark.d.ts +0 -762
  123. package/lib/generated/themes-fs/troms-theme/dark.js +0 -764
  124. package/lib/generated/themes-fs/troms-theme/dark.js.map +0 -1
  125. package/lib/generated/themes-fs/troms-theme/light.d.ts +0 -762
  126. package/lib/generated/themes-fs/troms-theme/light.js +0 -764
  127. package/lib/generated/themes-fs/troms-theme/light.js.map +0 -1
  128. package/lib/generated/themes-fs/troms-theme/theme.css +0 -10
  129. package/lib/generated/themes-fs/troms-theme/theme.d.ts +0 -1522
  130. package/lib/generated/themes-fs/troms-theme/theme.js +0 -16
  131. package/lib/generated/themes-fs/troms-theme/theme.js.map +0 -1
  132. package/lib/generated/themes-fs/vkt-theme/dark.d.ts +0 -762
  133. package/lib/generated/themes-fs/vkt-theme/dark.js +0 -764
  134. package/lib/generated/themes-fs/vkt-theme/dark.js.map +0 -1
  135. package/lib/generated/themes-fs/vkt-theme/light.d.ts +0 -762
  136. package/lib/generated/themes-fs/vkt-theme/light.js +0 -764
  137. package/lib/generated/themes-fs/vkt-theme/light.js.map +0 -1
  138. package/lib/generated/themes-fs/vkt-theme/theme.css +0 -10
  139. package/lib/generated/themes-fs/vkt-theme/theme.d.ts +0 -1522
  140. package/lib/generated/themes-fs/vkt-theme/theme.js +0 -16
  141. package/lib/generated/themes-fs/vkt-theme/theme.js.map +0 -1
  142. package/lib/sizes.d.ts +0 -23
  143. package/lib/sizes.js +0 -26
  144. package/lib/sizes.js.map +0 -1
  145. package/lib/themes/atb-theme/theme.css +0 -803
  146. package/lib/themes/atb-theme/theme.d.ts +0 -113
  147. package/lib/themes/atb-theme/theme.js +0 -483
  148. package/lib/themes/atb-theme/theme.js.map +0 -1
  149. package/lib/themes/atb-theme/theme.module.css +0 -803
  150. package/lib/themes/farte-theme/theme.css +0 -803
  151. package/lib/themes/farte-theme/theme.d.ts +0 -113
  152. package/lib/themes/farte-theme/theme.js +0 -483
  153. package/lib/themes/farte-theme/theme.js.map +0 -1
  154. package/lib/themes/farte-theme/theme.module.css +0 -803
  155. package/lib/themes/fram-theme/theme.css +0 -803
  156. package/lib/themes/fram-theme/theme.d.ts +0 -215
  157. package/lib/themes/fram-theme/theme.js +0 -603
  158. package/lib/themes/fram-theme/theme.js.map +0 -1
  159. package/lib/themes/fram-theme/theme.module.css +0 -803
  160. package/lib/themes/index.d.ts +0 -7
  161. package/lib/themes/index.js +0 -21
  162. package/lib/themes/index.js.map +0 -1
  163. package/lib/themes/innlandet-theme/theme.css +0 -803
  164. package/lib/themes/innlandet-theme/theme.d.ts +0 -113
  165. package/lib/themes/innlandet-theme/theme.js +0 -483
  166. package/lib/themes/innlandet-theme/theme.js.map +0 -1
  167. package/lib/themes/innlandet-theme/theme.module.css +0 -803
  168. package/lib/themes/nfk-theme/theme.css +0 -803
  169. package/lib/themes/nfk-theme/theme.d.ts +0 -185
  170. package/lib/themes/nfk-theme/theme.js +0 -576
  171. package/lib/themes/nfk-theme/theme.js.map +0 -1
  172. package/lib/themes/nfk-theme/theme.module.css +0 -803
  173. package/lib/themes/troms-theme/theme.css +0 -803
  174. package/lib/themes/troms-theme/theme.d.ts +0 -118
  175. package/lib/themes/troms-theme/theme.js +0 -488
  176. package/lib/themes/troms-theme/theme.js.map +0 -1
  177. package/lib/themes/troms-theme/theme.module.css +0 -803
  178. package/lib/themes/vkt-theme/theme.css +0 -803
  179. package/lib/themes/vkt-theme/theme.d.ts +0 -113
  180. package/lib/themes/vkt-theme/theme.js +0 -483
  181. package/lib/themes/vkt-theme/theme.js.map +0 -1
  182. package/lib/themes/vkt-theme/theme.module.css +0 -803
  183. package/lib/typography.css +0 -260
  184. package/lib/typography.module.css +0 -260
  185. /package/lib/generated/{themes-fs → themes}/atb-theme/dark.css +0 -0
  186. /package/lib/generated/{themes-fs → themes}/atb-theme/light.css +0 -0
  187. /package/lib/generated/{themes-fs → themes}/farte-theme/dark.css +0 -0
  188. /package/lib/generated/{themes-fs → themes}/farte-theme/light.css +0 -0
  189. /package/lib/generated/{themes-fs → themes}/fram-theme/dark.css +0 -0
  190. /package/lib/generated/{themes-fs → themes}/fram-theme/light.css +0 -0
  191. /package/lib/generated/{themes-fs → themes}/innlandet-theme/dark.css +0 -0
  192. /package/lib/generated/{themes-fs → themes}/innlandet-theme/light.css +0 -0
  193. /package/lib/generated/{themes-fs → themes}/nfk-theme/dark.css +0 -0
  194. /package/lib/generated/{themes-fs → themes}/nfk-theme/light.css +0 -0
  195. /package/lib/generated/{themes-fs → themes}/troms-theme/dark.css +0 -0
  196. /package/lib/generated/{themes-fs → themes}/troms-theme/light.css +0 -0
  197. /package/lib/generated/{themes-fs → themes}/vkt-theme/dark.css +0 -0
  198. /package/lib/generated/{themes-fs → themes}/vkt-theme/light.css +0 -0
package/README.md CHANGED
@@ -6,117 +6,100 @@
6
6
  yarn add @atb-as/theme
7
7
  ```
8
8
 
9
+ ## Recommended usage
9
10
 
10
- ## Usage
11
+ ### `TS`/`JS` import
11
12
 
12
13
  Import through `ts`/`js`:
13
14
 
14
-
15
15
  ```ts
16
- import {createThemesFor,ThemeVariant} from '@atb-as/theme';
17
- const themes = createThemesFor(ThemeVariant.AtB)
18
- console.log(themes.light.colors.background_0);
16
+ import {createThemesFor, ThemeVariant} from '@atb-as/theme';
17
+ const { light, dark } = createThemesFor(ThemeVariant.AtB)
18
+ console.log(light.color.background.neutral[0].background);
19
+ // #000000
19
20
  ```
20
21
 
22
+ ### CSS import
21
23
 
22
- ### Usage CSS
24
+ Colors can be imported as CSS files. Typography styles can be imported as CSS Modules.
23
25
 
24
- > ⚠️ We're currently transitioning to a new variable structure.
25
- > Importing CSS from `../theme-fs/..` applies variables to `data-theme["auto"]`.
26
- > The theme follows the device preference.
27
- >
28
- > This behaviour can be overwritten by explicitly setting `data-theme["light"]` or `data-theme["dark"]`
29
- > on an element. All children will follow that specific theme.
26
+ To retrieve CSS files depending on your organization, we recommend setting up aliasing in your bundler. An example is provided for Webpack. This process is similar for other bundlers
30
27
 
31
- Or you could import CSS files or as CSS Modules. The actual content is currently the same, but named differently to be imported by CSS modules.
28
+ ```ts
29
+ const orgID = process.env.ORG_ID
30
+
31
+ webpack(config) {
32
+ config.resolve.alias = {
33
+ ...config.resolve.alias,
34
+ '@atb/theme/theme.css': `@atb-as/theme/lib/generated/themes/${orgId}-theme/theme.css`,
35
+ '@atb/theme/typography.css': '@atb-as/theme/lib/generated/typography.css',
36
+ '@atb/theme/typography.module.css':
37
+ '@atb-as/theme/lib/generated/typography.module.css',
38
+ };
39
+ }
40
+ ```
32
41
 
42
+ Then import CSS files using the alias above.
33
43
 
34
44
  ```ts
35
45
  // When using imports from bundlers
36
46
 
37
47
  // With CSS Modules for atb-theme
38
- import * as classNamesTheme from '@atb-as/theme/lib/themes/atb-theme/theme.module.css';
39
- import * as classNamesTypo from '@atb-as/theme/lib/typography.module.css';
40
-
48
+ import * as classNamesTypo from '@atb/theme/typography.module.css';
41
49
 
42
50
  // Without CSS Modules for atb-theme
43
- import '@atb-as/theme/lib/themes/atb-theme/theme.css';
44
- import '@atb-as/theme/lib/typography.css';
51
+ import '@atb/theme/theme.css';
52
+ import '@atb/theme/typography.css';
45
53
  ```
46
54
 
47
55
  ```css
48
56
  /* Using css/postcss/bundlers */
49
- @import '@atb-as/theme/lib/themes/atb-theme/theme.module.css';
50
- @import '@atb-as/theme/lib/typography.module.css';
57
+ @import '@atb/theme/typography.module.css';
51
58
 
52
59
  /* or without modules */
53
- @import '@atb-as/theme/lib/themes/atb-theme/theme.css';
54
- @import '@atb-as/theme/lib/typography.css';
55
-
60
+ @import '@atb/theme/themes/theme.css';
61
+ @import '@atb/theme/typography.css';
56
62
 
57
- /* And potentially */
63
+ /* You can also import from an organization directly */
58
64
  @value myClassname from "@atb-as/theme/lib/themes/atb-theme/theme.css";
59
65
  ```
60
66
 
61
67
  _(note: This all depends on how you setup bundlers and consumes styles.)_
62
68
 
69
+ #### Using tokens
70
+
71
+ For CSS, we recommend [our token plugin](https://github.com/AtB-AS/design-system/tree/main/packages/token), which provides typesafety and an easy interfacing for accessing CSS variables (design tokens).
63
72
 
64
73
  #### Theming with CSS
65
74
 
66
75
  Uses CSS Custom Properties to do theming. This means by default it only support newer browsers. This needs to be compansated for by the consumer if wanted.
67
- By setting class `light` or `dark` on a parent component the cascading of custom props will change the theme. This means we can set what level we want the theming to operate on.
76
+ By setting the attribute `data-theme` to `light`, `dark` or `auto` on a parent component the cascading of custom props will change the theme. This means we can set what level we want the theming to operate on.
68
77
 
69
78
  ```html
70
- <body class="light">
79
+ <body data-theme="light">
71
80
  <!-- My content -->
72
81
  </body>
73
82
 
74
- <body class="dark">
83
+ <body data-theme="dark">
75
84
  <!-- My content -->
76
85
  </body>
77
- ```
78
-
79
- **You must set either `light` or `dark` for themes to work.**
80
-
81
- #### Regular CSS
82
-
83
- With regular CSS.
84
-
85
- ```html
86
- <!-- Named same as theme objects -->
87
-
88
- <div class="colors-primary_2">
89
- <!-- background color and text color set -->
90
- </div>
91
-
92
- <div class="colors-transport_city" />
93
- ```
94
-
95
- #### CSS Modules
96
86
 
97
- ```css
98
- .mySpecificClassName {
99
- composes: colors-primary_2 from 'theme.modules.css';
100
- }
87
+ <body data-theme="auto">
88
+ <!-- My content -->
89
+ </body>
101
90
  ```
102
91
 
103
- ```css
104
- @import 'theme.modules.css';
92
+ `data-theme="auto"` follows the device preferences.
105
93
 
106
- .mySpecificClassName {
107
- composes: colors-transport_train;
108
- }
109
- ```
94
+ ## Theme API
110
95
 
111
- ### Theme API
96
+ ### `createThemes(themes: Themes, overrides?: ConfigurationOverride<Theme>): Themes`
112
97
 
113
- #### `createThemes(themes: Themes,overrides?: ConfigurationOverride<Theme>): Themes`
114
-
115
- Create new themes (light/dark) with optinally overriden defaults
98
+ Create new themes (light/dark) with optionally overriden defaults
116
99
 
117
100
  ```ts
118
101
  const themesVariant = createThemesFor(ThemeVariant.AtB)
119
- const themes = createThemes(
102
+ const { light, dark } = createThemes(
120
103
  themesVariant,
121
104
  {
122
105
  light: {
@@ -125,12 +108,11 @@ const themes = createThemes(
125
108
  },
126
109
  },
127
110
  });
128
- themes.dark.spacings.medium;
129
- //=> 20
111
+ console.log(light.spacing.medium);
112
+ // 20
130
113
  ```
131
114
 
132
-
133
- #### `createExtendedThemes<T>(themes: Themes,extension: T)`
115
+ ### `createExtendedThemes<T>(themes: Themes, extension: T)`
134
116
 
135
117
  Use Theme as base and extend with new properties. Properties can be nested and will be deep merged.
136
118
 
@@ -140,19 +122,19 @@ type FooExtension = {
140
122
  }
141
123
  const themesVariant = createThemesFor(ThemeVariant.AtB)
142
124
 
143
- const _themes = createExtendedThemes<FooExtension>(
125
+ const { light, dark } = createExtendedThemes<FooExtension>(
144
126
  themesVariant,
145
127
  {
146
128
  light: {statusBarStyle: 'dark'},
147
129
  dark: {statusBarStyle: 'light'}
148
130
  });
149
- _themes.dark.statusBarStyle;
150
- //=> (property) statusBarStyle: "dark" | "light"
131
+ console.log(light.statusBarStyle);
132
+ // dark
151
133
  ```
152
134
 
153
- ### Typography API
135
+ ## Typography API
154
136
 
155
- #### `createTextTypeStyles(PlatformTypes, ConfigurationOverride<TextTypeStyles>)`
137
+ ### `createTextTypeStyles(PlatformTypes, ConfigurationOverride<TextTypeStyles>)`
156
138
 
157
139
  Create new text type style with optinally overriden defaults.
158
140
 
@@ -167,7 +149,7 @@ createTextTypeStyles({
167
149
  })
168
150
  ```
169
151
 
170
- #### `extendTextTypeStyles<T>(type: PlatformTypes, extension: T)`
152
+ ### `extendTextTypeStyles<T>(type: PlatformTypes, extension: T)`
171
153
 
172
154
  Use text type style as base and extend with new properties. Properties can be nested and will be deep merged.
173
155
 
@@ -184,22 +166,42 @@ const foo = extendTextTypeStyles<Foo>({
184
166
  });
185
167
 
186
168
  console.log(foo.paragraphHeadline.additional);
187
- //=> (property) additional: boolean
169
+ // true
188
170
  ```
189
171
 
172
+ ## Updating the design system
190
173
 
174
+ Figma is the source of truth of variables. **Changes should therefore be made in Figma only** and imported into code afterwards through a GitHub Action.
191
175
 
176
+ 1. Make changes to Figma Variables in Figma
177
+ 2. Go to [GitHub Actions](https://github.com/AtB-AS/design-system/actions/workflows/design-tokens.yml), click **Run workflow**
178
+ ```
179
+ `Use workflow from`: `main`
180
+ `Which org did you make changes for?`: `orgId` // or `all`
181
+ ```
182
+ 3. A PR is created with the changes you made in step 1 and selected in step 2. If the expected changes are included, approve and merge the PR
192
183
 
193
- ### Building locally
184
+ ## Building locally
194
185
 
195
- From monorepo root, to generate CSS run:
186
+ > If you want to make changes to variables, we recommend making changes in Figma and import them into code using the steps above.
196
187
 
188
+ If you want to fetch new variables from Figma, you need to set environment variables.
189
+
190
+ ```sh
191
+ $ Replace [id_of_figma_file] with the actual ID of the file
192
+ export FIGMA_VARIABLES_URL=https://api.figma.com/v1/files/[id_of_figma_file]/variables/local
193
+
194
+ $ Create access token with Figma Variables read access
195
+ $ https://help.figma.com/hc/en-us/articles/8085703771159-Manage-personal-access-tokens
196
+ export FIGMA_REST_API_KEY=personal_access_token
197
197
  ```
198
- yarn workspace @atb-as/theme create-css
199
- ```
200
198
 
201
- or from project root:
199
+ ```sh
200
+ yarn
201
+
202
+ $ Only if you want to fetch new variables
203
+ $ Not need when just building the design system from source
204
+ yarn workspace @atb-as/theme fetch-variables
202
205
 
203
- ```
204
- yarn create-css
206
+ yarn workspace @atb-as/theme build
205
207
  ```