@atlaskit/textarea 4.5.1 → 4.5.2

package/report.api.md

@@ -1,6 +1,10 @@
-## API Report File for "@atlaskit/textarea".
+## API Report File for "@atlaskit/textarea"
 
-> Do not edit this file. This report is auto-generated by [API Extractor](https://api-extractor.com/).
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+<!--
+	Generated API Report version: 2.0
+-->
 
 [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
 
@@ -13,396 +17,324 @@ import { ReactNode } from 'react';
 import { ThemeProp } from '@atlaskit/theme/components';
 import { WithAnalyticsEventsProps } from '@atlaskit/analytics-next';
 
-declare type Combine<First, Second> = Omit<First, keyof Second> & Second;
+// @public (undocumented)
+type Combine<First, Second> = Omit<First, keyof Second> & Second;
 
-declare interface OwnProps extends WithAnalyticsEventsProps {
-  /**
-   * controls the appearance of the field.
-   * subtle shows styling on hover.
-   * none prevents all field styling.
-   */
+// @public (undocumented)
+interface OwnProps extends WithAnalyticsEventsProps {
   appearance?: 'standard' | 'subtle' | 'none';
-  /**
-   * Set whether the fields should expand to fill available horizontal space.
-   */
+  defaultValue?: string;
   isCompact?: boolean;
-  /**
-   * Sets the field as uneditable, with a changed hover state.
-   */
   isDisabled?: boolean;
-  /**
-   * If true, prevents the value of the input from being edited.
-   */
+  isInvalid?: boolean;
+  isMonospaced?: boolean;
   isReadOnly?: boolean;
-  /**
-   * Set required for form that the field is part of.
-   */
   isRequired?: boolean;
-  /**
-   * Sets styling to indicate that the input is invalid.
-   */
-  isInvalid?: boolean;
-  /**
-   * The minimum number of rows of text to display
-   */
-  minimumRows?: number;
-  /**
-   * The maxheight of the textarea
-   */
   maxHeight?: string;
-  /**
-   * The value of the text-area.
-   */
-  value?: string;
-  /**
-   * The default value of the textarea
-   */
-  defaultValue?: string;
-  /**
-   * Name of the input form control
-   */
+  minimumRows?: number;
   name?: string;
-  /**
-   * The placeholder within the textarea
-   */
-  placeholder?: string;
-  /**
-   * Handler to be called when the input is blurred
-   */
   onBlur?: React_2.FocusEventHandler<HTMLTextAreaElement>;
-  /**
-   * Handler to be called when the input changes.
-   */
   onChange?: React_2.ChangeEventHandler<HTMLTextAreaElement>;
-  /**
-   * Handler to be called when the input is focused
-   */
   onFocus?: React_2.FocusEventHandler<HTMLTextAreaElement>;
-  /**
-   * Sets content text value to monospace
-   */
-  isMonospaced?: boolean;
-  /**
-   * Enables the resizing of the textarea:
-   * auto: both directions.
-   * horizontal: only along the x axis.
-   * vertical: only along the y axis.
-   * smart (default): vertically grows and shrinks the textarea automatically to wrap your input text.
-   * none: explicitly disallow resizing on the textarea.
-   */
+  placeholder?: string;
   resize?: 'auto' | 'vertical' | 'horizontal' | 'smart' | 'none';
-  /**
-   * Enables native spell check on the `textarea` element.
-   */
   spellCheck?: boolean;
-  /**
-   * The theme function TextArea consumes to derive theming constants for use in styling its components
-   */
-  theme?: any;
-  /**
-   * A `testId` prop is provided for specified elements, which is a unique
-   * string that appears as a data attribute `data-testid` in the rendered code,
-   * serving as a hook for automated tests
-   */
   testId?: string;
+  theme?: any;
+  value?: string;
 }
 
-/**
- * __Text area__
- *
- * A text area lets users enter long form text which spans over multiple lines.
- *
- * - [Examples](https://atlassian.design/components/textarea/examples)
- * - [Code](https://atlassian.design/components/textarea/code)
- * - [Usage](https://atlassian.design/components/textarea/usage)
- */
-declare const TextArea: React_2.MemoExoticComponent<React_2.ForwardRefExoticComponent<
-  Pick<
-    TextAreaProps,
-    | 'appearance'
-    | 'color'
-    | 'maxHeight'
-    | 'resize'
-    | 'hidden'
-    | 'style'
-    | 'wrap'
-    | 'minimumRows'
-    | 'isMonospaced'
-    | 'autoComplete'
-    | 'autoFocus'
-    | 'cols'
-    | 'dirName'
-    | 'form'
-    | 'maxLength'
-    | 'minLength'
-    | 'name'
-    | 'placeholder'
-    | 'readOnly'
-    | 'rows'
-    | 'value'
-    | 'onChange'
-    | 'defaultChecked'
-    | 'defaultValue'
-    | 'suppressContentEditableWarning'
-    | 'suppressHydrationWarning'
-    | 'accessKey'
-    | 'className'
-    | 'contentEditable'
-    | 'contextMenu'
-    | 'dir'
-    | 'draggable'
-    | 'id'
-    | 'lang'
-    | 'slot'
-    | 'spellCheck'
-    | 'tabIndex'
-    | 'title'
-    | 'inputMode'
-    | 'is'
-    | 'radioGroup'
-    | 'role'
-    | 'about'
-    | 'datatype'
-    | 'inlist'
-    | 'prefix'
-    | 'property'
-    | 'resource'
-    | 'typeof'
-    | 'vocab'
-    | 'autoCapitalize'
-    | 'autoCorrect'
-    | 'autoSave'
-    | 'itemProp'
-    | 'itemScope'
-    | 'itemType'
-    | 'itemID'
-    | 'itemRef'
-    | 'results'
-    | 'security'
-    | 'unselectable'
-    | 'aria-activedescendant'
-    | 'aria-atomic'
-    | 'aria-autocomplete'
-    | 'aria-busy'
-    | 'aria-checked'
-    | 'aria-colcount'
-    | 'aria-colindex'
-    | 'aria-colspan'
-    | 'aria-controls'
-    | 'aria-current'
-    | 'aria-describedby'
-    | 'aria-details'
-    | 'aria-disabled'
-    | 'aria-dropeffect'
-    | 'aria-errormessage'
-    | 'aria-expanded'
-    | 'aria-flowto'
-    | 'aria-grabbed'
-    | 'aria-haspopup'
-    | 'aria-hidden'
-    | 'aria-invalid'
-    | 'aria-keyshortcuts'
-    | 'aria-label'
-    | 'aria-labelledby'
-    | 'aria-level'
-    | 'aria-live'
-    | 'aria-modal'
-    | 'aria-multiline'
-    | 'aria-multiselectable'
-    | 'aria-orientation'
-    | 'aria-owns'
-    | 'aria-placeholder'
-    | 'aria-posinset'
-    | 'aria-pressed'
-    | 'aria-readonly'
-    | 'aria-relevant'
-    | 'aria-required'
-    | 'aria-roledescription'
-    | 'aria-rowcount'
-    | 'aria-rowindex'
-    | 'aria-rowspan'
-    | 'aria-selected'
-    | 'aria-setsize'
-    | 'aria-sort'
-    | 'aria-valuemax'
-    | 'aria-valuemin'
-    | 'aria-valuenow'
-    | 'aria-valuetext'
-    | 'children'
-    | 'dangerouslySetInnerHTML'
-    | 'onCopy'
-    | 'onCopyCapture'
-    | 'onCut'
-    | 'onCutCapture'
-    | 'onPaste'
-    | 'onPasteCapture'
-    | 'onCompositionEnd'
-    | 'onCompositionEndCapture'
-    | 'onCompositionStart'
-    | 'onCompositionStartCapture'
-    | 'onCompositionUpdate'
-    | 'onCompositionUpdateCapture'
-    | 'onFocus'
-    | 'onFocusCapture'
-    | 'onBlur'
-    | 'onBlurCapture'
-    | 'onChangeCapture'
-    | 'onBeforeInput'
-    | 'onBeforeInputCapture'
-    | 'onInput'
-    | 'onInputCapture'
-    | 'onReset'
-    | 'onResetCapture'
-    | 'onSubmit'
-    | 'onSubmitCapture'
-    | 'onInvalid'
-    | 'onInvalidCapture'
-    | 'onLoad'
-    | 'onLoadCapture'
-    | 'onError'
-    | 'onErrorCapture'
-    | 'onKeyDown'
-    | 'onKeyDownCapture'
-    | 'onKeyPress'
-    | 'onKeyPressCapture'
-    | 'onKeyUp'
-    | 'onKeyUpCapture'
-    | 'onAbort'
-    | 'onAbortCapture'
-    | 'onCanPlay'
-    | 'onCanPlayCapture'
-    | 'onCanPlayThrough'
-    | 'onCanPlayThroughCapture'
-    | 'onDurationChange'
-    | 'onDurationChangeCapture'
-    | 'onEmptied'
-    | 'onEmptiedCapture'
-    | 'onEncrypted'
-    | 'onEncryptedCapture'
-    | 'onEnded'
-    | 'onEndedCapture'
-    | 'onLoadedData'
-    | 'onLoadedDataCapture'
-    | 'onLoadedMetadata'
-    | 'onLoadedMetadataCapture'
-    | 'onLoadStart'
-    | 'onLoadStartCapture'
-    | 'onPause'
-    | 'onPauseCapture'
-    | 'onPlay'
-    | 'onPlayCapture'
-    | 'onPlaying'
-    | 'onPlayingCapture'
-    | 'onProgress'
-    | 'onProgressCapture'
-    | 'onRateChange'
-    | 'onRateChangeCapture'
-    | 'onSeeked'
-    | 'onSeekedCapture'
-    | 'onSeeking'
-    | 'onSeekingCapture'
-    | 'onStalled'
-    | 'onStalledCapture'
-    | 'onSuspend'
-    | 'onSuspendCapture'
-    | 'onTimeUpdate'
-    | 'onTimeUpdateCapture'
-    | 'onVolumeChange'
-    | 'onVolumeChangeCapture'
-    | 'onWaiting'
-    | 'onWaitingCapture'
-    | 'onAuxClick'
-    | 'onAuxClickCapture'
-    | 'onClick'
-    | 'onClickCapture'
-    | 'onContextMenu'
-    | 'onContextMenuCapture'
-    | 'onDoubleClick'
-    | 'onDoubleClickCapture'
-    | 'onDrag'
-    | 'onDragCapture'
-    | 'onDragEnd'
-    | 'onDragEndCapture'
-    | 'onDragEnter'
-    | 'onDragEnterCapture'
-    | 'onDragExit'
-    | 'onDragExitCapture'
-    | 'onDragLeave'
-    | 'onDragLeaveCapture'
-    | 'onDragOver'
-    | 'onDragOverCapture'
-    | 'onDragStart'
-    | 'onDragStartCapture'
-    | 'onDrop'
-    | 'onDropCapture'
-    | 'onMouseDown'
-    | 'onMouseDownCapture'
-    | 'onMouseEnter'
-    | 'onMouseLeave'
-    | 'onMouseMove'
-    | 'onMouseMoveCapture'
-    | 'onMouseOut'
-    | 'onMouseOutCapture'
-    | 'onMouseOver'
-    | 'onMouseOverCapture'
-    | 'onMouseUp'
-    | 'onMouseUpCapture'
-    | 'onSelect'
-    | 'onSelectCapture'
-    | 'onTouchCancel'
-    | 'onTouchCancelCapture'
-    | 'onTouchEnd'
-    | 'onTouchEndCapture'
-    | 'onTouchMove'
-    | 'onTouchMoveCapture'
-    | 'onTouchStart'
-    | 'onTouchStartCapture'
-    | 'onPointerDown'
-    | 'onPointerDownCapture'
-    | 'onPointerMove'
-    | 'onPointerMoveCapture'
-    | 'onPointerUp'
-    | 'onPointerUpCapture'
-    | 'onPointerCancel'
-    | 'onPointerCancelCapture'
-    | 'onPointerEnter'
-    | 'onPointerEnterCapture'
-    | 'onPointerLeave'
-    | 'onPointerLeaveCapture'
-    | 'onPointerOver'
-    | 'onPointerOverCapture'
-    | 'onPointerOut'
-    | 'onPointerOutCapture'
-    | 'onGotPointerCapture'
-    | 'onGotPointerCaptureCapture'
-    | 'onLostPointerCapture'
-    | 'onLostPointerCaptureCapture'
-    | 'onScroll'
-    | 'onScrollCapture'
-    | 'onWheel'
-    | 'onWheelCapture'
-    | 'onAnimationStart'
-    | 'onAnimationStartCapture'
-    | 'onAnimationEnd'
-    | 'onAnimationEndCapture'
-    | 'onAnimationIteration'
-    | 'onAnimationIterationCapture'
-    | 'onTransitionEnd'
-    | 'onTransitionEndCapture'
-    | 'isCompact'
-    | 'isDisabled'
-    | 'isReadOnly'
-    | 'isRequired'
-    | 'isInvalid'
-    | 'theme'
-    | 'testId'
-    | 'createAnalyticsEvent'
-  > &
-    React_2.RefAttributes<HTMLTextAreaElement>
->>;
+// @public
+const TextArea: React_2.MemoExoticComponent<
+  React_2.ForwardRefExoticComponent<
+    Pick<
+      TextAreaProps,
+      | 'appearance'
+      | 'color'
+      | 'maxHeight'
+      | 'resize'
+      | 'hidden'
+      | 'style'
+      | 'wrap'
+      | 'minimumRows'
+      | 'isMonospaced'
+      | 'autoComplete'
+      | 'autoFocus'
+      | 'cols'
+      | 'dirName'
+      | 'form'
+      | 'maxLength'
+      | 'minLength'
+      | 'name'
+      | 'placeholder'
+      | 'readOnly'
+      | 'rows'
+      | 'value'
+      | 'onChange'
+      | 'defaultChecked'
+      | 'defaultValue'
+      | 'suppressContentEditableWarning'
+      | 'suppressHydrationWarning'
+      | 'accessKey'
+      | 'className'
+      | 'contentEditable'
+      | 'contextMenu'
+      | 'dir'
+      | 'draggable'
+      | 'id'
+      | 'lang'
+      | 'slot'
+      | 'spellCheck'
+      | 'tabIndex'
+      | 'title'
+      | 'inputMode'
+      | 'is'
+      | 'radioGroup'
+      | 'role'
+      | 'about'
+      | 'datatype'
+      | 'inlist'
+      | 'prefix'
+      | 'property'
+      | 'resource'
+      | 'typeof'
+      | 'vocab'
+      | 'autoCapitalize'
+      | 'autoCorrect'
+      | 'autoSave'
+      | 'itemProp'
+      | 'itemScope'
+      | 'itemType'
+      | 'itemID'
+      | 'itemRef'
+      | 'results'
+      | 'security'
+      | 'unselectable'
+      | 'aria-activedescendant'
+      | 'aria-atomic'
+      | 'aria-autocomplete'
+      | 'aria-busy'
+      | 'aria-checked'
+      | 'aria-colcount'
+      | 'aria-colindex'
+      | 'aria-colspan'
+      | 'aria-controls'
+      | 'aria-current'
+      | 'aria-describedby'
+      | 'aria-details'
+      | 'aria-disabled'
+      | 'aria-dropeffect'
+      | 'aria-errormessage'
+      | 'aria-expanded'
+      | 'aria-flowto'
+      | 'aria-grabbed'
+      | 'aria-haspopup'
+      | 'aria-hidden'
+      | 'aria-invalid'
+      | 'aria-keyshortcuts'
+      | 'aria-label'
+      | 'aria-labelledby'
+      | 'aria-level'
+      | 'aria-live'
+      | 'aria-modal'
+      | 'aria-multiline'
+      | 'aria-multiselectable'
+      | 'aria-orientation'
+      | 'aria-owns'
+      | 'aria-placeholder'
+      | 'aria-posinset'
+      | 'aria-pressed'
+      | 'aria-readonly'
+      | 'aria-relevant'
+      | 'aria-required'
+      | 'aria-roledescription'
+      | 'aria-rowcount'
+      | 'aria-rowindex'
+      | 'aria-rowspan'
+      | 'aria-selected'
+      | 'aria-setsize'
+      | 'aria-sort'
+      | 'aria-valuemax'
+      | 'aria-valuemin'
+      | 'aria-valuenow'
+      | 'aria-valuetext'
+      | 'children'
+      | 'dangerouslySetInnerHTML'
+      | 'onCopy'
+      | 'onCopyCapture'
+      | 'onCut'
+      | 'onCutCapture'
+      | 'onPaste'
+      | 'onPasteCapture'
+      | 'onCompositionEnd'
+      | 'onCompositionEndCapture'
+      | 'onCompositionStart'
+      | 'onCompositionStartCapture'
+      | 'onCompositionUpdate'
+      | 'onCompositionUpdateCapture'
+      | 'onFocus'
+      | 'onFocusCapture'
+      | 'onBlur'
+      | 'onBlurCapture'
+      | 'onChangeCapture'
+      | 'onBeforeInput'
+      | 'onBeforeInputCapture'
+      | 'onInput'
+      | 'onInputCapture'
+      | 'onReset'
+      | 'onResetCapture'
+      | 'onSubmit'
+      | 'onSubmitCapture'
+      | 'onInvalid'
+      | 'onInvalidCapture'
+      | 'onLoad'
+      | 'onLoadCapture'
+      | 'onError'
+      | 'onErrorCapture'
+      | 'onKeyDown'
+      | 'onKeyDownCapture'
+      | 'onKeyPress'
+      | 'onKeyPressCapture'
+      | 'onKeyUp'
+      | 'onKeyUpCapture'
+      | 'onAbort'
+      | 'onAbortCapture'
+      | 'onCanPlay'
+      | 'onCanPlayCapture'
+      | 'onCanPlayThrough'
+      | 'onCanPlayThroughCapture'
+      | 'onDurationChange'
+      | 'onDurationChangeCapture'
+      | 'onEmptied'
+      | 'onEmptiedCapture'
+      | 'onEncrypted'
+      | 'onEncryptedCapture'
+      | 'onEnded'
+      | 'onEndedCapture'
+      | 'onLoadedData'
+      | 'onLoadedDataCapture'
+      | 'onLoadedMetadata'
+      | 'onLoadedMetadataCapture'
+      | 'onLoadStart'
+      | 'onLoadStartCapture'
+      | 'onPause'
+      | 'onPauseCapture'
+      | 'onPlay'
+      | 'onPlayCapture'
+      | 'onPlaying'
+      | 'onPlayingCapture'
+      | 'onProgress'
+      | 'onProgressCapture'
+      | 'onRateChange'
+      | 'onRateChangeCapture'
+      | 'onSeeked'
+      | 'onSeekedCapture'
+      | 'onSeeking'
+      | 'onSeekingCapture'
+      | 'onStalled'
+      | 'onStalledCapture'
+      | 'onSuspend'
+      | 'onSuspendCapture'
+      | 'onTimeUpdate'
+      | 'onTimeUpdateCapture'
+      | 'onVolumeChange'
+      | 'onVolumeChangeCapture'
+      | 'onWaiting'
+      | 'onWaitingCapture'
+      | 'onAuxClick'
+      | 'onAuxClickCapture'
+      | 'onClick'
+      | 'onClickCapture'
+      | 'onContextMenu'
+      | 'onContextMenuCapture'
+      | 'onDoubleClick'
+      | 'onDoubleClickCapture'
+      | 'onDrag'
+      | 'onDragCapture'
+      | 'onDragEnd'
+      | 'onDragEndCapture'
+      | 'onDragEnter'
+      | 'onDragEnterCapture'
+      | 'onDragExit'
+      | 'onDragExitCapture'
+      | 'onDragLeave'
+      | 'onDragLeaveCapture'
+      | 'onDragOver'
+      | 'onDragOverCapture'
+      | 'onDragStart'
+      | 'onDragStartCapture'
+      | 'onDrop'
+      | 'onDropCapture'
+      | 'onMouseDown'
+      | 'onMouseDownCapture'
+      | 'onMouseEnter'
+      | 'onMouseLeave'
+      | 'onMouseMove'
+      | 'onMouseMoveCapture'
+      | 'onMouseOut'
+      | 'onMouseOutCapture'
+      | 'onMouseOver'
+      | 'onMouseOverCapture'
+      | 'onMouseUp'
+      | 'onMouseUpCapture'
+      | 'onSelect'
+      | 'onSelectCapture'
+      | 'onTouchCancel'
+      | 'onTouchCancelCapture'
+      | 'onTouchEnd'
+      | 'onTouchEndCapture'
+      | 'onTouchMove'
+      | 'onTouchMoveCapture'
+      | 'onTouchStart'
+      | 'onTouchStartCapture'
+      | 'onPointerDown'
+      | 'onPointerDownCapture'
+      | 'onPointerMove'
+      | 'onPointerMoveCapture'
+      | 'onPointerUp'
+      | 'onPointerUpCapture'
+      | 'onPointerCancel'
+      | 'onPointerCancelCapture'
+      | 'onPointerEnter'
+      | 'onPointerEnterCapture'
+      | 'onPointerLeave'
+      | 'onPointerLeaveCapture'
+      | 'onPointerOver'
+      | 'onPointerOverCapture'
+      | 'onPointerOut'
+      | 'onPointerOutCapture'
+      | 'onGotPointerCapture'
+      | 'onGotPointerCaptureCapture'
+      | 'onLostPointerCapture'
+      | 'onLostPointerCaptureCapture'
+      | 'onScroll'
+      | 'onScrollCapture'
+      | 'onWheel'
+      | 'onWheelCapture'
+      | 'onAnimationStart'
+      | 'onAnimationStartCapture'
+      | 'onAnimationEnd'
+      | 'onAnimationEndCapture'
+      | 'onAnimationIteration'
+      | 'onAnimationIterationCapture'
+      | 'onTransitionEnd'
+      | 'onTransitionEndCapture'
+      | 'isCompact'
+      | 'isDisabled'
+      | 'isReadOnly'
+      | 'isRequired'
+      | 'isInvalid'
+      | 'theme'
+      | 'testId'
+      | 'createAnalyticsEvent'
+    > &
+      React_2.RefAttributes<HTMLTextAreaElement>
+  >
+>;
 export default TextArea;
 
-declare type TextAreaProps = Combine<
+// @public (undocumented)
+type TextAreaProps = Combine<
   Omit<
     React_2.TextareaHTMLAttributes<HTMLTextAreaElement>,
     'disabled' | 'required' | 'readonly'
@@ -410,12 +342,8 @@ declare type TextAreaProps = Combine<
   OwnProps
 >;
 
-/**
- * @deprecated
- * Component-level theming is deprecated in the design system.
- * Components should respect the global theme.
- */
-export declare const Theme: {
+// @public @deprecated (undocumented)
+export const Theme: {
   Consumer: ComponentType<
     {
       children: (tokens: ThemeTokens) => ReactNode;
@@ -428,23 +356,17 @@ export declare const Theme: {
   useTheme: (props: ThemeProps) => ThemeTokens;
 };
 
-export declare type ThemeAppearance = 'standard' | 'subtle' | 'none';
+// @public (undocumented)
+export type ThemeAppearance = 'standard' | 'subtle' | 'none';
 
-export declare type ThemeProps = {
+// @public (undocumented)
+export type ThemeProps = {
   appearance: ThemeAppearance;
-  /**
-   * @deprecated
-   * Mode is deprecated and will be deleted in the future.
-   */
   mode: 'dark' | 'light';
 };
 
-/**
- * @deprecated
- * Component-level theming is deprecated in the design system.
- * Components should respect the global theme.
- */
-export declare type ThemeTokens = {
+// @public @deprecated (undocumented)
+export type ThemeTokens = {
   borderColor: string;
   borderColorFocus: string;
   backgroundColor: string;
@@ -469,12 +391,8 @@ export declare type ThemeTokens = {
   placeholderTextColor: string;
 };
 
-/**
- * @deprecated
- * Component-level theming is deprecated in the design system.
- * Components should respect the global theme.
- */
-export declare const themeTokens: {
+// @public @deprecated (undocumented)
+export const themeTokens: {
   borderColor: {
     standard: {
       light: 'var(--ds-border-input)';
@@ -589,5 +507,5 @@ export declare const themeTokens: {
   };
 };
 
-export {};
+// (No @packageDocumentation comment for this package)
 ```