@atlaskit/forge-react-types 0.36.0 → 0.37.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/forge-react-types
 
+## 0.37.0
+
+### Minor Changes
+
+- [#116826](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/116826)
+  [`8c12c6e2b3efe`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/8c12c6e2b3efe) -
+  Add props for "Text" component
+
 ## 0.36.0
 
 ### Minor Changes

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

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

package/dist/cjs/components/__generated__/index.js

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

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

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

package/dist/es2019/components/__generated__/index.js

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

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

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

package/dist/esm/components/__generated__/index.js

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

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

@@ -3,9 +3,9 @@
  *
  * Extract component prop types from UIKit 2 components - CodeProps
  *
- * @codegen <<SignedSource::1a39727c921b99c3519aa0020e967c21>>
+ * @codegen <<SignedSource::e0386444a3c82762fe87b25289122301>>
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/code/__generated__/code.partial.tsx <<SignedSource::370e450903cb8f21b11acac7a9fc720b>>
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/code/__generated__/code.partial.tsx <<SignedSource::a54209d8f81fb1e2f354f4563725efeb>>
  */
 import React from 'react';
 import { Code as PlatformCode } from '@atlaskit/code';

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

@@ -3,16 +3,16 @@
  *
  * Extract component prop types from UIKit 2 components - HeadingProps
  *
- * @codegen <<SignedSource::f5b58f64c5c8cfbaff45b7d288ec4ffd>>
+ * @codegen <<SignedSource::b8bb5780d2b0112f8f2a4c7190d63fc7>>
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/heading/__generated__/index.partial.tsx <<SignedSource::b9f5a7af9c404be1b3bf1e55075715fc>>
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/heading/__generated__/index.partial.tsx <<SignedSource::96b99b296364dce930bb91174b226eaa>>
  */
 import type { HeadingProps as PlatformHeadingProps } from '@atlaskit/heading';
-type HeadingTags = 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6';
+type Sizes = 'xxlarge' | 'xlarge' | 'large' | 'medium' | 'small' | 'xsmall' | 'xxsmall';
 type TemporaryColors = 'default' | 'inverse';
 type NewColors = 'color.text' | 'color.text.inverse' | 'color.text.warning.inverse';
-export type HeadingProps = Pick<PlatformHeadingProps, 'children' | 'id' | 'testId'> & {
-    as: HeadingTags;
+export type HeadingProps = Pick<PlatformHeadingProps, 'children' | 'id' | 'testId' | 'as'> & {
+    size?: Sizes;
     color?: NewColors | TemporaryColors;
 };
 /**

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

@@ -3,9 +3,9 @@
  *
  * Extract component prop types from UIKit 2 components - LozengeProps
  *
- * @codegen <<SignedSource::010c29755ec75417d1649af3008801cd>>
+ * @codegen <<SignedSource::3d662c95d84fa4bb1441b1edbac2c302>>
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/lozenge/__generated__/index.partial.tsx <<SignedSource::20810ed29278b94c2bf310c8d80efdf8>>
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/lozenge/__generated__/index.partial.tsx <<SignedSource::e362dbb308b0f7785d47bb5e9aa46ab0>>
  */
 import React from 'react';
 import PlatformLozenge from '@atlaskit/lozenge';

package/dist/types/components/__generated__/TextProps.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 - TextProps
+ *
+ * @codegen <<SignedSource::31d160b53a47008ce61df934652b99c0>>
+ * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/text/__generated__/index.partial.tsx <<SignedSource::813a1a6f22d33e27a5651da301ca7ab1>>
+ */
+import React from 'react';
+import { Text as PlatformText } from '@atlaskit/primitives';
+type PlatformTextProps = React.ComponentProps<typeof PlatformText>;
+export type TextProps = Pick<PlatformTextProps, 'align' | 'as' | 'color' | 'maxLines' | 'size' | 'weight' | 'children' | 'testId'>;
+/**
+ * Primitives are token-backed low-level building blocks.
+ */
+export type TText<T> = (props: TextProps) => T;
+export {};

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

@@ -59,3 +59,7 @@ export type { TooltipProps } from './TooltipProps.codegen';
 export type { ValidMessageProps } from './ValidMessageProps.codegen';
 export type { PopupProps } from './PopupProps.codegen';
 export type { AdfRendererProps, TAdfRenderer } from './AdfRendererProps.codegen';
+import type { TextProps as OriginalTextProps } from './TextProps.codegen';
+export type TextProps = Omit<OriginalTextProps, 'as'> & {
+    as?: OriginalTextProps['as'] | 'strike';
+};

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, TextAreaProps, TextfieldProps, ToggleProps, TooltipProps, TimePickerProps, ValidMessageProps, PopupProps, InlineEditProps, TBadge, TBox, TAdfRenderer, } from './components/__generated__';
+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, TBox, TAdfRenderer, } from './components/__generated__';
 export type { BarChartProps, StackBarChartProps, HorizontalStackBarChartProps, HorizontalBarChartProps, LineChartProps, SingleValueChartProps, PieChartProps, } from './components/charts';
 export type { ChartColorTokens } from './types';

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

