@atlaskit/forge-react-types 0.42.22 → 0.43.0

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 (95) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/dist/cjs/components/__generated__/BoxProps.codegen.js +1 -1
  3. package/dist/cjs/components/__generated__/PressableProps.codegen.js +2 -2
  4. package/dist/cjs/components/__generated__/types.codegen.js +1 -5
  5. package/dist/cjs/components/editor/index.js +5 -0
  6. package/dist/cjs/components/editor/types.js +5 -0
  7. package/dist/es2019/components/__generated__/BoxProps.codegen.js +1 -1
  8. package/dist/es2019/components/__generated__/PressableProps.codegen.js +2 -2
  9. package/dist/es2019/components/__generated__/types.codegen.js +0 -1
  10. package/dist/esm/components/__generated__/BoxProps.codegen.js +1 -1
  11. package/dist/esm/components/__generated__/PressableProps.codegen.js +2 -2
  12. package/dist/esm/components/__generated__/types.codegen.js +0 -1
  13. package/dist/esm/components/editor/ChromelessEditorProps.js +1 -0
  14. package/dist/esm/components/editor/CommentEditorProps.js +1 -0
  15. package/dist/esm/components/editor/index.js +1 -0
  16. package/dist/esm/components/editor/types.js +1 -0
  17. package/dist/types/components/__generated__/AdfRendererProps.codegen.d.ts +3 -3
  18. package/dist/types/components/__generated__/BoxProps.codegen.d.ts +2 -2
  19. package/dist/types/components/__generated__/ButtonProps.codegen.d.ts +3 -3
  20. package/dist/types/components/__generated__/CheckboxGroupProps.codegen.d.ts +12 -12
  21. package/dist/types/components/__generated__/DatePickerProps.codegen.d.ts +6 -6
  22. package/dist/types/components/__generated__/FormFooterProps.codegen.d.ts +2 -2
  23. package/dist/types/components/__generated__/FormProps.codegen.d.ts +3 -3
  24. package/dist/types/components/__generated__/InlineEditProps.codegen.d.ts +6 -6
  25. package/dist/types/components/__generated__/LinkButtonProps.codegen.d.ts +4 -4
  26. package/dist/types/components/__generated__/ListProps.codegen.d.ts +6 -6
  27. package/dist/types/components/__generated__/LoadingButtonProps.codegen.d.ts +2 -2
  28. package/dist/types/components/__generated__/PopupProps.codegen.d.ts +2 -2
  29. package/dist/types/components/__generated__/PressableProps.codegen.d.ts +2 -2
  30. package/dist/types/components/__generated__/SectionMessageProps.codegen.d.ts +2 -2
  31. package/dist/types/components/__generated__/TextProps.codegen.d.ts +2 -2
  32. package/dist/types/components/__generated__/TimePickerProps.codegen.d.ts +6 -6
  33. package/dist/types/components/__generated__/index.d.ts +0 -2
  34. package/dist/types/components/__generated__/types.codegen.d.ts +2 -56
  35. package/dist/types/components/editor/ChromelessEditorProps.d.ts +8 -0
  36. package/dist/types/components/{__generated__/CommentEditorProps.codegen.d.ts → editor/CommentEditorProps.d.ts} +1 -10
  37. package/dist/types/components/editor/index.d.ts +2 -0
  38. package/dist/types/components/editor/types.d.ts +54 -0
  39. package/dist/types/index.d.ts +2 -1
  40. package/dist/types-ts4.5/components/__generated__/AdfRendererProps.codegen.d.ts +3 -3
  41. package/dist/types-ts4.5/components/__generated__/BoxProps.codegen.d.ts +2 -2
  42. package/dist/types-ts4.5/components/__generated__/ButtonProps.codegen.d.ts +3 -3
  43. package/dist/types-ts4.5/components/__generated__/CheckboxGroupProps.codegen.d.ts +12 -12
  44. package/dist/types-ts4.5/components/__generated__/DatePickerProps.codegen.d.ts +6 -6
  45. package/dist/types-ts4.5/components/__generated__/FormFooterProps.codegen.d.ts +2 -2
  46. package/dist/types-ts4.5/components/__generated__/FormProps.codegen.d.ts +3 -3
  47. package/dist/types-ts4.5/components/__generated__/InlineEditProps.codegen.d.ts +6 -6
  48. package/dist/types-ts4.5/components/__generated__/LinkButtonProps.codegen.d.ts +4 -4
  49. package/dist/types-ts4.5/components/__generated__/ListProps.codegen.d.ts +6 -6
  50. package/dist/types-ts4.5/components/__generated__/LoadingButtonProps.codegen.d.ts +2 -2
  51. package/dist/types-ts4.5/components/__generated__/PopupProps.codegen.d.ts +2 -2
  52. package/dist/types-ts4.5/components/__generated__/PressableProps.codegen.d.ts +2 -2
  53. package/dist/types-ts4.5/components/__generated__/SectionMessageProps.codegen.d.ts +2 -2
  54. package/dist/types-ts4.5/components/__generated__/TextProps.codegen.d.ts +2 -2
  55. package/dist/types-ts4.5/components/__generated__/TimePickerProps.codegen.d.ts +6 -6
  56. package/dist/types-ts4.5/components/__generated__/index.d.ts +0 -2
  57. package/dist/types-ts4.5/components/__generated__/types.codegen.d.ts +2 -56
  58. package/dist/types-ts4.5/components/editor/ChromelessEditorProps.d.ts +8 -0
  59. package/dist/types-ts4.5/components/{__generated__/CommentEditorProps.codegen.d.ts → editor/CommentEditorProps.d.ts} +1 -10
  60. package/dist/types-ts4.5/components/editor/index.d.ts +2 -0
  61. package/dist/types-ts4.5/components/editor/types.d.ts +54 -0
  62. package/dist/types-ts4.5/index.d.ts +2 -1
  63. package/package.json +12 -12
  64. package/src/components/__generated__/AdfRendererProps.codegen.tsx +5 -5
  65. package/src/components/__generated__/BoxProps.codegen.tsx +2 -2
  66. package/src/components/__generated__/ButtonProps.codegen.tsx +6 -2
  67. package/src/components/__generated__/CheckboxGroupProps.codegen.tsx +12 -12
  68. package/src/components/__generated__/DatePickerProps.codegen.tsx +6 -6
  69. package/src/components/__generated__/FormFooterProps.codegen.tsx +2 -2
  70. package/src/components/__generated__/FormProps.codegen.tsx +3 -3
  71. package/src/components/__generated__/InlineEditProps.codegen.tsx +6 -6
  72. package/src/components/__generated__/LinkButtonProps.codegen.tsx +4 -4
  73. package/src/components/__generated__/ListProps.codegen.tsx +6 -6
  74. package/src/components/__generated__/LoadingButtonProps.codegen.tsx +2 -2
  75. package/src/components/__generated__/PopupProps.codegen.tsx +2 -2
  76. package/src/components/__generated__/PressableProps.codegen.tsx +59 -59
  77. package/src/components/__generated__/SectionMessageProps.codegen.tsx +4 -4
  78. package/src/components/__generated__/TextProps.codegen.tsx +2 -2
  79. package/src/components/__generated__/TimePickerProps.codegen.tsx +6 -6
  80. package/src/components/__generated__/index.ts +0 -2
  81. package/src/components/__generated__/types.codegen.ts +2 -62
  82. package/src/components/editor/ChromelessEditorProps.tsx +10 -0
  83. package/src/components/{__generated__/CommentEditorProps.codegen.tsx → editor/CommentEditorProps.tsx} +2 -13
  84. package/src/components/editor/index.ts +2 -0
  85. package/src/components/editor/types.ts +59 -0
  86. package/src/index.ts +7 -4
  87. package/dist/types/components/__generated__/ChromelessEditorProps.codegen.d.ts +0 -17
  88. package/dist/types-ts4.5/components/__generated__/ChromelessEditorProps.codegen.d.ts +0 -17
  89. package/src/components/__generated__/ChromelessEditorProps.codegen.tsx +0 -21
  90. /package/dist/cjs/components/{__generated__/ChromelessEditorProps.codegen.js → editor/ChromelessEditorProps.js} +0 -0
  91. /package/dist/cjs/components/{__generated__/CommentEditorProps.codegen.js → editor/CommentEditorProps.js} +0 -0
  92. /package/dist/es2019/components/{__generated__/ChromelessEditorProps.codegen.js → editor/ChromelessEditorProps.js} +0 -0
  93. /package/dist/es2019/components/{__generated__/CommentEditorProps.codegen.js → editor/CommentEditorProps.js} +0 -0
  94. /package/dist/{esm/components/__generated__/ChromelessEditorProps.codegen.js → es2019/components/editor/index.js} +0 -0
  95. /package/dist/{esm/components/__generated__/CommentEditorProps.codegen.js → es2019/components/editor/types.js} +0 -0
