@bloomreach/react-banana-ui 1.1.0-next.2 → 1.1.0-next.4

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 (35) hide show
  1. package/README.md +8 -26
  2. package/dist/bloomreach-react-banana-ui.es.js +851 -852
  3. package/dist/bloomreach-react-banana-ui.es.js.map +1 -1
  4. package/dist/bloomreach-react-banana-ui.umd.js +2 -2
  5. package/dist/bloomreach-react-banana-ui.umd.js.map +1 -1
  6. package/dist/fonts/inter-latin-100-normal.woff +0 -0
  7. package/dist/fonts/inter-latin-100-normal.woff2 +0 -0
  8. package/dist/fonts/inter-latin-200-normal.woff +0 -0
  9. package/dist/fonts/inter-latin-200-normal.woff2 +0 -0
  10. package/dist/fonts/inter-latin-300-normal.woff +0 -0
  11. package/dist/fonts/inter-latin-300-normal.woff2 +0 -0
  12. package/dist/fonts/inter-latin-400-normal.woff +0 -0
  13. package/dist/fonts/inter-latin-400-normal.woff2 +0 -0
  14. package/dist/fonts/inter-latin-500-normal.woff +0 -0
  15. package/dist/fonts/inter-latin-500-normal.woff2 +0 -0
  16. package/dist/fonts/inter-latin-600-normal.woff +0 -0
  17. package/dist/fonts/inter-latin-600-normal.woff2 +0 -0
  18. package/dist/fonts/inter-latin-700-normal.woff +0 -0
  19. package/dist/fonts/inter-latin-700-normal.woff2 +0 -0
  20. package/dist/fonts/roboto-mono-latin-100-normal.woff +0 -0
  21. package/dist/fonts/roboto-mono-latin-100-normal.woff2 +0 -0
  22. package/dist/fonts/roboto-mono-latin-200-normal.woff +0 -0
  23. package/dist/fonts/roboto-mono-latin-200-normal.woff2 +0 -0
  24. package/dist/fonts/roboto-mono-latin-300-normal.woff +0 -0
  25. package/dist/fonts/roboto-mono-latin-300-normal.woff2 +0 -0
  26. package/dist/fonts/roboto-mono-latin-400-normal.woff +0 -0
  27. package/dist/fonts/roboto-mono-latin-400-normal.woff2 +0 -0
  28. package/dist/fonts/roboto-mono-latin-500-normal.woff +0 -0
  29. package/dist/fonts/roboto-mono-latin-500-normal.woff2 +0 -0
  30. package/dist/fonts/roboto-mono-latin-600-normal.woff +0 -0
  31. package/dist/fonts/roboto-mono-latin-600-normal.woff2 +0 -0
  32. package/dist/fonts/roboto-mono-latin-700-normal.woff +0 -0
  33. package/dist/fonts/roboto-mono-latin-700-normal.woff2 +0 -0
  34. package/dist/style.css +1 -1
  35. package/package.json +2 -2
package/README.md CHANGED
@@ -12,17 +12,12 @@ Visit the library [storybook](https://design.corp.bloomreach.com/storybooks/reac
12
12
 
13
13
  ## Using library in a project
14
14
 
15
- Install the following libraries to the project dependencies
15
+ Install the library as a dependency in the project
16
16
 
17
17
  ```sh
18
- npm i --save --save-exact @bloomreach/react-banana-ui @bloomreach/banana-theme
18
+ npm i --save --save-exact @bloomreach/react-banana-ui
19
19
  ```
20
20
 
21
- **Note:**
22
-
23
- The library `@bloomreach/banana-theme` is required only to bring fonts used by default in the global design system which is going to be used across all Bloomreach applications.
24
- Using it as a separate dependency in the end application is a temporary solution and will be changed in the near future by hiding inside `@bloomreach/react-banana-ui` library.
25
-
26
21
  ### Components
27
22
 
28
23
  In case project settings are properly established, use the components in the application like so
@@ -35,35 +30,22 @@ import { <ComponentName> } from "@bloomreach/react-banana-ui";
35
30
 
36
31
  Do the following steps to make styles and fonts available
37
32
 
38
- * Import the library styles along with fonts by adding the following lines in the main application style file
33
+ * Import the library styles in the main application style file as the following line
39
34
 
40
35
  ```css
41
36
  // main.scss
42
37
 
43
- @import '@bloomreach/banana-theme/css/fonts.css';
44
38
  @import '@bloomreach/react-banana-ui/style.css';
45
39
 
46
40
  ...
47
41
  ```
48
- * Additionally, set the `font-family` property to the root element using CSS custom properties available from the library
49
-
50
- ```css
51
- // main.scss
52
-
53
- ...
54
-
55
- html, body {
56
- font-family: var(--broccoli-font-family-primary);
57
- }
58
-
59
- ...
60
- ```
61
-
62
- The full list of available CSS custom properties will be available soon. Now just use the browser dev tools to see all available CSS custom properties. Filter them with the `--broccoli-` prefix to reduce the amount.
42
+ * The font family for your `html` and `body` tags are already specified in the library styles
63
43
 
64
- **ATTENTION:**
44
+ ### IMPORTANT
65
45
 
66
- Please, avoid using `--banana-...` CSS custom properties as they are intended to be used inside the library itself.
46
+ Please, avoid using `--rbui-...` and/or `--banana-...` CSS custom properties directly in the application styles
47
+ as they are intended to be used inside the library only.
48
+ Stick to use library components to bring the styles into the application.
67
49
 
68
50
 
69
51
  ## Development