npm package diff
Package: @forge/react
Versions: 11.1.0 - 11.2.0-next.0
File: package/out/components/ui-kit-components.d.ts
Index: package/out/components/ui-kit-components.d.ts
===================================================================
--- package/out/components/ui-kit-components.d.ts
+++ package/out/components/ui-kit-components.d.ts
@@ -1,14 +1,18 @@
/// <reference types="react" />
import { ForgeElement } from '../types/index';
-import type { TBadge, TBarChart, TBox, TButton, TButtonGroup, TCalendar, TCheckbox, TCode, TCodeBlock, TDatePicker, TErrorMessage, THeading, THelperMessage, THorizontalBarChart, THorizontalStackBarChart, TInline, TLabel, TList, TListItem, TLozenge, TLineChart, TLinkButton, TModal, TModalHeader, TModalBody, TModalFooter, TModalTitle, TModalTransition, TPieChart, TProgressBar, TProgressTracker, TRadio, TRadioGroup, TRange, TSectionMessage, TSectionMessageAction, TSingleValueChart, TSpinner, TStack, TStackBarChart, TTabs, TTab, TTabList, TTabPanel, TTag, TTagGroup, TTimePicker, TForm, TFormHeader, TFormFooter, TFormSection, TTooltip, TTextArea, TTextfield, TText, TToggle, TValidMessage, TLoadingButton, TSelect, TIcon, TEmptyState } from '@atlaskit/forge-react-types';
+import type { TBadge, TBarChart, TBox, TButton, TButtonGroup, TCalendar, TCheckbox, TCode, TCodeBlock, TDatePicker, TDonutChart, TErrorMessage, THeading, THelperMessage, THorizontalBarChart, THorizontalStackBarChart, TInline, TLabel, TList, TListItem, TLozenge, TLineChart, TLinkButton, TModal, TModalHeader, TModalBody, TModalFooter, TModalTitle, TModalTransition, TPieChart, TProgressBar, TProgressTracker, TRadio, TRadioGroup, TRange, TSectionMessage, TSectionMessageAction, TSpinner, TStack, TStackBarChart, TTabs, TTab, TTabList, TTabPanel, TTag, TTagGroup, TTimePicker, TForm, TFormHeader, TFormFooter, TFormSection, TTooltip, TTextArea, TTextfield, TText, TToggle, TValidMessage, TLoadingButton, TSelect, TIcon, TEmptyState } from '@atlaskit/forge-react-types';
/**
* A badge is a visual indicator for numeric values such as tallies and scores.
*
* @see [Badge](https://developer.atlassian.com/platform/forge/ui-kit/components/badge/) in UI Kit documentation for more information
*/
export declare const Badge: TBadge<ForgeElement<Record<string, any>>>;
-/** A visual representation of data using rectangular bars of varying heights to compare different categories or values. */
+/**
+ * A visual representation of data using rectangular bars of varying heights to compare different categories or values.
+ *
+ * @see [BarChart](https://developer.atlassian.com/platform/forge/ui-kit/components/bar-chart/) in UI Kit documentation for more information
+ */
export declare const BarChart: TBarChart<ForgeElement<Record<string, any>>>;
/**
* A box is a generic container that provides managed access to design tokens.
*
@@ -57,8 +61,14 @@
* @see [DatePicker](https://developer.atlassian.com/platform/forge/ui-kit/components/date-picker/) in UI Kit documentation for more information
*/
export declare const DatePicker: TDatePicker<ForgeElement<Record<string, any>>>;
/**
+ * A visual representation of data proportions in a donut format.
+ *
+ * @see [DonutChart](https://developer.atlassian.com/platform/forge/ui-kit/components/donut-chart/) in UI Kit documentation for more information
+ */
+export declare const DonutChart: TDonutChart<ForgeElement<Record<string, any>>>;
+/**
* An empty state appears when there is no data to display and describes what the user can do next.
*
* @see [EmptyState](https://developer.atlassian.com/platform/forge/ui-kit/components/empty-state/) in UI Kit documentation for more information
*/
@@ -111,11 +121,19 @@
*
* @see [HelperMessage](https://developer.atlassian.com/platform/forge/ui-kit/components/form/#helper-message) in UI Kit documentation for more information
*/
export declare const HelperMessage: THelperMessage<ForgeElement<Record<string, any>>>;
-/** A visual representation of data using horizontal rectangular bars of varying lengths to compare different categories or values. */
+/**
+ * A visual representation of data using horizontal rectangular bars of varying lengths to compare different categories or values.
+ *
+ * @see [HorizontalBarChart](https://developer.atlassian.com/platform/forge/ui-kit/components/horizontal-bar-chart/) in UI Kit documentation for more information
+ */
export declare const HorizontalBarChart: THorizontalBarChart<ForgeElement<Record<string, any>>>;
-/** A visual representation of data using horizontal rectangular bars of varying lengths to demonstrate comparisons between categories of data. */
+/**
+ * A visual representation of data using horizontal rectangular bars of varying lengths to demonstrate comparisons between categories of data.
+ *
+ * @see [HorizontalStackBarChart](https://developer.atlassian.com/platform/forge/ui-kit/components/horizontal-stack-bar-chart/) in UI Kit documentation for more information
+ */
export declare const HorizontalStackBarChart: THorizontalStackBarChart<ForgeElement<Record<string, any>>>;
/**
* An icon is a visual representation of a command, device, directory, or common action.
*
@@ -133,9 +151,13 @@
*
* @see [Label](https://developer.atlassian.com/platform/forge/ui-kit/components/form/#label) in UI Kit documentation for more information
*/
export declare const Label: TLabel<ForgeElement<Record<string, any>>>;
-/** A visual representation of data showing trends. */
+/**
+ * A visual representation of data showing trends.
+ *
+ * @see [LineChart](https://developer.atlassian.com/platform/forge/ui-kit/components/line-chart/) in UI Kit documentation for more information
+ */
export declare const LineChart: TLineChart<ForgeElement<Record<string, any>>>;
/**
* Renders a link in the style of a button.
*
@@ -197,9 +219,13 @@
*
* @see [ModalTransition](https://developer.atlassian.com/platform/forge/ui-kit/components/modal/#modal-transition) in UI Kit documentation for more information
*/
export declare const ModalTransition: TModalTransition<ForgeElement<Record<string, any>>>;
-/** A visual representation of data proportions in a circular format. */
+/**
+ * A visual representation of data proportions in a circular format.
+ *
+ * @see [PieChart](https://developer.atlassian.com/platform/forge/ui-kit/components/pie-chart/) in UI Kit documentation for more information
+ */
export declare const PieChart: TPieChart<ForgeElement<Record<string, any>>>;
/**
* A progress bar communicates the status of a system process.
*
@@ -248,13 +274,8 @@
* @see [SectionMessageAction](https://developer.atlassian.com/platform/forge/ui-kit/components/section-message/#section-message-action) in UI Kit documentation for more information
*/
export declare const SectionMessageAction: TSectionMessageAction<ForgeElement<Record<string, any>>>;
/**
- * A visualization representation of information with a single value as its metrics.
- * The metric can be displayed with a increase/decrease indicator to display trends or changes over time.
- */
-export declare const SingleValueChart: TSingleValueChart<ForgeElement<Record<string, any>>>;
-/**
* A spinner is an animated spinning icon that lets users know content is being loaded.
*
* @see [Spinner](https://developer.atlassian.com/platform/forge/ui-kit/components/spinner/) in UI Kit documentation for more information
*/
@@ -264,9 +285,13 @@
*
* @see [Stack](https://developer.atlassian.com/platform/forge/ui-kit/components/stack/) in UI Kit documentation for more information
*/
export declare const Stack: TStack<ForgeElement<Record<string, any>>>;
-/** A visual representation of data using rectangular bars of varying heights to demonstrate comparisons between categories of data. */
+/**
+ * A visual representation of data using rectangular bars of varying heights to demonstrate comparisons between categories of data.
+ *
+ * @see [StackBarChart](https://developer.atlassian.com/platform/forge/ui-kit/components/stack-bar-chart/) in UI Kit documentation for more information
+ */
export declare const StackBarChart: TStackBarChart<ForgeElement<Record<string, any>>>;
/**
* `Tab` represents an individual tab displayed in a TabList.
*