@atlaskit/forge-react-types 0.37.7 → 0.37.9

package/dist/types-ts4.5/components/charts/PieChartProps.d.ts

@@ -1,15 +1,59 @@
 import type { ChartColorTokens } from '../../types';
 export type PieChartProps = {
+    /**
+     * The static width of the chart in pixels. If this is not specified, the width is responsive.
+     */
     width?: number;
+    /**
+     * The static height of the chart in pixels. Defaults to `400`.
+     */
     height?: number;
+    /**
+     * Data can be one of two formats:
+     * 1. [Array of arrays](https://developer.atlassian.com/platform/forge/ui-kit/components/pie-chart/#1--array-of-arrays).
+     * 2. [Array of objects](https://developer.atlassian.com/platform/forge/ui-kit/components/pie-chart/#2--array-of-objects).
+     */
     data: unknown[];
+    /**
+     * Boolean to display the chart border. Defaults to `false`.
+     */
     showBorder?: boolean;
+    /**
+     * Accessor to define the color grouping. This can be a numerical or string index.
+     * For more information on all accessors, see [Data](https://developer.atlassian.com/platform/forge/ui-kit/components/pie-chart/#data).
+     */
     colorAccessor: number | string;
+    /**
+     * Accessor to define the angle of arcs in a pie.
+     */
     valueAccessor: number | string;
+    /**
+     * Accessor to define the labels.
+     */
     labelAccessor: number | string;
+    /**
+     * A string value that represents the title of the chart.
+     */
     title?: string;
+    /**
+     * A string value that represents the subtitle of the chart. This appears below the title.
+     */
     subtitle?: string;
+    /**
+     * Boolean to render the pie as the donut variation. Defaults to `false`.
+     */
     isDonut?: boolean;
+    /**
+     * Boolean to display labels on top of each slice. Defaults to `false`.
+     */
     showMarkLabels?: boolean;
+    /**
+     * An array of [chart color tokens](https://atlassian.design/components/tokens/all-tokens#color-chart).
+     * This is utilized to render each slice with the specified colors, based on the color grouping given by colorAccessor.
+     */
     colors?: ChartColorTokens[];
 };
+/**
+ * A visual representation of data proportions in a circular format.
+ */
+export type TPieChart<T> = (props: PieChartProps) => T;

package/dist/types-ts4.5/components/charts/SingleValueChartProps.d.ts

@@ -1,8 +1,33 @@
 export type SingleValueChartProps = {
+    /**
+     * Data can be one of two formats:
+     * 1. A **number** - The value that is displayed, abbreviated at the thousand, millions, trillions and billions.
+     * 2. An **array of numbers**: The first number in the array is used as the display value, the second number in the array is used to calculate the increase/decrease percentage relative to the first number.
+     */
     data: number | number[];
+    /**
+     * The static width of the chart in pixels. If this is not specified, the width is responsive.
+     */
     width?: number;
+    /**
+     * The static height of the chart in pixels. Defaults to `120`.
+     */
     height?: number;
+    /**
+     * Boolean to display the chart border. Defaults to `false`.
+     */
     showBorder?: boolean;
+    /**
+     * A string value that represents the title of the chart.
+     */
     title?: string;
+    /**
+     * A string value that represents the subtitle of the chart. This appears below the metric value.
+     */
     subtitle?: string;
 };
+/**
+ * A visualization representation of information with a single value as its metrics.
+ * The metric can be displayed with a increase/decrease indicator to display trends or changes over time.
+ */
+export type TSingleValueChart<T> = (props: SingleValueChartProps) => T;

package/dist/types-ts4.5/components/charts/index.d.ts

@@ -1,4 +1,4 @@
-export type { BarChartProps, StackBarChartProps, HorizontalStackBarChartProps, HorizontalBarChartProps, } from './BarChartProps';
-export type { LineChartProps } from './LineChartProps';
-export type { SingleValueChartProps } from './SingleValueChartProps';
-export type { PieChartProps } from './PieChartProps';
+export type { BarChartProps, StackBarChartProps, HorizontalStackBarChartProps, HorizontalBarChartProps, TBarChart, TStackBarChart, THorizontalStackBarChart, THorizontalBarChart, } from './BarChartProps';
+export type { LineChartProps, TLineChart } from './LineChartProps';
+export type { SingleValueChartProps, TSingleValueChart } from './SingleValueChartProps';
+export type { PieChartProps, TPieChart } from './PieChartProps';

