Skip to content

v3.7.2 - deprecated Formatters

Compare
Choose a tag to compare
@github-actions github-actions released this 12 Dec 23:20
· 444 commits to master since this release

3.7.2 (2023-12-12)

Deprecations

Please note that multiple built-in Formatters are now deprecated and will be removed in the next major version (which is coming very soon). Below is the list of Formatters and their alternatives with code sample on what to change. The CSS class may vary depending on which UI framework you use

Formatter removed cssClass equivalent alternative
Formatters.bold cssClass: 'text-bold' or fs-bold
Formatters.center cssClass: 'text-center'
Formatters.italic cssClass: 'text-italic' or fst-italic
Formatters.alignRight cssClass: 'text-right' or text-end
Formatters.lowercase cssClass: 'text-lowercase'
Formatters.uppercase cssClass: 'text-uppercase'
Formatters.fakeHyperlink cssClass: 'text-underline cursor' cssClass: 'fake-hyperlink'
Formatters.checkbox to be removed use the Formatters.iconBoolean
Formatters.deleteIcon to be removed use the Formatters.icon (see below)
Formatters.editIcon to be removed use the Formatters.icon (see below)
Formatters.infoIcon to be removed use the Formatters.icon (see below)
Formatters.yesNo to be removed create a custom Formatter

The alternative is to use cssClass as shown below

this.columnDefinitions = [
  { 
    id: 'firstName', name: 'First Name', field: 'firstName',
-   formatter: Formatters.bold
+   cssClass: 'text-bold'
  },
  { 
    id: 'lastName', name: 'Last Name', field: 'lastName',
-   formatter: Formatters.multiple, params: { formatters: [Formatters.uppercase, Formatters.bold] },
+   cssClass: 'text-uppercase text-bold'
  },
  {
    id: 'deleteIcon', name: '', field: '',
-   formatter: Formatters.deleteIcon, 
    // NOTE: we previously accepted "icon" and "formatterIcon" property in the past but these props will be removed
+   formatter: Formatters.icon, params: { iconCssClass: 'fa fa-trash pointer' }
  },
];

Bug Fixes