@aws-amplify/ui-react 3.0.0 → 3.0.1

package/dist/types/primitives/types/textArea.d.ts

@@ -4,46 +4,58 @@ import { Sizes } from './base';
 import { FieldVariations } from './field';
 import { ViewProps } from './view';
 export interface TextAreaStyleProps {
+    /**
+     * @description
+     * Defines if (and how) an element is resizable by the user
+     */
     resize?: Property.Resize;
 }
 export interface TextAreaProps extends TextAreaStyleProps, ViewProps {
     /**
+     * @description
      * Specifies permissions for browser UA to autocomplete field
-     * @link https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete
+     * @see [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete)
      */
     autoComplete?: string;
     /**
+     * @description
      * Use this to provide a default value for an uncontrolled field
      */
     defaultValue?: React.AllHTMLAttributes<'textarea'>['defaultValue'];
     /**
+     * @description
      * Indicates that Field is in error state
      */
     hasError?: boolean;
     /**
+     * @description
      *  Determines whether field should be disabled
      * @default false
      */
     isDisabled?: boolean;
     /**
-     * Determines whether field should be immutable
-     * @link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#attr-readonly
+     * @description
+     * @see [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#attr-readonly)
      * @default false
      */
     isReadOnly?: boolean;
     /**
+     * @description
      * Whether field should be marked required
      */
     isRequired?: boolean;
     /**
+     * @description
      * Text contents maximum length
      */
     maxLength?: number;
     /**
+     * @description
      * Name of the field. Submitted with the form as part of a name/value pair.
      */
     name?: string;
     /**
+     * @description
      * Placeholder text shown when field is empty
      * Accessibility tip: avoid putting important instructions for
      * filling out the TextField in the placeholder. Use descriptiveText
@@ -51,18 +63,22 @@ export interface TextAreaProps extends TextAreaStyleProps, ViewProps {
      */
     placeholder?: string;
     /**
+     * @description
      * Controls height based on number of rows of text to display
      */
     rows?: number;
     /**
+     * @description
      * Changes the font-size, padding, and height of the field.
      */
     size?: Sizes;
     /**
+     * @description
      * If value is provided, this will be a controlled field
      */
     value?: React.AllHTMLAttributes<'textarea'>['value'];
     /**
+     * @description
      * Variants
      */
     variation?: FieldVariations;

package/dist/types/primitives/types/textField.d.ts

@@ -5,22 +5,27 @@ import { FieldProps } from './field';
 import { TextAreaProps } from './textArea';
 export interface TextFieldOptions extends FieldProps, FlexContainerStyleProps {
     /**
+     * @description
      * Component(s) to show after input
      */
     outerEndComponent?: React.ReactNode;
     /**
+     * @description
      * Component(s) to show before input
      */
     outerStartComponent?: React.ReactNode;
     /**
+     * @description
      * FieldGroupIconButton component to show inside of input at start
      */
     innerStartComponent?: React.ReactNode;
     /**
+     * @description
      * FieldGroupIconButton component to show inside of input at end
      */
     innerEndComponent?: React.ReactNode;
     /**
+     * @description
      * Input field type (only applies when isMultiline = false)
      */
     type?: InputProps['type'];

package/dist/types/primitives/types/toggleButton.d.ts

@@ -1,7 +1,23 @@
 import { ButtonProps } from './button';
 export interface ToggleButtonProps extends ButtonProps {
+    /**
+     * @description
+     * Controls the selected state of the ToggleButton
+     */
     value?: string;
+    /**
+     * @description
+     * Controls the `isPressed` state of the ToggleButton when using it as a controlled component
+     */
     isPressed?: boolean;
+    /**
+     * @description
+     * When `true`, sets the `isPressed` state of the ToggleButton to `true` on initial render
+     */
     defaultPressed?: boolean;
+    /**
+     * @description
+     * Handles changes to the current value when using the ToggleButton as a controlled component
+     */
     onChange?: (value: string) => void;
 }

package/dist/types/primitives/types/toggleButtonGroup.d.ts

@@ -2,9 +2,29 @@ import * as React from 'react';
 import { FlexProps } from './flex';
 import { ToggleButtonProps } from './toggleButton';
 export interface ToggleButtonGroupProps extends FlexProps, Pick<ToggleButtonProps, 'size' | 'variation'> {
+    /**
+     * @description
+     * Accepts any number of ToggleButton components
+     */
     children: React.ReactNode;
+    /**
+     * @description
+     * When `true`, only allows one ToggleButton to be pressed at a time within a ToggleButtonGroup
+     */
     isExclusive?: boolean;
+    /**
+     * @description
+     * Used when at least one ToggleButton needs to be currently pressed
+     */
     isSelectionRequired?: boolean;
+    /**
+     * @description
+     * Controls which of its ToggleButton children are currently selected
+     */
     value: string | string[];
+    /**
+     * @description
+     * Handles changes to the current value when using the ToggleButtonGroup as a controlled component
+     */
     onChange: (value: string | string[]) => void;
 }

package/dist/types/primitives/types/view.d.ts

@@ -4,26 +4,50 @@ import { BaseStyleProps } from './style';
 declare type MergeProps<A, B> = A & Omit<B, keyof A>;
 export declare type ElementType = React.FC<any> | keyof JSX.IntrinsicElements;
 /**
+ * @description
  * Convert string element type to DOMElement Type
  * e.g. 'button' => HTMLButtonElement
  */
 export declare type HTMLElementType<Element extends ElementType> = Element extends keyof JSX.IntrinsicElements ? React.ElementRef<Element> : HTMLElementTypeFromExoticComponentRef<Element>;
 /**
+ * @description
  * Allows us to extract ElementType from `typeof Root` used in SliderField
  * e.g. React.ForwardRefExoticComponent<SliderProps & React.RefAttributes<HTMLSpanElement>> => HTMLSpanElement
  */
 declare type HTMLElementTypeFromExoticComponentRef<Element extends ElementType> = Element extends React.ForwardRefExoticComponent<React.RefAttributes<infer DOMHTMLElement>> ? DOMHTMLElement : HTMLElement;
 export declare type ElementProps<Element extends ElementType> = Element extends keyof JSX.IntrinsicElements ? JSX.IntrinsicElements[Element] : Element extends React.FC<infer ComponentProps> ? ComponentProps : never;
 export declare type PrimitiveProps<Props extends ViewProps, Element extends ElementType> = MergeProps<Omit<Props, 'as'> & {
+    /**
+     * @description
+     * Changes the type of HTML element rendered
+     */
     as?: Element | Props['as'];
 }, Omit<ElementProps<Element>, 'ref'>>;
 export declare type PrimitivePropsWithRef<Props extends ViewProps, Element extends ElementType> = PrimitiveProps<Props, Element> & {
+    /**
+     * @description
+     * References a DOM element from within a parent component
+     */
     ref?: React.Ref<HTMLElementType<Element>>;
 };
 export declare type Primitive<Props extends ViewProps, Element extends ElementType> = React.ForwardRefRenderFunction<HTMLElementType<Element>, PrimitivePropsWithRef<Props, Element>>;
 export interface ViewProps extends BaseComponentProps, BaseStyleProps, AriaProps {
+    /**
+     * @description
+     * Changes the type of HTML element rendered
+     */
     as?: ElementType;
+    /**
+     * @description
+     * Sets the Boolean `disabled` HTML attribute, which, when present, makes the element not mutable, focusable, or even submitted with the form
+     */
     isDisabled?: boolean;
+    /**
+     * @description
+     * Accepts a JavaScript object with camelCased properties rather than a CSS string.
+     * This is consistent with the DOM style JavaScript property, is more efficient, and prevents XSS security holes.
+     * [React docs]{@link https://reactjs.org/docs/dom-elements.html#style}
+     */
     style?: React.CSSProperties;
 }
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-amplify/ui-react",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "main": "dist/index.js",
   "module": "dist/esm/index.js",
   "exports": {
@@ -59,7 +59,7 @@
     "size": "yarn run size-limit"
   },
   "dependencies": {
-    "@aws-amplify/ui": "3.11.0",
+    "@aws-amplify/ui": "3.11.1",
     "@aws-amplify/ui-react-v1": "npm:@aws-amplify/ui-react@1.2.9",
     "@radix-ui/react-accordion": "0.1.6",
     "@radix-ui/react-dropdown-menu": "0.1.6",