@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
package/CHANGELOG.md CHANGED
@@ -1,5 +1,14 @@
1
1
  # @atlaskit/forge-react-types
2
2
 
3
+ ## 0.37.13
4
+
5
+ ### Patch Changes
6
+
7
+ - [#128027](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/128027)
8
+ [`db90756a95fcf`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/db90756a95fcf) -
9
+ Update component JSDoc comment to include link to forge component documentation
10
+ - Updated dependencies
11
+
3
12
  ## 0.37.12
4
13
 
5
14
  ### Patch Changes
@@ -8,7 +8,7 @@ Object.defineProperty(exports, "__esModule", {
8
8
  *
9
9
  * Extract component prop types from UIKit 2 components - BoxProps
10
10
  *
11
- * @codegen <<SignedSource::60edface96d5ea8300c5007b008cafad>>
11
+ * @codegen <<SignedSource::8ab6a67fa03d077a43a19a7e31c78146>>
12
12
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
13
13
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/box/__generated__/index.partial.tsx <<SignedSource::898e2c561f956fd22d43ade8ef60ca57>>
14
14
  */
@@ -182,4 +182,6 @@ var xcssValidator = makeXCSSValidator({
182
182
 
183
183
  /**
184
184
  * A box is a generic container that provides managed access to design tokens.
185
+ *
186
+ * @see [Box](https://developer.atlassian.com/platform/forge/ui-kit/components/box/) in UI Kit documentation for more information
185
187
  */
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - BoxProps
5
5
  *
6
- * @codegen <<SignedSource::60edface96d5ea8300c5007b008cafad>>
6
+ * @codegen <<SignedSource::8ab6a67fa03d077a43a19a7e31c78146>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
8
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/box/__generated__/index.partial.tsx <<SignedSource::898e2c561f956fd22d43ade8ef60ca57>>
9
9
  */
@@ -177,5 +177,7 @@ const xcssValidator = makeXCSSValidator({
177
177
 
178
178
  /**
179
179
  * A box is a generic container that provides managed access to design tokens.
180
+ *
181
+ * @see [Box](https://developer.atlassian.com/platform/forge/ui-kit/components/box/) in UI Kit documentation for more information
180
182
  */
181
183
  export {};
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - BoxProps
5
5
  *
6
- * @codegen <<SignedSource::60edface96d5ea8300c5007b008cafad>>
6
+ * @codegen <<SignedSource::8ab6a67fa03d077a43a19a7e31c78146>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
8
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/box/__generated__/index.partial.tsx <<SignedSource::898e2c561f956fd22d43ade8ef60ca57>>
9
9
  */
@@ -177,5 +177,7 @@ var xcssValidator = makeXCSSValidator({
177
177
 
178
178
  /**
179
179
  * A box is a generic container that provides managed access to design tokens.
180
+ *
181
+ * @see [Box](https://developer.atlassian.com/platform/forge/ui-kit/components/box/) in UI Kit documentation for more information
180
182
  */
181
183
  export {};
@@ -3,9 +3,9 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - AdfRendererProps
5
5
  *
6
- * @codegen <<SignedSource::5e5e266275ea97ba9ead9f2dca647d84>>
6
+ * @codegen <<SignedSource::4e44b65ce16ded81aeeb086d4abf54c9>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/adfrenderer/index.tsx <<SignedSource::12eb3f93e6fda477a20a6813ed9107ac>>
8
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/adfrenderer/index.tsx <<SignedSource::38be261305900c390921675abcf4c90c>>
9
9
  */
10
10
  import { type RendererProps } from '@atlaskit/renderer';
11
11
  import type { DocNode } from '@atlaskit/adf-schema';
@@ -35,5 +35,7 @@ export type AdfRendererProps = RendererProps & {
35
35
  * This component uses [@atlaskit/renderer](https://www.npmjs.com/package/@atlaskit/renderer) under the hood.
36
36
  *
37
37
  * Visit [Renderer editor](https://atlaskit.atlassian.com/examples/editor/renderer/basic) for a comprehensive list of different ADF document examples
38
+ *
39
+ * @see [AdfRenderer](https://developer.atlassian.com/platform/forge/ui-kit/components/adfRenderer/) in UI Kit documentation for more information
38
40
  */
39
41
  export type TAdfRenderer<T> = (props: AdfRendererProps) => T;
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - BadgeProps
5
5
  *
6
- * @codegen <<SignedSource::64c7e35a348ef5e063329091a361292f>>
6
+ * @codegen <<SignedSource::c3ed8f1b656c7e1c4a9aad0919de3f7d>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
8
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/badge/__generated__/index.partial.tsx <<SignedSource::89ad3341c1b8ef4b6fc93df162ac91d3>>
9
9
  */
@@ -21,6 +21,8 @@ export type PlatformBadgeProps = Omit<_PlatformBadgeProps, 'children'> & {
21
21
  export type BadgeProps = Pick<PlatformBadgeProps, 'appearance' | 'children' | 'max' | 'testId'>;
22
22
  /**
23
23
  * A badge is a visual indicator for numeric values such as tallies and scores.
24
+ *
25
+ * @see [Badge](https://developer.atlassian.com/platform/forge/ui-kit/components/badge/) in UI Kit documentation for more information
24
26
  */
25
27
  export type TBadge<T> = (props: BadgeProps) => T;
26
28
  export {};
@@ -3,16 +3,13 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - BleedProps
5
5
  *
6
- * @codegen <<SignedSource::c7fc1c22894c170849e24bf5e8171def>>
6
+ * @codegen <<SignedSource::cc28f1caa57c117f8db064f643bfe56d>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/bleed/__generated__/index.partial.tsx <<SignedSource::a2cfcd6831a7e1c773ef12a09fc07228>>
8
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/bleed/__generated__/index.partial.tsx <<SignedSource::406ffef6715a3dff3aa10511e2ec232c>>
9
9
  */
10
10
  import React from 'react';
11
11
  import { Bleed as PlatformBleed } from '@atlaskit/primitives';
12
12
  type PlatformBleedProps = React.ComponentProps<typeof PlatformBleed>;
13
13
  export type BleedProps = Pick<PlatformBleedProps, 'children' | 'all' | 'inline' | 'block' | 'testId' | 'role'>;
14
- /**
15
- * Primitives are token-backed low-level building blocks.
16
- */
17
14
  export type TBleed<T> = (props: BleedProps) => T;
18
15
  export {};
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - BoxProps
5
5
  *
6
- * @codegen <<SignedSource::60edface96d5ea8300c5007b008cafad>>
6
+ * @codegen <<SignedSource::8ab6a67fa03d077a43a19a7e31c78146>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
8
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/box/__generated__/index.partial.tsx <<SignedSource::898e2c561f956fd22d43ade8ef60ca57>>
9
9
  */
@@ -2431,5 +2431,7 @@ export type BoxProps = Pick<PlatformBoxProps, 'children' | 'ref' | 'testId'> & {
2431
2431
  };
2432
2432
  /**
2433
2433
  * A box is a generic container that provides managed access to design tokens.
2434
+ *
2435
+ * @see [Box](https://developer.atlassian.com/platform/forge/ui-kit/components/box/) in UI Kit documentation for more information
2434
2436
  */
2435
2437
  export type TBox<T> = (props: BoxProps) => T;
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - ButtonGroupProps
5
5
  *
6
- * @codegen <<SignedSource::cfcaf362cef2884ded73338c52c8f437>>
6
+ * @codegen <<SignedSource::1961536cd507ac4a052deeb8743f1267>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
8
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/button/__generated__/button-group.partial.tsx <<SignedSource::83622155981d05f77224a32bab4969b5>>
9
9
  */
@@ -14,5 +14,7 @@ export type ButtonGroupProps = Pick<PlatformButtonGroupProps, 'children' | 'test
14
14
  };
15
15
  /**
16
16
  * A button group gives users access to frequently performed, related actions.
17
+ *
18
+ * @see [ButtonGroup](https://developer.atlassian.com/platform/forge/ui-kit/components/button-group/) in UI Kit documentation for more information
17
19
  */
18
20
  export type TButtonGroup<T> = (props: ButtonGroupProps) => T;
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - ButtonProps
5
5
  *
6
- * @codegen <<SignedSource::77d1847e88419084fc81129d7637b40b>>
6
+ * @codegen <<SignedSource::8d3c96f4416729b792a7d3460ae23a27>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
8
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/button/__generated__/index.partial.tsx <<SignedSource::f9a16b36e0a307a53ee30a009373ab49>>
9
9
  */
@@ -17,6 +17,8 @@ export type ButtonProps = Pick<PlatformButtonProps, 'children' | 'autoFocus' | '
17
17
  };
18
18
  /**
19
19
  * A button triggers an event or action. They let users know what will happen next.
20
+ *
21
+ * @see [Button](https://developer.atlassian.com/platform/forge/ui-kit/components/button/) in UI Kit documentation for more information
20
22
  */
21
23
  export type TButton<T> = (props: ButtonProps) => T;
22
24
  export {};
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - CalendarProps
5
5
  *
6
- * @codegen <<SignedSource::87bad6f2a27e493eeba6d969450d3a3d>>
6
+ * @codegen <<SignedSource::497faee84f851775b401af97ebfc5c12>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
8
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/calendar/__generated__/index.partial.tsx <<SignedSource::3fb4c1249481ec420be5118220ebcd82>>
9
9
  */
@@ -13,6 +13,8 @@ type PlatformCalendarProps = React.ComponentProps<typeof PlatformCalendar>;
13
13
  export type CalendarProps = Pick<PlatformCalendarProps, 'day' | 'defaultDay' | 'defaultMonth' | 'defaultYear' | 'defaultPreviouslySelected' | 'defaultSelected' | 'disabled' | 'maxDate' | 'minDate' | 'nextMonthLabel' | 'onBlur' | 'onChange' | 'onFocus' | 'onSelect' | 'previouslySelected' | 'previousMonthLabel' | 'selected' | 'today' | 'year' | 'locale' | 'testId' | 'weekStartDay' | 'tabIndex'>;
14
14
  /**
15
15
  * An interactive calendar for date selection experiences.
16
+ *
17
+ * @see [Calendar](https://developer.atlassian.com/platform/forge/ui-kit/components/calendar/) in UI Kit documentation for more information
16
18
  */
17
19
  export type TCalendar<T> = (props: CalendarProps) => T;
18
20
  export {};
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - CheckboxGroupProps
5
5
  *
6
- * @codegen <<SignedSource::89e98a25ac16f92b5d18b061bb6fce57>>
6
+ * @codegen <<SignedSource::63e9cf6f2e444db397f9e170b4e1ce7b>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
8
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/checkboxgroup/index.tsx <<SignedSource::4db9e0c029805d1c1fd28b923f3dbae3>>
9
9
  */
@@ -36,5 +36,7 @@ export interface CheckboxGroupProps {
36
36
  }
37
37
  /**
38
38
  * A Checkbox group is a list of options where one or more choices can be selected.
39
+ *
40
+ * @see [CheckboxGroup](https://developer.atlassian.com/platform/forge/ui-kit/components/checkbox-group/) in UI Kit documentation for more information
39
41
  */
40
42
  export type TCheckboxGroup<T> = (props: CheckboxGroupProps) => T;
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - CheckboxProps
5
5
  *
6
- * @codegen <<SignedSource::7f4aa902734166585716f52e001a6d8f>>
6
+ * @codegen <<SignedSource::d5cd5c6518e80c98416fc61091717141>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
8
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/checkbox/__generated__/index.partial.tsx <<SignedSource::e34c0ab52d3409a8548b6e51450ba43b>>
9
9
  */
@@ -14,6 +14,8 @@ type PlatformCheckboxProps = React.ComponentProps<typeof PlatformCheckbox>;
14
14
  export type CheckboxProps = Pick<PlatformCheckboxProps, 'testId' | 'defaultChecked' | 'isChecked' | 'isIndeterminate' | 'label' | 'id' | 'isRequired' | 'isDisabled' | 'isInvalid' | 'value' | 'aria-invalid' | 'aria-labelledby' | 'name'> & Pick<EventHandlerProps, 'onChange' | 'onBlur' | 'onFocus'>;
15
15
  /**
16
16
  * A checkbox is an input control that allows a user to select one or more options from a number of choices.
17
+ *
18
+ * @see [Checkbox](https://developer.atlassian.com/platform/forge/ui-kit/components/checkbox/) in UI Kit documentation for more information
17
19
  */
18
20
  export type TCheckbox<T> = (props: CheckboxProps) => T;
19
21
  export {};
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - CodeBlockProps
5
5
  *
6
- * @codegen <<SignedSource::7ac72aa38d908f5ad8be5452cccb84d1>>
6
+ * @codegen <<SignedSource::8ab4ed1e38d2bd1f9ceafe4cbc20f97d>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
8
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/code/__generated__/codeblock.partial.tsx <<SignedSource::88ed38fdfc47db0938e7801195a00403>>
9
9
  */
@@ -13,6 +13,8 @@ type PlatformCodeBlockProps = React.ComponentProps<typeof PlatformCodeBlock>;
13
13
  export type CodeBlockProps = Pick<PlatformCodeBlockProps, 'text' | 'testId' | 'showLineNumbers' | 'language' | 'highlight' | 'highlightedStartText' | 'highlightedEndText' | 'shouldWrapLongLines'>;
14
14
  /**
15
15
  * Code highlights short strings of code snippets inline with body text.
16
+ *
17
+ * @see [CodeBlock](https://developer.atlassian.com/platform/forge/ui-kit/components/code-block/) in UI Kit documentation for more information
16
18
  */
17
19
  export type TCodeBlock<T> = (props: CodeBlockProps) => T;
18
20
  export {};
@@ -3,9 +3,9 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - CodeProps
5
5
  *
6
- * @codegen <<SignedSource::e0386444a3c82762fe87b25289122301>>
6
+ * @codegen <<SignedSource::baf6b565e34d8df53db53b8855ec120d>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/code/__generated__/code.partial.tsx <<SignedSource::a54209d8f81fb1e2f354f4563725efeb>>
8
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/code/__generated__/code.partial.tsx <<SignedSource::6f210b052488fe7ece12d865706a551e>>
9
9
  */
10
10
  import React from 'react';
11
11
  import { Code as PlatformCode } from '@atlaskit/code';
@@ -13,6 +13,8 @@ type PlatformCodeProps = React.ComponentProps<typeof PlatformCode>;
13
13
  export type CodeProps = Pick<PlatformCodeProps, 'children' | 'testId'>;
14
14
  /**
15
15
  * Code highlights short strings of code snippets inline with body text.
16
+ *
17
+ * @see [Code](https://developer.atlassian.com/platform/forge/ui-kit/components/code/) in UI Kit documentation for more information
16
18
  */
17
19
  export type TCode<T> = (props: CodeProps) => T;
18
20
  export {};
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - DatePickerProps
5
5
  *
6
- * @codegen <<SignedSource::a4fe0c77ab65e00b2bc8ebeadd33e2e3>>
6
+ * @codegen <<SignedSource::d146cd7a368d85498c033934001b9a6c>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
8
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/datepicker/__generated__/index.partial.tsx <<SignedSource::5dcbe693f00f3a2725b9e64932a3309c>>
9
9
  */
@@ -49,6 +49,8 @@ export type DatePickerProps = {
49
49
  } & Partial<Omit<FieldProps, 'onChange'>>;
50
50
  /**
51
51
  * A date picker allows the user to select a particular date.
52
+ *
53
+ * @see [DatePicker](https://developer.atlassian.com/platform/forge/ui-kit/components/date-picker/) in UI Kit documentation for more information
52
54
  */
53
55
  export type TDatePicker<T> = (props: DatePickerProps) => T;
54
56
  export {};
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - DynamicTableProps
5
5
  *
6
- * @codegen <<SignedSource::213e682fc5fc702c30fb176cf45969b3>>
6
+ * @codegen <<SignedSource::8923606b45ea3fb8adc1f391645ee46e>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
8
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/dynamictable/__generated__/index.partial.tsx <<SignedSource::579e3dddf7bd4b762d0fd40744619b89>>
9
9
  */
@@ -15,6 +15,8 @@ export type DynamicTableProps = Pick<StatefulProps, 'defaultPage' | 'defaultSort
15
15
  };
16
16
  /**
17
17
  * A dynamic table displays rows of data with built-in pagination, sorting, and re-ordering functionality.
18
+ *
19
+ * @see [DynamicTable](https://developer.atlassian.com/platform/forge/ui-kit/components/dynamic-table/) in UI Kit documentation for more information
18
20
  */
19
21
  export type TDynamicTable<T> = (props: DynamicTableProps) => T;
20
22
  export {};
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - EmptyStateProps
5
5
  *
6
- * @codegen <<SignedSource::07a70b90ed6e68ae200fd5e38e163a89>>
6
+ * @codegen <<SignedSource::142748ed4aa864312e3b9ea16f297672>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
8
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/emptystate/__generated__/index.partial.tsx <<SignedSource::d6c509a722d55de0f55d401cd2e75435>>
9
9
  */
@@ -13,6 +13,8 @@ type PlatformEmptyStateProps = React.ComponentProps<typeof PlatformEmptyState>;
13
13
  export type EmptyStateProps = Pick<PlatformEmptyStateProps, 'buttonGroupLabel' | 'description' | 'header' | 'headingLevel' | 'isLoading' | 'primaryAction' | 'secondaryAction' | 'tertiaryAction' | 'testId' | 'width'>;
14
14
  /**
15
15
  * An empty state appears when there is no data to display and describes what the user can do next.
16
+ *
17
+ * @see [EmptyState](https://developer.atlassian.com/platform/forge/ui-kit/components/empty-state/) in UI Kit documentation for more information
16
18
  */
17
19
  export type TEmptyState<T> = (props: EmptyStateProps) => T;
18
20
  export {};
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - ErrorMessageProps
5
5
  *
6
- * @codegen <<SignedSource::059ea63aef7f094365447bb300fed9f6>>
6
+ * @codegen <<SignedSource::f2821b3d824a19e37d6d769695a883f4>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
8
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/form/__generated__/error-message.partial.tsx <<SignedSource::3758488a0115c629a624fcaae1f524c7>>
9
9
  */
@@ -14,6 +14,8 @@ export type ErrorMessageProps = Pick<PlatformErrorMessageProps, 'children' | 'te
14
14
  /**
15
15
  * An error message is used to tell a user that the field input is invalid.
16
16
  * For example, an error message could be "Invalid username, needs to be more than 4 characters".
17
+ *
18
+ * @see [ErrorMessage](https://developer.atlassian.com/platform/forge/ui-kit/components/form/#error-message) in UI Kit documentation for more information
17
19
  */
18
20
  export type TErrorMessage<T> = (props: ErrorMessageProps) => T;
19
21
  export {};
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - FlexProps
5
5
  *
6
- * @codegen <<SignedSource::a7674fb0691e3265f6e0940ae4f938e1>>
6
+ * @codegen <<SignedSource::06ae2024098beefe1f0166cee45e00eb>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
8
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/flex/__generated__/index.partial.tsx <<SignedSource::0e480e44e57f21f761bec4613ac4988d>>
9
9
  */
@@ -13,6 +13,8 @@ type PlatformFlexProps = React.ComponentProps<typeof PlatformFlex>;
13
13
  export type FlexProps = Pick<PlatformFlexProps, 'children' | 'justifyContent' | 'alignItems' | 'columnGap' | 'gap' | 'rowGap' | 'direction' | 'wrap' | 'testId' | 'role'>;
14
14
  /**
15
15
  * Primitives are token-backed low-level building blocks.
16
+ *
17
+ * @see [Flex](https://developer.atlassian.com/platform/forge/ui-kit/components/flex/) in UI Kit documentation for more information
16
18
  */
17
19
  export type TFlex<T> = (props: FlexProps) => T;
18
20
  export {};
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - FormFooterProps
5
5
  *
6
- * @codegen <<SignedSource::e6d74700f46888d63a013f997339596b>>
6
+ * @codegen <<SignedSource::bd453251ee9501e44dfdef3abb96f526>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
8
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/form/__generated__/form-footer.partial.tsx <<SignedSource::0b729df36afbc86cc134984bb4c16b3e>>
9
9
  */
@@ -21,6 +21,8 @@ export type FormFooterProps = Pick<PlatformFormFooterProps, 'children' | 'align'
21
21
  * Use a form footer to set the content at the end of the form. This is used for a button that submits the form.
22
22
  *
23
23
  * This is positioned after the last field in the form.
24
+ *
25
+ * @see [FormFooter](https://developer.atlassian.com/platform/forge/ui-kit/components/form/#form-footer) in UI Kit documentation for more information
24
26
  */
25
27
  export type TFormFooter<T> = (props: FormFooterProps) => T;
26
28
  export {};
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - FormHeaderProps
5
5
  *
6
- * @codegen <<SignedSource::7ef542fd2e0804c707145ab13db81db1>>
6
+ * @codegen <<SignedSource::29600e7cd4c837834bdf3e2642eb297f>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
8
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/form/__generated__/form-header.partial.tsx <<SignedSource::8791c333c19a64caa8dd6b7461a53082>>
9
9
  */
@@ -15,6 +15,8 @@ export type FormHeaderProps = Pick<PlatformFormHeaderProps, 'title' | 'descripti
15
15
  * Use a form header to describe the contents of the form. This is the title and description of the form.
16
16
  * If your form contains required fields, the form header is also where you should include a legend
17
17
  * for sighted users to know that * indicates a required field.
18
+ *
19
+ * @see [FormHeader](https://developer.atlassian.com/platform/forge/ui-kit/components/form/#form-header) in UI Kit documentation for more information
18
20
  */
19
21
  export type TFormHeader<T> = (props: FormHeaderProps) => T;
20
22
  export {};
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - FormProps
5
5
  *
6
- * @codegen <<SignedSource::6ac049125d8d8c2436805c5e3a845802>>
6
+ * @codegen <<SignedSource::72d05fe1799ae83e2fbc1e01f76009ce>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
8
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/form/index.tsx <<SignedSource::b6dd991b4a5e73adbac9321d53cd909e>>
9
9
  */
@@ -23,5 +23,7 @@ export type FormProps = {
23
23
  };
24
24
  /**
25
25
  * A form allows users to input information.
26
+ *
27
+ * @see [Form](https://developer.atlassian.com/platform/forge/ui-kit/components/form/) in UI Kit documentation for more information
26
28
  */
27
29
  export type TForm<T> = (props: FormProps) => T;
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - FormSectionProps
5
5
  *
6
- * @codegen <<SignedSource::2d079615b76393e9241b054b75fde5f3>>
6
+ * @codegen <<SignedSource::c85e38840c5dd01b51a1c9fabeaf226b>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
8
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/form/__generated__/form-section.partial.tsx <<SignedSource::0dd9401d75f62dec7336bdea43302961>>
9
9
  */
@@ -14,6 +14,8 @@ export type FormSectionProps = Pick<PlatformFormSectionProps, 'title' | 'childre
14
14
  /**
15
15
  * Use a form section to group related information together, so that longer forms are easier to understand.
16
16
  * There can be multiple form sections in one form.
17
+ *
18
+ * @see [FormSection](https://developer.atlassian.com/platform/forge/ui-kit/components/form/#form-section) in UI Kit documentation for more information
17
19
  */
18
20
  export type TFormSection<T> = (props: FormSectionProps) => T;
19
21
  export {};
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - HeadingProps
5
5
  *
6
- * @codegen <<SignedSource::b8bb5780d2b0112f8f2a4c7190d63fc7>>
6
+ * @codegen <<SignedSource::c2e29c89ead70009a792cea03271e9c4>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
8
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/heading/__generated__/index.partial.tsx <<SignedSource::96b99b296364dce930bb91174b226eaa>>
9
9
  */
@@ -17,6 +17,8 @@ export type HeadingProps = Pick<PlatformHeadingProps, 'children' | 'id' | 'testI
17
17
  };
18
18
  /**
19
19
  * A heading is a typography component used to display text in different sizes and formats.
20
+ *
21
+ * @see [Heading](https://developer.atlassian.com/platform/forge/ui-kit/components/heading/) in UI Kit documentation for more information
20
22
  */
21
23
  export type THeading<T> = (props: HeadingProps) => T;
22
24
  export {};
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - HelperMessageProps
5
5
  *
6
- * @codegen <<SignedSource::0da9514581e07c67f8f9a8ba0d9774b9>>
6
+ * @codegen <<SignedSource::867186ab9065c1955019578515e5b441>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
8
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/form/__generated__/helper-message.partial.tsx <<SignedSource::03fa772bfaf53905106f1cafbb428104>>
9
9
  */
@@ -14,6 +14,8 @@ export type HelperMessageProps = Pick<PlatformHelperMessageProps, 'children' | '
14
14
  /**
15
15
  * A helper message tells the user what kind of input the field takes.
16
16
  * For example, a helper message could be "Password should be more than 4 characters".
17
+ *
18
+ * @see [HelperMessage](https://developer.atlassian.com/platform/forge/ui-kit/components/form/#helper-message) in UI Kit documentation for more information
17
19
  */
18
20
  export type THelperMessage<T> = (props: HelperMessageProps) => T;
19
21
  export {};
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - IconProps
5
5
  *
6
- * @codegen <<SignedSource::b24cc22d6f60b86f1646a75a0bafc7cd>>
6
+ * @codegen <<SignedSource::40d5e815277b3ce91da33d74742659fc>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
8
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/icon/index.tsx <<SignedSource::54a87ae131386a26a52d09234f67aa98>>
9
9
  */
@@ -37,6 +37,8 @@ export interface IconProps {
37
37
  }
38
38
  /**
39
39
  * An icon is a visual representation of a command, device, directory, or common action.
40
+ *
41
+ * @see [Icon](https://developer.atlassian.com/platform/forge/ui-kit/components/icon/) in UI Kit documentation for more information
40
42
  */
41
43
  export type TIcon<T> = (props: IconProps) => T;
42
44
  export {};
@@ -3,9 +3,9 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - InlineEditProps
5
5
  *
6
- * @codegen <<SignedSource::450b0aa0943b6519e89ee7c91f4124ad>>
6
+ * @codegen <<SignedSource::76e64cd0950ea7da3cf92b08df75f5fc>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/inline-edit/index.tsx <<SignedSource::23f59ce10b527efc04d36919c24aa2b0>>
8
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/inline-edit/index.tsx <<SignedSource::7654358cb6b3406900f008113b08977d>>
9
9
  */
10
10
  import React from 'react';
11
11
  import { default as PlatformInlineEdit } from '@atlaskit/inline-edit';
@@ -23,6 +23,8 @@ export type InlineEditProps<V = string> = Omit<React.ComponentProps<typeof Platf
23
23
  };
24
24
  /**
25
25
  * An inline edit displays a custom input component that switches between reading and editing on the same page.
26
+ *
27
+ * @see [InlineEdit](https://developer.atlassian.com/platform/forge/ui-kit/components/inline-edit/) in UI Kit documentation for more information
26
28
  */
27
29
  export type TInlineEdit<T> = (props: InlineEditProps) => T;
28
30
  export {};
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - InlineProps
5
5
  *
6
- * @codegen <<SignedSource::7e0e8c23de8b2392bf101ad017431b86>>
6
+ * @codegen <<SignedSource::a184afd895391ad501b67ca2a5c49fc1>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
8
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/inline/__generated__/index.partial.tsx <<SignedSource::8123157b2afe19d52b47110fb754d43b>>
9
9
  */
@@ -13,6 +13,8 @@ type PlatformInlineProps = React.ComponentProps<typeof PlatformInline>;
13
13
  export type InlineProps = Pick<PlatformInlineProps, 'children' | 'alignBlock' | 'alignInline' | 'spread' | 'grow' | 'space' | 'shouldWrap' | 'separator' | 'rowSpace' | 'testId'>;
14
14
  /**
15
15
  * An inline manages the horizontal layout of direct children using flexbox.
16
+ *
17
+ * @see [Inline](https://developer.atlassian.com/platform/forge/ui-kit/components/inline/) in UI Kit documentation for more information
16
18
  */
17
19
  export type TInline<T> = (props: InlineProps) => T;
18
20
  export {};
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - LabelProps
5
5
  *
6
- * @codegen <<SignedSource::f12ab4339e5503f7db96ce306da7f685>>
6
+ * @codegen <<SignedSource::6f1e8259b596a6ca722fcbcb3eb8e4bd>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
8
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/form/__generated__/label.partial.tsx <<SignedSource::55ecafcd1d98afb9b7f6f37d5168725c>>
9
9
  */
@@ -13,5 +13,7 @@ export type LabelProps = Pick<PlatformLabelProps, 'children' | 'testId' | 'id'>
13
13
  };
14
14
  /**
15
15
  * A label represents a caption for an item in a user interface.
16
+ *
17
+ * @see [Label](https://developer.atlassian.com/platform/forge/ui-kit/components/form/#label) in UI Kit documentation for more information
16
18
  */
17
19
  export type TLabel<T> = (props: LabelProps) => T;
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - LinkButtonProps
5
5
  *
6
- * @codegen <<SignedSource::7c841825fdf02347d10084f2cd032f66>>
6
+ * @codegen <<SignedSource::5954a642054228f3f1ffb106dca3072f>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
8
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/button/__generated__/link-button.partial.tsx <<SignedSource::e74ee4aaf752a6e85a57950dce7a3683>>
9
9
  */
@@ -17,5 +17,7 @@ export type LinkButtonProps = Pick<PlatformLinkButtonProps, 'children' | 'target
17
17
  };
18
18
  /**
19
19
  * Renders a link in the style of a button.
20
+ *
21
+ * @see [LinkButton](https://developer.atlassian.com/platform/forge/ui-kit/components/button/#linkbutton-props) in UI Kit documentation for more information
20
22
  */
21
23
  export type TLinkButton<T> = (props: LinkButtonProps) => T;
@@ -3,9 +3,9 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - ListProps
5
5
  *
6
- * @codegen <<SignedSource::400e8f876b65d0f5902e544922d64a54>>
6
+ * @codegen <<SignedSource::d77d7e870d29834b0636dd18611690de>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/list/list.tsx <<SignedSource::08290162e7f9e2a672b27cec286206cf>>
8
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/list/list.tsx <<SignedSource::447b2a8735f97d1d9b091a97a64a7c89>>
9
9
  */
10
10
  import React from 'react';
11
11
  export interface ListProps {
@@ -22,5 +22,7 @@ export interface ListProps {
22
22
  }
23
23
  /**
24
24
  * An unordered (bulleted) or ordered (numbered) list.
25
+ *
26
+ * @see [List](https://developer.atlassian.com/platform/forge/ui-kit/components/list/) in UI Kit documentation for more information
25
27
  */
26
28
  export type TList<T> = (props: ListProps) => T;
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - LoadingButtonProps
5
5
  *
6
- * @codegen <<SignedSource::3abc490a74619a5e969b95b74b8ee6f6>>
6
+ * @codegen <<SignedSource::7976cc960c60dd5f5efe450507bd3d6b>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
8
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/button/loading-button.tsx <<SignedSource::66edb728e0e941c5f53236e94cd02c18>>
9
9
  */
@@ -13,6 +13,8 @@ type PlatformLoadingButtonProps = React.ComponentProps<typeof PlatformLoadingBut
13
13
  export type LoadingButtonProps = Pick<PlatformLoadingButtonProps, 'children' | 'appearance' | 'autoFocus' | 'isDisabled' | 'isSelected' | 'onBlur' | 'onClick' | 'onFocus' | 'spacing' | 'testId' | 'shouldFitContainer' | 'type' | 'isLoading'>;
14
14
  /**
15
15
  * A button that shows an spinner as an overlay on the button when you set an isLoading prop to true.
16
+ *
17
+ * @see [LoadingButton](https://developer.atlassian.com/platform/forge/ui-kit/components/button/#loadingbutton-props) in UI Kit documentation for more information
16
18
  */
17
19
  export type TLoadingButton<T> = (props: LoadingButtonProps) => T;
18
20
  export {};