@atlaskit/forge-react-types 0.37.12 → 0.37.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (187) hide show
  1. package/CHANGELOG.md +9 -0
  2. package/dist/cjs/components/__generated__/BoxProps.codegen.js +3 -1
  3. package/dist/es2019/components/__generated__/BoxProps.codegen.js +3 -1
  4. package/dist/esm/components/__generated__/BoxProps.codegen.js +3 -1
  5. package/dist/types/components/__generated__/AdfRendererProps.codegen.d.ts +4 -2
  6. package/dist/types/components/__generated__/BadgeProps.codegen.d.ts +3 -1
  7. package/dist/types/components/__generated__/BleedProps.codegen.d.ts +2 -5
  8. package/dist/types/components/__generated__/BoxProps.codegen.d.ts +3 -1
  9. package/dist/types/components/__generated__/ButtonGroupProps.codegen.d.ts +3 -1
  10. package/dist/types/components/__generated__/ButtonProps.codegen.d.ts +3 -1
  11. package/dist/types/components/__generated__/CalendarProps.codegen.d.ts +3 -1
  12. package/dist/types/components/__generated__/CheckboxGroupProps.codegen.d.ts +3 -1
  13. package/dist/types/components/__generated__/CheckboxProps.codegen.d.ts +3 -1
  14. package/dist/types/components/__generated__/CodeBlockProps.codegen.d.ts +3 -1
  15. package/dist/types/components/__generated__/CodeProps.codegen.d.ts +4 -2
  16. package/dist/types/components/__generated__/DatePickerProps.codegen.d.ts +3 -1
  17. package/dist/types/components/__generated__/DynamicTableProps.codegen.d.ts +3 -1
  18. package/dist/types/components/__generated__/EmptyStateProps.codegen.d.ts +3 -1
  19. package/dist/types/components/__generated__/ErrorMessageProps.codegen.d.ts +3 -1
  20. package/dist/types/components/__generated__/FlexProps.codegen.d.ts +3 -1
  21. package/dist/types/components/__generated__/FormFooterProps.codegen.d.ts +3 -1
  22. package/dist/types/components/__generated__/FormHeaderProps.codegen.d.ts +3 -1
  23. package/dist/types/components/__generated__/FormProps.codegen.d.ts +3 -1
  24. package/dist/types/components/__generated__/FormSectionProps.codegen.d.ts +3 -1
  25. package/dist/types/components/__generated__/HeadingProps.codegen.d.ts +3 -1
  26. package/dist/types/components/__generated__/HelperMessageProps.codegen.d.ts +3 -1
  27. package/dist/types/components/__generated__/IconProps.codegen.d.ts +3 -1
  28. package/dist/types/components/__generated__/InlineEditProps.codegen.d.ts +4 -2
  29. package/dist/types/components/__generated__/InlineProps.codegen.d.ts +3 -1
  30. package/dist/types/components/__generated__/LabelProps.codegen.d.ts +3 -1
  31. package/dist/types/components/__generated__/LinkButtonProps.codegen.d.ts +3 -1
  32. package/dist/types/components/__generated__/ListProps.codegen.d.ts +4 -2
  33. package/dist/types/components/__generated__/LoadingButtonProps.codegen.d.ts +3 -1
  34. package/dist/types/components/__generated__/LozengeProps.codegen.d.ts +3 -1
  35. package/dist/types/components/__generated__/ModalBodyProps.codegen.d.ts +3 -1
  36. package/dist/types/components/__generated__/ModalFooterProps.codegen.d.ts +3 -1
  37. package/dist/types/components/__generated__/ModalHeaderProps.codegen.d.ts +3 -1
  38. package/dist/types/components/__generated__/ModalProps.codegen.d.ts +3 -1
  39. package/dist/types/components/__generated__/ModalTitleProps.codegen.d.ts +3 -1
  40. package/dist/types/components/__generated__/ModalTransitionProps.codegen.d.ts +3 -1
  41. package/dist/types/components/__generated__/PopupProps.codegen.d.ts +4 -2
  42. package/dist/types/components/__generated__/ProgressBarProps.codegen.d.ts +3 -1
  43. package/dist/types/components/__generated__/ProgressTrackerProps.codegen.d.ts +3 -1
  44. package/dist/types/components/__generated__/RadioGroupProps.codegen.d.ts +3 -1
  45. package/dist/types/components/__generated__/RadioProps.codegen.d.ts +3 -1
  46. package/dist/types/components/__generated__/RangeProps.codegen.d.ts +3 -1
  47. package/dist/types/components/__generated__/SectionMessageActionProps.codegen.d.ts +3 -1
  48. package/dist/types/components/__generated__/SectionMessageProps.codegen.d.ts +3 -1
  49. package/dist/types/components/__generated__/SelectProps.codegen.d.ts +3 -1
  50. package/dist/types/components/__generated__/SpinnerProps.codegen.d.ts +3 -1
  51. package/dist/types/components/__generated__/StackProps.codegen.d.ts +3 -1
  52. package/dist/types/components/__generated__/TabListProps.codegen.d.ts +3 -1
  53. package/dist/types/components/__generated__/TabPanelProps.codegen.d.ts +3 -1
  54. package/dist/types/components/__generated__/TabProps.codegen.d.ts +3 -1
  55. package/dist/types/components/__generated__/TabsProps.codegen.d.ts +3 -1
  56. package/dist/types/components/__generated__/TagGroupProps.codegen.d.ts +3 -1
  57. package/dist/types/components/__generated__/TagProps.codegen.d.ts +3 -1
  58. package/dist/types/components/__generated__/TextAreaProps.codegen.d.ts +3 -1
  59. package/dist/types/components/__generated__/TextProps.codegen.d.ts +5 -3
  60. package/dist/types/components/__generated__/TextfieldProps.codegen.d.ts +3 -1
  61. package/dist/types/components/__generated__/TimePickerProps.codegen.d.ts +3 -1
  62. package/dist/types/components/__generated__/ToggleProps.codegen.d.ts +3 -1
  63. package/dist/types/components/__generated__/TooltipProps.codegen.d.ts +3 -1
  64. package/dist/types/components/__generated__/ValidMessageProps.codegen.d.ts +3 -1
  65. package/dist/types-ts4.5/components/__generated__/AdfRendererProps.codegen.d.ts +4 -2
  66. package/dist/types-ts4.5/components/__generated__/BadgeProps.codegen.d.ts +3 -1
  67. package/dist/types-ts4.5/components/__generated__/BleedProps.codegen.d.ts +2 -5
  68. package/dist/types-ts4.5/components/__generated__/BoxProps.codegen.d.ts +3 -1
  69. package/dist/types-ts4.5/components/__generated__/ButtonGroupProps.codegen.d.ts +3 -1
  70. package/dist/types-ts4.5/components/__generated__/ButtonProps.codegen.d.ts +3 -1
  71. package/dist/types-ts4.5/components/__generated__/CalendarProps.codegen.d.ts +3 -1
  72. package/dist/types-ts4.5/components/__generated__/CheckboxGroupProps.codegen.d.ts +3 -1
  73. package/dist/types-ts4.5/components/__generated__/CheckboxProps.codegen.d.ts +3 -1
  74. package/dist/types-ts4.5/components/__generated__/CodeBlockProps.codegen.d.ts +3 -1
  75. package/dist/types-ts4.5/components/__generated__/CodeProps.codegen.d.ts +4 -2
  76. package/dist/types-ts4.5/components/__generated__/DatePickerProps.codegen.d.ts +3 -1
  77. package/dist/types-ts4.5/components/__generated__/DynamicTableProps.codegen.d.ts +3 -1
  78. package/dist/types-ts4.5/components/__generated__/EmptyStateProps.codegen.d.ts +3 -1
  79. package/dist/types-ts4.5/components/__generated__/ErrorMessageProps.codegen.d.ts +3 -1
  80. package/dist/types-ts4.5/components/__generated__/FlexProps.codegen.d.ts +3 -1
  81. package/dist/types-ts4.5/components/__generated__/FormFooterProps.codegen.d.ts +3 -1
  82. package/dist/types-ts4.5/components/__generated__/FormHeaderProps.codegen.d.ts +3 -1
  83. package/dist/types-ts4.5/components/__generated__/FormProps.codegen.d.ts +3 -1
  84. package/dist/types-ts4.5/components/__generated__/FormSectionProps.codegen.d.ts +3 -1
  85. package/dist/types-ts4.5/components/__generated__/HeadingProps.codegen.d.ts +3 -1
  86. package/dist/types-ts4.5/components/__generated__/HelperMessageProps.codegen.d.ts +3 -1
  87. package/dist/types-ts4.5/components/__generated__/IconProps.codegen.d.ts +3 -1
  88. package/dist/types-ts4.5/components/__generated__/InlineEditProps.codegen.d.ts +4 -2
  89. package/dist/types-ts4.5/components/__generated__/InlineProps.codegen.d.ts +3 -1
  90. package/dist/types-ts4.5/components/__generated__/LabelProps.codegen.d.ts +3 -1
  91. package/dist/types-ts4.5/components/__generated__/LinkButtonProps.codegen.d.ts +3 -1
  92. package/dist/types-ts4.5/components/__generated__/ListProps.codegen.d.ts +4 -2
  93. package/dist/types-ts4.5/components/__generated__/LoadingButtonProps.codegen.d.ts +3 -1
  94. package/dist/types-ts4.5/components/__generated__/LozengeProps.codegen.d.ts +3 -1
  95. package/dist/types-ts4.5/components/__generated__/ModalBodyProps.codegen.d.ts +3 -1
  96. package/dist/types-ts4.5/components/__generated__/ModalFooterProps.codegen.d.ts +3 -1
  97. package/dist/types-ts4.5/components/__generated__/ModalHeaderProps.codegen.d.ts +3 -1
  98. package/dist/types-ts4.5/components/__generated__/ModalProps.codegen.d.ts +3 -1
  99. package/dist/types-ts4.5/components/__generated__/ModalTitleProps.codegen.d.ts +3 -1
  100. package/dist/types-ts4.5/components/__generated__/ModalTransitionProps.codegen.d.ts +3 -1
  101. package/dist/types-ts4.5/components/__generated__/PopupProps.codegen.d.ts +4 -2
  102. package/dist/types-ts4.5/components/__generated__/ProgressBarProps.codegen.d.ts +3 -1
  103. package/dist/types-ts4.5/components/__generated__/ProgressTrackerProps.codegen.d.ts +3 -1
  104. package/dist/types-ts4.5/components/__generated__/RadioGroupProps.codegen.d.ts +3 -1
  105. package/dist/types-ts4.5/components/__generated__/RadioProps.codegen.d.ts +3 -1
  106. package/dist/types-ts4.5/components/__generated__/RangeProps.codegen.d.ts +3 -1
  107. package/dist/types-ts4.5/components/__generated__/SectionMessageActionProps.codegen.d.ts +3 -1
  108. package/dist/types-ts4.5/components/__generated__/SectionMessageProps.codegen.d.ts +3 -1
  109. package/dist/types-ts4.5/components/__generated__/SelectProps.codegen.d.ts +3 -1
  110. package/dist/types-ts4.5/components/__generated__/SpinnerProps.codegen.d.ts +3 -1
  111. package/dist/types-ts4.5/components/__generated__/StackProps.codegen.d.ts +3 -1
  112. package/dist/types-ts4.5/components/__generated__/TabListProps.codegen.d.ts +3 -1
  113. package/dist/types-ts4.5/components/__generated__/TabPanelProps.codegen.d.ts +3 -1
  114. package/dist/types-ts4.5/components/__generated__/TabProps.codegen.d.ts +3 -1
  115. package/dist/types-ts4.5/components/__generated__/TabsProps.codegen.d.ts +3 -1
  116. package/dist/types-ts4.5/components/__generated__/TagGroupProps.codegen.d.ts +3 -1
  117. package/dist/types-ts4.5/components/__generated__/TagProps.codegen.d.ts +3 -1
  118. package/dist/types-ts4.5/components/__generated__/TextAreaProps.codegen.d.ts +3 -1
  119. package/dist/types-ts4.5/components/__generated__/TextProps.codegen.d.ts +5 -3
  120. package/dist/types-ts4.5/components/__generated__/TextfieldProps.codegen.d.ts +3 -1
  121. package/dist/types-ts4.5/components/__generated__/TimePickerProps.codegen.d.ts +3 -1
  122. package/dist/types-ts4.5/components/__generated__/ToggleProps.codegen.d.ts +3 -1
  123. package/dist/types-ts4.5/components/__generated__/TooltipProps.codegen.d.ts +3 -1
  124. package/dist/types-ts4.5/components/__generated__/ValidMessageProps.codegen.d.ts +3 -1
  125. package/package.json +2 -1
  126. package/scripts/codegen/codeGenerator.ts +72 -2
  127. package/scripts/codegen/componentPropTypes.ts +3 -1
  128. package/src/components/__generated__/AdfRendererProps.codegen.tsx +7 -5
  129. package/src/components/__generated__/BadgeProps.codegen.tsx +3 -1
  130. package/src/components/__generated__/BleedProps.codegen.tsx +2 -5
  131. package/src/components/__generated__/BoxProps.codegen.tsx +3 -1
  132. package/src/components/__generated__/ButtonGroupProps.codegen.tsx +3 -1
  133. package/src/components/__generated__/ButtonProps.codegen.tsx +3 -1
  134. package/src/components/__generated__/CalendarProps.codegen.tsx +3 -1
  135. package/src/components/__generated__/CheckboxGroupProps.codegen.tsx +3 -1
  136. package/src/components/__generated__/CheckboxProps.codegen.tsx +3 -1
  137. package/src/components/__generated__/CodeBlockProps.codegen.tsx +3 -1
  138. package/src/components/__generated__/CodeProps.codegen.tsx +4 -2
  139. package/src/components/__generated__/DatePickerProps.codegen.tsx +3 -1
  140. package/src/components/__generated__/DynamicTableProps.codegen.tsx +3 -1
  141. package/src/components/__generated__/EmptyStateProps.codegen.tsx +3 -1
  142. package/src/components/__generated__/ErrorMessageProps.codegen.tsx +3 -1
  143. package/src/components/__generated__/FlexProps.codegen.tsx +3 -1
  144. package/src/components/__generated__/FormFooterProps.codegen.tsx +4 -2
  145. package/src/components/__generated__/FormHeaderProps.codegen.tsx +3 -1
  146. package/src/components/__generated__/FormProps.codegen.tsx +3 -1
  147. package/src/components/__generated__/FormSectionProps.codegen.tsx +3 -1
  148. package/src/components/__generated__/HeadingProps.codegen.tsx +3 -1
  149. package/src/components/__generated__/HelperMessageProps.codegen.tsx +3 -1
  150. package/src/components/__generated__/IconProps.codegen.tsx +3 -1
  151. package/src/components/__generated__/InlineEditProps.codegen.tsx +4 -2
  152. package/src/components/__generated__/InlineProps.codegen.tsx +3 -1
  153. package/src/components/__generated__/LabelProps.codegen.tsx +3 -1
  154. package/src/components/__generated__/LinkButtonProps.codegen.tsx +3 -1
  155. package/src/components/__generated__/ListProps.codegen.tsx +4 -2
  156. package/src/components/__generated__/LoadingButtonProps.codegen.tsx +3 -1
  157. package/src/components/__generated__/LozengeProps.codegen.tsx +3 -1
  158. package/src/components/__generated__/ModalBodyProps.codegen.tsx +3 -1
  159. package/src/components/__generated__/ModalFooterProps.codegen.tsx +3 -1
  160. package/src/components/__generated__/ModalHeaderProps.codegen.tsx +3 -1
  161. package/src/components/__generated__/ModalProps.codegen.tsx +3 -1
  162. package/src/components/__generated__/ModalTitleProps.codegen.tsx +3 -1
  163. package/src/components/__generated__/ModalTransitionProps.codegen.tsx +3 -1
  164. package/src/components/__generated__/PopupProps.codegen.tsx +4 -2
  165. package/src/components/__generated__/ProgressBarProps.codegen.tsx +3 -1
  166. package/src/components/__generated__/ProgressTrackerProps.codegen.tsx +3 -1
  167. package/src/components/__generated__/RadioGroupProps.codegen.tsx +3 -1
  168. package/src/components/__generated__/RadioProps.codegen.tsx +3 -1
  169. package/src/components/__generated__/RangeProps.codegen.tsx +3 -1
  170. package/src/components/__generated__/SectionMessageActionProps.codegen.tsx +3 -1
  171. package/src/components/__generated__/SectionMessageProps.codegen.tsx +3 -1
  172. package/src/components/__generated__/SelectProps.codegen.tsx +3 -1
  173. package/src/components/__generated__/SpinnerProps.codegen.tsx +3 -1
  174. package/src/components/__generated__/StackProps.codegen.tsx +3 -1
  175. package/src/components/__generated__/TabListProps.codegen.tsx +3 -1
  176. package/src/components/__generated__/TabPanelProps.codegen.tsx +3 -1
  177. package/src/components/__generated__/TabProps.codegen.tsx +3 -1
  178. package/src/components/__generated__/TabsProps.codegen.tsx +3 -1
  179. package/src/components/__generated__/TagGroupProps.codegen.tsx +3 -1
  180. package/src/components/__generated__/TagProps.codegen.tsx +3 -1
  181. package/src/components/__generated__/TextAreaProps.codegen.tsx +3 -1
  182. package/src/components/__generated__/TextProps.codegen.tsx +7 -5
  183. package/src/components/__generated__/TextfieldProps.codegen.tsx +3 -1
  184. package/src/components/__generated__/TimePickerProps.codegen.tsx +3 -1
  185. package/src/components/__generated__/ToggleProps.codegen.tsx +3 -1
  186. package/src/components/__generated__/TooltipProps.codegen.tsx +3 -1
  187. package/src/components/__generated__/ValidMessageProps.codegen.tsx +3 -1
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - ModalTitleProps
5
5
  *
