@patternfly/react-core
Version:
This library provides a set of common React components for use with the PatternFly reference implementation.
40 lines • 1.8 kB
TypeScript
import { HTMLProps } from 'react';
export declare enum TextAreResizeOrientation {
horizontal = "horizontal",
vertical = "vertical",
both = "both",
none = "none"
}
export declare enum TextAreaReadOnlyVariant {
default = "default",
plain = "plain"
}
export interface TextAreaProps extends Omit<HTMLProps<HTMLTextAreaElement>, 'onChange' | 'ref'> {
/** Additional classes added to the text area. */
className?: string;
/** Flag to show if the text area is required. */
isRequired?: boolean;
/** Flag to show if the text area is disabled. */
isDisabled?: boolean;
/** Read only variant. */
readOnlyVariant?: 'default' | 'plain';
/** Flag to modify height based on contents. */
autoResize?: boolean;
/** Value to indicate if the text area is modified to show that validation state.
* If set to success, text area will be modified to indicate valid state.
* If set to error, text area will be modified to indicate error state.
*/
validated?: 'success' | 'warning' | 'error' | 'default';
/** Value of the text area. */
value?: string | number;
/** A callback for when the text area value changes. */
onChange?: (event: React.ChangeEvent<HTMLTextAreaElement>, value: string) => void;
/** Sets the orientation to limit the resize to */
resizeOrientation?: 'horizontal' | 'vertical' | 'both' | 'none';
/** Custom flag to show that the text area requires an associated id or aria-label. */
'aria-label'?: string;
/** @hide A reference object to attach to the text area. */
innerRef?: React.RefObject<any>;
}
export declare const TextArea: import("react").ForwardRefExoticComponent<TextAreaProps & import("react").RefAttributes<HTMLTextAreaElement>>;
//# sourceMappingURL=TextArea.d.ts.map