Skip to content

Commit

Permalink
docs(columnDef): update name regarding uniqueness
Browse files Browse the repository at this point in the history
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..
  • Loading branch information
markdebeer authored and mportuga committed Jun 6, 2017
1 parent b21a7ea commit ea36c35
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions src/js/core/factories/GridColumn.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,23 @@ angular.module('ui.grid')
* @ngdoc property
* @name name
* @propertyOf ui.grid.class:GridColumn
* @description (mandatory) each column should have a name, although for backward
* compatibility with 2.x name can be omitted if field is present
* @description (mandatory) Each column should have a name, although for backward
* compatibility with 2.x name can be omitted if field is present.
*
* Important - This must be unique to each column on a web page since it can
* be used as a key for retrieving information such as custom sort algorithms.
*
*/

/**
* @ngdoc property
* @name name
* @propertyOf ui.grid.class:GridOptions.columnDef
* @description (mandatory) each column should have a name, although for backward
* compatibility with 2.x name can be omitted if field is present
* @description (mandatory) Each column should have a name, although for backward
* compatibility with 2.x name can be omitted if field is present.
*
* Important - This must be unique to each column on a web page since it can
* be used as a key for retrieving information such as custom sort algorithms.
*
*/

Expand Down

0 comments on commit ea36c35

Please sign in to comment.