6
- * @codegen <<SignedSource::1742968eb34a6998cf335abcdb9ecd22>>
6
+ * @codegen <<SignedSource::5848a62020e85d018a41fb99f5b8c979>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
8
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/modal/__generated__/modal-title.partial.tsx <<SignedSource::8f0848e3fabd3cf3660c08e2b1863bd9>>
9
9
  */
@@ -13,6 +13,8 @@ type PlatformModalTitleProps = React.ComponentProps<typeof PlatformModalTitle>;
13
13
  export type ModalTitleProps = Pick<PlatformModalTitleProps, 'appearance' | 'children' | 'isMultiline' | 'testId'>;
14
14
  /**
15
15
  * A modal title is used to display a title within a modal.
16
+ *
17
+ * @see [ModalTitle](https://developer.atlassian.com/platform/forge/ui-kit/components/modal/#title) in UI Kit documentation for more information
16
18
  */
17
19
  export type TModalTitle<T> = (props: ModalTitleProps) => T;
18
20
  export {};
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - ModalTransitionProps
5
5
  *
6
- * @codegen <<SignedSource::fbd2e79db623371d79d173ce8c807737>>
6
+ * @codegen <<SignedSource::4df20ec54754f56f2bdaeafb075be019>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
8
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/modal/__generated__/modal-transition.partial.tsx <<SignedSource::9a5d35aaedbe614414c801acffdbeeff>>
9
9
  */