package/dist/types-ts4.5/index.d.ts

@@ -1,3 +1,3 @@
-export type { AdfRendererProps, BadgeProps, BleedProps, BoxProps, ButtonGroupProps, ButtonProps, CalendarProps, CheckboxProps, CheckboxGroupProps, CodeBlockProps, CodeProps, DatePickerProps, DynamicTableProps, EmptyStateProps, ErrorMessageProps, FlexProps, FormFooterProps, FormHeaderProps, FormProps, FormSectionProps, GridProps, HeadingProps, HelperMessageProps, IconProps, InlineProps, LabelProps, LinkButtonProps, ListProps, ListItemProps, LoadingButtonProps, LozengeProps, ModalBodyProps, ModalFooterProps, ModalHeaderProps, ModalProps, ModalTitleProps, ModalTransitionProps, ProgressBarProps, ProgressTrackerProps, RadioGroupProps, RadioProps, RangeProps, SectionMessageActionProps, SectionMessageProps, SelectProps, SpinnerProps, StackProps, TabListProps, TabPanelProps, TabProps, TabsProps, TagGroupProps, TagProps, TextProps, TextAreaProps, TextfieldProps, ToggleProps, TooltipProps, TimePickerProps, ValidMessageProps, PopupProps, InlineEditProps, TBadge, TBox, TAdfRenderer, } from './components/__generated__';
+export type { AdfRendererProps, BadgeProps, BleedProps, BoxProps, ButtonGroupProps, ButtonProps, CalendarProps, CheckboxProps, CheckboxGroupProps, CodeBlockProps, CodeProps, DatePickerProps, DynamicTableProps, EmptyStateProps, ErrorMessageProps, FlexProps, FormFooterProps, FormHeaderProps, FormProps, FormSectionProps, GridProps, HeadingProps, HelperMessageProps, IconProps, InlineProps, LabelProps, LinkButtonProps, ListProps, ListItemProps, LoadingButtonProps, LozengeProps, ModalBodyProps, ModalFooterProps, ModalHeaderProps, ModalProps, ModalTitleProps, ModalTransitionProps, ProgressBarProps, ProgressTrackerProps, RadioGroupProps, RadioProps, RangeProps, SectionMessageActionProps, SectionMessageProps, SelectProps, SpinnerProps, StackProps, TabListProps, TabPanelProps, TabProps, TabsProps, TagGroupProps, TagProps, TextProps, TextAreaProps, TextfieldProps, ToggleProps, TooltipProps, TimePickerProps, ValidMessageProps, PopupProps, InlineEditProps, TBadge, TBleed, TBox, TButtonGroup, TButton, TCalendar, TCheckbox, TCheckboxGroup, TCodeBlock, TCode, TDatePicker, TDynamicTable, TEmptyState, TErrorMessage, TFlex, TFormFooter, TFormHeader, TForm, TFormSection, TGrid, THeading, THelperMessage, TIcon, TInline, TInlineEdit, TLabel, TLinkButton, TList, TListItem, TLoadingButton, TLozenge, TModalBody, TModalFooter, TModalHeader, TModal, TModalTitle, TModalTransition, TProgressBar, TProgressTracker, TRadioGroup, TRadio, TRange, TSectionMessageAction, TSectionMessage, TSelect, TSpinner, TStack, TTabList, TTabPanel, TTab, TTabs, TTagGroup, TTag, TTextArea, TTextfield, TTimePicker, TToggle, TTooltip, TValidMessage, TPopup, TAdfRenderer, TText, } from './components/__generated__';
 export type { BarChartProps, StackBarChartProps, HorizontalStackBarChartProps, HorizontalBarChartProps, LineChartProps, SingleValueChartProps, PieChartProps, } from './components/charts';
 export type { ChartColorTokens } from './types';

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/forge-react-types",
-	"version": "0.37.7",
+	"version": "0.37.9",
 	"description": "Component types for Forge UI Kit React components",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -29,12 +29,12 @@
 		"@atlaskit/calendar": "^17.1.0",
 		"@atlaskit/checkbox": "^17.0.0",
 		"@atlaskit/code": "^16.0.0",
