Format Class

Module: Utils
Defined In: addon\utils\formats.js:4

These utils are designed for helping you be able to easily format a column by passing this function into the format attribute of the column. To use these functions, all you need to do is import them at the top of the Javascript file, with the following import:

import {functionName} from '@bennerinformatics/ember-fw-table/utils/formats';

Then you use it in the column array to format it appropriately. Each function gives you an example of how to use it.

Show:
formatBoolean
(
  • value
)
String

Defined in addon\utils\formats.js:14

Format function which replaces the value with a basic Yes/No format for if its true or false. Designed to be used in the following way with a boolean column (after importing formatBoolean in the way described above):

column: [{
    label: 'My Boolean',
    valuePath: 'myBoolean',
    format: formatBoolean
    ...
  }...],

Parameters:

  • value Any

    Value to test

Returns:

String:

"Yes" if the value is truthy, "No" otherwise

formatMoment
(
  • format
  • exportFormat
)
Function

Defined in addon\utils\formats.js:62

Generates a function which formats a moment based on the specified format. Designed to be used in the following way with a column displaying a date (after importing formatMoment in the way described above):

column: [
    //will display date as 1970-01-01
    {
       label: 'Some Column',
       valuePath: 'someColumn',
       format: formatMoment('YYYY-MM-DD')
       ...
    },
    //will display date in the table as 1970-01-01, but when exporting display 01-01-1970
    {
       label: 'Some Column',
       valueText: 'someColumn',
       format: formatMoment('YYYY-MM-DD', 'MM-DD-YYYY')
   }
  ...],

Parameters:

  • format String

    moment format. For a list of valid strings, see Moment docs

  • exportFormat String

    moment format used on exporting

Returns:

Function:

Function to pass into a column which formats by a moment

formatNullable
(
  • nullText='None'
)
Function

Defined in addon\utils\formats.js:31

Generates a format function which returns the value or an italic default text if the value is null. Designed to be used in the following way with a column that may have a null value (after importing formatNullable in the way described above):

column: [
   //if null, will display the default "None" in italics
    {
       label: 'Some Column',
       valuePath: 'someColumn',
       format: formatNullable
       ...
    },
    //if null, will display "No Value" instead of "None" in italics
    {
       label: 'Some Column',
       valueText: 'someColumn',
       format: formatNullable('No Value')
   }
  ...],

Parameters:

  • [nullText='None'] String optional

    Text if the value is null

Returns:

Function:

Function to pass into the column format