@@ -13,6 +13,8 @@ type PlatformModalTransitionProps = React.ComponentProps<typeof PlatformModalTra
13
13
  export type ModalTransitionProps = Pick<PlatformModalTransitionProps, 'children'>;
14
14
  /**
15
15
  * A modal transition wraps a modal to provide a fluid transition upon opening and closing.
16
+ *
17
+ * @see [ModalTransition](https://developer.atlassian.com/platform/forge/ui-kit/components/modal/#modal-transition) in UI Kit documentation for more information
16
18
  */
17
19
  export type TModalTransition<T> = (props: ModalTransitionProps) => T;
18
20
  export {};
@@ -3,9 +3,9 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - PopupProps
5
5
  *
6
- * @codegen <<SignedSource::9c82b51dc6635d8638a1f1f24ceaec66>>
6
+ * @codegen <<SignedSource::1406c01bd678b4f8525d6b2e48bf6021>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/popup/index.tsx <<SignedSource::cafa3868628edc1953d996c860801ed5>>
8
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/popup/index.tsx <<SignedSource::ff9b9f72bb5b2721d62300345e310108>>
9
9
  */
10
10
  import React from 'react';
11
11
  import { default as PlatformPopup } from '@atlaskit/popup';
@@ -25,5 +25,7 @@ export type PopupProps = Omit<React.ComponentProps<typeof PlatformPopup>, 'popup
25
25
  };