-		"@atlaskit/datetime-picker": "^16.0.0",
+		"@atlaskit/datetime-picker": "^16.1.0",
 		"@atlaskit/dynamic-table": "^18.0.0",
 		"@atlaskit/empty-state": "^9.0.0",
 		"@atlaskit/form": "^12.0.0",
 		"@atlaskit/heading": "^5.1.0",
-		"@atlaskit/inline-edit": "^15.0.0",
+		"@atlaskit/inline-edit": "^15.1.0",
 		"@atlaskit/lozenge": "^12.2.0",
 		"@atlaskit/modal-dialog": "^13.0.0",
 		"@atlaskit/popup": "^2.0.0",
@@ -44,7 +44,7 @@
 		"@atlaskit/radio": "^8.0.0",
 		"@atlaskit/range": "^9.0.0",
 		"@atlaskit/renderer": "^113.2.0",
-		"@atlaskit/section-message": "^8.0.0",
+		"@atlaskit/section-message": "^8.1.0",
 		"@atlaskit/select": "^20.0.0",
 		"@atlaskit/spinner": "^18.0.0",
 		"@atlaskit/tabs": "^18.0.0",

package/src/components/__generated__/ButtonGroupProps.codegen.tsx

@@ -3,9 +3,9 @@
  *
  * Extract component prop types from UIKit 2 components - ButtonGroupProps
  *
- * @codegen <<SignedSource::4daf3a960cc3108bbbc8ad0ede3b7011>>
+ * @codegen <<SignedSource::cfcaf362cef2884ded73338c52c8f437>>
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/button/__generated__/button-group.partial.tsx <<SignedSource::728cab6df690811513a66ea4bacb89c9>>
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/button/__generated__/button-group.partial.tsx <<SignedSource::83622155981d05f77224a32bab4969b5>>
  */
 /* eslint @repo/internal/codegen/signed-source-integrity: "warn" */
 
@@ -18,6 +18,6 @@ export type ButtonGroupProps = Pick<
 > & { appearance?: ButtonProps['appearance'] };
 
 /**
- * A button triggers an event or action. They let users know what will happen next.
+ * A button group gives users access to frequently performed, related actions.
  */
 export type TButtonGroup<T> = (props: ButtonGroupProps) => T;

package/src/components/__generated__/ButtonProps.codegen.tsx

@@ -3,9 +3,9 @@
  *
  * Extract component prop types from UIKit 2 components - ButtonProps
  *
- * @codegen <<SignedSource::333890773f42cacce17cee560686b34c>>
+ * @codegen <<SignedSource::77d1847e88419084fc81129d7637b40b>>
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/button/__generated__/index.partial.tsx <<SignedSource::c3a07cf50f9f4f166b94a72b4c2d5784>>
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/button/__generated__/index.partial.tsx <<SignedSource::f9a16b36e0a307a53ee30a009373ab49>>
  */
 /* eslint @repo/internal/codegen/signed-source-integrity: "warn" */
 
@@ -391,4 +391,7 @@ export type ButtonProps = Pick<
 	spacing?: PlatformButtonProps['spacing'] | 'none';
 };
 
+/**
+ * A button triggers an event or action. They let users know what will happen next.
+ */
 export type TButton<T> = (props: ButtonProps) => T;

package/src/components/__generated__/CheckboxGroupProps.codegen.tsx

@@ -3,17 +3,40 @@
  *
  * Extract component prop types from UIKit 2 components - CheckboxGroupProps
  *
