@aws-amplify/ui-react 3.0.1 → 3.0.4

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

@@ -2,58 +2,71 @@ import * as React from 'react';
 import { Sizes } from './base';
 import { FieldVariations } from './field';
 import { ViewProps } from './view';
+export declare type EnterKeyHint = 'enter' | 'done' | 'go' | 'next' | 'previous' | 'search' | 'send';
 export declare type InputMode = 'none' | 'text' | 'decimal' | 'numeric' | 'tel' | 'search' | 'email' | 'url';
 export declare type InputSizes = Sizes;
 export interface InputProps extends ViewProps {
     /**
      * @description
-     * Specifies permissions for browser UA to autocomplete field
-     * @see [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete)
+     * Specifies permissions for browser UA to autocomplete field.
+     * @see
+     * [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete)
      */
     autoComplete?: string;
     /**
      * @description
-     * If checked is provided, this will be a controlled checkbox or radio
+     * If checked is provided, this will be a controlled checkbox or radio.
      */
     checked?: boolean;
     /**
      * @description
-     * Use this to initialize an uncontrolled checkbox or radio
+     * Use this to initialize an uncontrolled checkbox or radio.
      */
     defaultChecked?: boolean;
     /**
      * @description
-     * Use this to provide a default value for an uncontrolled field
+     * Use this to provide a default value for an uncontrolled field.
      */
     defaultValue?: React.AllHTMLAttributes<'input'>['defaultValue'];
     /**
      * @description
-     * Indicates that Field is in error state
+     * Indicates that Field is in error state.
      */
     hasError?: boolean;
     /**
      * @description
-     * Provides hint for virtual keyboard shown
-     * @see [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/inputmode)
-     * @default: "text"
+     * Defines what action label (or icon) to present for the enter key on virtual keyboards.
+     * @see
+     * [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/enterkeyhint)
+     */
+    enterKeyHint?: EnterKeyHint;
+    /**
+     * @description
+     *  Provides hint for virtual keyboard shown
+     * @see
+     * [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/inputmode)
+     * @default "text"
      */
     inputMode?: InputMode;
     /**
      * @description
-     *  Determines whether field should be disabled
-     * @default false
+     *  Determines whether field should be disabled.
+     * @default
+     * false
      */
     isDisabled?: boolean;
     /**
      * @description
-     * Determines whether field should be immutable
-     * @see [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#attr-readonly)
-     * @default false
+     * Determines whether field should be immutable.
+     * @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
+     * Whether field should be marked required.
      */
     isRequired?: boolean;
     /**
@@ -63,10 +76,7 @@ export interface InputProps extends ViewProps {
     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
-     * for important instructions
+     * Placeholder text shown when field is empty Accessibility tip: avoid putting important instructions for filling out the TextField in the placeholder. Use descriptiveText for important instructions.
      */
     placeholder?: string;
     /**
@@ -76,17 +86,17 @@ export interface InputProps extends ViewProps {
     size?: InputSizes;
     /**
      * @description
-     * Input field type
+     * Input field type.
      */
     type?: React.HTMLInputTypeAttribute;
     /**
      * @description
-     * If value is provided, this will be a controlled field
+     * If value is provided, this will be a controlled field.
      */
     value?: React.AllHTMLAttributes<'input'>['value'];
     /**
      * @description
-     * Variants
+     * Variants.
      */
     variation?: FieldVariations;
 }

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

@@ -17,6 +17,13 @@ export interface LinkOptions {
      * A string representation of the URL path
      */
     to?: string;
+    /**
+     * @description
+     * a stringifier that returns a string containing the whole URL, and allows the href to be updated.
+     * @see
+     * [MDN](https://developer.mozilla.org/en-US/docs/Web/API/HTMLAnchorElement/href)
+     */
+    href?: string;
 }
 export interface LinkProps extends ViewProps, LinkOptions {
 }

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

