From cfe7d096df524d46116d147ffe828dd13817a2b5 Mon Sep 17 00:00:00 2001 From: Jessica Kuelz <15003460+jkuelz@users.noreply.github.com> Date: Fri, 13 Feb 2026 16:58:29 -0800 Subject: [PATCH] chore: Add descriptions for style API --- src/alert/interfaces.ts | 1 + src/autosuggest/interfaces.ts | 1 + src/badge/interfaces.ts | 1 + src/button-group/interfaces.ts | 1 + src/button/interfaces.ts | 1 + src/checkbox/interfaces.ts | 1 + src/container/interfaces.ts | 1 + src/flashbar/interfaces.ts | 1 + src/input/interfaces.ts | 1 + src/internal/components/radio-button/interfaces.ts | 1 + src/link/interfaces.ts | 1 + src/progress-bar/interfaces.ts | 1 + src/prompt-input/interfaces.ts | 1 + src/radio-group/interfaces.ts | 1 + src/segmented-control/interfaces.ts | 1 + src/slider/interfaces.ts | 1 + src/tabs/interfaces.ts | 1 + src/text-filter/interfaces.ts | 1 + src/textarea/interfaces.ts | 1 + src/toggle/interfaces.ts | 1 + 20 files changed, 20 insertions(+) diff --git a/src/alert/interfaces.ts b/src/alert/interfaces.ts index ff3fb3eb13..ec93eee951 100644 --- a/src/alert/interfaces.ts +++ b/src/alert/interfaces.ts @@ -157,6 +157,7 @@ export interface AlertProps extends BaseComponentProps { */ analyticsMetadata?: AlertProps.AnalyticsMetadata; /** + * An object containing CSS properties to customize the alert's visual appearance. * @awsuiSystem core */ style?: AlertProps.Style; diff --git a/src/autosuggest/interfaces.ts b/src/autosuggest/interfaces.ts index 8e9e66e6d5..dd31b5c683 100644 --- a/src/autosuggest/interfaces.ts +++ b/src/autosuggest/interfaces.ts @@ -165,6 +165,7 @@ export interface AutosuggestProps renderHighlightedAriaLive?: AutosuggestProps.ContainingOptionAndGroupString; /** + * An object containing CSS properties to customize the autosuggest's visual appearance. * @awsuiSystem core */ style?: AutosuggestProps.Style; diff --git a/src/badge/interfaces.ts b/src/badge/interfaces.ts index 9c8b51c82b..425bfeff98 100644 --- a/src/badge/interfaces.ts +++ b/src/badge/interfaces.ts @@ -29,6 +29,7 @@ export interface BadgeProps extends BaseComponentProps { children?: React.ReactNode; /** + * An object containing CSS properties to customize the badge's visual appearance. * @awsuiSystem core */ style?: BadgeProps.Style; diff --git a/src/button-group/interfaces.ts b/src/button-group/interfaces.ts index eb2be102dd..8fd42bc8c0 100644 --- a/src/button-group/interfaces.ts +++ b/src/button-group/interfaces.ts @@ -100,6 +100,7 @@ export interface ButtonGroupProps extends BaseComponentProps { */ onFilesChange?: NonCancelableEventHandler; /** + * An object containing CSS properties to customize the button group's visual appearance. * @awsuiSystem core */ style?: ButtonGroupProps.Style; diff --git a/src/button/interfaces.ts b/src/button/interfaces.ts index 8f6498d67d..c9e892891d 100644 --- a/src/button/interfaces.ts +++ b/src/button/interfaces.ts @@ -209,6 +209,7 @@ export interface ButtonProps extends BaseComponentProps, BaseButtonProps { iconAlt?: string; /** + * An object containing CSS properties to customize the button's visual appearance. * @awsuiSystem core */ style?: ButtonProps.Style; diff --git a/src/checkbox/interfaces.ts b/src/checkbox/interfaces.ts index 3a24975360..16e3a82f3e 100644 --- a/src/checkbox/interfaces.ts +++ b/src/checkbox/interfaces.ts @@ -34,6 +34,7 @@ export interface CheckboxProps extends BaseCheckboxProps { ariaRequired?: boolean; /** + * An object containing CSS properties to customize the checkbox's visual appearance. * @awsuiSystem core */ style?: CheckboxProps.Style; diff --git a/src/container/interfaces.ts b/src/container/interfaces.ts index 6173e7bbe5..20ec2aa867 100644 --- a/src/container/interfaces.ts +++ b/src/container/interfaces.ts @@ -83,6 +83,7 @@ export interface ContainerProps extends BaseComponentProps { variant?: 'default' | 'stacked'; /** + * An object containing CSS properties to customize the container's visual appearance. * @awsuiSystem core */ style?: ContainerProps.Style; diff --git a/src/flashbar/interfaces.ts b/src/flashbar/interfaces.ts index 90cf2ae68f..722c0cf6d2 100644 --- a/src/flashbar/interfaces.ts +++ b/src/flashbar/interfaces.ts @@ -217,6 +217,7 @@ export interface FlashbarProps extends BaseComponentProps { i18nStrings?: FlashbarProps.I18nStrings; /** + * An object containing CSS properties to customize the flashbar's visual appearance. * @awsuiSystem core */ style?: FlashbarProps.Style; diff --git a/src/input/interfaces.ts b/src/input/interfaces.ts index d0db2c9b8d..5885cd4e81 100644 --- a/src/input/interfaces.ts +++ b/src/input/interfaces.ts @@ -183,6 +183,7 @@ export interface InputProps step?: InputProps.Step; /** + * An object containing CSS properties to customize the input's visual appearance. * @awsuiSystem core */ style?: InputProps.Style; diff --git a/src/internal/components/radio-button/interfaces.ts b/src/internal/components/radio-button/interfaces.ts index a5df3dc293..db6f03c0ea 100644 --- a/src/internal/components/radio-button/interfaces.ts +++ b/src/internal/components/radio-button/interfaces.ts @@ -72,6 +72,7 @@ export interface RadioButtonProps extends BaseComponentProps { readOnly?: boolean; /** + * An object containing CSS properties to customize the radio button's visual appearance. * @awsuiSystem core */ style?: RadioButtonProps.Style; diff --git a/src/link/interfaces.ts b/src/link/interfaces.ts index 256f837337..a784600874 100644 --- a/src/link/interfaces.ts +++ b/src/link/interfaces.ts @@ -112,6 +112,7 @@ export interface LinkProps extends BaseComponentProps { rel?: string; /** + * An object containing CSS properties to customize the link's visual appearance. * @awsuiSystem core */ style?: LinkProps.Style; diff --git a/src/progress-bar/interfaces.ts b/src/progress-bar/interfaces.ts index 782d8fa612..6d2d5b9930 100644 --- a/src/progress-bar/interfaces.ts +++ b/src/progress-bar/interfaces.ts @@ -84,6 +84,7 @@ export interface ProgressBarProps extends BaseComponentProps { onResultButtonClick?: NonCancelableEventHandler; /** + * An object containing CSS properties to customize the progress bar's visual appearance. * @awsuiSystem core */ style?: ProgressBarProps.Style; diff --git a/src/prompt-input/interfaces.ts b/src/prompt-input/interfaces.ts index 42d388f778..d10126bb3a 100644 --- a/src/prompt-input/interfaces.ts +++ b/src/prompt-input/interfaces.ts @@ -131,6 +131,7 @@ export interface PromptInputProps nativeTextareaAttributes?: NativeAttributes>; /** + * An object containing CSS properties to customize the prompt input's visual appearance. * @awsuiSystem core */ style?: PromptInputProps.Style; diff --git a/src/radio-group/interfaces.ts b/src/radio-group/interfaces.ts index 6de71db76c..c5c31def6a 100644 --- a/src/radio-group/interfaces.ts +++ b/src/radio-group/interfaces.ts @@ -65,6 +65,7 @@ export interface RadioGroupProps extends BaseComponentProps, FormFieldControlPro readOnly?: boolean; /** + * An object containing CSS properties to customize the radio group's visual appearance. * @awsuiSystem core */ style?: RadioGroupProps.Style; diff --git a/src/segmented-control/interfaces.ts b/src/segmented-control/interfaces.ts index fd34ea16bf..7b1de7b453 100644 --- a/src/segmented-control/interfaces.ts +++ b/src/segmented-control/interfaces.ts @@ -46,6 +46,7 @@ export interface SegmentedControlProps extends BaseComponentProps { onChange?: NonCancelableEventHandler; /** + * An object containing CSS properties to customize the segmented control's visual appearance. * @awsuiSystem core */ style?: SegmentedControlProps.Style; diff --git a/src/slider/interfaces.ts b/src/slider/interfaces.ts index dd72a316bd..c3d0b594ea 100644 --- a/src/slider/interfaces.ts +++ b/src/slider/interfaces.ts @@ -84,6 +84,7 @@ export interface SliderProps extends BaseComponentProps, FormFieldValidationCont readOnly?: boolean; /** + * An object containing CSS properties to customize the slider's visual appearance. * @awsuiSystem core */ style?: SliderProps.Style; diff --git a/src/tabs/interfaces.ts b/src/tabs/interfaces.ts index b4cb77c93d..0e23bc84a7 100644 --- a/src/tabs/interfaces.ts +++ b/src/tabs/interfaces.ts @@ -104,6 +104,7 @@ export interface TabsProps extends BaseComponentProps { keyboardActivationMode?: 'automatic' | 'manual'; /** + * An object containing CSS properties to customize the tabs' visual appearance. * @awsuiSystem core */ style?: TabsProps.Style; diff --git a/src/text-filter/interfaces.ts b/src/text-filter/interfaces.ts index 9259e3cd08..d2a4ed04bd 100644 --- a/src/text-filter/interfaces.ts +++ b/src/text-filter/interfaces.ts @@ -61,6 +61,7 @@ export interface TextFilterProps extends BaseComponentProps, FormFieldControlPro onDelayedChange?: NonCancelableEventHandler; /** + * An object containing CSS properties to customize the text filter's visual appearance. * @awsuiSystem core */ style?: TextFilterProps.Style; diff --git a/src/textarea/interfaces.ts b/src/textarea/interfaces.ts index de2f6055c3..b3725fd6b1 100644 --- a/src/textarea/interfaces.ts +++ b/src/textarea/interfaces.ts @@ -52,6 +52,7 @@ export interface TextareaProps nativeTextareaAttributes?: NativeAttributes>; /** + * An object containing CSS properties to customize the textarea's visual appearance. * @awsuiSystem core */ style?: TextareaProps.Style; diff --git a/src/toggle/interfaces.ts b/src/toggle/interfaces.ts index d686bd5dd1..a87a73ea31 100644 --- a/src/toggle/interfaces.ts +++ b/src/toggle/interfaces.ts @@ -23,6 +23,7 @@ export interface ToggleProps extends BaseCheckboxProps { onChange?: NonCancelableEventHandler; /** + * An object containing CSS properties to customize the toggle's visual appearance. * @awsuiSystem core */ style?: ToggleProps.Style;