26
26
  /**
27
27
  * A popup displays brief content in an overlay.
28
+ *
29
+ * @see [Popup](https://developer.atlassian.com/platform/forge/ui-kit/components/popup/) in UI Kit documentation for more information
28
30
  */
29
31
  export type TPopup<T> = (props: PopupProps) => T;
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - ProgressBarProps
5
5
  *
6
- * @codegen <<SignedSource::311fb087e468c54b326bbb425bd62594>>
6
+ * @codegen <<SignedSource::e0050bb3ee946768c292e24b263334d1>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
8
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/progressbar/__generated__/index.partial.tsx <<SignedSource::aafdad776f93c659dc29fdb27eca9027>>
9
9
  */
@@ -13,6 +13,8 @@ type PlatformProgressBarProps = React.ComponentProps<typeof PlatformProgressBar>
13
13
  export type ProgressBarProps = Pick<PlatformProgressBarProps, 'appearance' | 'ariaLabel' | 'isIndeterminate' | 'testId' | 'value'>;
14
14
  /**
15
15
  * A progress bar communicates the status of a system process.
16
+ *
17
+ * @see [ProgressBar](https://developer.atlassian.com/platform/forge/ui-kit/components/progress-bar/) in UI Kit documentation for more information
16
18
  */
17
19
  export type TProgressBar<T> = (props: ProgressBarProps) => T;
18
20
  export {};
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - ProgressTrackerProps
5
5
  *
6
- * @codegen <<SignedSource::936e27b6592ef14e79d5fe0a336ceb81>>
6
+ * @codegen <<SignedSource::69d1395fe597e269eaeb412f1b476443>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
8
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/progresstracker/__generated__/index.partial.tsx <<SignedSource::50d000e383a00beab96a51973f57c769>>
9
9
  */
@@ -14,6 +14,8 @@ export type ProgressTrackerProps = Pick<PlatformProgressTrackerProps, 'label' |
14
14
  };
15
15
  /**
16
16
  * A progress tracker displays the steps and progress through a journey.
17
+ *
18
+ * @see [ProgressTracker](https://developer.atlassian.com/platform/forge/ui-kit/components/progress-tracker/) in UI Kit documentation for more information
17
19
  */
18
20
  export type TProgressTracker<T> = (props: ProgressTrackerProps) => T;
19
21
  export {};
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - RadioGroupProps
5
5
  *
6
- * @codegen <<SignedSource::9e8f5f00ccd2499b16825fd3a979fa49>>
6
+ * @codegen <<SignedSource::62c3aaa3d85514469943303c4668c07b>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
8
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/radio/__generated__/radio-group.partial.tsx <<SignedSource::eb1a74ed6578669af32fa8e9eccfc967>>
9
9
  */
@@ -14,6 +14,8 @@ type PlatformRadioGroupProps = React.ComponentProps<typeof PlatformRadioGroup>;
14
14
  export type RadioGroupProps = Pick<PlatformRadioGroupProps, 'defaultValue' | 'options' | 'onInvalid' | 'testId' | 'isRequired' | 'isDisabled' | 'isInvalid' | 'value' | 'aria-labelledby' | 'name'> & Pick<EventHandlerProps, 'onChange'>;
15
15
  /**
16
16
  * A radio input allows users to select only one option from a number of choices. Radio is generally displayed in a radio group.
17
+ *
18
+ * @see [RadioGroup](https://developer.atlassian.com/platform/forge/ui-kit/components/radio-group/) in UI Kit documentation for more information
17
19
  */
18
20
  export type TRadioGroup<T> = (props: RadioGroupProps) => T;
19
21
  export {};
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - RadioProps
5
5
  *
6
- * @codegen <<SignedSource::15501f4da2db03fc496259f6cf9db704>>
6
+ * @codegen <<SignedSource::a7627645dca3852c8c716b51629a953d>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
8
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/radio/__generated__/index.partial.tsx <<SignedSource::24d94151d76a83de0609bd9b427e4f3a>>
9
9
  */
@@ -14,6 +14,8 @@ type PlatformRadioProps = React.ComponentProps<typeof PlatformRadio>;
14
14
  export type RadioProps = Pick<PlatformRadioProps, 'label' | 'testId' | 'isChecked' | 'ariaLabel' | 'onInvalid' | 'id' | 'isRequired' | 'isDisabled' | 'isInvalid' | 'value' | 'aria-invalid' | 'aria-labelledby' | 'name'> & Pick<EventHandlerProps, 'onChange' | 'onBlur' | 'onFocus'>;
15
15
  /**
16
16
  * A radio input allows users to select only one option from a number of choices. Radio is generally displayed in a radio group.
17
+ *
18
+ * @see [Radio](https://developer.atlassian.com/platform/forge/ui-kit/components/radio/) in UI Kit documentation for more information
17
19
  */
18
20
  export type TRadio<T> = (props: RadioProps) => T;
19
21
  export {};
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - RangeProps
5
5
  *
6
- * @codegen <<SignedSource::90b0ddabf2167e8a5baee6fb2a2c151d>>
6
+ * @codegen <<SignedSource::8059d330e7cc4a21c671966f6c2496cc>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
8
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/range/__generated__/index.partial.tsx <<SignedSource::66f3c55587192848bc42f9fc146e6c7e>>
9
9
  */
@@ -14,6 +14,8 @@ type PlatformRangeProps = React.ComponentProps<typeof PlatformRange>;
14
14
  export type RangeProps = Pick<PlatformRangeProps, 'defaultValue' | 'max' | 'min' | 'step' | 'testId' | 'onChange' | 'id' | 'isDisabled' | 'value' | 'aria-invalid' | 'aria-labelledby' | 'name'> & Pick<EventHandlerProps, 'onBlur' | 'onFocus'>;
15
15
  /**
16
16
  * A range lets users choose an approximate value on a slider.
17
+ *
18
+ * @see [Range](https://developer.atlassian.com/platform/forge/ui-kit/components/range/) in UI Kit documentation for more information
17
19
  */
18
20
  export type TRange<T> = (props: RangeProps) => T;
