chore: Add descriptions for style API

jkuelz · jkuelz · commit ce29e55e2948 · 2026-02-15T18:34:57.000-08:00
diff --git a/src/__tests__/snapshot-tests/__snapshots__/documenter.test.ts.snap b/src/__tests__/snapshot-tests/__snapshots__/documenter.test.ts.snap
@@ -209,6 +209,7 @@ If the label is assigned via the \`i18nStrings\` property, this label will be ig
       "type": "string",
     },
     {
+      "description": "An object containing CSS properties to customize the alert's visual appearance.",
       "inlineType": {
         "name": "AlertProps.Style",
         "properties": [
@@ -3637,6 +3638,7 @@ This is required to provide a good screen reader experience. For more informatio
       "type": "string",
     },
     {
+      "description": "An object containing CSS properties to customize the autosuggest's visual appearance.",
       "inlineType": {
         "name": "AutosuggestProps.Style",
         "properties": [
@@ -3980,6 +3982,7 @@ We do not support using this attribute to apply custom styling.",
       "type": "Omit<React.HTMLAttributes<HTMLElement>, "children"> & Record<\`data-\${string}\`, string>",
     },
     {
+      "description": "An object containing CSS properties to customize the badge's visual appearance.",
       "inlineType": {
         "name": "BadgeProps.Style",
         "properties": [
@@ -5495,6 +5498,7 @@ If the \`rel\` property is provided, it overrides the default behavior.",
       "type": "string",
     },
     {
+      "description": "An object containing CSS properties to customize the button's visual appearance.",
       "inlineType": {
         "name": "ButtonProps.Style",
         "properties": [
@@ -6611,6 +6615,7 @@ use the \`id\` attribute, consider setting it on a parent element instead.",
       "type": "ReadonlyArray<ButtonGroupProps.ItemOrGroup>",
     },
     {
+      "description": "An object containing CSS properties to customize the button group's visual appearance.",
       "inlineType": {
         "name": "ButtonGroupProps.Style",
         "properties": [
@@ -7592,6 +7597,7 @@ If both \`readOnly\` and \`disabled\` are set, \`disabled\` takes precedence.",
       "type": "boolean",
     },
     {
+      "description": "An object containing CSS properties to customize the checkbox's visual appearance.",
       "inlineType": {
         "name": "CheckboxProps.Style",
         "properties": [
@@ -9554,6 +9560,7 @@ If no height is provided, the media slot will be displayed at its full height.",
       "type": "ContainerProps.Media",
     },
     {
+      "description": "An object containing CSS properties to customize the container's visual appearance.",
       "inlineType": {
         "name": "ContainerProps.Style",
         "properties": [
@@ -12757,6 +12764,7 @@ If the \`action\` property is set, this property is ignored. **Deprecated**, rep
       "type": "boolean",
     },
     {
+      "description": "An object containing CSS properties to customize the flashbar's visual appearance.",
       "inlineType": {
         "name": "FlashbarProps.Style",
         "properties": [
@@ -15410,6 +15418,7 @@ including the date, month, week, time, datetime-local, number and range types.",
       "type": "InputProps.Step",
     },
     {
+      "description": "An object containing CSS properties to customize the input's visual appearance.",
       "inlineType": {
         "name": "InputProps.Style",
         "properties": [
@@ -16453,6 +16462,7 @@ By default, the component sets the \`rel\` attribute to "noopener noreferrer" wh
       "type": "string",
     },
     {
+      "description": "An object containing CSS properties to customize the link's visual appearance.",
       "inlineType": {
         "name": "LinkProps.Style",
         "properties": [
@@ -19325,6 +19335,7 @@ Add a button using the \`action\` property of the flashbar item instead.",
       "type": "string",
     },
     {
+      "description": "An object containing CSS properties to customize the progress bar's visual appearance.",
       "inlineType": {
         "name": "ProgressBarProps.Style",
         "properties": [
@@ -20036,6 +20047,7 @@ inadvertently sending data (such as user passwords) to third parties.",
       "type": "boolean",
     },
     {
+      "description": "An object containing CSS properties to customize the prompt input's visual appearance.",
       "inlineType": {
         "name": "PromptInputProps.Style",
         "properties": [
@@ -21242,6 +21254,7 @@ This property should be set for either all or none of the radio buttons in a gro
       "type": "boolean",
     },
     {
+      "description": "An object containing CSS properties to customize the radio button's visual appearance.",
       "inlineType": {
         "name": "RadioButtonProps.Style",
         "properties": [
@@ -21647,6 +21660,7 @@ being included in a form submission. A read-only control is still focusable.",
       "type": "boolean",
     },
     {
+      "description": "An object containing CSS properties to customize the radio group's visual appearance.",
       "inlineType": {
         "name": "RadioButtonProps.Style",
         "properties": [
@@ -22833,6 +22847,7 @@ Each segment has the following properties:
       "type": "string | null",
     },
     {
+      "description": "An object containing CSS properties to customize the segmented control's visual appearance.",
       "inlineType": {
         "name": "SegmentedControlProps.Style",
         "properties": [
@@ -24385,6 +24400,7 @@ being included in a form submission. A read-only control is still focusable.",
       "type": "number",
     },
     {
+      "description": "An object containing CSS properties to customize the slider's visual appearance.",
       "inlineType": {
         "name": "SliderProps.Style",
         "properties": [
@@ -26442,6 +26458,7 @@ need to introduce friction to the switching of tabs.",
       "type": "string",
     },
     {
+      "description": "An object containing CSS properties to customize the tabs' visual appearance.",
       "inlineType": {
         "name": "TabsProps.Style",
         "properties": [
@@ -27466,6 +27483,7 @@ If set to \`true\`, the live announcement of countText by assistive technologies
       "type": "boolean",
     },
     {
+      "description": "An object containing CSS properties to customize the text filter's visual appearance.",
       "inlineType": {
         "name": "TextFilterProps.Style",
         "properties": [
@@ -28042,6 +28060,7 @@ inadvertently sending data (such as user passwords) to third parties.",
       "type": "boolean",
     },
     {
+      "description": "An object containing CSS properties to customize the textarea's visual appearance.",
       "inlineType": {
         "name": "TextareaProps.Style",
         "properties": [
@@ -28855,6 +28874,7 @@ If both \`readOnly\` and \`disabled\` are set, \`disabled\` takes precedence.",
       "type": "boolean",
     },
     {
+      "description": "An object containing CSS properties to customize the toggle's visual appearance.",
       "inlineType": {
         "name": "ToggleProps.Style",
         "properties": [
diff --git 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
@@ -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
@@ -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
@@ -100,6 +100,7 @@ export interface ButtonGroupProps extends BaseComponentProps {
    */
   onFilesChange?: NonCancelableEventHandler<ButtonGroupProps.FilesChangeDetails>;
   /**
+   * 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -131,6 +131,7 @@ export interface PromptInputProps
   nativeTextareaAttributes?: NativeAttributes<React.TextareaHTMLAttributes<HTMLTextAreaElement>>;
 
   /**
+   * 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
@@ -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
@@ -46,6 +46,7 @@ export interface SegmentedControlProps extends BaseComponentProps {
   onChange?: NonCancelableEventHandler<SegmentedControlProps.ChangeDetail>;
 
   /**
+   * 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
@@ -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
@@ -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
@@ -61,6 +61,7 @@ export interface TextFilterProps extends BaseComponentProps, FormFieldControlPro
   onDelayedChange?: NonCancelableEventHandler<TextFilterProps.ChangeDetail>;
 
   /**
+   * 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
@@ -52,6 +52,7 @@ export interface TextareaProps
   nativeTextareaAttributes?: NativeAttributes<React.TextareaHTMLAttributes<HTMLTextAreaElement>>;
 
   /**
+   * 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
@@ -23,6 +23,7 @@ export interface ToggleProps extends BaseCheckboxProps {
   onChange?: NonCancelableEventHandler<ToggleProps.ChangeDetail>;
 
   /**
+   * An object containing CSS properties to customize the toggle's visual appearance.
    * @awsuiSystem core
    */
   style?: ToggleProps.Style;
