@atlaskit/forge-react-types 0.39.1 → 0.40.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/forge-react-types
 
+## 0.40.0
+
+### Minor Changes
+
+- [#128054](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/128054)
+  [`2bac28d495a29`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/2bac28d495a29) -
+  Added Comment component from Atlaskit into Forge UI Kit 2
+
 ## 0.39.1
 
 ### Patch Changes

package/dist/cjs/components/__generated__/CommentProps.codegen.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/dist/es2019/components/__generated__/CommentProps.codegen.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/components/__generated__/CommentProps.codegen.js

@@ -0,0 +1 @@
+export {};

package/dist/types/components/__generated__/CommentProps.codegen.d.ts

@@ -0,0 +1,18 @@
+/**
+ * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
+ *
+ * Extract component prop types from UIKit 2 components - CommentProps
+ *
+ * @codegen <<SignedSource::168060fac6a0765d20191280e916c97d>>
+ * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/comment/__generated__/index.partial.tsx <<SignedSource::9088f4c0a4e9e1ec151ec5ccba0cdfd6>>
+ */
+import React from 'react';
+import PlatformComment from '@atlaskit/comment';
+type PlatformCommentProps = React.ComponentProps<typeof PlatformComment>;
+export type CommentProps = Pick<PlatformCommentProps, 'actions' | 'afterContent' | 'avatar' | 'children' | 'content' | 'errorIconLabel' | 'headingLevel' | 'highlighted' | 'id' | 'isError' | 'isSaving' | 'restrictedTo' | 'savingText' | 'shouldRenderNestedCommentsInline' | 'testId' | 'type'>;
+/**
+ * A comment displays discussions and user feedback.
+ */
+export type TComment<T> = (props: CommentProps) => T;
+export {};

package/dist/types/components/__generated__/index.d.ts

@@ -8,6 +8,7 @@ export type { CalendarProps, TCalendar } from './CalendarProps.codegen';
 export type { CheckboxGroupProps, TCheckboxGroup } from './CheckboxGroupProps.codegen';
 export type { CodeBlockProps, TCodeBlock } from './CodeBlockProps.codegen';
 export type { CodeProps, TCode } from './CodeProps.codegen';
+export type { CommentProps, TComment } from './CommentProps.codegen';
 export type { DatePickerProps, TDatePicker } from './DatePickerProps.codegen';
 export type { DynamicTableProps, TDynamicTable } from './DynamicTableProps.codegen';
 export type { EmptyStateProps, TEmptyState } from './EmptyStateProps.codegen';
@@ -40,7 +41,7 @@ export type { ProgressTrackerProps, TProgressTracker } from './ProgressTrackerPr
 export type { RadioGroupProps, TRadioGroup } from './RadioGroupProps.codegen';
 export type { RadioProps, TRadio } from './RadioProps.codegen';
 export type { RangeProps, TRange } from './RangeProps.codegen';
-export type { SectionMessageActionProps, TSectionMessageAction } from './SectionMessageActionProps.codegen';
+export type { SectionMessageActionProps, TSectionMessageAction, } from './SectionMessageActionProps.codegen';
 export type { SectionMessageProps, TSectionMessage } from './SectionMessageProps.codegen';
 export type { SelectProps, TSelect } from './SelectProps.codegen';
 export type { SpinnerProps, TSpinner } from './SpinnerProps.codegen';

package/dist/types/index.d.ts

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

package/dist/types-ts4.5/components/__generated__/CommentProps.codegen.d.ts

@@ -0,0 +1,18 @@
+/**
+ * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
+ *
+ * Extract component prop types from UIKit 2 components - CommentProps
+ *
+ * @codegen <<SignedSource::168060fac6a0765d20191280e916c97d>>
+ * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/comment/__generated__/index.partial.tsx <<SignedSource::9088f4c0a4e9e1ec151ec5ccba0cdfd6>>
+ */
+import React from 'react';
+import PlatformComment from '@atlaskit/comment';
+type PlatformCommentProps = React.ComponentProps<typeof PlatformComment>;
+export type CommentProps = Pick<PlatformCommentProps, 'actions' | 'afterContent' | 'avatar' | 'children' | 'content' | 'errorIconLabel' | 'headingLevel' | 'highlighted' | 'id' | 'isError' | 'isSaving' | 'restrictedTo' | 'savingText' | 'shouldRenderNestedCommentsInline' | 'testId' | 'type'>;
+/**
+ * A comment displays discussions and user feedback.
+ */
+export type TComment<T> = (props: CommentProps) => T;
+export {};

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

@@ -8,6 +8,7 @@ export type { CalendarProps, TCalendar } from './CalendarProps.codegen';
 export type { CheckboxGroupProps, TCheckboxGroup } from './CheckboxGroupProps.codegen';
 export type { CodeBlockProps, TCodeBlock } from './CodeBlockProps.codegen';
 export type { CodeProps, TCode } from './CodeProps.codegen';
+export type { CommentProps, TComment } from './CommentProps.codegen';
 export type { DatePickerProps, TDatePicker } from './DatePickerProps.codegen';
 export type { DynamicTableProps, TDynamicTable } from './DynamicTableProps.codegen';
 export type { EmptyStateProps, TEmptyState } from './EmptyStateProps.codegen';
@@ -40,7 +41,7 @@ export type { ProgressTrackerProps, TProgressTracker } from './ProgressTrackerPr
 export type { RadioGroupProps, TRadioGroup } from './RadioGroupProps.codegen';
 export type { RadioProps, TRadio } from './RadioProps.codegen';
 export type { RangeProps, TRange } from './RangeProps.codegen';
-export type { SectionMessageActionProps, TSectionMessageAction } from './SectionMessageActionProps.codegen';
+export type { SectionMessageActionProps, TSectionMessageAction, } from './SectionMessageActionProps.codegen';
 export type { SectionMessageProps, TSectionMessage } from './SectionMessageProps.codegen';
 export type { SelectProps, TSelect } from './SelectProps.codegen';
 export type { SpinnerProps, TSpinner } from './SpinnerProps.codegen';

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

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

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/forge-react-types",
-	"version": "0.39.1",
+	"version": "0.40.0",
 	"description": "Component types for Forge UI Kit React components",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -29,6 +29,7 @@
 		"@atlaskit/calendar": "^17.1.0",
 		"@atlaskit/checkbox": "^17.0.0",
 		"@atlaskit/code": "^16.1.0",
+		"@atlaskit/comment": "^13.0.0",
 		"@atlaskit/datetime-picker": "^16.2.0",
 		"@atlaskit/dynamic-table": "^18.0.0",
 		"@atlaskit/empty-state": "^9.0.0",
@@ -43,7 +44,7 @@
 		"@atlaskit/progress-tracker": "^10.0.0",
 		"@atlaskit/radio": "^8.0.0",
 		"@atlaskit/range": "^9.0.0",
-		"@atlaskit/renderer": "^114.5.0",
+		"@atlaskit/renderer": "^114.6.0",
 		"@atlaskit/section-message": "^8.2.0",
 		"@atlaskit/select": "^20.0.0",
 		"@atlaskit/spinner": "^18.0.0",

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

@@ -0,0 +1,25 @@
+/**
+ * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
+ *
+ * Extract component prop types from UIKit 2 components - CommentProps
+ *
+ * @codegen <<SignedSource::168060fac6a0765d20191280e916c97d>>
+ * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/comment/__generated__/index.partial.tsx <<SignedSource::9088f4c0a4e9e1ec151ec5ccba0cdfd6>>
+ */
+/* eslint @repo/internal/codegen/signed-source-integrity: "warn" */
+
+import React from 'react';
+import PlatformComment from '@atlaskit/comment';
+
+type PlatformCommentProps = React.ComponentProps<typeof PlatformComment>;
+
+export type CommentProps = Pick<
+  PlatformCommentProps,
+  'actions' | 'afterContent' | 'avatar' | 'children' | 'content' | 'errorIconLabel' | 'headingLevel' | 'highlighted' | 'id' | 'isError' | 'isSaving' | 'restrictedTo' | 'savingText' | 'shouldRenderNestedCommentsInline' | 'testId' | 'type'
+>;
+
+/**
+ * A comment displays discussions and user feedback.
+ */
+export type TComment<T> = (props: CommentProps) => T;

package/src/components/__generated__/index.ts

@@ -8,6 +8,7 @@ export type { CalendarProps, TCalendar } from './CalendarProps.codegen';
 export type { CheckboxGroupProps, TCheckboxGroup } from './CheckboxGroupProps.codegen';
 export type { CodeBlockProps, TCodeBlock } from './CodeBlockProps.codegen';
 export type { CodeProps, TCode } from './CodeProps.codegen';
+export type { CommentProps, TComment } from './CommentProps.codegen';
 export type { DatePickerProps, TDatePicker } from './DatePickerProps.codegen';
 export type { DynamicTableProps, TDynamicTable } from './DynamicTableProps.codegen';
 export type { EmptyStateProps, TEmptyState } from './EmptyStateProps.codegen';
@@ -40,7 +41,10 @@ export type { ProgressTrackerProps, TProgressTracker } from './ProgressTrackerPr
 export type { RadioGroupProps, TRadioGroup } from './RadioGroupProps.codegen';
 export type { RadioProps, TRadio } from './RadioProps.codegen';
 export type { RangeProps, TRange } from './RangeProps.codegen';
-export type { SectionMessageActionProps, TSectionMessageAction } from './SectionMessageActionProps.codegen';
+export type {
+	SectionMessageActionProps,
+	TSectionMessageAction,
+} from './SectionMessageActionProps.codegen';
 export type { SectionMessageProps, TSectionMessage } from './SectionMessageProps.codegen';
 export type { SelectProps, TSelect } from './SelectProps.codegen';
 export type { SpinnerProps, TSpinner } from './SpinnerProps.codegen';

package/src/index.ts

@@ -10,6 +10,7 @@ export type {
 	CheckboxGroupProps,
 	CodeBlockProps,
 	CodeProps,
+	CommentProps,
 	DatePickerProps,
 	DynamicTableProps,
 	EmptyStateProps,
@@ -71,6 +72,7 @@ export type {
 	TCheckboxGroup,
 	TCodeBlock,
 	TCode,
+	TComment,
 	TDatePicker,
 	TDynamicTable,
 	TEmptyState,