@aws-amplify/ui-react 3.0.0 → 3.0.3

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

@@ -2,13 +2,38 @@ import * as React from 'react';
 import { SelectFieldProps } from './selectField';
 import { TextInputFieldProps } from './textField';
 export interface PhoneNumberFieldProps extends TextInputFieldProps {
+    /**
+     * @description
+     * Sets a hidden and accessible label for the dial code selector
+     */
     countryCodeLabel?: string;
+    /**
+     * @description
+     * Sets the name used when handling form submission for the dial code selector
+     */
     countryCodeName?: string;
+    /**
+     * @description
+     * Sets the default dial code that will be selected on initial render
+     */
     defaultCountryCode: string;
+    /**
+     * @description
+     * Accepts an array of dial codes (strings) used as options in the dial code selector
+     */
     dialCodeList?: Array<string>;
+    /**
+     * @description
+     * Handles change events for the dial code selector
+     */
     onCountryCodeChange?: React.ChangeEventHandler<HTMLSelectElement>;
+    /**
+     * @description
+     * <input> elements of type 'tel' are used to let the user enter and edit a telephone number
+     */
     type?: 'tel';
     /**
+     * @description
      * Forwarded ref for access to Country Code select DOM element
      */
     countryCodeRef?: React.Ref<HTMLSelectElement>;

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

@@ -3,11 +3,14 @@ import { ViewProps } from './view';
 export declare type PlaceholderSizes = Sizes;
 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;
     /**
+     * @description
      * Controls the display size of placeholder
      */
     size?: PlaceholderSizes;

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

@@ -3,6 +3,7 @@ import { LabelPositions } from './field';
 export interface RadioProps extends InputProps {
     value: string;
     /**
+     * @description
      * Position of label in relation to the radio,
      * default is 'start'
      */

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

@@ -7,10 +7,12 @@ export interface RadioGroupFieldProps extends FieldProps, FlexContainerStyleProp
     value?: string;
     defaultValue?: string;
     /**
+     * @description
      * Handle onChange event
      */
     onChange?: React.ChangeEventHandler<HTMLInputElement>;
     /**
+     * @description
      * Position of label in relation to the radio,
      * default is 'start'
      */

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

@@ -5,22 +5,26 @@ import { StyleToken } from './style';
 export declare type RatingSizes = Sizes;
 export interface RatingOptions {
     /**
+     * @description
      * The CSS color to use on the empty rating icon
      * Default css value is #A2A2A2
      */
     emptyColor?: StyleToken<Property.Color>;
     /**
+     * @description
      * This will override which icon to use as the empty icon. This will only
      * override the empty icon an will create a rating component that uses
      * different icons for filled and empty icons.
      */
     emptyIcon?: JSX.Element;
     /**
+     * @description
      * The CSS color to use on the filled rating icon
      * Default css value is #ffb400
      */
     fillColor?: StyleToken<Property.Color>;
     /**
+     * @description
      * This will override which icon to use. This will override both
      * the filled and empty icon values unless an empty icon is specified
      * with the emptyIcon prop
@@ -28,17 +32,20 @@ export interface RatingOptions {
      */
     icon?: JSX.Element;
     /**
+     * @description
      * The max rating integer value
      * Default is 5
      */
     maxValue?: number;
     /**
+     * @description
      *
      * This will set the icon size of the stars
      * Default css value is medium
      */
     size?: RatingSizes;
     /**
+     * @description
      * The value of the rating
      * Default is 0
      */

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

@@ -3,24 +3,31 @@ import { FieldGroupIconButtonProps } from './fieldGroupIcon';
 import { TextInputFieldProps } from './textField';
 export interface SearchFieldProps extends TextInputFieldProps {
     /**
+     * @description
      * Handle submission of search field input
      */
     onSubmit?: (value: string) => void;
     /**
+     * @description
      * Triggered when search field is cleared
      */
     onClear?: () => void;
     /**
+     * @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;
     /**
+     * @description
      * Provides ref access to search button DOM element
      */
     searchButtonRef?: React.Ref<HTMLButtonElement>;

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

@@ -3,17 +3,69 @@ import { ViewProps } from './view';
 import { Sizes } from './base';
 export declare type SelectVariation = 'quiet';
 export interface SelectProps extends ViewProps {
+    /**
+     * @description
+     * A string providing a hint for a user agent's autocomplete feature
+     */
     autoComplete?: string;
+    /**
+     * @description
+     * Specifies the name of the control used when submitting form data
+     */
     name?: string;
+    /**
+     * @description
+     * Sets the SelectField’s initial value on render
+     */
     defaultValue?: string;
+    /**
+     * @description
+     * Controls the current value when using the SelectField as a controlled component
+     */
     value?: string;
+    /**
+     * @description
+     * Changes the height and font size of the SelectField. Available options are ‘small’, none (default), and ‘large’
+     */
     size?: Sizes;
+    /**
+     * @description
+     * Changes the displayed style of the SelectField. Options include ‘quiet’ and none (default)
+     */
     variation?: SelectVariation;
+    /**
+     * @description
+     * Changes the icon used to expand and collapse the SelectField
+     */
     icon?: React.ReactElement;
+    /**
+     * @description
+     * Controls the color of the icon used to expand and collapse the SelectField
+     */
     iconColor?: string;
+    /**
+     * @description
+     * Sets the text that appears in the form control when it has no value set
+     */
     placeholder?: string;
+    /**
+     * @description
+     * Marks the SelectField as having a validation error
+     */
     hasError?: boolean;
+    /**
+     * @description
+     * A Boolean attribute indicating that the user cannot interact with the control
+     */
     isDisabled?: boolean;
+    /**
+     * @description
+     * A Boolean attribute indicating that an option with a non-empty string value must be selected
+     */
     isRequired?: boolean;
+    /**
+     * @description
+     * Handles changes to the current value when using the SelectField as a controlled component
+     */
     onChange?: React.ChangeEventHandler<HTMLSelectElement>;
 }

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

@@ -3,6 +3,7 @@ import { SelectProps } from './select';
 import { FieldProps } from './field';
 export interface SelectFieldProps extends FieldProps, FlexContainerStyleProps, SelectProps {
     /**
+     * @description
      * List of option values for select dropdown
      */
     options?: string[];

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

@@ -3,18 +3,74 @@ 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
+     * Sets the minimum value for the SliderField range
+     */
     min?: number;
+    /**
+     * @description
+     * Sets the maximum value for the SliderField range
+     */
     max?: number;
+    /**
+     * @description
+     * Controls the interval between selectable values
+     */
     step?: number;
+    /**
+     * @description
+     * Changes the orientation of the SliderField to either 'vertical' or 'horizontal' (default)
+     */
     orientation?: SliderOrientation;
+    /**
+     * @description
+     * When `true`, hides the numerical value to the right of the label
+     */
     isValueHidden?: boolean;
+    /**
+     * @description
+     * Controls the width of the track and size of the thumb. Options include 'small', none (default), and 'large'
+     */
     trackSize?: string;
+    /**
+     * @description
+     * Applies to the empty part of the SliderField track
+     */
     emptyTrackColor?: StyleToken<Property.Color>;
+    /**
+     * @description
+     * Applies to the filled-in part of the SliderField track
+     */
     filledTrackColor?: StyleToken<Property.Color>;
+    /**
+     * @description
+     * Applies to the thumb component that users can slide
+     */
     thumbColor?: StyleToken<Property.Color>;
+    /**
+     * @description
+     * Controls the current value when using the SliderField as a controlled component
+     */
     value?: number;
+    /**
+     * @description
+     * Sets the SliderField’s initial value on render
+     */
     defaultValue?: number;
+    /**
+     * @description
+     * 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

@@ -1,29 +1,66 @@
 import { TextInputFieldProps } from '../types/textField';
 export interface StepperFieldProps extends TextInputFieldProps {
+    /**
+     * @description
+     * <input> elements of type number are used to let the user enter a number. They include built-in validation to reject non-numerical entries.
+     */
     type?: 'number';
+    /**
+     * @description
+     * Sets the minimum possible value
+     */
     min?: number;
+    /**
+     * @description
+     * Sets the maximum possible value
+     */
     max?: number;
+    /**
+     * @description
+     * Controls the interval between selectable values
+     */
     step?: number;
+    /**
+     * @description
+     * Controls the current value when using the StepperField as a controlled component
+     */
     value?: number;
+    /**
+     * @description
+     * Sets the StepperField’s initial value on render
+     */
     defaultValue?: number;
     /**
+     * @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;
     /**
+     * @description
      * TODO:
      * Extends StepperField props from Omit<TextFieldProps, 'onChange'>, after removing [key: string]: any from the base type
      * and rename onStepChange to onChange
      */
     onStepChange?: (value: number) => void;
+    /**
+     * @description
+     * Handles the event when a user clicks on the increment button
+     */
     onIncrease?: () => void;
+    /**
+     * @description
+     * Handles the event when a user clicks on the decrement button
+     */
     onDecrease?: () => void;
 }