doj-react-adminlte
Version:
Simple and easy-to-use AdminLTE components for React
74 lines (69 loc) • 2.11 kB
TypeScript
import * as React from 'react';
export interface SelectInputProps {
/**
* When set to true, allows clearing of current selection
*/
clearable?: boolean;
/**
* Setting to true disables interaction with component
*/
disabled?: boolean;
/**
* Accepts an object of errors having the property key as the name of
* the component and property value as an array of error messages. See
* Forms > Usage page for example.
*/
errors?: any;
/**
* Specifies a Bootstrap 3 grid class
*/
gridClass?: string;
/**
* Specifies the component label
*/
label?: React.ReactNode;
/**
* Specifies the component name. It is used to distinguish elements
* for a single form change handler
*/
name: string;
/**
* Callback fired when the component value changes.
* Accepts a function with two parameters, the first being the component name prop
* and the second being the selected value
*/
onChange?: (...args: any[])=>any;
/**
* Callback used to determine the label to display for each option in the options property
*/
getOptionLabel?: (...args: any[])=>any;
/**
* Callback used to determine the determining value (such as a unique ID) for each option
* in the options property
*/
getOptionValue?: (...args: any[])=>any;
/**
* Array of objects that populate the select menu
*/
options?: any[];
/**
* Placeholder for the select component
*/
placeholder?: string;
/**
* Setting to true enables option search functionality
*/
searchable?: boolean;
/**
* Setting to true sets the onChange second parameter to the value returned by getOptionValue
* instead of the option object itself
*/
simpleValue?: boolean;
/**
* The currently selected value.
*/
value?: any;
}
export default class SelectInput extends React.Component<SelectInputProps, any> {
render(): JSX.Element;
}