@instructure/ui-text-area 8.13.1-snapshot.9 → 8.14.0

package/types/TextArea/index.d.ts

@@ -1,12 +1,12 @@
 /** @jsx jsx */
 import { Component } from 'react';
-import type { RequestAnimationFrameType } from '@instructure/ui-dom-utils';
 import { jsx } from '@instructure/emotion';
 import type { TextAreaProps } from './props';
 /**
 ---
 category: components
 ---
+@tsProps
 **/
 declare class TextArea extends Component<TextAreaProps> {
     static readonly componentId = "TextArea";
@@ -26,10 +26,10 @@ declare class TextArea extends Component<TextAreaProps> {
         disabled?: boolean | undefined;
         readOnly?: boolean | undefined;
         required?: boolean | undefined;
-        textareaRef?: ((...args: any[]) => any) | undefined;
+        textareaRef?: ((textarea: HTMLTextAreaElement | null) => void) | undefined;
         defaultValue?: string | undefined;
-        value?: any;
-        onChange?: ((...args: any[]) => any) | undefined;
+        value?: string | undefined;
+        onChange?: ((event: import("react").ChangeEvent<HTMLTextAreaElement>) => void) | undefined;
     })[];
     static propTypes: import("@instructure/shared-types/types/UtilityTypes").PropValidators<keyof {
         label: import("react").ReactNode;
@@ -47,10 +47,10 @@ declare class TextArea extends Component<TextAreaProps> {
         disabled?: boolean | undefined;
         readOnly?: boolean | undefined;
         required?: boolean | undefined;
-        textareaRef?: ((...args: any[]) => any) | undefined;
+        textareaRef?: ((textarea: HTMLTextAreaElement | null) => void) | undefined;
         defaultValue?: string | undefined;
-        value?: any;
-        onChange?: ((...args: any[]) => any) | undefined;
+        value?: string | undefined;
+        onChange?: ((event: import("react").ChangeEvent<HTMLTextAreaElement>) => void) | undefined;
     }>;
     static defaultProps: {
         size: string;
@@ -60,29 +60,33 @@ declare class TextArea extends Component<TextAreaProps> {
         messages: never[];
         disabled: boolean;
         readOnly: boolean;
-        textareaRef: (textarea: any) => void;
         layout: string;
         required: boolean;
     };
-    _listener: {
-        remove(): void;
-    } | null;
-    _request: RequestAnimationFrameType | undefined;
-    constructor();
+    private _listener?;
+    private _request?;
+    private _defaultId;
+    private _textareaResizeListener?;
+    private _debounced?;
+    private _textarea;
+    private _container;
+    private _height?;
+    private _manuallyResized;
+    constructor(props: TextAreaProps);
     componentDidMount(): void;
-    componentDidUpdate(prevProps: any, prevState: any, snapshot: any): void;
+    componentDidUpdate(): void;
     componentWillUnmount(): void;
-    _textareaResize: (evt: any) => void;
+    _textareaResize: () => void;
     autoGrow(): void;
-    grow: (evt: any) => void;
+    grow: () => void;
     focus(): void;
-    handleChange: (event: any) => void;
-    handleContainerRef: (node: any) => void;
-    get minHeight(): any;
+    handleChange: (event: React.ChangeEvent<HTMLTextAreaElement>) => void;
+    handleContainerRef: (node: HTMLDivElement | null) => void;
+    get minHeight(): string;
     get invalid(): boolean | undefined;
-    get id(): any;
+    get id(): string;
     get focused(): boolean;
-    get value(): any;
+    get value(): string;
     render(): jsx.JSX.Element;
 }
 export default TextArea;

package/types/TextArea/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/TextArea/index.tsx"],"names":[],"mappings":"AAwBA,eAAe;AACf,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAQjC,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,2BAA2B,CAAA;AAE1E,OAAO,EAAa,GAAG,EAAE,MAAM,sBAAsB,CAAA;AAQrD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAG5C;;;;GAIG;AACH,cAEM,QAAS,SAAQ,SAAS,CAAC,aAAa,CAAC;IAC7C,MAAM,CAAC,QAAQ,CAAC,WAAW,cAAa;IAExC,MAAM,CAAC,YAAY;;;;;;;;;;;;;;;;;;;;SAAe;IAClC,MAAM,CAAC,SAAS;;;;;;;;;;;;;;;;;;;;OAAY;IAE5B,MAAM,CAAC,YAAY;;;;;;;;;;;MAYlB;IAED,SAAS,EAAE;QAAE,MAAM,IAAI,IAAI,CAAA;KAAE,GAAG,IAAI,CAAO;IAC3C,QAAQ,EAAE,yBAAyB,GAAG,SAAS,CAAA;;IAU/C,iBAAiB;IAMjB,kBAAkB,CAAC,SAAS,KAAA,EAAE,SAAS,KAAA,EAAE,QAAQ,KAAA;IAKjD,oBAAoB;IAuBpB,eAAe,qBAcd;IAED,QAAQ;IAyCR,IAAI,qBAoDH;IAED,KAAK;IAML,YAAY,uBAgBX;IAGD,kBAAkB,sBAGjB;IAED,IAAI,SAAS,QAGZ;IAED,IAAI,OAAO,wBAOV;IAED,IAAI,EAAE,QAGL;IAED,IAAI,OAAO,YAGV;IAED,IAAI,KAAK,QAGR;IAED,MAAM;CA4EP;AAED,eAAe,QAAQ,CAAA;AACvB,OAAO,EAAE,QAAQ,EAAE,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/TextArea/index.tsx"],"names":[],"mappings":"AAwBA,eAAe;AACf,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAWjC,OAAO,EAAa,GAAG,EAAE,MAAM,sBAAsB,CAAA;AAQrD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAG5C;;;;;GAKG;AACH,cAEM,QAAS,SAAQ,SAAS,CAAC,aAAa,CAAC;IAC7C,MAAM,CAAC,QAAQ,CAAC,WAAW,cAAa;IAExC,MAAM,CAAC,YAAY;;;;;;;;;;;;;;;;;;;;SAAe;IAClC,MAAM,CAAC,SAAS;;;;;;;;;;;;;;;;;;;;OAAY;IAE5B,MAAM,CAAC,YAAY;;;;;;;;;;MAUlB;IAED,OAAO,CAAC,SAAS,CAAC,CAAoB;IACtC,OAAO,CAAC,QAAQ,CAAC,CAA2B;IAC5C,OAAO,CAAC,UAAU,CAAQ;IAC1B,OAAO,CAAC,uBAAuB,CAAC,CAAgB;IAChD,OAAO,CAAC,UAAU,CAAC,CAAW;IAC9B,OAAO,CAAC,SAAS,CAAmC;IACpD,OAAO,CAAC,UAAU,CAA8B;IAChD,OAAO,CAAC,OAAO,CAAC,CAAQ;IACxB,OAAO,CAAC,gBAAgB,CAAQ;gBAEpB,KAAK,EAAE,aAAa;IAMhC,iBAAiB;IAKjB,kBAAkB;IAKlB,oBAAoB;IAkBpB,eAAe,aASd;IAED,QAAQ;IAgCR,IAAI,aA4CH;IAED,KAAK;IAIL,YAAY,UAAW,MAAM,WAAW,CAAC,mBAAmB,CAAC,UAgB5D;IAED,kBAAkB,SAAU,cAAc,GAAG,IAAI,UAEhD;IAED,IAAI,SAAS,WAEZ;IAED,IAAI,OAAO,wBAOV;IAED,IAAI,EAAE,WAEL;IAED,IAAI,OAAO,YAEV;IAED,IAAI,KAAK,WAER;IAED,MAAM;CAuEP;AAED,eAAe,QAAQ,CAAA;AACvB,OAAO,EAAE,QAAQ,EAAE,CAAA"}

package/types/TextArea/props.d.ts

@@ -1,31 +1,83 @@
+import React from 'react';
+import type { TextareaHTMLAttributes } from 'react';
 import type { OtherHTMLAttributes, PropValidators, TextAreaTheme } from '@instructure/shared-types';
-import type { FormMessage } from '@instructure/ui-form-field';
+import type { FormMessage, FormFieldOwnProps } from '@instructure/ui-form-field';
 import type { WithStyleProps, ComponentStyle } from '@instructure/emotion';
-import { TextareaHTMLAttributes } from 'react';
 declare type TextAreaOwnProps = {
     label: React.ReactNode;
     id?: string;
+    /**
+     * sets the font-size for the textarea
+     */
     size?: 'small' | 'medium' | 'large';
     layout?: 'stacked' | 'inline';
+    /**
+     * the textarea will expand vertically to fit the height of the content,
+     * unless its content exceeds `maxHeight`
+     */
     autoGrow?: boolean;
+    /**
+     * is the textarea resizable (in supported browsers)
+     */
     resize?: 'none' | 'both' | 'horizontal' | 'vertical';
+    /**
+     * a fixed width for the textarea
+     */
     width?: string;
+    /**
+     * Initial height for the textarea (if autoGrow is true it will grow vertically)
+     * Accepts CSS units, e.g. '55px'
+     */
     height?: string;
+    /**
+     * when autoGrow is true, the textarea will never grow beyond this value
+     */
     maxHeight?: number | string;
+    /**
+     * Array of objects with shape: `{
+     *   text: React.ReactNode,
+     *   type: One of: ['error', 'hint', 'success', 'screenreader-only']
+     * }`
+     */
     messages?: FormMessage[];
     inline?: boolean;
+    /**
+     * Html placeholder text to display when the input has no value. This should be hint text, not a label
+     * replacement.
+     */
     placeholder?: string;
+    /**
+     * Whether or not to disable the textarea
+     */
     disabled?: boolean;
+    /**
+     * Works just like disabled but keeps the same styles as if it were active
+     */
     readOnly?: boolean;
+    /**
+     * Sets the required property on the underlying native textArea
+     */
     required?: boolean;
-    textareaRef?: (...args: any[]) => any;
+    /**
+     * a function that provides a reference to the actual textarea element
+     */
+    textareaRef?: (textarea: HTMLTextAreaElement | null) => void;
+    /**
+     * value to set on initial render
+     */
     defaultValue?: string;
-    value?: any;
-    onChange?: (...args: any[]) => any;
+    /**
+     * the selected value (must be accompanied by an `onChange` prop)
+     */
+    value?: string;
+    /**
+     * when used with the `value` prop, the component will not control its own state
+     */
+    onChange?: (event: React.ChangeEvent<HTMLTextAreaElement>) => void;
 };
 declare type PropKeys = keyof TextAreaOwnProps;
 declare type AllowedPropKeys = Readonly<Array<PropKeys>>;
-declare type TextAreaProps = TextAreaOwnProps & WithStyleProps<TextAreaTheme, TextAreaStyle> & OtherHTMLAttributes<TextAreaOwnProps, TextareaHTMLAttributes<TextAreaOwnProps>>;
+declare type TextAreaProps = Omit<FormFieldOwnProps, 'label' | 'inline' | 'id' | 'elementRef'> & TextAreaOwnProps & WithStyleProps<TextAreaTheme, TextAreaStyle> & OtherHTMLAttributes<TextAreaOwnProps, TextareaHTMLAttributes<TextAreaOwnProps>>;
 declare type TextAreaStyle = ComponentStyle<'textArea' | 'textAreaLayout' | 'textAreaOutline'>;
 declare const propTypes: PropValidators<PropKeys>;
 declare const allowedProps: AllowedPropKeys;

package/types/TextArea/props.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../src/TextArea/props.ts"],"names":[],"mappings":"AA6BA,OAAO,KAAK,EACV,mBAAmB,EACnB,cAAc,EACd,aAAa,EACd,MAAM,2BAA2B,CAAA;AAClC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAA;AAC7D,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAC1E,OAAO,EAAE,sBAAsB,EAAE,MAAM,OAAO,CAAA;AAE9C,aAAK,gBAAgB,GAAG;IACtB,KAAK,EAAE,KAAK,CAAC,SAAS,CAAA;IACtB,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,IAAI,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,OAAO,CAAA;IACnC,MAAM,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAA;IAC7B,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,YAAY,GAAG,UAAU,CAAA;IACpD,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IAC3B,QAAQ,CAAC,EAAE,WAAW,EAAE,CAAA;IACxB,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,WAAW,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IACrC,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,KAAK,CAAC,EAAE,GAAG,CAAA;IACX,QAAQ,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;CACnC,CAAA;AAED,aAAK,QAAQ,GAAG,MAAM,gBAAgB,CAAA;AAEtC,aAAK,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA;AAEhD,aAAK,aAAa,GAAG,gBAAgB,GACnC,cAAc,CAAC,aAAa,EAAE,aAAa,CAAC,GAC5C,mBAAmB,CACjB,gBAAgB,EAChB,sBAAsB,CAAC,gBAAgB,CAAC,CACzC,CAAA;AAEH,aAAK,aAAa,GAAG,cAAc,CACjC,UAAU,GAAG,gBAAgB,GAAG,iBAAiB,CAClD,CAAA;AAED,QAAA,MAAM,SAAS,EAAE,cAAc,CAAC,QAAQ,CAuEvC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eAoBnB,CAAA;AAED,YAAY,EAAE,aAAa,EAAE,aAAa,EAAE,CAAA;AAC5C,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAA"}
+{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../src/TextArea/props.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,MAAM,OAAO,CAAA;AACzB,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,OAAO,CAAA;AAMnD,OAAO,KAAK,EACV,mBAAmB,EACnB,cAAc,EACd,aAAa,EACd,MAAM,2BAA2B,CAAA;AAClC,OAAO,KAAK,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAA;AAChF,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAE1E,aAAK,gBAAgB,GAAG;IACtB,KAAK,EAAE,KAAK,CAAC,SAAS,CAAA;IACtB,EAAE,CAAC,EAAE,MAAM,CAAA;IACX;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,OAAO,CAAA;IACnC,MAAM,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAA;IAC7B;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,YAAY,GAAG,UAAU,CAAA;IACpD;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IAC3B;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,WAAW,EAAE,CAAA;IACxB,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB;;OAEG;IACH,WAAW,CAAC,EAAE,CAAC,QAAQ,EAAE,mBAAmB,GAAG,IAAI,KAAK,IAAI,CAAA;IAC5D;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,WAAW,CAAC,mBAAmB,CAAC,KAAK,IAAI,CAAA;CACnE,CAAA;AAED,aAAK,QAAQ,GAAG,MAAM,gBAAgB,CAAA;AAEtC,aAAK,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA;AAEhD,aAAK,aAAa,GAEhB,IAAI,CAAC,iBAAiB,EAAE,OAAO,GAAG,QAAQ,GAAG,IAAI,GAAG,YAAY,CAAC,GAC/D,gBAAgB,GAChB,cAAc,CAAC,aAAa,EAAE,aAAa,CAAC,GAC5C,mBAAmB,CACjB,gBAAgB,EAChB,sBAAsB,CAAC,gBAAgB,CAAC,CACzC,CAAA;AAEL,aAAK,aAAa,GAAG,cAAc,CACjC,UAAU,GAAG,gBAAgB,GAAG,iBAAiB,CAClD,CAAA;AAED,QAAA,MAAM,SAAS,EAAE,cAAc,CAAC,QAAQ,CAoBvC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eAoBnB,CAAA;AAED,YAAY,EAAE,aAAa,EAAE,aAAa,EAAE,CAAA;AAC5C,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAA"}

package/LICENSE.md

@@ -1,27 +0,0 @@
----
-title: The MIT License (MIT)
-category: Getting Started
-order: 9
----
-
-# The MIT License (MIT)
-
-Copyright (c) 2015 Instructure, Inc.
-
-**Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions.**
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.