@@ -3,9 +3,9 @@
  *
  * Extract component prop types from UIKit 2 components - CodeProps
  *
- * @codegen <<SignedSource::1a39727c921b99c3519aa0020e967c21>>
+ * @codegen <<SignedSource::e0386444a3c82762fe87b25289122301>>
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/code/__generated__/code.partial.tsx <<SignedSource::370e450903cb8f21b11acac7a9fc720b>>
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/code/__generated__/code.partial.tsx <<SignedSource::a54209d8f81fb1e2f354f4563725efeb>>
  */
 import React from 'react';
 import { Code as PlatformCode } from '@atlaskit/code';

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

@@ -3,16 +3,16 @@
  *
  * Extract component prop types from UIKit 2 components - HeadingProps
  *
- * @codegen <<SignedSource::f5b58f64c5c8cfbaff45b7d288ec4ffd>>
+ * @codegen <<SignedSource::b8bb5780d2b0112f8f2a4c7190d63fc7>>
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/heading/__generated__/index.partial.tsx <<SignedSource::b9f5a7af9c404be1b3bf1e55075715fc>>
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/heading/__generated__/index.partial.tsx <<SignedSource::96b99b296364dce930bb91174b226eaa>>
  */
 import type { HeadingProps as PlatformHeadingProps } from '@atlaskit/heading';
-type HeadingTags = 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6';
+type Sizes = 'xxlarge' | 'xlarge' | 'large' | 'medium' | 'small' | 'xsmall' | 'xxsmall';
 type TemporaryColors = 'default' | 'inverse';
 type NewColors = 'color.text' | 'color.text.inverse' | 'color.text.warning.inverse';
-export type HeadingProps = Pick<PlatformHeadingProps, 'children' | 'id' | 'testId'> & {
-    as: HeadingTags;
+export type HeadingProps = Pick<PlatformHeadingProps, 'children' | 'id' | 'testId' | 'as'> & {
+    size?: Sizes;
     color?: NewColors | TemporaryColors;
 };
 /**

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

@@ -3,9 +3,9 @@
  *
  * Extract component prop types from UIKit 2 components - LozengeProps
  *
- * @codegen <<SignedSource::010c29755ec75417d1649af3008801cd>>
+ * @codegen <<SignedSource::3d662c95d84fa4bb1441b1edbac2c302>>
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/lozenge/__generated__/index.partial.tsx <<SignedSource::20810ed29278b94c2bf310c8d80efdf8>>
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/lozenge/__generated__/index.partial.tsx <<SignedSource::e362dbb308b0f7785d47bb5e9aa46ab0>>
  */
 import React from 'react';
 import PlatformLozenge from '@atlaskit/lozenge';

package/dist/types-ts4.5/components/__generated__/TextProps.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 - TextProps
+ *
+ * @codegen <<SignedSource::31d160b53a47008ce61df934652b99c0>>
+ * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/text/__generated__/index.partial.tsx <<SignedSource::813a1a6f22d33e27a5651da301ca7ab1>>
+ */
+import React from 'react';
+import { Text as PlatformText } from '@atlaskit/primitives';
+type PlatformTextProps = React.ComponentProps<typeof PlatformText>;
+export type TextProps = Pick<PlatformTextProps, 'align' | 'as' | 'color' | 'maxLines' | 'size' | 'weight' | 'children' | 'testId'>;
+/**
+ * Primitives are token-backed low-level building blocks.
+ */
+export type TText<T> = (props: TextProps) => T;
+export {};

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

@@ -59,3 +59,7 @@ export type { TooltipProps } from './TooltipProps.codegen';
 export type { ValidMessageProps } from './ValidMessageProps.codegen';
 export type { PopupProps } from './PopupProps.codegen';
 export type { AdfRendererProps, TAdfRenderer } from './AdfRendererProps.codegen';
+import type { TextProps as OriginalTextProps } from './TextProps.codegen';
+export type TextProps = Omit<OriginalTextProps, 'as'> & {
+    as?: OriginalTextProps['as'] | 'strike';
+};

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, TextAreaProps, TextfieldProps, ToggleProps, TooltipProps, TimePickerProps, ValidMessageProps, PopupProps, InlineEditProps, TBadge, TBox, TAdfRenderer, } from './components/__generated__';
+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, TBox, TAdfRenderer, } from './components/__generated__';
 export type { BarChartProps, StackBarChartProps, HorizontalStackBarChartProps, HorizontalBarChartProps, LineChartProps, SingleValueChartProps, PieChartProps, } from './components/charts';
 export type { ChartColorTokens } from './types';

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/forge-react-types",
-	"version": "0.36.0",
+	"version": "0.37.0",
 	"description": "Component types for Forge UI Kit React components",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -25,7 +25,7 @@
 	},
 	"dependencies": {
 		"@atlaskit/badge": "^18.0.0",
-		"@atlaskit/button": "^21.0.0",
+		"@atlaskit/button": "^21.1.0",
 		"@atlaskit/calendar": "^17.0.0",
 		"@atlaskit/checkbox": "^16.0.0",
 		"@atlaskit/code": "^16.0.0",
@@ -53,7 +53,7 @@
 		"@atlaskit/textarea": "^8.0.0",
 		"@atlaskit/textfield": "^8.0.0",
 		"@atlaskit/toggle": "^15.0.0",
-		"@atlaskit/tokens": "^4.0.0",
+		"@atlaskit/tokens": "^4.1.0",
 		"@atlaskit/tooltip": "^20.0.0",
 		"@babel/runtime": "^7.0.0"
 	},

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

