box-ui-elements-mlh/src/components/i18n/Param.js

Box UI Elements

// @flow
import * as React from 'react';

import {
    JSTYPE_BOOLEAN,
    JSTYPE_FUNCTION,
    JSTYPE_NUMBER,
    JSTYPE_OBJECT,
    JSTYPE_STRING,
    JSTYPE_UNDEFINED,
} from './constants';

type Props = {
    /** The value of this parameter */
    description: string,

    /** A description of this parameter to help the translators understand what it is */
    value: any,
};

/**
 * @class A placeholder for a replacement parameter in the body of a FormattedCompMessage
 * component.
 *
 * This component renders into the value of the named parameter to the FormattedCompMessage
 * component. Children are not allowed in this component and typically, it is used with
 * the self-closing syntax.
 *
 * @example
 * <pre>
 *   <FormattedCompMessage id="x" description="y">
 *     The file <Param value={filelist[i].path} description="Name of the file that was deleted."/> has been deleted.
 *   </FormattedCompMessage>
 * </pre>
 */
const Param = ({ value }: Props) => {
    switch (typeof value) {
        default:
        case JSTYPE_UNDEFINED:
            return '';

        case JSTYPE_BOOLEAN:
        case JSTYPE_NUMBER:
            return String(value);

        case JSTYPE_FUNCTION:
            return value();

        case JSTYPE_STRING:
            return value;

        case JSTYPE_OBJECT:
            if (value === null) {
                return '';
            }
            if (React.isValidElement(value)) {
                return value;
            }
            return value.toString();
    }
};

export default Param;