@atlaskit/forge-react-types 0.42.8 → 0.42.9

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

@@ -3,13 +3,13 @@
  *
  * Extract component prop types from UIKit 2 components - BadgeProps
  *
- * @codegen <<SignedSource::70958e2a60c7a0e1b3443db2d24003cc>>
+ * @codegen <<SignedSource::e4726fc9fc56127107db590dd21ef3f6>>
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/badge/__generated__/index.partial.tsx <<SignedSource::89ad3341c1b8ef4b6fc93df162ac91d3>>
  */
 /* eslint @repo/internal/codegen/signed-source-integrity: "warn" */
 
-import React from 'react';
+import type React from 'react';
 
 export type PlatformBadgeProps = Omit<_PlatformBadgeProps, 'children'> & {
 /**
@@ -26,11 +26,7 @@ type _PlatformBadgeProps = {
 	 * Affects the visual style of the badge.
 	 */
 	appearance?: 'added' | 'default' | 'important' | 'primary' | 'primaryInverted' | 'removed';
-  /**
- * The value displayed within the badge. A badge should only be used in cases where you want to represent a number. Use a lozenge for non-numeric information.
- * 
- * @type string | number
- */
+  
 	children?: React.ReactNode;
   /**
 	 * The maximum value to display. Defaults to `99`. If the value is 100, and max is 50, "50+" will be displayed.

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

@@ -3,16 +3,131 @@
  *
  * Extract component prop types from UIKit 2 components - CalendarProps
  *
- * @codegen <<SignedSource::497faee84f851775b401af97ebfc5c12>>
+ * @codegen <<SignedSource::65f2be98c591eb5479ed6a1c399394b2>>
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/calendar/__generated__/index.partial.tsx <<SignedSource::3fb4c1249481ec420be5118220ebcd82>>
  */
 /* eslint @repo/internal/codegen/signed-source-integrity: "warn" */
 
-import React from 'react';
-import PlatformCalendar from '@atlaskit/calendar';
+import type React from 'react';
 
-type PlatformCalendarProps = React.ComponentProps<typeof PlatformCalendar>;
+
+// Serialized type
+type PlatformCalendarProps = {
+  /**
+	 * The number of the day currently focused. Places border around the date. Enter `0` to highlight no date.
+	 */
+	day?: number;
+  /**
+	 * Sets the default value for `day`.
+	 */
+	defaultDay?: number;
+  /**
+	 * Sets the default value for `month`.
+	 */
+	defaultMonth?: number;
+  /**
+	 * Sets the default value for `previouslySelected`.
+	 */
+	defaultPreviouslySelected?: string[];
+  /**
+	 * Sets the default value for `selected`.
+	 */
+	defaultSelected?: string[];
+  /**
+	 * Sets the default value for `year`.
+	 */
+	defaultYear?: number;
+  /**
+	 * Takes an array of dates as string in the format 'YYYY-MM-DD'. All dates provided are greyed out and not selectable.
+	 */
+	disabled?: string[];
+  /**
+	 * The latest enabled date. All dates in the future after this date will be disabled.
+	 */
+	maxDate?: string;
+  /**
+	 * The earliest enabled date. All dates in the past before this date will be disabled.
+	 */
+	minDate?: string;
+  /**
+	 * The aria-label attribute associated with the next month arrow, to describe it to assistive technology.
+	 */
+	nextMonthLabel?: string;
+  /**
+	 * Function which is called when the calendar is no longer focused.
+	 */
+	onBlur?: React.FocusEventHandler<Element>;
+  /**
+	 * Called when the calendar is navigated. This can be triggered by the keyboard, or by clicking the navigational buttons.
+	 * The 'interface' property indicates the the direction the calendar was navigated whereas the 'iso' property is a string of the format YYYY-MM-DD.
+	 */
+	onChange?: (event: { iso: string, type: 'left' | 'up' | 'right' | 'down' | 'prevMonth' | 'prevYear' | 'nextMonth' | 'nextYear', day: number, month: number, year: number }, analyticsEvent: any) => void;
+  /**
+	 * Called when the calendar receives focus. This could be called from a mouse event on the container, or by tabbing into it.
+	 */
+	onFocus?: React.FocusEventHandler<Element>;
+  /**
+	 * Function called when a day is clicked on. Calls with an object that has
+	 * a day, month and year property as numbers, representing the date just clicked.
+	 * It also has an 'iso' property, which is a string of the selected date in the
+	 * format YYYY-MM-DD.
+	 */
+	onSelect?: (event: { iso: string, day: number, month: number, year: number }, analyticsEvent: any) => void;
+  /**
+	 * Takes an array of dates as string in the format 'YYYY-MM-DD'. All dates
+	 * provided are given a background color.
+	 */
+	previouslySelected?: string[];
+  /**
+	 * The aria-label attribute associated with the previous month arrow, to describe it to assistive technology.
+	 */
+	previousMonthLabel?: string;
+  /**
+	 * Takes an array of dates as string in the format 'YYYY-MM-DD'. All dates
+	 * provided are given a background color.
+	 */
+	selected?: string[];
+  /**
+	 * Value of current day, as a string in the format 'YYYY-MM-DD'.
+	 */
+	today?: string;
+  /**
+	 * Year to display the calendar for.
+	 */
+	year?: number;
+  /**
+	 * BCP 47 language tag (e.g. `ja-JP`) that ensures dates are in the official format for the locale.
+	 */
+	locale?: string;
+  /**
+	 * Start day of the week for the calendar. The mapping between numbers and days of the week is as follows:
+	 * - `0` Sunday (default value)
+	 * - `1` Monday
+	 * - `2` Tuesday
+	 * - `3` Wednesday
+	 * - `4` Thursday
+	 * - `5` Friday
+	 * - `6` Saturday
+	 */
+	weekStartDay?: 0 | 1 | 2 | 3 | 4 | 5 | 6;
+  /**
+	 * A `testId` prop is provided for specified elements, which is a unique string that appears as a data attribute `data-testid` in the rendered code, serving as a hook for automated tests
+	 *
+	 * - testId--container - Outermost container containing everything inside calendar
+	 * - testId--month - Container containing all available days for the month
+	 * - testId--previous-month - Button to show next month
+	 * - testId--next-month - Button to show previous month
+	 * - testId--current-month-year - Text containing the current month and year
+	 * - testId--selected-day - The currently selected day (may be missing if a date isn’t selected)
+	 */
+	testId?: string;
+  /**
+	 * Indicates if the calendar can be focused by keyboard or only
+	 * programmatically. Defaults to "0".
+	 */
+	tabIndex?: 0 | -1;
+};
 
 export type CalendarProps = Pick<
   PlatformCalendarProps,

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

@@ -3,13 +3,13 @@
  *
  * Extract component prop types from UIKit 2 components - CodeProps
  *
- * @codegen <<SignedSource::e915d32433441373892842df5cce597e>>
+ * @codegen <<SignedSource::43cc01ed86828245cbe59920bda9cd4a>>
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
  * @codegenDependency ../../../../forge-ui/src/components/UIKit/code/__generated__/code.partial.tsx <<SignedSource::6f210b052488fe7ece12d865706a551e>>
  */
 /* eslint @repo/internal/codegen/signed-source-integrity: "warn" */
 
-import React from 'react';
+import type React from 'react';
 
 
 // Serialized type

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

@@ -3,16 +3,44 @@
  *
  * Extract component prop types from UIKit 2 components - HeadingProps
  *
- * @codegen <<SignedSource::0edc0326125b06e6a1280e81282d048d>>
+ * @codegen <<SignedSource::8ab3b3f5dd85c2eff37cf908d6e693ba>>
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/heading/__generated__/index.partial.tsx <<SignedSource::c7fa27d57c7e5695728bcfa2ffa634f9>>
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/heading/__generated__/index.partial.tsx <<SignedSource::b40904da638774634ed529b90c13d99d>>
  */
 /* eslint @repo/internal/codegen/signed-source-integrity: "warn" */
 
-import type { HeadingProps as PlatformHeadingProps } from '@atlaskit/heading';
+import type React from 'react';
 
 type Sizes = 'xxlarge' | 'xlarge' | 'large' | 'medium' | 'small' | 'xsmall' | 'xxsmall';
 
+// Serialized type
+type PlatformHeadingProps = {
+  /**
+	 * Allows the component to be rendered as the specified DOM element, overriding a default element set by `level` prop.
+	 */
+	as?: 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'div' | 'span';
+  /**
+	 * Token representing text color with a built-in fallback value.
+	 * Will apply inverse text color automatically if placed within a Box with bold background color.
+	 * Defaults to `color.text`.
+	 */
+	color?: 'color.text' | 'color.text.inverse' | 'color.text.warning.inverse';
+  /**
+	 * The text of the heading.
+	 */
+	children: React.ReactNode;
+  /**
+	 * Unique identifier for the heading DOM element.
+	 */
+	id?: string;
+  /**
+	 * A `testId` prop is provided for specified elements, which is a unique
+	 * string that appears as a data attribute `data-testid` in the rendered code,
+	 * serving as a hook for automated tests.
+	 */
+	testId?: string;
+};
+
 export type HeadingProps = Pick<
 	PlatformHeadingProps,
 	'children' | 'id' | 'testId' | 'as' | 'color'

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

@@ -3,17 +3,66 @@
  *
  * Extract component prop types from UIKit 2 components - RangeProps
  *
- * @codegen <<SignedSource::8059d330e7cc4a21c671966f6c2496cc>>
+ * @codegen <<SignedSource::630c202e2564f5bfeac2d313285aad09>>
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/range/__generated__/index.partial.tsx <<SignedSource::66f3c55587192848bc42f9fc146e6c7e>>
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/range/__generated__/index.partial.tsx <<SignedSource::d9ea91886a193f2c5119bc1ed1b50c71>>
  */
 /* eslint @repo/internal/codegen/signed-source-integrity: "warn" */
 
-import React from 'react';
-import PlatformRange from '@atlaskit/range';
 import type { EventHandlerProps } from './types.codegen';
 
-type PlatformRangeProps = React.ComponentProps<typeof PlatformRange>;
+
+// Serialized type
+type PlatformRangeProps = {
+  /**
+	 * Sets the maximum value of the range.
+	 */
+	max?: number;
+  /**
+	 * Sets the minimum value of the range.
+	 */
+	min?: number;
+  
+	name?: string;
+  /**
+	 * Sets the step value for the range.
+	 */
+	step?: number;
+  /**
+	 * Sets the value of the range.
+	 */
+	value?: number;
+  /**
+	 * Hook to be invoked on change of the range.
+	 */
+	onChange?: (value: number) => void;
+  /**
+	 * Sets the default value if range is not set.
+	 */
+	defaultValue?: number;
+  
+	id?: string;
+  /**
+         * Indicates the entered value does not conform to the format expected by the application.
+         * @see aria-errormessage.
+         */
+	"aria-invalid"?: false | true | 'false' | 'true' | 'grammar' | 'spelling';
+  /**
+         * Identifies the element (or elements) that labels the current element.
+         * @see aria-describedby.
+         */
+	"aria-labelledby"?: string;
+  /**
+	 * Sets whether the field range is disabled.
+	 */
+	isDisabled?: boolean;
+  /**
+	 * A `testId` prop is provided for specific elements. This is a unique string
+	 * that appears as a data attribute `data-testid` in the rendered code and
+	 * serves as a hook for automated tests.
+	 */
+	testId?: string;
+};
 
 export type RangeProps = Pick<
   PlatformRangeProps,

package/src/components/__generated__/index.ts

@@ -1,5 +1,4 @@
 export type { BadgeProps, TBadge } from './BadgeProps.codegen';
-export type { BleedProps, TBleed } from './BleedProps.codegen';
 export type { BoxProps, TBox } from './BoxProps.codegen';
 export type { ButtonGroupProps, TButtonGroup } from './ButtonGroupProps.codegen';
 export type { ButtonProps, TButton } from './ButtonProps.codegen';
@@ -79,4 +78,4 @@ export type TText<T> = (props: TextProps) => T;
 
 export type { CommentEditorProps, TCommentEditor } from './CommentEditorProps.codegen';
 export type { ChromelessEditorProps, TChromelessEditor } from './ChromelessEditorProps.codegen';
-export type { PressableProps, TPressable } from './PressableProps.codegen';
+export type { PressableProps, TPressable } from './PressableProps.codegen';

package/src/index.ts

@@ -1,7 +1,6 @@
 export type {
 	AdfRendererProps,
 	BadgeProps,
-	BleedProps,
 	BoxProps,
 	ButtonGroupProps,
 	ButtonProps,
@@ -66,7 +65,6 @@ export type {
 	CommentEditorProps,
 	PressableProps,
 	TBadge,
-	TBleed,
 	TBox,
 	TButtonGroup,
 	TButton,

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

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

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

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

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

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

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

@@ -1,15 +0,0 @@
-/**
- * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
- *
- * Extract component prop types from UIKit 2 components - BleedProps
- *
- * @codegen <<SignedSource::cc28f1caa57c117f8db064f643bfe56d>>
- * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/bleed/__generated__/index.partial.tsx <<SignedSource::406ffef6715a3dff3aa10511e2ec232c>>
- */
-import React from 'react';
-import { Bleed as PlatformBleed } from '@atlaskit/primitives';
-type PlatformBleedProps = React.ComponentProps<typeof PlatformBleed>;
-export type BleedProps = Pick<PlatformBleedProps, 'children' | 'all' | 'inline' | 'block' | 'testId' | 'role'>;
-export type TBleed<T> = (props: BleedProps) => T;
-export {};

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

@@ -1,15 +0,0 @@
-/**
- * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
- *
- * Extract component prop types from UIKit 2 components - BleedProps
- *
- * @codegen <<SignedSource::cc28f1caa57c117f8db064f643bfe56d>>
- * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/bleed/__generated__/index.partial.tsx <<SignedSource::406ffef6715a3dff3aa10511e2ec232c>>
- */
-import React from 'react';
-import { Bleed as PlatformBleed } from '@atlaskit/primitives';
-type PlatformBleedProps = React.ComponentProps<typeof PlatformBleed>;
-export type BleedProps = Pick<PlatformBleedProps, 'children' | 'all' | 'inline' | 'block' | 'testId' | 'role'>;
-export type TBleed<T> = (props: BleedProps) => T;
-export {};

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

@@ -1,22 +0,0 @@
-/**
- * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
- *
- * Extract component prop types from UIKit 2 components - BleedProps
- *
- * @codegen <<SignedSource::cc28f1caa57c117f8db064f643bfe56d>>
- * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/bleed/__generated__/index.partial.tsx <<SignedSource::406ffef6715a3dff3aa10511e2ec232c>>
- */
-/* eslint @repo/internal/codegen/signed-source-integrity: "warn" */
-
-import React from 'react';
-import { Bleed as PlatformBleed } from '@atlaskit/primitives';
-
-type PlatformBleedProps = React.ComponentProps<typeof PlatformBleed>;
-
-export type BleedProps = Pick<
-  PlatformBleedProps,
-  'children' | 'all' | 'inline' | 'block' | 'testId' | 'role'
->;
-
-export type TBleed<T> = (props: BleedProps) => T;