19
21
  export {};
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - SectionMessageActionProps
5
5
  *
6
- * @codegen <<SignedSource::ec58a4fcf2dc9bef11c61ab8aa605d64>>
6
+ * @codegen <<SignedSource::287b8b418516838ff371d14e49272fa5>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
8
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/sectionmessage/__generated__/action.partial.tsx <<SignedSource::50b24e38b69e96bf0beef119eeba8b2f>>
9
9
  */
@@ -13,6 +13,8 @@ type PlatformSectionMessageActionProps = React.ComponentProps<typeof PlatformSec
13
13
  export type SectionMessageActionProps = Pick<PlatformSectionMessageActionProps, 'children' | 'onClick' | 'href' | 'testId'>;
14
14
  /**
15
15
  * A section message is used to alert users to a particular section of the screen.
16
+ *
17
+ * @see [SectionMessageAction](https://developer.atlassian.com/platform/forge/ui-kit/components/section-message/#section-message-action) in UI Kit documentation for more information
16
18
  */
17
19
  export type TSectionMessageAction<T> = (props: SectionMessageActionProps) => T;
18
20
  export {};
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - SectionMessageProps
5
5
  *
6
- * @codegen <<SignedSource::a8d8f62dc2c73c2c021e658bd7efbcd7>>
6
+ * @codegen <<SignedSource::725983e3bb955783124380fc689f56de>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
8
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/sectionmessage/__generated__/index.partial.tsx <<SignedSource::164319f578b12a9ab6d85a5bd3e4cc8a>>
9
9
  */
@@ -13,6 +13,8 @@ type PlatformSectionMessageProps = React.ComponentProps<typeof PlatformSectionMe
13
13
  export type SectionMessageProps = Pick<PlatformSectionMessageProps, 'children' | 'appearance' | 'title' | 'actions' | 'testId'>;
14
14
  /**
15
15
  * A section message is used to alert users to a particular section of the screen.
16
+ *
17
+ * @see [SectionMessage](https://developer.atlassian.com/platform/forge/ui-kit/components/section-message/) in UI Kit documentation for more information
16
18
  */
17
19
  export type TSectionMessage<T> = (props: SectionMessageProps) => T;
18
20
  export {};
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - SelectProps
5
5
  *
6
- * @codegen <<SignedSource::27434c8de7f2e3082a44901a80c594a9>>
6
+ * @codegen <<SignedSource::e7cc2654f6b4dfb3d3f0374d0970989f>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
8
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/select/index.tsx <<SignedSource::f7eed13874b04c56ded5f3434e03c70e>>
9
9
  */
@@ -11,5 +11,7 @@ import type { SelectProps as PlatformSelectProps } from '@atlaskit/select';
11
11
  export type SelectProps = Pick<PlatformSelectProps<any, true | false>, 'appearance' | 'autoFocus' | 'closeMenuOnScroll' | 'closeMenuOnSelect' | 'defaultInputValue' | 'defaultMenuIsOpen' | 'defaultValue' | 'id' | 'inputId' | 'inputValue' | 'isClearable' | 'isDisabled' | 'isInvalid' | 'isLoading' | 'isMulti' | 'isSearchable' | 'menuIsOpen' | 'openMenuOnFocus' | 'name' | 'onBlur' | 'onChange' | 'onFocus' | 'onInputChange' | 'options' | 'placeholder' | 'spacing' | 'testId' | 'value' | 'isRequired'>;
12
12
  /**
13
13
  * Select allows users to make a single selection or multiple selections from a list of options.
14
+ *
15
+ * @see [Select](https://developer.atlassian.com/platform/forge/ui-kit/components/select/) in UI Kit documentation for more information
14
16
  */
15
17
  export type TSelect<T> = (props: SelectProps) => T;
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - SpinnerProps
5
5
  *
6
- * @codegen <<SignedSource::4e5a68490063fadaa3ca7fb88f04cb94>>
6
+ * @codegen <<SignedSource::da564e9fcc19afc8bb55ad494a1e1aa6>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
8
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/spinner/__generated__/index.partial.tsx <<SignedSource::d6138d211e143990a6133754180f565c>>
9
9
  */
@@ -13,6 +13,8 @@ type PlatformSpinnerProps = React.ComponentProps<typeof PlatformSpinner>;
13
13
  export type SpinnerProps = Pick<PlatformSpinnerProps, 'appearance' | 'delay' | 'label' | 'size' | 'testId'>;
14
14
  /**
15
15
  * A spinner is an animated spinning icon that lets users know content is being loaded.
16
+ *
17
+ * @see [Spinner](https://developer.atlassian.com/platform/forge/ui-kit/components/spinner/) in UI Kit documentation for more information
16
18
  */
17
19
  export type TSpinner<T> = (props: SpinnerProps) => T;
18
20
  export {};
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - StackProps
5
5
  *
6
- * @codegen <<SignedSource::d2ba0849ecf2dcab0851f9678f03e102>>
6
+ * @codegen <<SignedSource::b7d1ae39888c2693e5fc459da4e5871f>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
8
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/stack/__generated__/index.partial.tsx <<SignedSource::191f725f0992bea2117b07b99f6444de>>
9
9
  */
@@ -13,6 +13,8 @@ type PlatformStackProps = React.ComponentProps<typeof PlatformStack>;
13
13
  export type StackProps = Pick<PlatformStackProps, 'children' | 'alignBlock' | 'alignInline' | 'grow' | 'space' | 'spread' | 'testId'>;
14
14
  /**
15
15
  * A stack manages the vertical layout of direct children using flexbox.
16
+ *
17
+ * @see [Stack](https://developer.atlassian.com/platform/forge/ui-kit/components/stack/) in UI Kit documentation for more information
16
18
  */
17
19
  export type TStack<T> = (props: StackProps) => T;
18
20
  export {};
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - TabListProps
5
5
  *
6
- * @codegen <<SignedSource::2ac5252a55c5b4f8bbdf29439ab10dcf>>
6
+ * @codegen <<SignedSource::0ebcb7d52f40dc55d1ecb1924576a165>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
8
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/tabs/__generated__/tablist.partial.tsx <<SignedSource::fbd3384538b87c1a820790b55241ee21>>
9
9
  */
@@ -13,6 +13,8 @@ type PlatformTabListProps = React.ComponentProps<typeof PlatformTabList>;
13
13
  export type TabListProps = Pick<PlatformTabListProps, 'children'>;
14
14
  /**
15
15
  * A `TabList` groups `Tab` components together.
16
+ *
17
+ * @see [TabList](https://developer.atlassian.com/platform/forge/ui-kit/components/tab-list/) in UI Kit documentation for more information
16
18
  */
17
19
  export type TTabList<T> = (props: TabListProps) => T;
18
20
  export {};
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - TabPanelProps
5
5
  *