- * @codegen <<SignedSource::293ea13e93c4a78fe93d7192e0bdaddb>>
+ * @codegen <<SignedSource::89e98a25ac16f92b5d18b061bb6fce57>>
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/checkboxgroup/index.tsx <<SignedSource::e4f95cf79182924e927523227eebf6fc>>
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/checkboxgroup/index.tsx <<SignedSource::4db9e0c029805d1c1fd28b923f3dbae3>>
  */
 /* eslint @repo/internal/codegen/signed-source-integrity: "warn" */
 
 export interface CheckboxGroupProps {
+	/**
+	 * Sets the name prop on each of the Checkbox elements in the group.
+	 */
 	name: string;
+	/**
+	 * An array of objects, each object is mapped onto a Checkbox element within the group.
+	 */
 	options: { label: string; value: string; isDisabled?: boolean }[];
+	/**
+	 * Once set, controls the selected value on the `CheckboxGroup`.
+	 */
 	value?: string[];
+	/*
+	 * Function that gets fired after each change event.
+	 */
 	onChange?: (values: string[]) => void;
+	/**
+	 * Sets the initial selected value on the `CheckboxGroup`.
+	 */
 	defaultValue?: string[];
+	/**
+	 * Sets the disabled state of all Checkbox elements in the group.
+	 */
 	isDisabled?: boolean;
-}
+}
+
+/**
+ * A Checkbox group is a list of options where one or more choices can be selected.
+ */
+export type TCheckboxGroup<T> = (props: CheckboxGroupProps) => T;

package/src/components/__generated__/DatePickerProps.codegen.tsx

@@ -3,9 +3,9 @@
  *
  * Extract component prop types from UIKit 2 components - DatePickerProps
  *
- * @codegen <<SignedSource::14d82d10ae64e4333440817918f6e955>>
+ * @codegen <<SignedSource::a4fe0c77ab65e00b2bc8ebeadd33e2e3>>
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/datepicker/__generated__/index.partial.tsx <<SignedSource::6bc5d63c14b9dda11b370e386ccf4955>>
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/datepicker/__generated__/index.partial.tsx <<SignedSource::5dcbe693f00f3a2725b9e64932a3309c>>
  */
 /* eslint @repo/internal/codegen/signed-source-integrity: "warn" */
 
@@ -54,6 +54,6 @@ export type DatePickerProps = {
 } & Partial<Omit<FieldProps, 'onChange'>>;
 
 /**
- * A date time picker allows the user to select an associated date and time.
+ * A date picker allows the user to select a particular date.
  */
 export type TDatePicker<T> = (props: DatePickerProps) => T;

package/src/components/__generated__/ErrorMessageProps.codegen.tsx

@@ -3,9 +3,9 @@
  *
  * Extract component prop types from UIKit 2 components - ErrorMessageProps
  *
- * @codegen <<SignedSource::3d3da7aa33a6ac0adb1524f89ee28208>>
+ * @codegen <<SignedSource::059ea63aef7f094365447bb300fed9f6>>
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/form/__generated__/error-message.partial.tsx <<SignedSource::9e1a8d256d8d999a689140fbcda430fa>>
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/form/__generated__/error-message.partial.tsx <<SignedSource::3758488a0115c629a624fcaae1f524c7>>
  */
 /* eslint @repo/internal/codegen/signed-source-integrity: "warn" */
 
@@ -20,6 +20,7 @@ export type ErrorMessageProps = Pick<
 >;
 
 /**
- * A form allows users to input information.
+ * An error message is used to tell a user that the field input is invalid.
+ * For example, an error message could be "Invalid username, needs to be more than 4 characters".
  */
 export type TErrorMessage<T> = (props: ErrorMessageProps) => T;

package/src/components/__generated__/FormFooterProps.codegen.tsx

@@ -3,16 +3,22 @@
  *
  * Extract component prop types from UIKit 2 components - FormFooterProps
  *