@@ -3,9 +3,9 @@
  *
  * Extract component prop types from UIKit 2 components - CodeProps
  *
- * @codegen <<SignedSource::1a39727c921b99c3519aa0020e967c21>>
+ * @codegen <<SignedSource::e0386444a3c82762fe87b25289122301>>
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/code/__generated__/code.partial.tsx <<SignedSource::370e450903cb8f21b11acac7a9fc720b>>
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/code/__generated__/code.partial.tsx <<SignedSource::a54209d8f81fb1e2f354f4563725efeb>>
  */
 /* eslint @repo/internal/codegen/signed-source-integrity: "warn" */
 

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

@@ -3,20 +3,20 @@
  *
  * Extract component prop types from UIKit 2 components - HeadingProps
  *
- * @codegen <<SignedSource::f5b58f64c5c8cfbaff45b7d288ec4ffd>>
+ * @codegen <<SignedSource::b8bb5780d2b0112f8f2a4c7190d63fc7>>
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/heading/__generated__/index.partial.tsx <<SignedSource::b9f5a7af9c404be1b3bf1e55075715fc>>
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/heading/__generated__/index.partial.tsx <<SignedSource::96b99b296364dce930bb91174b226eaa>>
  */
 /* eslint @repo/internal/codegen/signed-source-integrity: "warn" */
 
 import type { HeadingProps as PlatformHeadingProps } from '@atlaskit/heading';
 
-type HeadingTags = 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6';
+type Sizes = 'xxlarge' | 'xlarge' | 'large' | 'medium' | 'small' | 'xsmall' | 'xxsmall';
 type TemporaryColors = 'default' | 'inverse';
 type NewColors = 'color.text' | 'color.text.inverse' | 'color.text.warning.inverse';
 
-export type HeadingProps = Pick<PlatformHeadingProps, 'children' | 'id' | 'testId'> & {
-	as: HeadingTags;
+export type HeadingProps = Pick<PlatformHeadingProps, 'children' | 'id' | 'testId' | 'as'> & {
+	size?: Sizes;
 	color?: NewColors | TemporaryColors;
 };
 

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

@@ -3,9 +3,9 @@
  *
  * Extract component prop types from UIKit 2 components - LozengeProps
  *
- * @codegen <<SignedSource::010c29755ec75417d1649af3008801cd>>
+ * @codegen <<SignedSource::3d662c95d84fa4bb1441b1edbac2c302>>
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/lozenge/__generated__/index.partial.tsx <<SignedSource::20810ed29278b94c2bf310c8d80efdf8>>
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/lozenge/__generated__/index.partial.tsx <<SignedSource::e362dbb308b0f7785d47bb5e9aa46ab0>>
  */
 /* eslint @repo/internal/codegen/signed-source-integrity: "warn" */
 

package/src/components/__generated__/TextProps.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 - TextProps
+ *
+ * @codegen <<SignedSource::31d160b53a47008ce61df934652b99c0>>
+ * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/text/__generated__/index.partial.tsx <<SignedSource::813a1a6f22d33e27a5651da301ca7ab1>>
+ */
+/* eslint @repo/internal/codegen/signed-source-integrity: "warn" */
+
+import React from 'react';
+import { Text as PlatformText } from '@atlaskit/primitives';
+
+type PlatformTextProps = React.ComponentProps<typeof PlatformText>;
+
+export type TextProps = Pick<
+  PlatformTextProps,
+  'align' | 'as' | 'color' | 'maxLines' | 'size' | 'weight' | 'children' | 'testId'
+>;
+
+/**
+ * Primitives are token-backed low-level building blocks.
+ */
+export type TText<T> = (props: TextProps) => T;

package/src/components/__generated__/index.ts

@@ -59,3 +59,8 @@ export type { TooltipProps } from './TooltipProps.codegen';
 export type { ValidMessageProps } from './ValidMessageProps.codegen';
 export type { PopupProps } from './PopupProps.codegen';
 export type { AdfRendererProps, TAdfRenderer } from './AdfRendererProps.codegen';
+
+// Forge UI supports the value "strike" for the "as" prop of the Text component, to have a migration path
+// off using <Strike>. The native ADS Text component does not support it, so we patched it to support it.
+import type { TextProps as OriginalTextProps } from './TextProps.codegen'
+export type TextProps = Omit<OriginalTextProps, 'as'> & { as?: OriginalTextProps['as'] | 'strike' };

package/src/index.ts

@@ -52,6 +52,7 @@ export type {
 	TabsProps,
 	TagGroupProps,
 	TagProps,
+	TextProps,
 	TextAreaProps,
 	TextfieldProps,
 	ToggleProps,