@@ -0,0 +1,54 @@
1
+ import type { JSONDocNode } from '@atlaskit/editor-json-transformer';
2
+ export type Appearance = 'comment' | 'chromeless';
3
+ export type Features = {
4
+ /**
5
+ * Enables text to be different heading levels or in quote blocks.
6
+ */
7
+ blockType?: boolean;
8
+ /**
9
+ * Enables text to be placed in a code block.
10
+ */
11
+ codeBlock?: boolean;
12
+ /**
13
+ * Enables links to become hyperlink.
14
+ */
15
+ hyperLink?: boolean;
16
+ /**
17
+ * Enables toolbar items for link, codeblock and quote block.
18
+ */
19
+ insertBlock?: boolean;
20
+ /**
21
+ * Enables ordered and unordered lists.
22
+ */
23
+ list?: boolean;
24
+ /**
25
+ * Enables the quick insert menu. Type '/' to open the menu in the editor.
26
+ */
27
+ quickInsert?: boolean;
28
+ /**
29
+ * Enables color on text.
30
+ */
31
+ textColor?: boolean;
32
+ /**
33
+ * Enables stylistic formatting on text. This allows text to be set to bold, italic, underline, strikethrough code, subscript and superscript.
34
+ */
35
+ textFormatting?: boolean;
36
+ };
37
+ export type EditorProps = {
38
+ /**
39
+ * Set the default editor content.
40
+ */
41
+ defaultValue?: JSONDocNode;
42
+ /**
43
+ * Set allowed features in the editor.
44
+ */
45
+ features?: Features;
46
+ /**
47
+ * Set if the editor should be disabled
48
+ */
49
+ isDisabled?: boolean;
50
+ /**
51
+ * Handler called when the inputs value changes.
52
+ */
53
+ onChange?: (value?: JSONDocNode) => void;
54
+ };
@@ -1,3 +1,4 @@
1
- export type { AdfRendererProps, BadgeProps, BoxProps, ButtonGroupProps, ButtonProps, CalendarProps, CheckboxProps, CheckboxGroupProps, CodeBlockProps, CodeProps, CommentProps, DatePickerProps, DynamicTableProps, EmptyStateProps, ErrorMessageProps, FlexProps, FormFooterProps, FormHeaderProps, FormProps, FormSectionProps, GridProps, HeadingProps, HelperMessageProps, IconProps, InlineProps, LabelProps, LinkButtonProps, ListProps, ListItemProps, LoadingButtonProps, LozengeProps, ModalBodyProps, ModalFooterProps, ModalHeaderProps, ModalProps, ModalTitleProps, ModalTransitionProps, ProgressBarProps, ProgressTrackerProps, RadioGroupProps, RadioProps, RangeProps, SectionMessageActionProps, SectionMessageProps, SelectProps, SpinnerProps, StackProps, TabListProps, TabPanelProps, TabProps, TabsProps, TagGroupProps, TagProps, TextProps, TextAreaProps, TextfieldProps, ToggleProps, TooltipProps, TimePickerProps, ValidMessageProps, PopupProps, InlineEditProps, ChromelessEditorProps, CommentEditorProps, PressableProps, TBadge, TBox, TButtonGroup, TButton, TCalendar, TCheckbox, TCheckboxGroup, TCodeBlock, TCode, TComment, TDatePicker, TDynamicTable, TEmptyState, TErrorMessage, TFlex, TFormFooter, TFormHeader, TForm, TFormSection, TGrid, THeading, THelperMessage, TIcon, TInline, TInlineEdit, TLabel, TLinkButton, TList, TListItem, TLoadingButton, TLozenge, TModalBody, TModalFooter, TModalHeader, TModal, TModalTitle, TModalTransition, TProgressBar, TProgressTracker, TRadioGroup, TRadio, TRange, TSectionMessageAction, TSectionMessage, TSelect, TSpinner, TStack, TTabList, TTabPanel, TTab, TTabs, TTagGroup, TTag, TTextArea, TTextfield, TTimePicker, TToggle, TTooltip, TValidMessage, TPopup, TAdfRenderer, TText, TChromelessEditor, TCommentEditor, TPressable, } from './components/__generated__';
1
+ export type { AdfRendererProps, BadgeProps, BoxProps, ButtonGroupProps, ButtonProps, CalendarProps, CheckboxProps, CheckboxGroupProps, CodeBlockProps, CodeProps, CommentProps, DatePickerProps, DynamicTableProps, EmptyStateProps, ErrorMessageProps, FlexProps, FormFooterProps, FormHeaderProps, FormProps, FormSectionProps, GridProps, HeadingProps, HelperMessageProps, IconProps, InlineProps, LabelProps, LinkButtonProps, ListProps, ListItemProps, LoadingButtonProps, LozengeProps, ModalBodyProps, ModalFooterProps, ModalHeaderProps, ModalProps, ModalTitleProps, ModalTransitionProps, ProgressBarProps, ProgressTrackerProps, RadioGroupProps, RadioProps, RangeProps, SectionMessageActionProps, SectionMessageProps, SelectProps, SpinnerProps, StackProps, TabListProps, TabPanelProps, TabProps, TabsProps, TagGroupProps, TagProps, TextProps, TextAreaProps, TextfieldProps, ToggleProps, TooltipProps, TimePickerProps, ValidMessageProps, PopupProps, InlineEditProps, PressableProps, TBadge, TBox, TButtonGroup, TButton, TCalendar, TCheckbox, TCheckboxGroup, TCodeBlock, TCode, TComment, TDatePicker, TDynamicTable, TEmptyState, TErrorMessage, TFlex, TFormFooter, TFormHeader, TForm, TFormSection, TGrid, THeading, THelperMessage, TIcon, TInline, TInlineEdit, TLabel, TLinkButton, TList, TListItem, TLoadingButton, TLozenge, TModalBody, TModalFooter, TModalHeader, TModal, TModalTitle, TModalTransition, TProgressBar, TProgressTracker, TRadioGroup, TRadio, TRange, TSectionMessageAction, TSectionMessage, TSelect, TSpinner, TStack, TTabList, TTabPanel, TTab, TTabs, TTagGroup, TTag, TTextArea, TTextfield, TTimePicker, TToggle, TTooltip, TValidMessage, TPopup, TAdfRenderer, TText, TPressable, } from './components/__generated__';
2
2
  export type { BarChartProps, StackBarChartProps, HorizontalStackBarChartProps, HorizontalBarChartProps, LineChartProps, DonutChartProps, PieChartProps, TBarChart, TStackBarChart, THorizontalStackBarChart, THorizontalBarChart, TLineChart, TDonutChart, TPieChart, } from './components/charts';
