Skip to content

Commit ea36c35

Browse files
markdebeermportuga
authored andcommitted
docs(columnDef): update name regarding uniqueness
Add a warning about the name needing to be unique to all instances of grids on a page because it can be used as a key for retrieving custom sort algorithms, etc..
1 parent b21a7ea commit ea36c35

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

src/js/core/factories/GridColumn.js

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,23 @@ angular.module('ui.grid')
1818
* @ngdoc property
1919
* @name name
2020
* @propertyOf ui.grid.class:GridColumn
21-
* @description (mandatory) each column should have a name, although for backward
22-
* compatibility with 2.x name can be omitted if field is present
21+
* @description (mandatory) Each column should have a name, although for backward
22+
* compatibility with 2.x name can be omitted if field is present.
23+
*
24+
* Important - This must be unique to each column on a web page since it can
25+
* be used as a key for retrieving information such as custom sort algorithms.
2326
*
2427
*/
2528

2629
/**
2730
* @ngdoc property
2831
* @name name
2932
* @propertyOf ui.grid.class:GridOptions.columnDef
30-
* @description (mandatory) each column should have a name, although for backward
31-
* compatibility with 2.x name can be omitted if field is present
33+
* @description (mandatory) Each column should have a name, although for backward
34+
* compatibility with 2.x name can be omitted if field is present.
35+
*
36+
* Important - This must be unique to each column on a web page since it can
37+
* be used as a key for retrieving information such as custom sort algorithms.
3238
*
3339
*/
3440

0 commit comments

Comments
 (0)