@atlaskit/forge-react-types 0.37.12 → 0.37.14

package/scripts/codegen/codeGenerator.ts

@@ -6,6 +6,8 @@ import {
 	type TypeAliasDeclaration,
 	type ImportDeclaration,
 } from 'ts-morph';
+// eslint-disable-next-line import/no-extraneous-dependencies
+import kebabCase from 'lodash/kebabCase';
 
 const getNames = (symbol: Symbol) => {
 	const name = symbol.getName();
@@ -53,6 +55,34 @@ const getBaseComponentSymbol = (componentSymbol: Symbol, sourceFile: SourceFile)
  * This function will extract the PlatformButtonProps type declaration.
  */
 const getDependentTypeDeclarations = (baseComponentPropSymbol: Symbol, sourceFile: SourceFile) => {
+	const declarations = getDependentTypeDeclarationsBase(baseComponentPropSymbol, sourceFile);
+
+	for (const declaration of declarations) {
+		// further extract dependent types from the dependent type declarations, if it is not yet the base component prop symbol
+		// e.g. Text component depends on OriginalPlatformProps which depends on PlatformTextProps
+		if (
+			!declaration.getName().startsWith('_Platform') &&
+			!declaration.getName().startsWith('Platform')
+		) {
+			const typeAliasSymbol = declaration.getSymbolOrThrow();
+			const baseComponentPropCode = getDeclaration(baseComponentPropSymbol).getText();
+			for (const dependentTypeAliasDeclaration of getDependentTypeDeclarationsBase(
+				typeAliasSymbol,
+				sourceFile,
+			)) {
+				if (baseComponentPropCode !== dependentTypeAliasDeclaration.getText()) {
+					declarations.push(dependentTypeAliasDeclaration);
+				}
+			}
+		}
+	}
+	return declarations;
+};
+
+const getDependentTypeDeclarationsBase = (
+	baseComponentPropSymbol: Symbol,
+	sourceFile: SourceFile,
+) => {
 	return sourceFile.getTypeAliases().reduce((declarations, typeAlias) => {
 		const typeAliasName = typeAlias.getName();
 		if (typeAliasName !== baseComponentPropSymbol.getName()) {
@@ -163,6 +193,7 @@ const extractImportDeclarations = (
 		componentDeclarationCode,
 		...dependentTypeDeclarations.map((typeAlias) => typeAlias.getText()).filter((code) => !!code),
 	];
+
 	return sourceFile
 		.getImportDeclarations()
 		.filter((declaration) => {
@@ -300,8 +331,13 @@ const resolveExternalTypesCode = (
 };
 
 const makeJSDocComment = (comment: string) => {
+	const commentBody = comment
+		.split('\n')
+		.map((line) => line.trimEnd())
+		.map((line) => (line.length === 0 ? ' *' : ` * ${line}`))
+		.join('\n');
 	return `/**
- * ${comment.split('\n').join('\n * ')}
+${commentBody}
  */`;
 };
 
@@ -319,7 +355,13 @@ const getComponentTypeCode = (componentPropSymbol: Symbol, sourceFile: SourceFil
 			.join('\n');
 
 		if (comment && comment.length > 0) {
-			statements.push(updateDACUrlInJSDocComment(makeJSDocComment(comment)));
+			let jsDocContent = comment;
+			const componentDocUrl = getUIKitComponentDocUrl(componentName);
+			if (componentDocUrl) {
+				jsDocContent = `${comment}\n\n@see [${componentName}](${getUIKitComponentDocUrl(componentName)}) in UI Kit documentation for more information`;
+			}
+
+			statements.push(updateDACUrlInJSDocComment(makeJSDocComment(jsDocContent)));
 		}
 	}
 	statements.push(`export type T${componentName}<T> = (props: ${propName}) => T;`);
@@ -373,6 +415,45 @@ const getComponentPropsTypeCode = (componentPropSymbol: Symbol) => {
 	return updateDACUrlInJSDocComment(sourceCode);
 };
 
+// this is to map special cases, and we should later review them for better consistency
+const componentPathMap: Record<string, string | false> = {
+	AdfRenderer: 'adfRenderer',
+	ErrorMessage: 'form/#error-message',
+	HelperMessage: 'form/#helper-message',
+	ValidMessage: 'form/#validation-message',
+	FormHeader: 'form/#form-header',
+	FormFooter: 'form/#form-footer',
+	FormSection: 'form/#form-section',
+	Label: 'form/#label',
+	LinkButton: 'button/#linkbutton-props',
+	LoadingButton: 'button/#loadingbutton-props',
+	ModalBody: 'modal/#body',
+	ModalFooter: 'modal/#footer',
+	ModalHeader: 'modal/#header',
+	ModalTitle: 'modal/#title',
+	ModalTransition: 'modal/#modal-transition',
+	SectionMessageAction: 'section-message/#section-message-action',
+	TabsList: 'tabs',
+	TabPanel: 'tabs',
+	Tab: 'tabs',
+	SimpleTag: 'tag',
+	Grid: false,
+	Bleed: false,
+};
+
+const getUIKitComponentDocUrl = (componentName: string) => {
+	const matchedComponentPath = componentPathMap[componentName];
+	if (matchedComponentPath === false) {
+		return null;
+	}
+	const baseComponentPath = matchedComponentPath ?? kebabCase(componentName);
+	const componentPath = baseComponentPath.includes('/#')
+		? baseComponentPath
+		: `${baseComponentPath}/`;
+
+	return `/platform/forge/ui-kit/components/${componentPath}`;
+};
+
 const baseGenerateComponentPropTypeSourceCode = (
 	componentPropSymbol: Symbol,
 	sourceFile: SourceFile,

package/scripts/codegen/componentPropTypes.ts

@@ -196,7 +196,9 @@ const generateComponentPropTypes = (componentName?: string) => {
 	try {
 		const componentPropTypeSymbols = componentIndexSourceFile
 			.getExportSymbols()
-			.filter((symbol) => symbol.getName().endsWith(`${componentName}Props` ?? 'Props'))
+			.filter((symbol) =>
+				symbol.getName().endsWith(componentName ? `${componentName}Props` : 'Props'),
+			)
 			.sort((a, b) => a.getName().localeCompare(b.getName()));
 
 		// generate share types file first

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

@@ -3,9 +3,9 @@
  *
  * Extract component prop types from UIKit 2 components - AdfRendererProps
  *
- * @codegen <<SignedSource::5e5e266275ea97ba9ead9f2dca647d84>>
+ * @codegen <<SignedSource::4e44b65ce16ded81aeeb086d4abf54c9>>
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/adfrenderer/index.tsx <<SignedSource::12eb3f93e6fda477a20a6813ed9107ac>>
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/adfrenderer/index.tsx <<SignedSource::38be261305900c390921675abcf4c90c>>
  */
 /* eslint @repo/internal/codegen/signed-source-integrity: "warn" */
 
@@ -29,16 +29,18 @@ export type AdfRendererProps = RendererProps & {
 	 *
 	 * @type [Visitor](https://bitbucket.org/atlassian/atlassian-frontend-mirror/src/master/editor/adf-utils/src/types/index.ts)
 	 */
-	replaceUnsupportedNode?: Function
+	replaceUnsupportedNode?: Function;
 };
 
 /**
  * The AdfRenderer component provides a way to render a valid ADF document, using the same renderer that Atlassian uses internally to render ADF content in Confluence pages, Jira work items, and so on.
  * It allows you to replace node types that are unsupported in the context of a Forge app with replacement content, or remove them entirely.
  * See [Atlassian Document Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/) for information on valid nodes.
- * 
+ *
  * This component uses [@atlaskit/renderer](https://www.npmjs.com/package/@atlaskit/renderer) under the hood.
- * 
+ *
  * Visit [Renderer editor](https://atlaskit.atlassian.com/examples/editor/renderer/basic) for a comprehensive list of different ADF document examples
+ *
+ * @see [AdfRenderer](https://developer.atlassian.com/platform/forge/ui-kit/components/adfRenderer/) in UI Kit documentation for more information
  */
 export type TAdfRenderer<T> = (props: AdfRendererProps) => T;

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

@@ -3,7 +3,7 @@
  *
  * Extract component prop types from UIKit 2 components - BadgeProps
  *
- * @codegen <<SignedSource::64c7e35a348ef5e063329091a361292f>>
+ * @codegen <<SignedSource::c3ed8f1b656c7e1c4a9aad0919de3f7d>>
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/badge/__generated__/index.partial.tsx <<SignedSource::89ad3341c1b8ef4b6fc93df162ac91d3>>
  */
@@ -29,5 +29,7 @@ export type BadgeProps = Pick<
 
 /**
  * A badge is a visual indicator for numeric values such as tallies and scores.
+ *
+ * @see [Badge](https://developer.atlassian.com/platform/forge/ui-kit/components/badge/) in UI Kit documentation for more information
  */
 export type TBadge<T> = (props: BadgeProps) => T;

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

@@ -3,9 +3,9 @@
  *
  * Extract component prop types from UIKit 2 components - BleedProps
  *
- * @codegen <<SignedSource::c7fc1c22894c170849e24bf5e8171def>>
+ * @codegen <<SignedSource::cc28f1caa57c117f8db064f643bfe56d>>
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/bleed/__generated__/index.partial.tsx <<SignedSource::a2cfcd6831a7e1c773ef12a09fc07228>>
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/bleed/__generated__/index.partial.tsx <<SignedSource::406ffef6715a3dff3aa10511e2ec232c>>
  */
 /* eslint @repo/internal/codegen/signed-source-integrity: "warn" */
 
@@ -19,7 +19,4 @@ export type BleedProps = Pick<
   'children' | 'all' | 'inline' | 'block' | 'testId' | 'role'
 >;
 
-/**
- * Primitives are token-backed low-level building blocks.
- */
 export type TBleed<T> = (props: BleedProps) => T;

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

@@ -3,7 +3,7 @@
  *
  * Extract component prop types from UIKit 2 components - BoxProps
  *
- * @codegen <<SignedSource::60edface96d5ea8300c5007b008cafad>>
+ * @codegen <<SignedSource::8ab6a67fa03d077a43a19a7e31c78146>>
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/box/__generated__/index.partial.tsx <<SignedSource::898e2c561f956fd22d43ade8ef60ca57>>
  */
@@ -272,5 +272,7 @@ export type BoxProps = Pick<PlatformBoxProps, 'children' | 'ref' | 'testId'> & {
 
 /**
  * A box is a generic container that provides managed access to design tokens.
+ *
+ * @see [Box](https://developer.atlassian.com/platform/forge/ui-kit/components/box/) in UI Kit documentation for more information
  */
 export type TBox<T> = (props: BoxProps) => T;

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

@@ -3,7 +3,7 @@
  *
  * Extract component prop types from UIKit 2 components - ButtonGroupProps
  *
- * @codegen <<SignedSource::cfcaf362cef2884ded73338c52c8f437>>
+ * @codegen <<SignedSource::1961536cd507ac4a052deeb8743f1267>>
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/button/__generated__/button-group.partial.tsx <<SignedSource::83622155981d05f77224a32bab4969b5>>
  */
@@ -19,5 +19,7 @@ export type ButtonGroupProps = Pick<
 
 /**
  * A button group gives users access to frequently performed, related actions.
+ *
+ * @see [ButtonGroup](https://developer.atlassian.com/platform/forge/ui-kit/components/button-group/) in UI Kit documentation for more information
  */
 export type TButtonGroup<T> = (props: ButtonGroupProps) => T;

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

@@ -3,7 +3,7 @@
  *
  * Extract component prop types from UIKit 2 components - ButtonProps
  *
- * @codegen <<SignedSource::77d1847e88419084fc81129d7637b40b>>
+ * @codegen <<SignedSource::8d3c96f4416729b792a7d3460ae23a27>>
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/button/__generated__/index.partial.tsx <<SignedSource::f9a16b36e0a307a53ee30a009373ab49>>
  */
@@ -393,5 +393,7 @@ export type ButtonProps = Pick<
 
 /**
  * A button triggers an event or action. They let users know what will happen next.
+ *
+ * @see [Button](https://developer.atlassian.com/platform/forge/ui-kit/components/button/) in UI Kit documentation for more information
  */
 export type TButton<T> = (props: ButtonProps) => T;

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

@@ -3,7 +3,7 @@
  *
  * Extract component prop types from UIKit 2 components - CalendarProps
  *
- * @codegen <<SignedSource::87bad6f2a27e493eeba6d969450d3a3d>>
+ * @codegen <<SignedSource::497faee84f851775b401af97ebfc5c12>>
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/calendar/__generated__/index.partial.tsx <<SignedSource::3fb4c1249481ec420be5118220ebcd82>>
  */
@@ -21,5 +21,7 @@ export type CalendarProps = Pick<
 
 /**
  * An interactive calendar for date selection experiences.
+ *
+ * @see [Calendar](https://developer.atlassian.com/platform/forge/ui-kit/components/calendar/) in UI Kit documentation for more information
  */
 export type TCalendar<T> = (props: CalendarProps) => T;

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

@@ -3,7 +3,7 @@
  *
  * Extract component prop types from UIKit 2 components - CheckboxGroupProps
  *
- * @codegen <<SignedSource::89e98a25ac16f92b5d18b061bb6fce57>>
+ * @codegen <<SignedSource::63e9cf6f2e444db397f9e170b4e1ce7b>>
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/checkboxgroup/index.tsx <<SignedSource::4db9e0c029805d1c1fd28b923f3dbae3>>
  */
@@ -38,5 +38,7 @@ export interface CheckboxGroupProps {
 
 /**
  * A Checkbox group is a list of options where one or more choices can be selected.
+ *
+ * @see [CheckboxGroup](https://developer.atlassian.com/platform/forge/ui-kit/components/checkbox-group/) in UI Kit documentation for more information
  */
 export type TCheckboxGroup<T> = (props: CheckboxGroupProps) => T;

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

@@ -3,7 +3,7 @@
  *
  * Extract component prop types from UIKit 2 components - CheckboxProps
  *
- * @codegen <<SignedSource::7f4aa902734166585716f52e001a6d8f>>
+ * @codegen <<SignedSource::d5cd5c6518e80c98416fc61091717141>>
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/checkbox/__generated__/index.partial.tsx <<SignedSource::e34c0ab52d3409a8548b6e51450ba43b>>
  */
@@ -23,5 +23,7 @@ export type CheckboxProps = Pick<
 
 /**
  * A checkbox is an input control that allows a user to select one or more options from a number of choices.
+ *
+ * @see [Checkbox](https://developer.atlassian.com/platform/forge/ui-kit/components/checkbox/) in UI Kit documentation for more information
  */
 export type TCheckbox<T> = (props: CheckboxProps) => T;

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

@@ -3,7 +3,7 @@
  *
  * Extract component prop types from UIKit 2 components - CodeBlockProps
  *
- * @codegen <<SignedSource::7ac72aa38d908f5ad8be5452cccb84d1>>
+ * @codegen <<SignedSource::8ab4ed1e38d2bd1f9ceafe4cbc20f97d>>
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/code/__generated__/codeblock.partial.tsx <<SignedSource::88ed38fdfc47db0938e7801195a00403>>
  */
@@ -21,5 +21,7 @@ export type CodeBlockProps = Pick<
 
 /**
  * Code highlights short strings of code snippets inline with body text.
+ *
+ * @see [CodeBlock](https://developer.atlassian.com/platform/forge/ui-kit/components/code-block/) in UI Kit documentation for more information
  */
 export type TCodeBlock<T> = (props: CodeBlockProps) => T;

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

@@ -3,9 +3,9 @@
  *
  * Extract component prop types from UIKit 2 components - CodeProps
  *
- * @codegen <<SignedSource::e0386444a3c82762fe87b25289122301>>
+ * @codegen <<SignedSource::baf6b565e34d8df53db53b8855ec120d>>
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/code/__generated__/code.partial.tsx <<SignedSource::a54209d8f81fb1e2f354f4563725efeb>>
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/code/__generated__/code.partial.tsx <<SignedSource::6f210b052488fe7ece12d865706a551e>>
  */
 /* eslint @repo/internal/codegen/signed-source-integrity: "warn" */
 
@@ -21,5 +21,7 @@ export type CodeProps = Pick<
 
 /**
  * Code highlights short strings of code snippets inline with body text.
+ *
+ * @see [Code](https://developer.atlassian.com/platform/forge/ui-kit/components/code/) in UI Kit documentation for more information
  */
 export type TCode<T> = (props: CodeProps) => T;

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

@@ -3,7 +3,7 @@
  *
  * Extract component prop types from UIKit 2 components - DatePickerProps
  *
- * @codegen <<SignedSource::a4fe0c77ab65e00b2bc8ebeadd33e2e3>>
+ * @codegen <<SignedSource::d146cd7a368d85498c033934001b9a6c>>
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/datepicker/__generated__/index.partial.tsx <<SignedSource::5dcbe693f00f3a2725b9e64932a3309c>>
  */
@@ -55,5 +55,7 @@ export type DatePickerProps = {
 
 /**
  * A date picker allows the user to select a particular date.
+ *
+ * @see [DatePicker](https://developer.atlassian.com/platform/forge/ui-kit/components/date-picker/) in UI Kit documentation for more information
  */
 export type TDatePicker<T> = (props: DatePickerProps) => T;

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

@@ -3,7 +3,7 @@
  *
  * Extract component prop types from UIKit 2 components - DynamicTableProps
  *
- * @codegen <<SignedSource::213e682fc5fc702c30fb176cf45969b3>>
+ * @codegen <<SignedSource::8923606b45ea3fb8adc1f391645ee46e>>
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/dynamictable/__generated__/index.partial.tsx <<SignedSource::579e3dddf7bd4b762d0fd40744619b89>>
  */
@@ -42,5 +42,7 @@ export type DynamicTableProps = Pick<
 
 /**
  * A dynamic table displays rows of data with built-in pagination, sorting, and re-ordering functionality.
+ *
+ * @see [DynamicTable](https://developer.atlassian.com/platform/forge/ui-kit/components/dynamic-table/) in UI Kit documentation for more information
  */
 export type TDynamicTable<T> = (props: DynamicTableProps) => T;

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

@@ -3,7 +3,7 @@
  *
  * Extract component prop types from UIKit 2 components - EmptyStateProps
  *
- * @codegen <<SignedSource::07a70b90ed6e68ae200fd5e38e163a89>>
+ * @codegen <<SignedSource::142748ed4aa864312e3b9ea16f297672>>
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/emptystate/__generated__/index.partial.tsx <<SignedSource::d6c509a722d55de0f55d401cd2e75435>>
  */
@@ -21,5 +21,7 @@ export type EmptyStateProps = Pick<
 
 /**
  * An empty state appears when there is no data to display and describes what the user can do next.
+ *
+ * @see [EmptyState](https://developer.atlassian.com/platform/forge/ui-kit/components/empty-state/) in UI Kit documentation for more information
  */
 export type TEmptyState<T> = (props: EmptyStateProps) => T;

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

@@ -3,7 +3,7 @@
  *
  * Extract component prop types from UIKit 2 components - ErrorMessageProps
  *
- * @codegen <<SignedSource::059ea63aef7f094365447bb300fed9f6>>
+ * @codegen <<SignedSource::f2821b3d824a19e37d6d769695a883f4>>
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/form/__generated__/error-message.partial.tsx <<SignedSource::3758488a0115c629a624fcaae1f524c7>>
  */
@@ -22,5 +22,7 @@ export type ErrorMessageProps = Pick<
 /**
  * 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".
+ *
+ * @see [ErrorMessage](https://developer.atlassian.com/platform/forge/ui-kit/components/form/#error-message) in UI Kit documentation for more information
  */
 export type TErrorMessage<T> = (props: ErrorMessageProps) => T;

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

@@ -3,7 +3,7 @@
  *
  * Extract component prop types from UIKit 2 components - FlexProps
  *
- * @codegen <<SignedSource::a7674fb0691e3265f6e0940ae4f938e1>>
+ * @codegen <<SignedSource::06ae2024098beefe1f0166cee45e00eb>>
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/flex/__generated__/index.partial.tsx <<SignedSource::0e480e44e57f21f761bec4613ac4988d>>
  */
@@ -21,5 +21,7 @@ export type FlexProps = Pick<
 
 /**
  * Primitives are token-backed low-level building blocks.
+ *
+ * @see [Flex](https://developer.atlassian.com/platform/forge/ui-kit/components/flex/) in UI Kit documentation for more information
  */
 export type TFlex<T> = (props: FlexProps) => T;

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

@@ -3,7 +3,7 @@
  *
  * Extract component prop types from UIKit 2 components - FormFooterProps
  *
- * @codegen <<SignedSource::e6d74700f46888d63a013f997339596b>>
+ * @codegen <<SignedSource::bd453251ee9501e44dfdef3abb96f526>>
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/form/__generated__/form-footer.partial.tsx <<SignedSource::0b729df36afbc86cc134984bb4c16b3e>>
  */
@@ -27,7 +27,9 @@ export type FormFooterProps = Pick<
 
 /**
  * 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.
+ *
+ * @see [FormFooter](https://developer.atlassian.com/platform/forge/ui-kit/components/form/#form-footer) in UI Kit documentation for more information
  */
 export type TFormFooter<T> = (props: FormFooterProps) => T;

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

@@ -3,7 +3,7 @@
  *
  * Extract component prop types from UIKit 2 components - FormHeaderProps
  *
- * @codegen <<SignedSource::7ef542fd2e0804c707145ab13db81db1>>
+ * @codegen <<SignedSource::29600e7cd4c837834bdf3e2642eb297f>>
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/form/__generated__/form-header.partial.tsx <<SignedSource::8791c333c19a64caa8dd6b7461a53082>>
  */
@@ -23,5 +23,7 @@ export type FormHeaderProps = Pick<
  * 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.
+ *
+ * @see [FormHeader](https://developer.atlassian.com/platform/forge/ui-kit/components/form/#form-header) in UI Kit documentation for more information
  */
 export type TFormHeader<T> = (props: FormHeaderProps) => T;

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

@@ -3,7 +3,7 @@
  *
  * Extract component prop types from UIKit 2 components - FormProps
  *
- * @codegen <<SignedSource::6ac049125d8d8c2436805c5e3a845802>>
+ * @codegen <<SignedSource::72d05fe1799ae83e2fbc1e01f76009ce>>
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/form/index.tsx <<SignedSource::b6dd991b4a5e73adbac9321d53cd909e>>
  */
@@ -27,5 +27,7 @@ export type FormProps = {
 
 /**
  * A form allows users to input information.
+ *
+ * @see [Form](https://developer.atlassian.com/platform/forge/ui-kit/components/form/) in UI Kit documentation for more information
  */
 export type TForm<T> = (props: FormProps) => T;

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

@@ -3,7 +3,7 @@
  *
  * Extract component prop types from UIKit 2 components - FormSectionProps
  *
- * @codegen <<SignedSource::2d079615b76393e9241b054b75fde5f3>>
+ * @codegen <<SignedSource::c85e38840c5dd01b51a1c9fabeaf226b>>
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/form/__generated__/form-section.partial.tsx <<SignedSource::0dd9401d75f62dec7336bdea43302961>>
  */
@@ -22,5 +22,7 @@ export type FormSectionProps = Pick<
 /**
  * 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.
+ *
+ * @see [FormSection](https://developer.atlassian.com/platform/forge/ui-kit/components/form/#form-section) in UI Kit documentation for more information
  */
 export type TFormSection<T> = (props: FormSectionProps) => T;

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

@@ -3,7 +3,7 @@
  *
  * Extract component prop types from UIKit 2 components - HeadingProps
  *
- * @codegen <<SignedSource::b8bb5780d2b0112f8f2a4c7190d63fc7>>
+ * @codegen <<SignedSource::c2e29c89ead70009a792cea03271e9c4>>
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/heading/__generated__/index.partial.tsx <<SignedSource::96b99b296364dce930bb91174b226eaa>>
  */
@@ -22,5 +22,7 @@ export type HeadingProps = Pick<PlatformHeadingProps, 'children' | 'id' | 'testI
 
 /**
  * A heading is a typography component used to display text in different sizes and formats.
+ *
+ * @see [Heading](https://developer.atlassian.com/platform/forge/ui-kit/components/heading/) in UI Kit documentation for more information
  */
 export type THeading<T> = (props: HeadingProps) => T;

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

@@ -3,7 +3,7 @@
  *
  * Extract component prop types from UIKit 2 components - HelperMessageProps
  *
- * @codegen <<SignedSource::0da9514581e07c67f8f9a8ba0d9774b9>>
+ * @codegen <<SignedSource::867186ab9065c1955019578515e5b441>>
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/form/__generated__/helper-message.partial.tsx <<SignedSource::03fa772bfaf53905106f1cafbb428104>>
  */
@@ -22,5 +22,7 @@ export type HelperMessageProps = Pick<
 /**
  * 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".
+ *
+ * @see [HelperMessage](https://developer.atlassian.com/platform/forge/ui-kit/components/form/#helper-message) in UI Kit documentation for more information
  */
 export type THelperMessage<T> = (props: HelperMessageProps) => T;

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

@@ -3,7 +3,7 @@
  *
  * Extract component prop types from UIKit 2 components - IconProps
  *
- * @codegen <<SignedSource::b24cc22d6f60b86f1646a75a0bafc7cd>>
+ * @codegen <<SignedSource::40d5e815277b3ce91da33d74742659fc>>
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/icon/index.tsx <<SignedSource::54a87ae131386a26a52d09234f67aa98>>
  */
@@ -401,5 +401,7 @@ export interface IconProps {
 
 /**
  * An icon is a visual representation of a command, device, directory, or common action.
+ *
+ * @see [Icon](https://developer.atlassian.com/platform/forge/ui-kit/components/icon/) in UI Kit documentation for more information
  */
 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::450b0aa0943b6519e89ee7c91f4124ad>>
+ * @codegen <<SignedSource::76e64cd0950ea7da3cf92b08df75f5fc>>
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/inline-edit/index.tsx <<SignedSource::23f59ce10b527efc04d36919c24aa2b0>>
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/inline-edit/index.tsx <<SignedSource::7654358cb6b3406900f008113b08977d>>
  */
 /* eslint @repo/internal/codegen/signed-source-integrity: "warn" */
 
@@ -32,5 +32,7 @@ export type InlineEditProps<V = string> = Omit<
 
 /**
  * An inline edit displays a custom input component that switches between reading and editing on the same page.
+ *
+ * @see [InlineEdit](https://developer.atlassian.com/platform/forge/ui-kit/components/inline-edit/) in UI Kit documentation for more information
  */
 export type TInlineEdit<T> = (props: InlineEditProps) => T;

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

@@ -3,7 +3,7 @@
  *
  * Extract component prop types from UIKit 2 components - InlineProps
  *
- * @codegen <<SignedSource::7e0e8c23de8b2392bf101ad017431b86>>
+ * @codegen <<SignedSource::a184afd895391ad501b67ca2a5c49fc1>>
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/inline/__generated__/index.partial.tsx <<SignedSource::8123157b2afe19d52b47110fb754d43b>>
  */
@@ -21,5 +21,7 @@ export type InlineProps = Pick<
 
 /**
  * An inline manages the horizontal layout of direct children using flexbox.
+ *
+ * @see [Inline](https://developer.atlassian.com/platform/forge/ui-kit/components/inline/) in UI Kit documentation for more information
  */
 export type TInline<T> = (props: InlineProps) => T;

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

@@ -3,7 +3,7 @@
  *
  * Extract component prop types from UIKit 2 components - LabelProps
  *
- * @codegen <<SignedSource::f12ab4339e5503f7db96ce306da7f685>>
+ * @codegen <<SignedSource::6f1e8259b596a6ca722fcbcb3eb8e4bd>>
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/form/__generated__/label.partial.tsx <<SignedSource::55ecafcd1d98afb9b7f6f37d5168725c>>
  */
@@ -17,5 +17,7 @@ export type LabelProps = Pick<PlatformLabelProps, 'children' | 'testId' | 'id'>
 
 /**
  * A label represents a caption for an item in a user interface.
+ *
+ * @see [Label](https://developer.atlassian.com/platform/forge/ui-kit/components/form/#label) in UI Kit documentation for more information
  */
 export type TLabel<T> = (props: LabelProps) => T;