- * @codegen <<SignedSource::cb77ae443b27f1229afcd556eb365acf>>
+ * @codegen <<SignedSource::e6d74700f46888d63a013f997339596b>>
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/form/__generated__/form-footer.partial.tsx <<SignedSource::ff2413efe154db0f89a03200caf50ced>>
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/form/__generated__/form-footer.partial.tsx <<SignedSource::0b729df36afbc86cc134984bb4c16b3e>>
  */
 /* eslint @repo/internal/codegen/signed-source-integrity: "warn" */
 
 import React from 'react';
 import { FormFooter as PlatformFormFooter } from '@atlaskit/form';
 
-type PlatformFormFooterProps = React.ComponentProps<typeof PlatformFormFooter>;
+type _PlatformFormFooterProps = React.ComponentProps<typeof PlatformFormFooter>;
+export type PlatformFormFooterProps = Omit<_PlatformFormFooterProps, 'align'> & {
+/**
+ * Sets the alignment of the footer contents. This is often a button. Defaults to `end`.
+ */
+	align?: _PlatformFormFooterProps['align'];
+}
 
 export type FormFooterProps = Pick<
   PlatformFormFooterProps,
@@ -20,6 +26,8 @@ export type FormFooterProps = Pick<
 >;
 
 /**
- * A form allows users to input information.
+ * Use a form footer to set the content at the end of the form. This is used for a button that submits the form.
+ * 
+ * This is positioned after the last field in the form.
  */
 export type TFormFooter<T> = (props: FormFooterProps) => T;

package/src/components/__generated__/FormHeaderProps.codegen.tsx

@@ -3,9 +3,9 @@
  *
  * Extract component prop types from UIKit 2 components - FormHeaderProps
  *
- * @codegen <<SignedSource::74a8285c7ae5a0c5db7b8cafa4d8226b>>
+ * @codegen <<SignedSource::7ef542fd2e0804c707145ab13db81db1>>
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/form/__generated__/form-header.partial.tsx <<SignedSource::038ad7a850af23fb1c9b30de39ab0552>>
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/form/__generated__/form-header.partial.tsx <<SignedSource::8791c333c19a64caa8dd6b7461a53082>>
  */
 /* eslint @repo/internal/codegen/signed-source-integrity: "warn" */
 
@@ -20,6 +20,8 @@ export type FormHeaderProps = Pick<
 >;
 
 /**
- * A form allows users to input information.
+ * Use a form header to describe the contents of the form. This is the title and description of the form.
+ * If your form contains required fields, the form header is also where you should include a legend
+ * for sighted users to know that * indicates a required field.
  */
 export type TFormHeader<T> = (props: FormHeaderProps) => T;

package/src/components/__generated__/FormProps.codegen.tsx

@@ -3,17 +3,29 @@
  *
  * Extract component prop types from UIKit 2 components - FormProps
  *
- * @codegen <<SignedSource::7b259a0bfc883f09eb65cdccee169a6a>>
+ * @codegen <<SignedSource::6ac049125d8d8c2436805c5e3a845802>>
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/form/index.tsx <<SignedSource::0e0a2f1184da9df422fb61ff7d906158>>
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/form/index.tsx <<SignedSource::b6dd991b4a5e73adbac9321d53cd909e>>
  */
 /* eslint @repo/internal/codegen/signed-source-integrity: "warn" */
 
 import type { ReactNode } from 'react';
 
 export type FormProps = {
+	/**
+	 * Event handler called when the form is submitted. Fields must be free of validation errors.
+	 *
+	 * All modules except for `jiraServiceManagement:assetsImportType` must use `() => Promise<void>|void`.
+	 *
+	 * For the `jiraServiceManagement:assetsImportType` module, the `onSubmit` event handler returns
+	 * a `boolean` value indicating if the form is valid (`true`) or invalid (`false`).
+	 * If you use `() => Promise<void>|void` for this module, it will default to true.
+	 */
 	onSubmit: () => Promise<void | boolean> | void;
 	children: ReactNode;
 };
 
+/**
+ * A form allows users to input information.
+ */
 export type TForm<T> = (props: FormProps) => T;

package/src/components/__generated__/FormSectionProps.codegen.tsx

@@ -3,9 +3,9 @@
  *
  * Extract component prop types from UIKit 2 components - FormSectionProps
  *
