[TAP5-2609] Grid component doc: configuration sample code is incorrect

• Type: Bug
• Status: Closed
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: 5.4.4
• Fix Version/s: 5.8.2
• Component/s: documentation
• Assignee: Volker Lamp
• Reporter: Andrew Fowler
• Created: 06/Mar/19 06:02
• Updated: 27/May/22 21:47
• Resolved: 20/Apr/22 18:39

Description

In the "Configuring the Grid Component in the AppModule class" section of the Grid component documentation this code is given:

public static void contributeApplicationDefaults(MappedConfiguration<String, String> configuration)
{
  configuration.add(GridConstants.ROWS_PER_PAGE, "show");

  configuration.add(GridConstants.PAGER_POSITION, "bottom");

  configuration.add(GridConstants.TABLE_CLASS, "t-data-grid");
}

This should be:

public static void contributeApplicationDefaults(MappedConfiguration<String, String> configuration)
{
  configuration.add(ComponentParameterConstants.GRID_ROWS_PER_PAGE, "25");

  configuration.add(ComponentParameterConstants.GRID_PAGER_POSITION, "top");

  configuration.add(ComponentParameterConstants.GRID_TABLE_CSS_CLASS, "table table-hover table-bordered table-striped");
}

The relevant documentation source is here in pre-5.5.0:
Grid.xdoc:364