@atlaskit/forge-react-types 0.58.0 → 0.59.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @atlaskit/forge-react-types
 
+## 0.59.0
+
+### Minor Changes
+
+- [`e5e1ada56ae7f`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/e5e1ada56ae7f) -
+  New component AtlassianIcon added.
+
 ## 0.58.0
 
 ### Minor Changes

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

@@ -0,0 +1 @@
+"use strict";

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

@@ -0,0 +1,37 @@
+/**
+ * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
+ *
+ * Extract component prop types from UIKit 2 components - AtlassianIconProps
+ *
+ * @codegen <<SignedSource::48d2fe2d1559dde01c83341d7d963d7f>>
+ * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/atlassianicon/index.tsx <<SignedSource::953d41a93d1452a3e634edd32d3f49de>>
+ */
+export type AtlassianIconType = 'blog' | 'branch' | 'bug' | 'calendar' | 'changes' | 'code' | 'commit' | 'database' | 'epic' | 'idea' | 'improvement' | 'incident' | 'new-feature' | 'page' | 'page-live-doc' | 'problem' | 'pull-request' | 'question' | 'story' | 'subtask' | 'task' | 'whiteboard' | 'work-item';
+export type AtlassianIconProps = {
+    /**
+     * The glyph type of AtlassianIcon to render. This will automatically set the color.
+     * Available options are derived from @atlaskit/object metadata and will
+     * automatically include any new object types added to the design system.
+     */
+    glyph: AtlassianIconType;
+    /**
+     * The label for the AtlassianIcon. If decorative, set to empty string.
+     */
+    label?: string;
+    /**
+     * The size of the AtlassianIcon: 'small' (12px) or 'medium' (16px).
+     */
+    size?: 'small' | 'medium';
+    /**
+   * Test ID for testing
+   */
+    testId?: string;
+};
+/**
+ * An AtlassianIcon is an icon that represents an Atlassian-specific content type.
+ * The glyph prop automatically sets the color for the object.
+ *
+ * @see [AtlassianIcon](https://developer.atlassian.com/platform/forge/ui-kit/components/atlassian-icon/) in UI Kit documentation for more information
+ */
+export type TAtlassianIcon<T> = (props: AtlassianIconProps) => T;

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

@@ -36,6 +36,7 @@ export type { ModalHeaderProps, TModalHeader } from './ModalHeaderProps.codegen'
 export type { ModalProps, TModal } from './ModalProps.codegen';
 export type { ModalTitleProps, TModalTitle } from './ModalTitleProps.codegen';
 export type { ModalTransitionProps, TModalTransition } from './ModalTransitionProps.codegen';
+export type { AtlassianIconProps, TAtlassianIcon } from './AtlassianIconProps.codegen';
 export type { ProgressBarProps, TProgressBar } from './ProgressBarProps.codegen';
 export type { ProgressTrackerProps, TProgressTracker } from './ProgressTrackerProps.codegen';
 export type { RadioGroupProps, TRadioGroup } from './RadioGroupProps.codegen';

package/dist/types/index.d.ts

@@ -1,4 +1,4 @@
-export type { AdfRendererProps, AtlassianTileProps, 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, TileProps, ToggleProps, TooltipProps, TimePickerProps, ValidMessageProps, PopupProps, InlineEditProps, PressableProps, TBadge, TBox, TButtonGroup, TButton, TCalendar, TCheckbox, TCheckboxGroup, TCodeBlock, TCode, TComment, TDatePicker, TDynamicTable, TEmptyState, TErrorMessage, TFileCard, 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, TFilePicker, TTile, TAtlassianTile, } from './components/__generated__';
+export type { AdfRendererProps, AtlassianTileProps, AtlassianIconProps, 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, TileProps, ToggleProps, TooltipProps, TimePickerProps, ValidMessageProps, PopupProps, InlineEditProps, PressableProps, TBadge, TBox, TButtonGroup, TButton, TCalendar, TCheckbox, TCheckboxGroup, TCodeBlock, TCode, TComment, TDatePicker, TDynamicTable, TEmptyState, TErrorMessage, TFileCard, 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, TFilePicker, TTile, TAtlassianTile, TAtlassianIcon, } from './components/__generated__';
 export type { BarChartProps, StackBarChartProps, HorizontalStackBarChartProps, HorizontalBarChartProps, LineChartProps, DonutChartProps, PieChartProps, TBarChart, TStackBarChart, THorizontalStackBarChart, THorizontalBarChart, TLineChart, TDonutChart, TPieChart, } from './components/charts';
 export type { ChromelessEditorProps, CommentEditorProps, TChromelessEditor, TCommentEditor, } from './components/editor';
 export type { ChartColorTokens } from './types';

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