@@ -6,7 +6,8 @@ export interface MenuProps extends FlexProps {
     /**
      * @description
      * Alignment of menu against trigger
-     * @default "start"
+     * @default
+     * "start"
      */
     menuAlign?: 'start' | 'center' | 'end';
     /**
@@ -27,8 +28,10 @@ export interface MenuProps extends FlexProps {
     /**
      * @description
      * Trigger node
-     * @default MenuButton with IconMenu
-     * @note Must forward refs to DOM element
+     * @default
+     * MenuButton with IconMenu
+     * @note
+     * Must forward refs to DOM element
      */
     trigger?: React.ReactNode;
     /**

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

@@ -23,32 +23,37 @@ interface BasePaginationProps {
     /**
      * @description
      * Optionally indicates whether there are more pages after `totalPages`. Can be combined with `totalPages` to enable the next button when reaching the last page.
-     * @default false
+     * @default
+     * false
      */
     hasMorePages?: boolean;
     /**
      * @description
      * Set the invisible label for current page.
-     * @default "Current Page:"
+     * @default
+     * "Current Page:"
      */
     currentPageLabel?: string;
     /**
      * @description
      * Set the label text for each page button other than the current page.
      * It will be used to construct the `aria-label` for each page button. e.g, "Go to page 1" for page 1 button
-     * @default "Go to page"
+     * @default
+     * "Go to page"
      */
     pageLabel?: string;
     /**
      * @description
      * Set the `aria-label` for the left arrow button.
-     * @default "Go to previous page"
+     * @default
+     * "Go to previous page"
      */
     previousLabel?: string;
     /**
      * @description
      * Set the `aria-label` for the right arrow button.
-     * @default "Go to next page"
+     * @default
+     * "Go to next page"
      */
     nextLabel?: string;
     /**
@@ -87,6 +92,8 @@ export interface PaginationItemProps extends BaseComponentProps, BaseStyleProps,
     /**
      * @description
      * The index of current page.
+     * @default
+     * "Current Page:"
      */
     currentPage?: number;
     /**
@@ -97,7 +104,6 @@ export interface PaginationItemProps extends BaseComponentProps, BaseStyleProps,
     /**
      * @description
      * Set the invisible label for current page.
-     * @default "Current Page:"
      */
     currentPageLabel?: string;
     /**

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

@@ -10,20 +10,23 @@ export interface PasswordFieldProps extends TextInputFieldProps {
     /**
      * @description
      * Set the `aria-label` for hide password button
-     * @default "Hide password"
+     * @default
+     * "Hide password"
      */
     hidePasswordButtonLabel?: string;
     /**
      * @description
      * Set the `aria-label` for show password button
-     * @default "Show password"
+     * @default
+     * "Show password"
      */
     showPasswordButtonLabel?: string;
     /**
      * @description
      * Password autocomplete type
      * @See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete#values)
-     * @default "current-password"
+     * @default
+     * "current-password"
      */
     autoComplete?: 'new-password' | 'current-password' | string;
     /**
@@ -42,13 +45,15 @@ export interface ShowPasswordButtonProps extends ButtonProps {
     /**
      * @description
      * Set the `aria-label` for hide password button
-     * @default "Hide password"
+     * @default
+     * "Hide password"
      */
     hidePasswordButtonLabel?: string;
     /**
      * @description
      * Set the `aria-label` for show password button
-     * @default "Show password"
+     * @default
+     * "Show password"
      */
     showPasswordButtonLabel?: string;
 }

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

@@ -5,7 +5,8 @@ export interface PlaceholderProps extends ViewProps {
     /**
      * @description
      * If true, the placeholder won't show, if false the placeholder will show.
-     * @default false
+     * @default
+     * false
      */
     isLoaded?: boolean;
     /**

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

@@ -15,13 +15,15 @@ export interface SearchFieldProps extends TextInputFieldProps {
     /**
      * @description
      * Visually hide label
-     * @default true
+     * @default
+     * true
      */
     labelHidden?: boolean;
     /**
      * @description
      * Set the `aria-label` for clear button
-     * @default "Clear search"
+     * @default
+     * "Clear search"
      */
     clearButtonLabel?: string;
     /**

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

@@ -3,6 +3,7 @@ import { StyleToken } from './style';
 import { TextInputFieldProps } from './textField';
 import { ViewProps } from './view';
 declare type SliderOrientation = 'horizontal' | 'vertical';
+declare type Direction = 'ltr' | 'rtl';
 export interface SliderFieldProps extends TextInputFieldProps, ViewProps {
     /**
      * @description
@@ -64,5 +65,12 @@ export interface SliderFieldProps extends TextInputFieldProps, ViewProps {
      * Handles changes to the current value when using the SliderField as a controlled component
      */
     onChange?: (value: number) => void;
+    /**
+     * @description
+     * sets the direction of the slider.
+     * @see
+     * [Radix docs](https://www.radix-ui.com/docs/primitives/components/slider)
+     */
+    dir?: Direction;
 }
 export {};

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

@@ -34,14 +34,16 @@ export interface StepperFieldProps extends TextInputFieldProps {
      * @description
      * Set the label text for increase button.
      * This will be used to construct its the `aria-label`. e.g., "Increase to 2" if the current step is 1.
-     * @default "Increase to"
+     * @default
+     * "Increase to"
      */
     increaseButtonLabel?: string;
     /**
      * @description
      * Set the label text for decrease button.
      * This will be used to construct its the `aria-label`. e.g., "Decrease to 0" if the current step is 1.
-     * @default "Decrease to"
+     * @default
+     * "Decrease to"
      */
     decreaseButtonLabel?: string;
     /**