You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: DEVELOPER.md
+9-5
Original file line number
Diff line number
Diff line change
@@ -32,16 +32,20 @@ The core angular module (ui.grid) provides the basics
32
32
- Virtualization
33
33
- Row Selection
34
34
35
-
Everything else should be added as new angular modules unless the grid team agrees that it's a core feature.
35
+
Everything else should be added as new angular modules unless the grid team agrees that it's a core feature. All new feature
36
+
modules should be developed as plugins, and be hosted in their own repositories. There is a great [blog post](http://brianhann.com/write-your-own-ui-grid-plugin/)
37
+
about developing a plugin for ui-grid. Your plugin should use the available publicApi, if you need something in the publicApi that isn't
38
+
currently exposed, we welcome pull requests.
39
+
40
+
The grid team has limited time to spend on this project, and as the list of features grows, so does the effort required to support
41
+
those features. In a future release we will be working to move some of the existing features out of the core repository. The basic
42
+
rule of thumb for any new features is: "If it is possible to implement it as a plugin, it should be a plugin".
36
43
37
44
## Feature module design
38
-
* We prefer no 3rd party dependencies other than angular. Contact grid team if you have a 3rd party need that can't be avoided.
45
+
* We prefer no 3rd party dependencies other than angular.
39
46
* jQuery is only used in Unit Tests
40
47
* unit test your code! not that hard. see test/unit for examples. Features will be rejected if the test coverage isn't adequate.
41
48
* use ngDoc to document how to use your feature. see examples in existing code.
42
-
* New module should be named ui.grid.feature
43
-
* feature folder is added below src
44
-
* One js file per feature
45
49
* no global variables
46
50
* public methods and events are registered in grid.api (more on that later)
47
51
* design and code the angular way. What do we mean by that? Dependency injection, small directives, emphasis the model, not the DOM, tests!
Copy file name to clipboardExpand all lines: README.md
+6
Original file line number
Diff line number
Diff line change
@@ -76,6 +76,12 @@ Feature | Release state
76
76
77
77
For more details on the features check the [Tutorials](http://ui-grid.info/docs/#/tutorial).
78
78
79
+
# Plugins
80
+
81
+
UI-Grid has an excellent plugin system. Most new features can be added as plugins. Please see some discussion of that in the [Developer guidelines](DEVELOPER.md).
82
+
There is a [list of known plugins](http://ui-grid.info/docs/#/tutorial/299_third_party_features) on the tutorial site. If you would
83
+
like your plugin added to that list, please [edit the tutorial page](misc/tutorial/299_third_party_features.ngdoc) and send a pull request.
0 commit comments