@@ -0,0 +1,37 @@
+/**
+ * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
+ *
+ * Extract component prop types from UIKit 2 components - AtlassianIconProps
+ *
+ * @codegen <<SignedSource::48d2fe2d1559dde01c83341d7d963d7f>>
+ * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/atlassianicon/index.tsx <<SignedSource::953d41a93d1452a3e634edd32d3f49de>>
+ */
+export type AtlassianIconType = 'blog' | 'branch' | 'bug' | 'calendar' | 'changes' | 'code' | 'commit' | 'database' | 'epic' | 'idea' | 'improvement' | 'incident' | 'new-feature' | 'page' | 'page-live-doc' | 'problem' | 'pull-request' | 'question' | 'story' | 'subtask' | 'task' | 'whiteboard' | 'work-item';
+export type AtlassianIconProps = {
+    /**
+     * The glyph type of AtlassianIcon to render. This will automatically set the color.
+     * Available options are derived from @atlaskit/object metadata and will
+     * automatically include any new object types added to the design system.
+     */
+    glyph: AtlassianIconType;
+    /**
+     * The label for the AtlassianIcon. If decorative, set to empty string.
+     */
+    label?: string;
+    /**
+     * The size of the AtlassianIcon: 'small' (12px) or 'medium' (16px).
+     */
+    size?: 'small' | 'medium';
+    /**
+   * Test ID for testing
+   */
+    testId?: string;
+};
+/**
+ * An AtlassianIcon is an icon that represents an Atlassian-specific content type.
+ * The glyph prop automatically sets the color for the object.
+ *
+ * @see [AtlassianIcon](https://developer.atlassian.com/platform/forge/ui-kit/components/atlassian-icon/) in UI Kit documentation for more information
+ */
+export type TAtlassianIcon<T> = (props: AtlassianIconProps) => T;

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

@@ -36,6 +36,7 @@ export type { ModalHeaderProps, TModalHeader } from './ModalHeaderProps.codegen'
 export type { ModalProps, TModal } from './ModalProps.codegen';
 export type { ModalTitleProps, TModalTitle } from './ModalTitleProps.codegen';
 export type { ModalTransitionProps, TModalTransition } from './ModalTransitionProps.codegen';
+export type { AtlassianIconProps, TAtlassianIcon } from './AtlassianIconProps.codegen';
 export type { ProgressBarProps, TProgressBar } from './ProgressBarProps.codegen';
 export type { ProgressTrackerProps, TProgressTracker } from './ProgressTrackerProps.codegen';
 export type { RadioGroupProps, TRadioGroup } from './RadioGroupProps.codegen';

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

@@ -1,4 +1,4 @@
-export type { AdfRendererProps, AtlassianTileProps, 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, TileProps, ToggleProps, TooltipProps, TimePickerProps, ValidMessageProps, PopupProps, InlineEditProps, PressableProps, TBadge, TBox, TButtonGroup, TButton, TCalendar, TCheckbox, TCheckboxGroup, TCodeBlock, TCode, TComment, TDatePicker, TDynamicTable, TEmptyState, TErrorMessage, TFileCard, 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, TFilePicker, TTile, TAtlassianTile, } from './components/__generated__';
+export type { AdfRendererProps, AtlassianTileProps, AtlassianIconProps, 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, TileProps, ToggleProps, TooltipProps, TimePickerProps, ValidMessageProps, PopupProps, InlineEditProps, PressableProps, TBadge, TBox, TButtonGroup, TButton, TCalendar, TCheckbox, TCheckboxGroup, TCodeBlock, TCode, TComment, TDatePicker, TDynamicTable, TEmptyState, TErrorMessage, TFileCard, 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, TFilePicker, TTile, TAtlassianTile, TAtlassianIcon, } from './components/__generated__';
 export type { BarChartProps, StackBarChartProps, HorizontalStackBarChartProps, HorizontalBarChartProps, LineChartProps, DonutChartProps, PieChartProps, TBarChart, TStackBarChart, THorizontalStackBarChart, THorizontalBarChart, TLineChart, TDonutChart, TPieChart, } from './components/charts';
 export type { ChromelessEditorProps, CommentEditorProps, TChromelessEditor, TCommentEditor, } from './components/editor';
 export type { ChartColorTokens } from './types';

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/forge-react-types",
-	"version": "0.58.0",
+	"version": "0.59.0",
 	"description": "Component types for Forge UI Kit React components",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -29,6 +29,7 @@
 		"@atlaskit/inline-edit": "^15.6.0",
 		"@atlaskit/modal-dialog": "^14.10.0",
 		"@atlaskit/navigation-system": "^5.32.0",