6
- * @codegen <<SignedSource::6ff302a008a6520f4b1b03de50bfe530>>
6
+ * @codegen <<SignedSource::81d45904da28e8174cfe981f4d3c9ff4>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
8
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/tabs/__generated__/tabpanel.partial.tsx <<SignedSource::e7936c96c90f8f4682c85a00f85a23f4>>
9
9
  */
@@ -13,6 +13,8 @@ type PlatformTabPanelProps = React.ComponentProps<typeof PlatformTabPanel>;
13
13
  export type TabPanelProps = Pick<PlatformTabPanelProps, 'children' | 'testId'>;
14
14
  /**
15
15
  * A `TabPanel` houses the contents of a `Tab`.
16
+ *
17
+ * @see [TabPanel](https://developer.atlassian.com/platform/forge/ui-kit/components/tabs/) in UI Kit documentation for more information
16
18
  */
17
19
  export type TTabPanel<T> = (props: TabPanelProps) => T;
18
20
  export {};
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - TabProps
5
5
  *
6
- * @codegen <<SignedSource::d69181ff464555d27568e977900710b6>>
6
+ * @codegen <<SignedSource::06bf788051c0103d75e2ff758f1982ad>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
8
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/tabs/__generated__/tab.partial.tsx <<SignedSource::05b588ddfb6bfa200363a1127660dce4>>
9
9
  */
@@ -13,6 +13,8 @@ type PlatformTabProps = React.ComponentProps<typeof PlatformTab>;
13
13
  export type TabProps = Pick<PlatformTabProps, 'children' | 'testId'>;
14
14
  /**
15
15
  * `Tab` represents an individual tab displayed in a TabList.
16
+ *
17
+ * @see [Tab](https://developer.atlassian.com/platform/forge/ui-kit/components/tabs/) in UI Kit documentation for more information
16
18
  */
17
19
  export type TTab<T> = (props: TabProps) => T;
18
20
  export {};
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - TabsProps
5
5
  *
6
- * @codegen <<SignedSource::218a06565465557c9f3831d190600268>>
6
+ * @codegen <<SignedSource::064a9bb9ab87e096878895e81bd4bf6a>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
8
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/tabs/__generated__/tabs.partial.tsx <<SignedSource::f5d8442dd79c61463d58ed2e436af3f4>>
9
9
  */
@@ -13,6 +13,8 @@ type PlatformTabsProps = React.ComponentProps<typeof PlatformTabs>;
13
13
  export type TabsProps = Pick<PlatformTabsProps, 'id' | 'children' | 'defaultSelected' | 'onChange' | 'selected' | 'shouldUnmountTabPanelOnChange' | 'testId'>;
14
14
  /**
15
15
  * Tabs are used to organize content by grouping similar information on the same page.
16
+ *
17
+ * @see [Tabs](https://developer.atlassian.com/platform/forge/ui-kit/components/tabs/) in UI Kit documentation for more information
16
18
  */
17
19
  export type TTabs<T> = (props: TabsProps) => T;
18
20
  export {};
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - TagGroupProps
5
5
  *
6
- * @codegen <<SignedSource::45fcdf87d3eec9b19786d1085f656356>>
6
+ * @codegen <<SignedSource::eaa939ea39a1dac5b1f04c5d6541463c>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
8
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/taggroup/__generated__/index.partial.tsx <<SignedSource::5ecfc76aae3b3e7f55b076d81f20c782>>
9
9
  */
@@ -13,6 +13,8 @@ type PlatformTagGroupProps = React.ComponentProps<typeof PlatformTagGroup>;
13
13
  export type TagGroupProps = Pick<PlatformTagGroupProps, 'children' | 'alignment'>;
14
14
  /**
15
15
  * A tag group controls the layout and alignment for a collection of tags.
16
+ *
17
+ * @see [TagGroup](https://developer.atlassian.com/platform/forge/ui-kit/components/tag-group/) in UI Kit documentation for more information
16
18
  */
17
19
  export type TTagGroup<T> = (props: TagGroupProps) => T;
18
20
  export {};
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - TagProps
5
5
  *
6
- * @codegen <<SignedSource::1d48163194ea309ddc6f7353e5123202>>
6
+ * @codegen <<SignedSource::8dd4fdab8ec8a06ebdaa818808a12d3a>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
8
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/tag/__generated__/index.partial.tsx <<SignedSource::1f9f7073797cd01947c622c0400785ae>>
9
9
  */
@@ -13,6 +13,8 @@ type PlatformSimpleTagProps = React.ComponentProps<typeof PlatformSimpleTag>;
13
13
  export type SimpleTagProps = Pick<PlatformSimpleTagProps, 'text' | 'appearance' | 'color' | 'elemBefore' | 'href' | 'testId'>;
14
14
  /**
15
15
  * A tag labels UI objects for quick recognition and navigation.
16
+ *
17
+ * @see [SimpleTag](https://developer.atlassian.com/platform/forge/ui-kit/components/tag/) in UI Kit documentation for more information
16
18
  */
17
19
  export type TSimpleTag<T> = (props: SimpleTagProps) => T;
18
20
  export {};
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - TextAreaProps
5
5
  *
6
- * @codegen <<SignedSource::4735e4d09b0b6c4a75fe1c08151b6054>>
6
+ * @codegen <<SignedSource::efe2109932fd748ce38c5d36a2ad4194>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
8
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/textarea/index.tsx <<SignedSource::282c20421c108bd52e5341ba0ee4293c>>
9
9
  */
@@ -14,6 +14,8 @@ type PlatformTextareaProps = React.ComponentProps<typeof PlatformTextarea>;
14
14
  export type TextAreaProps = Pick<PlatformTextareaProps, 'appearance' | 'defaultValue' | 'isCompact' | 'isMonospaced' | 'isReadOnly' | 'maxHeight' | 'minimumRows' | 'placeholder' | 'resize' | 'spellCheck' | 'testId' | 'maxLength' | 'minLength' | 'autoFocus' | 'id' | 'isRequired' | 'isDisabled' | 'isInvalid' | 'value' | 'aria-invalid' | 'aria-labelledby' | 'name'> & Pick<EventHandlerProps, 'onChange' | 'onBlur' | 'onFocus'>;
15
15
  /**
16
16
  * A text area lets users enter long form text which spans over multiple lines.
17
+ *
18
+ * @see [TextArea](https://developer.atlassian.com/platform/forge/ui-kit/components/text-area/) in UI Kit documentation for more information
17
19
  */
18
20
  export type TTextArea<T> = (props: TextAreaProps) => T;
19
21
  export {};
