Skip to content

Commit

Permalink
docs: improve formatters doc
Browse files Browse the repository at this point in the history
  • Loading branch information
ghiscoding authored Jan 23, 2025
1 parent 2e279f0 commit 83278ac
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/column-functionalities/Formatters.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

`Formatters` are functions that can be used to change and format certain column(s) in the grid. Please note that it does not alter the input data, it simply changes the styling by formatting the data differently to the screen (what the user visually see).

A good example of a `Formatter` could be a column name `isActive` which is a `boolean` field with input data as `True` or `False`. User would prefer to simply see a checkbox as a visual indication representing the `True` flag, for this behavior you can use `Formatters.checkmarkMaterial` which will use Material Design icon of `mdi-check` when `True` or an empty string when `False`.
A good example of a `Formatter` could be a timestamp or a `Date` object that we could format differently in the grid, for example using `Formatters.dateIso` or `Formatters.dateUs` which is more human readable.

#### Provided Formatters

Expand Down

0 comments on commit 83278ac

Please sign in to comment.