import React, { SFC, ReactElement } from 'react';
import PropTypes from 'prop-types';
import get from 'lodash/get';
import pure from 'recompose/pure';
import compose from 'recompose/compose';
import { withTranslate, TranslationContextProps } from 'ra-core';
import Typography from '@material-ui/core/Typography';
import sanitizeRestProps from './sanitizeRestProps';
import { FieldProps, InjectedFieldProps, fieldPropTypes } from './types';
interface Choice {
id: string;
name: string;
}
type OptionTextElement = ReactElement<{ record: Choice }>;
type OptionText = (choice: Choice) => string | OptionTextElement;
interface Props extends FieldProps {
choices: Choice[];
optionValue: string;
optionText: OptionTextElement | OptionText | string;
translateChoice: boolean;
}
/**
* Display a value in an enumeration
*
* Pass possible options as an array of objects in the 'choices' attribute.
*
* @example
* const choices = [
* { id: 'M', name: 'Male' },
* { id: 'F', name: 'Female' },
* ];
*
*
* By default, the text is built by
* - finding a choice where the 'id' property equals the field value
* - using the 'name' property an the option text
*
* You can also customize the properties to use for the value and text,
* thanks to the 'optionValue' and 'optionText' attributes.
*
* @example
* const choices = [
* { _id: 123, full_name: 'Leo Tolstoi', sex: 'M' },
* { _id: 456, full_name: 'Jane Austen', sex: 'F' },
* ];
*
*
* `optionText` also accepts a function, so you can shape the option text at will:
* @example
* const choices = [
* { id: 123, first_name: 'Leo', last_name: 'Tolstoi' },
* { id: 456, first_name: 'Jane', last_name: 'Austen' },
* ];
* const optionRenderer = choice => `${choice.first_name} ${choice.last_name}`;
*
*
* `optionText` also accepts a React Element, that will be cloned and receive
* the related choice as the `record` prop. You can use Field components there.
* @example
* const choices = [
* { id: 123, first_name: 'Leo', last_name: 'Tolstoi' },
* { id: 456, first_name: 'Jane', last_name: 'Austen' },
* ];
* const FullNameField = ({ record }) => {record.first_name} {record.last_name};
* }/>
*
* The current choice is translated by default, so you can use translation identifiers as choices:
* @example
* const choices = [
* { id: 'M', name: 'myroot.gender.male' },
* { id: 'F', name: 'myroot.gender.female' },
* ];
*
* However, in some cases (e.g. inside a ``), you may not want
* the choice to be translated. In that case, set the `translateChoice` prop to false.
* @example
*
*
* **Tip**: sets `translateChoice` to false by default.
*/
export const SelectField: SFC<
Props & InjectedFieldProps & TranslationContextProps
> = ({
className,
source,
record,
choices,
optionValue,
optionText,
translate,
translateChoice,
...rest
}) => {
const value = get(record, source);
const choice = choices.find(c => c[optionValue] === value);
if (!choice) {
return null;
}
const choiceName = React.isValidElement(optionText) // eslint-disable-line no-nested-ternary
? React.cloneElement(optionText, { record: choice })
: typeof optionText === 'function'
? optionText(choice)
: choice[optionText];
return (
{translateChoice
? translate(choiceName, { _: choiceName })
: choiceName}
);
};
SelectField.defaultProps = {
optionText: 'name',
optionValue: 'id',
translateChoice: true,
};
const enhance = compose<
Props & InjectedFieldProps & TranslationContextProps,
Props & TranslationContextProps
>(
pure,
withTranslate
);
const EnhancedSelectField = enhance(SelectField);
EnhancedSelectField.defaultProps = {
addLabel: true,
};
EnhancedSelectField.propTypes = {
...Typography.propTypes,
...fieldPropTypes,
choices: PropTypes.arrayOf(PropTypes.object).isRequired,
optionText: PropTypes.oneOfType([
PropTypes.string,
PropTypes.func,
PropTypes.element,
]),
optionValue: PropTypes.string,
translateChoice: PropTypes.bool,
};
EnhancedSelectField.displayName = 'EnhancedSelectField';
export default EnhancedSelectField;