+		"@atlaskit/object": "^1.0.0",
 		"@atlaskit/popup": "^4.13.0",
 		"@atlaskit/primitives": "^18.0.0",
 		"@atlaskit/progress-bar": "^4.1.0",
@@ -55,7 +56,7 @@
 	},
 	"devDependencies": {
 		"@atlassian/codegen": "^0.1.0",
-		"@atlassian/forge-ui": "^32.80.0",
+		"@atlassian/forge-ui": "^32.81.0",
 		"@types/node": "^24.0.0",
 		"lodash": "^4.17.21",
 		"react": "^18.2.0",

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

@@ -0,0 +1,41 @@
+/**
+ * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
+ *
+ * Extract component prop types from UIKit 2 components - AtlassianIconProps
+ *
+ * @codegen <<SignedSource::48d2fe2d1559dde01c83341d7d963d7f>>
+ * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/atlassianicon/index.tsx <<SignedSource::953d41a93d1452a3e634edd32d3f49de>>
+ */
+/* eslint @repo/internal/codegen/signed-source-integrity: "warn" */
+
+export type AtlassianIconType = 'blog' | 'branch' | 'bug' | 'calendar' | 'changes' | 'code' | 'commit' | 'database' | 'epic' | 'idea' | 'improvement' | 'incident' | 'new-feature' | 'page' | 'page-live-doc' | 'problem' | 'pull-request' | 'question' | 'story' | 'subtask' | 'task' | 'whiteboard' | 'work-item';
+
+export type AtlassianIconProps = {
+  /**
+   * The glyph type of AtlassianIcon to render. This will automatically set the color.
+   * Available options are derived from @atlaskit/object metadata and will
+   * automatically include any new object types added to the design system.
+   */
+  glyph: AtlassianIconType;
+  /**
+   * The label for the AtlassianIcon. If decorative, set to empty string.
+   */
+  label?: string;
+  /**
+   * The size of the AtlassianIcon: 'small' (12px) or 'medium' (16px).
+   */
+  size?: 'small' | 'medium';
+	/**
+   * Test ID for testing
+   */
+  testId?: string;
+};
+
+/**
+ * An AtlassianIcon is an icon that represents an Atlassian-specific content type.
+ * The glyph prop automatically sets the color for the object.
+ *
+ * @see [AtlassianIcon](https://developer.atlassian.com/platform/forge/ui-kit/components/atlassian-icon/) in UI Kit documentation for more information
+ */
+export type TAtlassianIcon<T> = (props: AtlassianIconProps) => T;

package/src/components/__generated__/index.ts

@@ -36,6 +36,7 @@ export type { ModalHeaderProps, TModalHeader } from './ModalHeaderProps.codegen'
 export type { ModalProps, TModal } from './ModalProps.codegen';
 export type { ModalTitleProps, TModalTitle } from './ModalTitleProps.codegen';
 export type { ModalTransitionProps, TModalTransition } from './ModalTransitionProps.codegen';
+export type { AtlassianIconProps, TAtlassianIcon } from './AtlassianIconProps.codegen';
 export type { ProgressBarProps, TProgressBar } from './ProgressBarProps.codegen';
 export type { ProgressTrackerProps, TProgressTracker } from './ProgressTrackerProps.codegen';
 export type { RadioGroupProps, TRadioGroup } from './RadioGroupProps.codegen';

package/src/index.ts

@@ -1,6 +1,7 @@
 export type {
 	AdfRendererProps,
 	AtlassianTileProps,
+	AtlassianIconProps,
 	BadgeProps,
 	BoxProps,
 	ButtonGroupProps,
@@ -131,6 +132,7 @@ export type {
 	TFilePicker,
 	TTile,
 	TAtlassianTile,
+	TAtlassianIcon,
 } from './components/__generated__';
 
 export type {