- * @codegen <<SignedSource::bb91841c1913229e7eb66d61b4ab693d>>
+ * @codegen <<SignedSource::2d079615b76393e9241b054b75fde5f3>>
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/form/__generated__/form-section.partial.tsx <<SignedSource::7b30101c26550bb11c0f4ca6d4cf46fc>>
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/form/__generated__/form-section.partial.tsx <<SignedSource::0dd9401d75f62dec7336bdea43302961>>
  */
 /* eslint @repo/internal/codegen/signed-source-integrity: "warn" */
 
@@ -20,6 +20,7 @@ export type FormSectionProps = Pick<
 >;
 
 /**
- * A form allows users to input information.
+ * Use a form section to group related information together, so that longer forms are easier to understand.
+ * There can be multiple form sections in one form.
  */
 export type TFormSection<T> = (props: FormSectionProps) => T;

package/src/components/__generated__/HelperMessageProps.codegen.tsx

@@ -3,9 +3,9 @@
  *
  * Extract component prop types from UIKit 2 components - HelperMessageProps
  *
- * @codegen <<SignedSource::85d8a9188648ed81c09769eedb4935e6>>
+ * @codegen <<SignedSource::0da9514581e07c67f8f9a8ba0d9774b9>>
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/form/__generated__/helper-message.partial.tsx <<SignedSource::f093808bbd8bf8738059aee750524013>>
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/form/__generated__/helper-message.partial.tsx <<SignedSource::03fa772bfaf53905106f1cafbb428104>>
  */
 /* eslint @repo/internal/codegen/signed-source-integrity: "warn" */
 
@@ -20,6 +20,7 @@ export type HelperMessageProps = Pick<
 >;
 
 /**
- * A form allows users to input information.
+ * A helper message tells the user what kind of input the field takes.
+ * For example, a helper message could be "Password should be more than 4 characters".
  */
 export type THelperMessage<T> = (props: HelperMessageProps) => T;

package/src/components/__generated__/IconProps.codegen.tsx

@@ -3,9 +3,9 @@
  *
  * Extract component prop types from UIKit 2 components - IconProps
  *
- * @codegen <<SignedSource::b20b7ee253d00fb37c349ea914f0f796>>
+ * @codegen <<SignedSource::b24cc22d6f60b86f1646a75a0bafc7cd>>
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/icon/index.tsx <<SignedSource::e8d3a49d7c0faccdf54a1e1ef3ec8d5b>>
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/icon/index.tsx <<SignedSource::54a87ae131386a26a52d09234f67aa98>>
  */
 /* eslint @repo/internal/codegen/signed-source-integrity: "warn" */
 
@@ -375,11 +375,31 @@ type Glyph = Icon;
 export type IconColor = Extract<ActiveTokens, `color.icon.${string}`> | 'color.icon';
 
 export interface IconProps {
+	/**
+	 * There are three icon sizes – `small` (16px), `medium` (24px), `large` (32px), and `xlarge` (48px).
+	 * This pixel size refers to the canvas the icon sits on, not the size of the icon shape itself.
+	 */
 	size?: 'small' | 'medium' | 'large';
+	/**
+	 * Text used to describe what the icon is in context. A label is needed when there is no pairing visible text next to the icon.
+	 * An empty string marks the icon as presentation only.
+	 */
 	label: string;
+	/**
+	 * Name of the icon to be rendered.
+	 */
 	glyph: Glyph;
+	/**
+	 * Primary color for the icon. Inherits the current font color by default.
+	 */
 	primaryColor?: IconColor;
+	/**
+	 * Secondary color for the icon. Defaults to the page background for an icon that supports two colors.
+	 */
 	secondaryColor?: IconColor;
 }
 
+/**
+ * An icon is a visual representation of a command, device, directory, or common action.
+ */
 export type TIcon<T> = (props: IconProps) => T;

package/src/components/__generated__/InlineEditProps.codegen.tsx

@@ -3,9 +3,9 @@
  *
  * Extract component prop types from UIKit 2 components - InlineEditProps
  *