@@ -1,14 +1,16 @@
1
- import type { TextProps as PlatformTextProps } from '@atlaskit/primitives/compiled';
2
1
  /**
3
2
  * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
4
3
  *
5
4
  * Extract component prop types from UIKit 2 components - TextProps
6
5
  *
7
- * @codegen <<SignedSource::3f7781db8852b0cd5c500d260310f09f>>
6
+ * @codegen <<SignedSource::c90b3120290d482160619bb4fea7e76e>>
8
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
9
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/text/__generated__/index.partial.tsx <<SignedSource::0cf707b56e3bfd72ceec543d90b2f840>>
8
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/text/__generated__/index.partial.tsx <<SignedSource::c49669a7876b51b4a88645a51f7a1451>>
10
9
  */
10
+ import React from 'react';
11
+ import { Text as PlatformText } from '@atlaskit/primitives/compiled';
11
12
  type OriginalPlatformProps = Pick<PlatformTextProps, 'align' | 'as' | 'color' | 'maxLines' | 'size' | 'weight' | 'children' | 'testId'>;
13
+ type PlatformTextProps = React.ComponentProps<typeof PlatformText>;
12
14
  export type TextProps = Omit<OriginalPlatformProps, 'as'> & {
13
15
  as?: OriginalPlatformProps['as'] | 'strike';
14
16
  };
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - TextfieldProps
5
5
  *
6
- * @codegen <<SignedSource::4f0a7b04b3a23a5889553b2bfaf7f454>>
6
+ * @codegen <<SignedSource::31074b919540a908cdd081018805c121>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
8
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/textfield/index.tsx <<SignedSource::03b967815639a5a5aae4f79da283d410>>
9
9
  */
@@ -14,6 +14,8 @@ type PlatformTextfieldProps = React.ComponentProps<typeof PlatformTextfield>;
14
14
  export type TextfieldProps = Pick<PlatformTextfieldProps, 'appearance' | 'elemAfterInput' | 'elemBeforeInput' | 'isCompact' | 'autoFocus' | 'isReadOnly' | 'isMonospaced' | 'placeholder' | 'testId' | 'width' | 'type' | 'defaultValue' | 'min' | 'max' | 'maxLength' | 'minLength' | 'pattern' | 'id' | 'isRequired' | 'isDisabled' | 'isInvalid' | 'value' | 'aria-invalid' | 'aria-labelledby' | 'name'> & Pick<EventHandlerProps, 'onChange' | 'onBlur' | 'onFocus'>;
15
15
  /**
16
16
  * A text field is an input that allows a user to write or edit text.
17
+ *
18
+ * @see [Textfield](https://developer.atlassian.com/platform/forge/ui-kit/components/textfield/) in UI Kit documentation for more information
17
19
  */
18
20
  export type TTextfield<T> = (props: TextfieldProps) => T;
19
21
  export {};
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - TimePickerProps
5
5
  *
6
- * @codegen <<SignedSource::3f20d9d9bd43c0d792ea07ff9ecc23b1>>
6
+ * @codegen <<SignedSource::8bad83ca67ad4480f1f89ff352a7a18d>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
8
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/timepicker/__generated__/index.partial.tsx <<SignedSource::8f1c6ab03a29e7279ed2d3e82b086ab0>>
9
9
  */
@@ -45,6 +45,8 @@ export type TimePickerProps = {
45
45
  } & Partial<Omit<FieldProps, 'onChange'>>;
46
46
  /**
47
47
  * A time picker allows the user to select a specific time.
48
+ *
49
+ * @see [TimePicker](https://developer.atlassian.com/platform/forge/ui-kit/components/time-picker/) in UI Kit documentation for more information
48
50
  */
49
51
  export type TTimePicker<T> = (props: TimePickerProps) => T;
50
52
  export {};
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - ToggleProps
5
5
  *
6
- * @codegen <<SignedSource::388ba32ab2e4bdf3dbe9d05944eb41f0>>
6
+ * @codegen <<SignedSource::26b64a1506fb8a63c7850417f78fd7ba>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
8
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/toggle/__generated__/index.partial.tsx <<SignedSource::b7d6483e971110f0134e350247bb54af>>
9
9
  */
@@ -14,6 +14,8 @@ type PlatformToggleProps = React.ComponentProps<typeof PlatformToggle>;
14
14
  export type ToggleProps = Pick<PlatformToggleProps, 'size' | 'testId' | 'defaultChecked' | 'isChecked' | 'label' | 'id' | 'isDisabled' | 'value' | 'name'> & Pick<EventHandlerProps, 'onChange' | 'onBlur' | 'onFocus'>;
15
15
  /**
16
16
  * A toggle is used to view or switch between enabled or disabled states.
17
+ *
18
+ * @see [Toggle](https://developer.atlassian.com/platform/forge/ui-kit/components/toggle/) in UI Kit documentation for more information
17
19
  */
18
20
  export type TToggle<T> = (props: ToggleProps) => T;
19
21
  export {};
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - TooltipProps
5
5
  *
6
- * @codegen <<SignedSource::4b27e1c130769985576ab4c910715b03>>
6
+ * @codegen <<SignedSource::9aa991d0f73b4055a3453375ad75cd71>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
8
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/tooltip/__generated__/index.partial.tsx <<SignedSource::e3e388170520502310149f23b8defa27>>
9
9
  */
@@ -13,6 +13,8 @@ type PlatformTooltipProps = React.ComponentProps<typeof PlatformTooltip>;
13
13
  export type TooltipProps = Pick<PlatformTooltipProps, 'children' | 'position' | 'mousePosition' | 'content' | 'truncate' | 'testId' | 'delay'>;
14
14
  /**
15
15
  * A `Tooltip` is a floating, non-actionable label used to explain a user interface element or feature.
16
+ *
17
+ * @see [Tooltip](https://developer.atlassian.com/platform/forge/ui-kit/components/tooltip/) in UI Kit documentation for more information
16
18
  */
17
19
  export type TTooltip<T> = (props: TooltipProps) => T;
18
20
  export {};
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - ValidMessageProps
5
5
  *
6
- * @codegen <<SignedSource::4cc4d2511f92d5cb8969eb03a63cb079>>
6
+ * @codegen <<SignedSource::3eb0a5c4721b83e37d1bc27e5b9547e2>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
8
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/form/__generated__/valid-message.partial.tsx <<SignedSource::7c24bfd118e399bb212709c31585209b>>
9
9
  */
@@ -14,6 +14,8 @@ export type ValidMessageProps = Pick<PlatformValidMessageProps, 'children' | 'te
14
14
  /**
15
15
  * A valid message is used to tell a user that the field input is valid.
16
16
  * For example, a helper message could be "Nice one, this username is available".
17
+ *
18
+ * @see [ValidMessage](https://developer.atlassian.com/platform/forge/ui-kit/components/form/#validation-message) in UI Kit documentation for more information
17
19
  */
18
20
  export type TValidMessage<T> = (props: ValidMessageProps) => T;