3
+ export type { ChromelessEditorProps, CommentEditorProps, TChromelessEditor, TCommentEditor, } from './components/editor';
3
4
  export type { ChartColorTokens } from './types';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/forge-react-types",
3
- "version": "0.42.22",
3
+ "version": "0.43.0",
4
4
  "description": "Component types for Forge UI Kit React components",
5
5
  "publishConfig": {
6
6
  "registry": "https://registry.npmjs.org/"
@@ -21,30 +21,30 @@
21
21
  "team": "Forge UI"
22
22
  },
23
23
  "dependencies": {
24
- "@atlaskit/button": "^23.4.0",
24
+ "@atlaskit/button": "^23.5.0",
25
25
  "@atlaskit/comment": "^13.0.0",
26
- "@atlaskit/datetime-picker": "^17.0.0",
27
- "@atlaskit/dynamic-table": "^18.2.0",
28
- "@atlaskit/form": "^14.0.0",
26
+ "@atlaskit/datetime-picker": "^17.1.0",
27
+ "@atlaskit/dynamic-table": "^18.3.0",
28
+ "@atlaskit/form": "^14.2.0",
29
29
  "@atlaskit/inline-edit": "^15.3.0",
30
- "@atlaskit/modal-dialog": "^14.3.0",
31
- "@atlaskit/navigation-system": "^2.10.0",
30
+ "@atlaskit/modal-dialog": "^14.5.0",
31
+ "@atlaskit/navigation-system": "^2.21.0",
32
32
  "@atlaskit/popup": "^4.4.0",
33
- "@atlaskit/primitives": "^14.15.0",
33
+ "@atlaskit/primitives": "^15.0.0",
34
34
  "@atlaskit/progress-bar": "^4.0.0",
35
35
  "@atlaskit/progress-tracker": "^10.3.0",
36
36
  "@atlaskit/radio": "^8.3.0",
37
37
  "@atlaskit/section-message": "^8.7.0",
38
38
  "@atlaskit/select": "^21.3.0",
39
39
  "@atlaskit/spinner": "^19.0.0",
40
- "@atlaskit/tabs": "^18.1.0",
40
+ "@atlaskit/tabs": "^18.2.0",
41
41
  "@atlaskit/tag": "^14.1.0",
42
42
  "@atlaskit/tag-group": "^12.0.0",
43
43
  "@atlaskit/textarea": "^8.0.0",
44
44
  "@atlaskit/textfield": "^8.0.0",
45
45
  "@atlaskit/toggle": "^15.1.0",
46
- "@atlaskit/tokens": "^6.3.0",
47
- "@atlaskit/tooltip": "^20.4.0",
46
+ "@atlaskit/tokens": "^6.5.0",
47
+ "@atlaskit/tooltip": "^20.5.0",
48
48
  "@babel/runtime": "^7.0.0"
49
49
  },
