@activelylearn/material-ui
Version:
Material-UI's workspace package
179 lines (169 loc) • 5.04 kB
JavaScript
// @inheritedComponent Input
import React from 'react';
import PropTypes from 'prop-types';
import SelectInput from './SelectInput';
import withStyles from '../styles/withStyles';
import ArrowDropDownIcon from '../internal/svg-icons/ArrowDropDown';
import Input from '../Input';
import { styles as nativeSelectStyles } from '../NativeSelect/NativeSelect';
import NativeSelectInput from '../NativeSelect/NativeSelectInput';
export const styles = nativeSelectStyles;
function Select(props) {
const {
autoWidth,
children,
classes,
displayEmpty,
IconComponent,
input,
inputProps,
MenuProps,
multiple,
native,
onClose,
onOpen,
open,
renderValue,
SelectDisplayProps,
...other
} = props;
const inputComponent = native ? NativeSelectInput : SelectInput;
const inputNativeProps = {
children,
classes,
IconComponent,
type: undefined, // We render a select. We can ignore the type provided by the `Input`.
};
return React.cloneElement(input, {
// Most of the logic is implemented in `SelectInput`.
// The `Select` component is a simple API wrapper to expose something better to play with.
inputComponent,
inputProps: {
...inputNativeProps,
...(native
? {}
: {
autoWidth,
children,
classes,
displayEmpty,
MenuProps,
multiple,
onClose,
onOpen,
open,
renderValue,
SelectDisplayProps,
}),
...inputProps,
...(input ? input.props.inputProps : {}),
},
...other,
});
}
Select.propTypes = {
/**
* If true, the width of the popover will automatically be set according to the items inside the
* menu, otherwise it will be at least the width of the select input.
*/
autoWidth: PropTypes.bool,
/**
* The option elements to populate the select with.
* Can be some `MenuItem` when `native` is false and `option` when `native` is true.
*/
children: PropTypes.node,
/**
* Override or extend the styles applied to the component.
* See [CSS API](#css-api) below for more details.
*/
classes: PropTypes.object.isRequired,
/**
* If `true`, the selected item is displayed even if its value is empty.
* You can only use it when the `native` property is `false` (default).
*/
displayEmpty: PropTypes.bool,
/**
* The icon that displays the arrow.
*/
IconComponent: PropTypes.oneOfType([PropTypes.string, PropTypes.func]),
/**
* An `Input` element; does not have to be a material-ui specific `Input`.
*/
input: PropTypes.element,
/**
* Properties applied to the `input` element.
* When `native` is `true`, the properties are applied on the `select` element.
*/
inputProps: PropTypes.object,
/**
* Properties applied to the `Menu` element.
*/
MenuProps: PropTypes.object,
/**
* If true, `value` must be an array and the menu will support multiple selections.
* You can only use it when the `native` property is `false` (default).
*/
multiple: PropTypes.bool,
/**
* If `true`, the component will be using a native `select` element.
*/
native: PropTypes.bool,
/**
* Callback function fired when a menu item is selected.
*
* @param {object} event The event source of the callback.
* You can pull out the new value by accessing `event.target.value`.
* @param {object} [child] The react element that was selected when `native` is `false` (default).
*/
onChange: PropTypes.func,
/**
* Callback fired when the component requests to be closed.
* Use in controlled mode (see open).
*
* @param {object} event The event source of the callback
*/
onClose: PropTypes.func,
/**
* Callback fired when the component requests to be opened.
* Use in controlled mode (see open).
*
* @param {object} event The event source of the callback
*/
onOpen: PropTypes.func,
/**
* Control `select` open state.
* You can only use it when the `native` property is `false` (default).
*/
open: PropTypes.bool,
/**
* Render the selected value.
* You can only use it when the `native` property is `false` (default).
*
* @param {*} value The `value` provided to the component.
* @returns {ReactElement}
*/
renderValue: PropTypes.func,
/**
* Properties applied to the clickable div element.
*/
SelectDisplayProps: PropTypes.object,
/**
* The input value.
* This property is required when the `native` property is `false` (default).
*/
value: PropTypes.oneOfType([
PropTypes.string,
PropTypes.number,
PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.string, PropTypes.number])),
]),
};
Select.defaultProps = {
autoWidth: false,
displayEmpty: false,
IconComponent: ArrowDropDownIcon,
input: <Input />,
multiple: false,
native: false,
};
Select.muiName = 'Select';
export default withStyles(nativeSelectStyles, { name: 'MuiSelect' })(Select);