19
21
  export {};
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/forge-react-types",
3
- "version": "0.37.12",
3
+ "version": "0.37.13",
4
4
  "description": "Component types for Forge UI Kit React components",
5
5
  "publishConfig": {
6
6
  "registry": "https://registry.npmjs.org/"
@@ -63,6 +63,7 @@
63
63
  "devDependencies": {
64
64
  "@atlassian/codegen": "^0.1.0",
65
65
  "@types/node": "~20.16.5",
66
+ "lodash": "^4.17.21",
66
67
  "react": "^18.2.0",
67
68
  "ts-morph": "^17.0.0",
68
69
  "ts-node": "^10.9.1",
@@ -6,6 +6,8 @@ import {
6
6
  type TypeAliasDeclaration,
7
7
  type ImportDeclaration,
8
8
  } from 'ts-morph';
9
+ // eslint-disable-next-line import/no-extraneous-dependencies
10
+ import kebabCase from 'lodash/kebabCase';
9
11
 
10
12
  const getNames = (symbol: Symbol) => {
11
13
  const name = symbol.getName();
@@ -53,6 +55,25 @@ const getBaseComponentSymbol = (componentSymbol: Symbol, sourceFile: SourceFile)
53
55
  * This function will extract the PlatformButtonProps type declaration.
54
56
  */
55
57
  const getDependentTypeDeclarations = (baseComponentPropSymbol: Symbol, sourceFile: SourceFile) => {
58
+ const declarations = getDependentTypeDeclarationsBase(baseComponentPropSymbol, sourceFile);
59
+
60
+ for (const declaration of declarations) {
61
+ // further extract dependent types from the dependent type declarations, if it is not yet the base component prop symbol
62
+ // e.g. Text component depends on OriginalPlatformProps which depends on PlatformTextProps
63
+ if (!declaration.getName().startsWith('_Platform') && !declaration.getName().startsWith('Platform')) {
64
+ const typeAliasSymbol = declaration.getSymbolOrThrow();
65
+ const baseComponentPropCode = getDeclaration(baseComponentPropSymbol).getText();
66
+ for (const dependentTypeAliasDeclaration of getDependentTypeDeclarationsBase(typeAliasSymbol, sourceFile)) {
67
+ if (baseComponentPropCode !== dependentTypeAliasDeclaration.getText()) {
68
+ declarations.push(dependentTypeAliasDeclaration);
69
+ }
70
+ }
71
+ }
72
+ }
73
+ return declarations;
74
+ };
75
+
76
+ const getDependentTypeDeclarationsBase = (baseComponentPropSymbol: Symbol, sourceFile: SourceFile) => {
56
77
  return sourceFile.getTypeAliases().reduce((declarations, typeAlias) => {
57
78
  const typeAliasName = typeAlias.getName();
58
79
  if (typeAliasName !== baseComponentPropSymbol.getName()) {
@@ -163,6 +184,7 @@ const extractImportDeclarations = (
163
184
  componentDeclarationCode,
164
185
  ...dependentTypeDeclarations.map((typeAlias) => typeAlias.getText()).filter((code) => !!code),
165
186
  ];
187
+
166
188
  return sourceFile
167
189
  .getImportDeclarations()
168
190
  .filter((declaration) => {
@@ -300,8 +322,13 @@ const resolveExternalTypesCode = (
300
322
  };
301
323
 
302
324
  const makeJSDocComment = (comment: string) => {
325
+ const commentBody = comment
326
+ .split('\n')
327
+ .map((line) => line.trimEnd())
328
+ .map((line) => (line.length === 0 ? ' *' : ` * ${line}`))
329
+ .join('\n');
303
330
  return `/**
304
- * ${comment.split('\n').join('\n * ')}
331
+ ${commentBody}
305
332
  */`;
306
333
  };
307
334
 
@@ -319,7 +346,13 @@ const getComponentTypeCode = (componentPropSymbol: Symbol, sourceFile: SourceFil
319
346
  .join('\n');
320
347
 
321
348
  if (comment && comment.length > 0) {
322
- statements.push(updateDACUrlInJSDocComment(makeJSDocComment(comment)));
349
+ let jsDocContent = comment;
350
+ const componentDocUrl = getUIKitComponentDocUrl(componentName);
351
+ if (componentDocUrl) {
352
+ jsDocContent = `${comment}\n\n@see [${componentName}](${getUIKitComponentDocUrl(componentName)}) in UI Kit documentation for more information`;
353
+ }
354
+
355
+ statements.push(updateDACUrlInJSDocComment(makeJSDocComment(jsDocContent)));
323
356
  }
324
357
  }
325
358
  statements.push(`export type T${componentName}<T> = (props: ${propName}) => T;`);
@@ -373,6 +406,43 @@ const getComponentPropsTypeCode = (componentPropSymbol: Symbol) => {
373
406
  return updateDACUrlInJSDocComment(sourceCode);
374
407
  };
375
408
 
409
+ // this is to map special cases, and we should later review them for better consistency
410
+ const componentPathMap: Record<string, string | false> = {
411
+ AdfRenderer: 'adfRenderer',
412
+ ErrorMessage: 'form/#error-message',
413
+ HelperMessage: 'form/#helper-message',
414
+ ValidMessage: 'form/#validation-message',
415
+ FormHeader: 'form/#form-header',
416
+ FormFooter: 'form/#form-footer',
417
+ FormSection: 'form/#form-section',
418
+ Label: 'form/#label',
419
+ LinkButton: 'button/#linkbutton-props',
420
+ LoadingButton: 'button/#loadingbutton-props',
421
+ ModalBody: 'modal/#body',
422
+ ModalFooter: 'modal/#footer',
423
+ ModalHeader: 'modal/#header',
424
+ ModalTitle: 'modal/#title',
425
+ ModalTransition: 'modal/#modal-transition',
426
+ SectionMessageAction: 'section-message/#section-message-action',
427
+ TabsList: 'tabs',
428
+ TabPanel: 'tabs',
429
+ Tab: 'tabs',
430
+ SimpleTag: 'tag',
431
+ Grid: false,
432
+ Bleed: false,
433
+ };
434
+
435
+ const getUIKitComponentDocUrl = (componentName: string) => {
436
+ const matchedComponentPath = componentPathMap[componentName];
437
+ if (matchedComponentPath === false) {
438
+ return null;
439
+ }
440
+ const baseComponentPath = matchedComponentPath ?? kebabCase(componentName);
441
+ const componentPath = baseComponentPath.includes('/#') ? baseComponentPath : `${baseComponentPath}/`;
442
+
443
+ return `/platform/forge/ui-kit/components/${componentPath}`;
444
+ };
445
+
376
446
  const baseGenerateComponentPropTypeSourceCode = (
377
447
  componentPropSymbol: Symbol,
378
448
  sourceFile: SourceFile,