- * @codegen <<SignedSource::a9f12cdb3310eb05479934fb78d94123>>
+ * @codegen <<SignedSource::450b0aa0943b6519e89ee7c91f4124ad>>
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/inline-edit/index.tsx <<SignedSource::9f519f258e72d24157290a0844371df9>>
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/inline-edit/index.tsx <<SignedSource::23f59ce10b527efc04d36919c24aa2b0>>
  */
 /* eslint @repo/internal/codegen/signed-source-integrity: "warn" */
 
@@ -28,4 +28,9 @@ export type InlineEditProps<V = string> = Omit<
 	// ADS has an additional analyticsEvent arg that is not optional. We don't use this in UI Kit and it can't be removed due to breaking changes in products
 	onConfirm: (value: V) => void;
 	editView: (fieldProps: EditViewFieldProps<V>) => React.ReactNode;
-};
+};
+
+/**
+ * An inline edit displays a custom input component that switches between reading and editing on the same page.
+ */
+export type TInlineEdit<T> = (props: InlineEditProps) => T;

package/src/components/__generated__/InlineProps.codegen.tsx

@@ -3,9 +3,9 @@
  *
  * Extract component prop types from UIKit 2 components - InlineProps
  *
- * @codegen <<SignedSource::f154fd7caa18fc53a1369bb9f496909c>>
+ * @codegen <<SignedSource::7e0e8c23de8b2392bf101ad017431b86>>
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/inline/__generated__/index.partial.tsx <<SignedSource::6f1af1d5438263ed1f6833c78c741ed9>>
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/inline/__generated__/index.partial.tsx <<SignedSource::8123157b2afe19d52b47110fb754d43b>>
  */
 /* eslint @repo/internal/codegen/signed-source-integrity: "warn" */
 
@@ -20,6 +20,6 @@ export type InlineProps = Pick<
 >;
 
 /**
- * Primitives are token-backed low-level building blocks.
+ * An inline manages the horizontal layout of direct children using flexbox.
  */
 export type TInline<T> = (props: InlineProps) => T;

package/src/components/__generated__/LabelProps.codegen.tsx

@@ -3,9 +3,9 @@
  *
  * Extract component prop types from UIKit 2 components - LabelProps
  *
- * @codegen <<SignedSource::0a894a2ad4f4410a2c67f12f0287dbcd>>
+ * @codegen <<SignedSource::f12ab4339e5503f7db96ce306da7f685>>
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/form/__generated__/label.partial.tsx <<SignedSource::60bad4561265206e7c10d92a99fce9f4>>
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/form/__generated__/label.partial.tsx <<SignedSource::55ecafcd1d98afb9b7f6f37d5168725c>>
  */
 /* eslint @repo/internal/codegen/signed-source-integrity: "warn" */
 
@@ -16,6 +16,6 @@ export type LabelProps = Pick<PlatformLabelProps, 'children' | 'testId' | 'id'>
 };
 
 /**
- * A form allows users to input information.
+ * A label represents a caption for an item in a user interface.
  */
 export type TLabel<T> = (props: LabelProps) => T;

package/src/components/__generated__/LinkButtonProps.codegen.tsx

@@ -3,9 +3,9 @@
  *
  * Extract component prop types from UIKit 2 components - LinkButtonProps
  *
- * @codegen <<SignedSource::ac79b85bde2efadf2186ea5acd6d267e>>
+ * @codegen <<SignedSource::7c841825fdf02347d10084f2cd032f66>>
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/button/__generated__/link-button.partial.tsx <<SignedSource::4f0e6eb251c01a13ba006b3d7569820d>>
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/button/__generated__/link-button.partial.tsx <<SignedSource::e74ee4aaf752a6e85a57950dce7a3683>>
  */
 /* eslint @repo/internal/codegen/signed-source-integrity: "warn" */
 
@@ -31,4 +31,7 @@ export type LinkButtonProps = Pick<
 	spacing?: PlatformLinkButtonProps['spacing'] | 'none';
 };
 
+/**
+ * Renders a link in the style of a button.
+ */
 export type TLinkButton<T> = (props: LinkButtonProps) => T;

