chem-generic-ui 2.3.0-rc6 → 2.3.0-rc7

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/CHANGELOG.md CHANGED
@@ -1,5 +1,10 @@
1
1
  # Chem-Generic-UI Changelog
2
2
 
3
+ ## [2.3.0]
4
+
5
+ ### Breaking Changes
6
+ - The library no longer registers AG Grid modules on import. The host application must call `ModuleRegistry.registerModules([AllCommunityModule])` (from `ag-grid-community`) before rendering any chem-generic-ui component that contains a grid. See the "Host application setup" section in the README.
7
+
3
8
  ## [2.1.0]
4
9
 
5
10
  ### Features and Enhancements
package/README.md CHANGED
@@ -39,6 +39,20 @@ or Yarn:
39
39
  yarn add chem-generic-ui
40
40
  ```
41
41
 
42
+ ## Host application setup
43
+
44
+ ### AG Grid module registration
45
+
46
+ `ag-grid-community` and `ag-grid-react` (`>=33.0.0 <34.0.0`) are peer dependencies — the host application provides them. Since version 2.3.0, chem-generic-ui no longer registers AG Grid modules itself. Register them once in your application entry point, before rendering any chem-generic-ui component that contains a grid:
47
+
48
+ ```js
49
+ import { ModuleRegistry, AllCommunityModule } from 'ag-grid-community';
50
+
51
+ ModuleRegistry.registerModules([AllCommunityModule]);
52
+ ```
53
+
54
+ Without this, AG Grid throws error #200 ("unable to use … as the module is not registered") when a grid component mounts.
55
+
42
56
  ## Support and Community
43
57
 
44
58
  If you have questions, comments, or suggestions, the best place to share them is in the [Discussions](https://github.com/LabIMotion/chem-generic-ui/discussions) section. We welcome your feedback and participation!