50
50
  "peerDependencies": {
@@ -52,7 +52,7 @@
52
52
  },
53
53
  "devDependencies": {
54
54
  "@atlassian/codegen": "^0.1.0",
55
- "@atlassian/forge-ui": "^32.35.0",
55
+ "@atlassian/forge-ui": "^32.39.0",
56
56
  "@types/node": "~22.17.1",
57
57
  "lodash": "^4.17.21",
58
58
  "react": "^18.2.0",
@@ -3,9 +3,9 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - AdfRendererProps
5
5
  *
6
- * @codegen <<SignedSource::126b3ad6e0833d5ef9d0270f34b9deb1>>
6
+ * @codegen <<SignedSource::757ab113edda1f83f41c49739c285bdc>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/adfrenderer/index.tsx <<SignedSource::812969188e3d278549014394c969938c>>
8
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/adfrenderer/index.tsx <<SignedSource::f0a45b8f69a7412792758f6a0f31f69d>>
9
9
  */
10
10
  /* eslint @repo/internal/codegen/signed-source-integrity: "warn" */
11
11
 
@@ -19,6 +19,9 @@ export type AdfRendererProps = {
19
19
  */
20
20
  document: DocNode;
21
21
 
22
+ // documentWithoutMedia is only used internally on the Forge side, this is not part of the public API
23
+ documentWithoutMedia?: DocNode;
24
+
22
25
  /**
23
26
  * A function to determine behaviour for handling unsupported nodes:
24
27
  * - Return a new Node to replace the unsupported one
@@ -28,9 +31,6 @@ export type AdfRendererProps = {
28
31
  * @type [Visitor](https://bitbucket.org/atlassian/atlassian-frontend-mirror/src/master/editor/adf-utils/src/types/index.ts)
29
32
  */
30
33
  replaceUnsupportedNode?: Function;
31
-
32
- // documentWithoutMedia is only used internally on the Forge side, this is not part of the public API
33
- documentWithoutMedia?: DocNode;
34
34
  };
35
35
 
36
36
  /**
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - BoxProps
5
5
  *
6
- * @codegen <<SignedSource::c3ad3413cf478b4f6da470a99c029688>>
6
+ * @codegen <<SignedSource::59d9053f6fa2fe522770b1b720b745a7>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
8
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/box/__generated__/index.partial.tsx <<SignedSource::cd2255d6156809f22f110b9eb0936c9d>>
9
9
  */
@@ -12,10 +12,10 @@
12
12
  import React from 'react';
13
13
  import { Box as PlatformBox } from '@atlaskit/primitives';
14
14
 
15
- import type { CSSProperties } from '@emotion/serialize';
16
15
  import type * as CSS from 'csstype';
17
16
  import type { MediaQuery } from '@atlaskit/primitives';
18
17
  import { tokensMap } from '@atlaskit/primitives';
18
+ type CSSProperties = CSS.PropertiesFallback<number | string>;
19
19
  type TokensMap = typeof tokensMap;
20
20
  type TokensMapPropKey = keyof TokensMap;
21
21
  type TokenizedProps = {
@@ -3,14 +3,15 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - ButtonProps
5
5
  *
6
- * @codegen <<SignedSource::8d3c96f4416729b792a7d3460ae23a27>>
6
+ * @codegen <<SignedSource::28ff60d0f3d4c1058baf352cebe4fc57>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/button/__generated__/index.partial.tsx <<SignedSource::f9a16b36e0a307a53ee30a009373ab49>>
8
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/button/index.tsx <<SignedSource::52b83f8562f7d67ebc840be38101d0a4>>
9
9
  */
10
10
  /* eslint @repo/internal/codegen/signed-source-integrity: "warn" */
11
11
 
12
12
  import type { ButtonProps as PlatformButtonProps } from '@atlaskit/button/new';
13
13
 
14
+ // TODO: File had to be manually updated as code gen is not correctly creating the Icon type
14
15
  export type Icon =
15
16
  | 'activity'
16
17
  | 'add'
@@ -195,6 +196,8 @@ export type Icon =
195
196
  | 'folder-filled'
196
197
  | 'followers'
197
198
  | 'following'
199
+ | 'full-screen-off'
200
+ | 'full-screen-on'
198
201
  | 'googledrive'
199
202
  | 'graph-bar'
200
203
  | 'graph-line'
@@ -369,6 +372,7 @@ export type Icon =
369
372
  | 'watch-filled'
370
373
  | 'world'
371
374
  | 'world-small';
375
+
372
376
  type IconType = Icon;
373
377
 
374
378
 
@@ -3,37 +3,37 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - CheckboxGroupProps
5
5
  *
6
- * @codegen <<SignedSource::63e9cf6f2e444db397f9e170b4e1ce7b>>
6
+ * @codegen <<SignedSource::6a61b3ffdd671a5e0084cc2eb8f266ca>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/checkboxgroup/index.tsx <<SignedSource::4db9e0c029805d1c1fd28b923f3dbae3>>
8
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/checkboxgroup/index.tsx <<SignedSource::c9be1ccedca06e7cd599a9ce5aa61fde>>
9
9
  */
10
10
  /* eslint @repo/internal/codegen/signed-source-integrity: "warn" */
11
11
 
12
12
  export interface CheckboxGroupProps {
13
13
  /**
14
- * Sets the name prop on each of the Checkbox elements in the group.
14
+ * Sets the initial selected value on the `CheckboxGroup`.
15
15
  */
16
- name: string;
16
+ defaultValue?: string[];
17
17
  /**
18
- * An array of objects, each object is mapped onto a Checkbox element within the group.
18
+ * Sets the disabled state of all Checkbox elements in the group.
19
19
  */
20
- options: { label: string; value: string; isDisabled?: boolean }[];
20
+ isDisabled?: boolean;
21
21
  /**
22
- * Once set, controls the selected value on the `CheckboxGroup`.
22
+ * Sets the name prop on each of the Checkbox elements in the group.
23
23
  */
24
- value?: string[];
24
+ name: string;
25
25
  /*
26
26
  * Function that gets fired after each change event.
27
27
  */
28
28
  onChange?: (values: string[]) => void;
29
29
  /**
30
- * Sets the initial selected value on the `CheckboxGroup`.
30
+ * An array of objects, each object is mapped onto a Checkbox element within the group.
31
31
  */
32
- defaultValue?: string[];
32
+ options: { isDisabled?: boolean; label: string; value: string }[];
33
33
  /**
34
- * Sets the disabled state of all Checkbox elements in the group.
34
+ * Once set, controls the selected value on the `CheckboxGroup`.
35
35
  */
36
- isDisabled?: boolean;
36
+ value?: string[];
37
37
  }
38
38
 
39
39
  /**
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - DatePickerProps
5
5
  *
6
- * @codegen <<SignedSource::d146cd7a368d85498c033934001b9a6c>>
6
+ * @codegen <<SignedSource::dd7f6d23d3c23b62f56cc3c8e78c7639>>
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
  */
@@ -12,17 +12,17 @@
12
12
  import type { DateTimePickerSelectProps } from '@atlaskit/datetime-picker';
13
13
 
14
14
  export interface FieldProps {
15
+ 'aria-invalid': 'true' | 'false';
16
+ 'aria-labelledby': string;
15
17
  id: string;
16
- isRequired: boolean;
17
18
  isDisabled: boolean;
18
19
  isInvalid: boolean;
19
- onChange: (event: unknown) => void;
20
+ isRequired: boolean;
21
+ name: string;
20
22
  onBlur: (event: unknown) => void;
23
+ onChange: (event: unknown) => void;
21
24
  onFocus: (event: unknown) => void;
22
25
  value: any;
23
- 'aria-invalid': 'true' | 'false';
24
- 'aria-labelledby': string;
25
- name: string;
26
26
  }
27
27
 
28
28
  type Appearance = 'default' | 'subtle' | 'none';
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - FormFooterProps
5
5
  *
6
- * @codegen <<SignedSource::bd453251ee9501e44dfdef3abb96f526>>
6
+ * @codegen <<SignedSource::4c90207f54696475cd9bfae6d8cfb8a9>>
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
  */
@@ -12,13 +12,13 @@
12
12
  import React from 'react';
13
13
  import { FormFooter as PlatformFormFooter } from '@atlaskit/form';
14
14
 
15
- type _PlatformFormFooterProps = React.ComponentProps<typeof PlatformFormFooter>;
16
15
  export type PlatformFormFooterProps = Omit<_PlatformFormFooterProps, 'align'> & {
17
16
  /**
18
17
  * Sets the alignment of the footer contents. This is often a button. Defaults to `end`.
19
18
  */
20
19
  align?: _PlatformFormFooterProps['align'];
21
20
  }
21
+ type _PlatformFormFooterProps = React.ComponentProps<typeof PlatformFormFooter>;
22
22
 
23
23
  export type FormFooterProps = Pick<
24
24
  PlatformFormFooterProps,
@@ -3,15 +3,16 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - FormProps
5
5
  *
6
- * @codegen <<SignedSource::72d05fe1799ae83e2fbc1e01f76009ce>>
6
+ * @codegen <<SignedSource::ca42eb4d628a4c566926524729cd5949>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/form/index.tsx <<SignedSource::b6dd991b4a5e73adbac9321d53cd909e>>
8
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/form/index.tsx <<SignedSource::227c9ed7a33e4ff2efd0c372e35c04c3>>
9
9
  */
10
10
  /* eslint @repo/internal/codegen/signed-source-integrity: "warn" */
11
11
 
12
12
  import type { ReactNode } from 'react';
13
13
 
14
14
  export type FormProps = {
15
+ children: ReactNode;
15
16
  /**
16
17
  * Event handler called when the form is submitted. Fields must be free of validation errors.
17
18
  *
@@ -22,7 +23,6 @@ export type FormProps = {
22
23
  * If you use `() => Promise<void>|void` for this module, it will default to true.
23
24
  */
24
25
  onSubmit: () => Promise<void | boolean> | void;
25
- children: ReactNode;
26
26
  };
27
27
 
28
28
  /**
@@ -3,9 +3,9 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - InlineEditProps
5
5
  *
6
- * @codegen <<SignedSource::76e64cd0950ea7da3cf92b08df75f5fc>>
6
+ * @codegen <<SignedSource::8f962ba10ad28d9c11ed0430a9195438>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/inline-edit/index.tsx <<SignedSource::7654358cb6b3406900f008113b08977d>>
8
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/inline-edit/index.tsx <<SignedSource::f4625a973245a2df44b3b63960773a46>>
9
9
  */
10
10
  /* eslint @repo/internal/codegen/signed-source-integrity: "warn" */
11
11
 
@@ -13,21 +13,21 @@ import React from 'react';
13
13
  import { default as PlatformInlineEdit } from '@atlaskit/inline-edit';
14
14
 
15
15
  type EditViewFieldProps<V> = {
16
- onChange: (event: any) => void;
17
- value: V;
16
+ 'aria-invalid': 'true' | 'false';
18
17
  errorMessage?: string;
19
18
  isInvalid: boolean;
20
- 'aria-invalid': 'true' | 'false';
21
19
  isRequired: boolean;
20
+ onChange: (event: any) => void;
21
+ value: V;
22
22
  };
23
23
 
24
24
  export type InlineEditProps<V = string> = Omit<
25
25
  React.ComponentProps<typeof PlatformInlineEdit<V>>,
26
26
  'analyticsContext' | 'onConfirm' | 'editView'
27
27
  > & {
28
+ editView: (fieldProps: EditViewFieldProps<V>) => React.ReactNode;
28
29
  // ADS has an additional analyticsEvent arg that is not optional. We don't use this in UI Kit and it can't be removed due to breaking changes in products
29
30
  onConfirm: (value: V) => void;
30
- editView: (fieldProps: EditViewFieldProps<V>) => React.ReactNode;
31
31
  };
32
32
 
33
33
  /**
@@ -3,14 +3,14 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - LinkButtonProps
5
5
  *
6
- * @codegen <<SignedSource::5954a642054228f3f1ffb106dca3072f>>
6
+ * @codegen <<SignedSource::65d972f12bee563f4cc6b347e042dc57>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/button/__generated__/link-button.partial.tsx <<SignedSource::e74ee4aaf752a6e85a57950dce7a3683>>
8
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/button/link-button.tsx <<SignedSource::260bb0ac991e48b6e7f0da4b938d73c7>>
9
9
  */
10
10
  /* eslint @repo/internal/codegen/signed-source-integrity: "warn" */
11
11
 
12
- import type { LinkButtonProps as PlatformLinkButtonProps } from '@atlaskit/button/new';
13
12
  import React from 'react';
13
+ import type { LinkButtonProps as PlatformLinkButtonProps } from '@atlaskit/button/new';
14
14
 
15
15
  export type LinkButtonProps = Pick<
16
16
  PlatformLinkButtonProps,
@@ -25,9 +25,9 @@ export type LinkButtonProps = Pick<
25
25
  | 'testId'
26
26
  | 'shouldFitContainer'
27
27
  > & {
28
+ appearance?: PlatformLinkButtonProps['appearance'] | 'link' | 'subtle-link';
28
29
  href?: string;
29
30
  ref?: React.Ref<HTMLAnchorElement>;
30
- appearance?: PlatformLinkButtonProps['appearance'] | 'link' | 'subtle-link';
31
31
  spacing?: PlatformLinkButtonProps['spacing'] | 'none';
32
32
  };
33
33
 
@@ -3,25 +3,25 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - ListProps
5
5
  *
6
- * @codegen <<SignedSource::d77d7e870d29834b0636dd18611690de>>
6
+ * @codegen <<SignedSource::f941ffed450aa45c5d58966679182193>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/list/list.tsx <<SignedSource::447b2a8735f97d1d9b091a97a64a7c89>>
8
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/list/list.tsx <<SignedSource::05949d787a1dce05d30cd93eed298093>>
9
9
  */
10
10
  /* eslint @repo/internal/codegen/signed-source-integrity: "warn" */
11
11
 
12
12
  import React from 'react';
13
13
 
14
14
  export interface ListProps {
15
+ /**
16
+ * The items to render inside a `List` group.
17
+ */
18
+ children: React.ReactNode;
15
19
  /**
16
20
  * The `ordered` type should be used when representing an ordered list of items.
17
21
  * The `unordered` type should be used when representing an unordered list of items.
18
22
  * The type is set to `unordered` by default.
19
23
  */
20
24
  type: 'ordered' | 'unordered';
21
- /**
22
- * The items to render inside a `List` group.
23
- */
24
- children: React.ReactNode;
25
25
  }
26
26
 
27
27
  /**
@@ -3,9 +3,9 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - LoadingButtonProps
5
5
  *
6
- * @codegen <<SignedSource::7976cc960c60dd5f5efe450507bd3d6b>>
6
+ * @codegen <<SignedSource::f3ab66b3494753ac1721770620800f33>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/button/loading-button.tsx <<SignedSource::66edb728e0e941c5f53236e94cd02c18>>
8
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/button/loading-button.tsx <<SignedSource::f8f88b5f1e0c23036af2f7649740ac92>>
9
9
  */
10
10
  /* eslint @repo/internal/codegen/signed-source-integrity: "warn" */
11
11
 
@@ -3,9 +3,9 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - PopupProps
5
5
  *
6
- * @codegen <<SignedSource::1406c01bd678b4f8525d6b2e48bf6021>>
6
+ * @codegen <<SignedSource::8763a054e66a7a157d421e05062d175f>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/popup/index.tsx <<SignedSource::ff9b9f72bb5b2721d62300345e310108>>
8
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/popup/index.tsx <<SignedSource::e9d4bff7da064f1461f189540b88554c>>
9
9
  */
10
10
  /* eslint @repo/internal/codegen/signed-source-integrity: "warn" */
11
11
 
@@ -3,9 +3,9 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - PressableProps
5
5
  *
6
- * @codegen <<SignedSource::5372ef8608441a2d8f71e99a6fd0a36e>>
6
+ * @codegen <<SignedSource::e2a66a4b4895b62cc4fce2fea034ad4b>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/pressable/__generated__/index.partial.tsx <<SignedSource::b297593f4c38160fa0272fb43fcaa19c>>
8
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/pressable/index.tsx <<SignedSource::d647047e3db08689d4030f643748e661>>
9
9
  */
10
10
  /* eslint-disable @atlaskit/design-system/ensure-design-token-usage/preview */
11
11
 
@@ -191,63 +191,63 @@ type XCSSProp = ReturnType<typeof xcssValidator>;
191
191
  type PlatformPressableProps = React.ComponentProps<typeof PlatformPressable>;
192
192
 
193
193
  export type PressableProps = Pick<PlatformPressableProps, 'children' | 'ref' | 'testId'> & {
194
- /**
195
- * Token representing background color with a built-in fallback value.
196
- */
197
- backgroundColor?: PlatformPressableProps['backgroundColor'],
198
- /**
199
- * Whether the button is disabled.
200
- */
201
- isDisabled?: PlatformPressableProps['isDisabled'],
202
- /**
203
- * Handler called on click.
204
- */
205
- onClick?: () => void,
206
- /**
207
- * Tokens representing CSS shorthand for `paddingBlock` and `paddingInline` together.
208
- *
209
- * @see paddingBlock
210
- * @see paddingInline
211
- */
212
- padding?: PlatformPressableProps['padding'],
213
- /**
214
- * Tokens representing CSS shorthand `paddingBlock`.
215
- *
216
- * @see paddingBlockStart
217
- * @see paddingBlockEnd
218
- */
219
- paddingBlock?: PlatformPressableProps['paddingBlock'],
220
- /**
221
- * Tokens representing CSS `paddingBlockEnd`.
222
- */
223
- paddingBlockEnd?: PlatformPressableProps['paddingBlockEnd'],
224
- /**
225
- * Tokens representing CSS `paddingBlockStart`.
226
- */
227
- paddingBlockStart?: PlatformPressableProps['paddingBlockStart'],
228
- /**
229
- * Tokens representing CSS shorthand `paddingInline`.
230
- *
231
- * @see paddingInlineStart
232
- * @see paddingInlineEnd
233
- */
234
- paddingInline?: PlatformPressableProps['paddingInline'],
235
- /**
236
- * Tokens representing CSS `paddingInlineEnd`.
237
- */
238
- paddingInlineEnd?: PlatformPressableProps['paddingInlineEnd'],
239
- /**
240
- * Tokens representing CSS `paddingInlineStart`.
241
- */
242
- paddingInlineStart?: PlatformPressableProps['paddingInlineStart'],
243
- /**
244
- * Apply a subset of permitted styles, powered by Atlassian Design System tokens.
245
- * For a list of supported style properties on this component, see [here](https://developer.atlassian.com/platform/forge/ui-kit/components/xcss).
246
- *
247
- * @type XCSSProp
248
- */
249
- xcss?: XCSSProp;
250
- }
194
+ /**
195
+ * Token representing background color with a built-in fallback value.
196
+ */
197
+ backgroundColor?: PlatformPressableProps['backgroundColor'];
198
+ /**
199
+ * Whether the button is disabled.
200
+ */
201
+ isDisabled?: PlatformPressableProps['isDisabled'];
202
+ /**
203
+ * Handler called on click.
204
+ */
205
+ onClick?: () => void;
206
+ /**
207
+ * Tokens representing CSS shorthand for `paddingBlock` and `paddingInline` together.
208
+ *
209
+ * @see paddingBlock
210
+ * @see paddingInline
211
+ */
212
+ padding?: PlatformPressableProps['padding'];
213
+ /**
214
+ * Tokens representing CSS shorthand `paddingBlock`.
215
+ *
216
+ * @see paddingBlockStart
217
+ * @see paddingBlockEnd
218
+ */
219
+ paddingBlock?: PlatformPressableProps['paddingBlock'];
220
+ /**
221
+ * Tokens representing CSS `paddingBlockEnd`.
222
+ */
223
+ paddingBlockEnd?: PlatformPressableProps['paddingBlockEnd'];
224
+ /**
225
+ * Tokens representing CSS `paddingBlockStart`.
226
+ */
227
+ paddingBlockStart?: PlatformPressableProps['paddingBlockStart'];
228
+ /**
229
+ * Tokens representing CSS shorthand `paddingInline`.
230
+ *
231
+ * @see paddingInlineStart
232
+ * @see paddingInlineEnd
233
+ */
234
+ paddingInline?: PlatformPressableProps['paddingInline'];
235
+ /**
236
+ * Tokens representing CSS `paddingInlineEnd`.
237
+ */
238
+ paddingInlineEnd?: PlatformPressableProps['paddingInlineEnd'];
239
+ /**
240
+ * Tokens representing CSS `paddingInlineStart`.
241
+ */
242
+ paddingInlineStart?: PlatformPressableProps['paddingInlineStart'];
243
+ /**
244
+ * Apply a subset of permitted styles, powered by Atlassian Design System tokens.
245
+ * For a list of supported style properties on this component, see [here](https://developer.atlassian.com/platform/forge/ui-kit/components/xcss).
246
+ *
247
+ * @type XCSSProp
248
+ */
249
+ xcss?: XCSSProp;
250
+ };
251
251
 
252
252
  /**
253
253
  * A pressable is a primitive for building custom buttons.
@@ -3,9 +3,9 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - SectionMessageProps
5
5
  *
6
- * @codegen <<SignedSource::725983e3bb955783124380fc689f56de>>
6
+ * @codegen <<SignedSource::08d9aec7dc84ab09fe105054828cea70>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/sectionmessage/__generated__/index.partial.tsx <<SignedSource::164319f578b12a9ab6d85a5bd3e4cc8a>>
8
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/sectionmessage/index.tsx <<SignedSource::a94e5a0d754b50192e4aeddb4c0d8500>>
9
9
  */
10
10
  /* eslint @repo/internal/codegen/signed-source-integrity: "warn" */
11
11
 
@@ -15,8 +15,8 @@ import PlatformSectionMessage from '@atlaskit/section-message';
15
15
  type PlatformSectionMessageProps = React.ComponentProps<typeof PlatformSectionMessage>;
16
16
 
17
17
  export type SectionMessageProps = Pick<
18
- PlatformSectionMessageProps,
19
- 'children' | 'appearance' | 'title' | 'actions' | 'testId'
18
+ PlatformSectionMessageProps,
19
+ 'children' | 'appearance' | 'title' | 'actions' | 'testId'
20
20
  >;
21
21
 
22
22
  /**
@@ -3,9 +3,9 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - TextProps
5
5
  *
6
- * @codegen <<SignedSource::1c42fde750e32bfa08754b99f8b46fc8>>
6
+ * @codegen <<SignedSource::2ed972ffd5e71c07a80894fade629a9d>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/text/__generated__/index.partial.tsx <<SignedSource::da061e381ac179a40cf7f65f94f3b651>>
8
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/text/__generated__/index.partial.tsx <<SignedSource::78e5f0ea9165ce254772921abbc01ccd>>
9
9
  */
10
10
  /* eslint @repo/internal/codegen/signed-source-integrity: "warn" */
11
11