package/src/components/__generated__/ListItemProps.codegen.tsx

@@ -3,9 +3,9 @@
  *
  * Extract component prop types from UIKit 2 components - ListItemProps
  *
- * @codegen <<SignedSource::5b0a462f70b0acd50425ef1c98dc4acd>>
+ * @codegen <<SignedSource::498ef4606a16b666a2b159d16dc69460>>
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/list/listitem.tsx <<SignedSource::979a16db9afd0d737ded8388e6563c2f>>
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/list/listitem.tsx <<SignedSource::73cdf1aa500fb4ffb5cbe4ecd40276a9>>
  */
 /* eslint @repo/internal/codegen/signed-source-integrity: "warn" */
 
@@ -13,4 +13,6 @@ import React from 'react';
 
 export interface ListItemProps {
 	children: React.ReactNode;
-}
+}
+
+export type TListItem<T> = (props: ListItemProps) => T;

package/src/components/__generated__/ListProps.codegen.tsx

@@ -3,15 +3,28 @@
  *
  * Extract component prop types from UIKit 2 components - ListProps
  *
- * @codegen <<SignedSource::e5d3409e37e543116ea009ca173ec496>>
+ * @codegen <<SignedSource::400e8f876b65d0f5902e544922d64a54>>
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/list/list.tsx <<SignedSource::15041a942a0c0a671c5d60df014ead74>>
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/list/list.tsx <<SignedSource::08290162e7f9e2a672b27cec286206cf>>
  */
 /* eslint @repo/internal/codegen/signed-source-integrity: "warn" */
 
 import React from 'react';
 
 export interface ListProps {
+	/**
+	 * The `ordered` type should be used when representing an ordered list of items.
+	 * The `unordered` type should be used when representing an unordered list of items.
+	 * The type is set to `unordered` by default.
+	 */
 	type: 'ordered' | 'unordered';
+	/**
+	 * The items to render inside a `List` group.
+	 */
 	children: React.ReactNode;
-}
+}
+
+/**
+ * An unordered (bulleted) or ordered (numbered) list.
+ */
+export type TList<T> = (props: ListProps) => T;

package/src/components/__generated__/LoadingButtonProps.codegen.tsx

@@ -3,9 +3,9 @@
  *
  * Extract component prop types from UIKit 2 components - LoadingButtonProps
  *
- * @codegen <<SignedSource::58521a43391f996afe6923d5a591a82c>>
+ * @codegen <<SignedSource::3abc490a74619a5e969b95b74b8ee6f6>>
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/button/__generated__/loading-button.partial.tsx <<SignedSource::078e02aff0fd36fb6bbf64711f0c5490>>
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/button/loading-button.tsx <<SignedSource::66edb728e0e941c5f53236e94cd02c18>>
  */
 /* eslint @repo/internal/codegen/signed-source-integrity: "warn" */
 
@@ -15,11 +15,23 @@ import { LoadingButton as PlatformLoadingButton } from '@atlaskit/button';
 type PlatformLoadingButtonProps = React.ComponentProps<typeof PlatformLoadingButton>;
 
 export type LoadingButtonProps = Pick<
-  PlatformLoadingButtonProps,
-  'children' | 'appearance' | 'autoFocus' | 'isDisabled' | 'isSelected' | 'onBlur' | 'onClick' | 'onFocus' | 'spacing' | 'testId' | 'shouldFitContainer' | 'type' | 'isLoading'
+	PlatformLoadingButtonProps,
+	| 'children'
+	| 'appearance'
+	| 'autoFocus'
+	| 'isDisabled'
+	| 'isSelected'
+	| 'onBlur'
+	| 'onClick'
+	| 'onFocus'
+	| 'spacing'
+	| 'testId'
+	| 'shouldFitContainer'
+	| 'type'
+	| 'isLoading'
 >;
 
 /**
- * A button triggers an event or action. They let users know what will happen next.
+ * A button that shows an spinner as an overlay on the button when you set an isLoading prop to true.
  */
 export type TLoadingButton<T> = (props: LoadingButtonProps) => T;