@movable/ui 1.9.0 → 1.9.1

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.
package/README.md CHANGED
@@ -16,6 +16,22 @@ This repo contains the shared components for our frontend applications. Using th
16
16
 
17
17
  Ensure the project consuming this library has all the required peer dependencies.
18
18
 
19
+ ### WARNING: Providing Theme Colors to Custom Components
20
+
21
+ While within using app you'll be able to use `(theme) => theme.palette...` style of sx props. But within our custom component this _does NOT_ traverse to the using app. You'll want to use the theme palette directly to ensure proper color strings. See #224
22
+
23
+ ```jsx
24
+ import palette from 'path_to_src/theme/palette';
25
+
26
+ export default InkCustomComponent() {
27
+ return (
28
+ <Box sx={{ backgroundColor: palette.neutral50 }}>
29
+ ...
30
+ </Box>
31
+ )
32
+ }
33
+ ```
34
+
19
35
  ### Yarn Linking
20
36
 
21
37
  1. `@movable/ui`: `yarn link`