@atlaskit/forge-react-types 0.38.0 → 0.39.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (38) hide show
  1. package/CHANGELOG.md +19 -0
  2. package/dist/cjs/components/charts/BarChartProps.js +1 -5
  3. package/dist/cjs/components/charts/DonutChartProps.js +5 -0
  4. package/dist/cjs/components/charts/LineChartProps.js +1 -5
  5. package/dist/cjs/components/charts/PieChartProps.js +1 -5
  6. package/dist/es2019/components/charts/BarChartProps.js +0 -1
  7. package/dist/es2019/components/charts/DonutChartProps.js +1 -0
  8. package/dist/es2019/components/charts/LineChartProps.js +0 -1
  9. package/dist/es2019/components/charts/PieChartProps.js +0 -1
  10. package/dist/esm/components/charts/BarChartProps.js +0 -1
  11. package/dist/esm/components/charts/DonutChartProps.js +1 -0
  12. package/dist/esm/components/charts/LineChartProps.js +0 -1
  13. package/dist/esm/components/charts/PieChartProps.js +0 -1
  14. package/dist/types/components/charts/BarChartProps.d.ts +0 -10
  15. package/dist/types/components/charts/DonutChartProps.d.ts +15 -0
  16. package/dist/types/components/charts/LineChartProps.d.ts +0 -7
  17. package/dist/types/components/charts/PieChartProps.d.ts +0 -14
  18. package/dist/types/components/charts/index.d.ts +1 -1
  19. package/dist/types/index.d.ts +1 -1
  20. package/dist/types-ts4.5/components/charts/BarChartProps.d.ts +0 -10
  21. package/dist/types-ts4.5/components/charts/DonutChartProps.d.ts +15 -0
  22. package/dist/types-ts4.5/components/charts/LineChartProps.d.ts +0 -7
  23. package/dist/types-ts4.5/components/charts/PieChartProps.d.ts +0 -14
  24. package/dist/types-ts4.5/components/charts/index.d.ts +1 -1
  25. package/dist/types-ts4.5/index.d.ts +1 -1
  26. package/package.json +3 -3
  27. package/src/components/charts/BarChartProps.tsx +0 -11
  28. package/src/components/charts/DonutChartProps.tsx +17 -0
  29. package/src/components/charts/LineChartProps.tsx +0 -8
  30. package/src/components/charts/PieChartProps.tsx +0 -15
  31. package/src/components/charts/index.ts +1 -1
  32. package/src/index.ts +2 -2
  33. package/dist/cjs/components/charts/SingleValueChartProps.js +0 -1
  34. package/dist/es2019/components/charts/SingleValueChartProps.js +0 -0
  35. package/dist/esm/components/charts/SingleValueChartProps.js +0 -0
  36. package/dist/types/components/charts/SingleValueChartProps.d.ts +0 -33
  37. package/dist/types-ts4.5/components/charts/SingleValueChartProps.d.ts +0 -33
  38. package/src/components/charts/SingleValueChartProps.tsx +0 -34
package/CHANGELOG.md CHANGED
@@ -1,5 +1,24 @@
1
1
  # @atlaskit/forge-react-types
2
2
 
3
+ ## 0.39.1
4
+
5
+ ### Patch Changes
6
+
7
+ - Updated dependencies
8
+
9
+ ## 0.39.0
10
+
11
+ ### Minor Changes
12
+
13
+ - [#130095](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/130095)
14
+ [`5cbce3c0a85b2`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/5cbce3c0a85b2) -
15
+ Update props for chart components to remove showBorder and colors props. Add prop types for
16
+ DonutChart component
17
+
18
+ ### Patch Changes
19
+
20
+ - Updated dependencies
21
+
3
22
  ## 0.38.0
4
23
 
5
24
  ### Minor Changes
@@ -1,5 +1 @@
1
- "use strict";
2
-
3
- Object.defineProperty(exports, "__esModule", {
4
- value: true
5
- });
1
+ "use strict";
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
@@ -1,5 +1 @@
1
- "use strict";
2
-
3
- Object.defineProperty(exports, "__esModule", {
4
- value: true
5
- });
1
+ "use strict";
@@ -1,5 +1 @@
1
- "use strict";
2
-
3
- Object.defineProperty(exports, "__esModule", {
4
- value: true
5
- });
1
+ "use strict";
@@ -1 +0,0 @@
1
- export {};
@@ -0,0 +1 @@
1
+ export {};
@@ -1 +0,0 @@
1
- export {};
@@ -1 +0,0 @@
1
- export {};
@@ -1 +0,0 @@
1
- export {};
@@ -0,0 +1 @@
1
+ export {};
@@ -1 +0,0 @@
1
- export {};
@@ -1 +0,0 @@
1
- export {};
@@ -1,4 +1,3 @@
1
- import type { ChartColorTokens } from '../../types';
2
1
  export type BarChartProps = {
3
2
  /**
4
3
  * The static width of the chart in pixels. If this is not specified, the width is responsive.
@@ -14,10 +13,6 @@ export type BarChartProps = {
14
13
  * 2. An [array of objects](https://developer.atlassian.com/platform/forge/ui-kit/components/bar-chart/#2--array-of-objects).
15
14
  */
16
15
  data: unknown[];
17
- /**
18
- * Boolean to display the chart border. Defaults to `false`.
19
- */
20
- showBorder?: boolean;
21
16
  /**
22
17
  * Accessor to define the x-axis values. This can be a numerical or string index.
23
18
  * For more information on all accessors, see [Data](https://developer.atlassian.com/platform/forge/ui-kit/components/bar-chart/#data).
@@ -39,11 +34,6 @@ export type BarChartProps = {
39
34
  * A string value that represents the subtitle of the chart. This appears below the title.
40
35
  */
41
36
  subtitle?: string;
42
- /**
43
- * An array of [chart color tokens](https://atlassian.design/components/tokens/all-tokens#color-chart).
44
- * This is utilized to render each bar with the specified colors, based on the color grouping given by colorAccessor.
45
- */
46
- colors?: ChartColorTokens[];
47
37
  };
48
38
  type StackChartProps = BarChartProps & {
49
39
  /**
@@ -0,0 +1,15 @@
1
+ import { type PieChartProps } from './PieChartProps';
2
+ export type DonutChartProps = PieChartProps & {
3
+ /**
4
+ * The radius of the inner circle of the donut chart in pixels. If this is not specified, the radius is responsive.
5
+ */
6
+ innerRadius?: number;
7
+ /**
8
+ * The radius of the outer circle of the donut chart in pixels. If this is not specified, the radius is responsive.
9
+ */
10
+ outerRadius?: number;
11
+ };
12
+ /**
13
+ * A visual representation of data proportions in a donut format.
14
+ */
15
+ export type TDonutChart<T> = (props: DonutChartProps) => T;
@@ -1,4 +1,3 @@
1
- import type { ChartColorTokens } from '../../types';
2
1
  export type LineChartProps = {
3
2
  /**
4
3
  * The static width of the chart in pixels. If this is not specified, the width is responsive.
@@ -14,7 +13,6 @@ export type LineChartProps = {
14
13
  * 2. An [array of objects](https://developer.atlassian.com/platform/forge/ui-kit/components/line-chart/#2--array-of-objects).
15
14
  */
16
15
  data: unknown[];
17
- showBorder?: boolean;
18
16
  /**
19
17
  * Accessor to define the x-axis values. This can be a numerical or string index.
20
18
  * For more information on all accessors, see [Data](https://developer.atlassian.com/platform/forge/ui-kit/components/line-chart/#data).
@@ -36,11 +34,6 @@ export type LineChartProps = {
36
34
  * A string value that represents the subtitle of the chart. This appears below the title.
37
35
  */
38
36
  subtitle?: string;
39
- /**
40
- * An array of [chart color tokens](https://atlassian.design/components/tokens/all-tokens#color-chart).
41
- * This is utilized to render each line with the specified colors, based on the color grouping given by colorAccessor.
42
- */
43
- colors?: ChartColorTokens[];
44
37
  };
45
38
  /**
46
39
  * A visual representation of data showing trends.
@@ -1,4 +1,3 @@
1
- import type { ChartColorTokens } from '../../types';
2
1
  export type PieChartProps = {
3
2
  /**
4
3
  * The static width of the chart in pixels. If this is not specified, the width is responsive.
@@ -14,10 +13,6 @@ export type PieChartProps = {
14
13
  * 2. [Array of objects](https://developer.atlassian.com/platform/forge/ui-kit/components/pie-chart/#2--array-of-objects).
15
14
  */
16
15
  data: unknown[];
17
- /**
18
- * Boolean to display the chart border. Defaults to `false`.
19
- */
20
- showBorder?: boolean;
21
16
  /**
22
17
  * Accessor to define the color grouping. This can be a numerical or string index.
23
18
  * For more information on all accessors, see [Data](https://developer.atlassian.com/platform/forge/ui-kit/components/pie-chart/#data).
@@ -39,19 +34,10 @@ export type PieChartProps = {
39
34
  * A string value that represents the subtitle of the chart. This appears below the title.
40
35
  */
41
36
  subtitle?: string;
42
- /**
43
- * Boolean to render the pie as the donut variation. Defaults to `false`.
44
- */
45
- isDonut?: boolean;
46
37
  /**
47
38
  * Boolean to display labels on top of each slice. Defaults to `false`.
48
39
  */
49
40
  showMarkLabels?: boolean;
50
- /**
51
- * An array of [chart color tokens](https://atlassian.design/components/tokens/all-tokens#color-chart).
52
- * This is utilized to render each slice with the specified colors, based on the color grouping given by colorAccessor.
53
- */
54
- colors?: ChartColorTokens[];
55
41
  };
56
42
  /**
57
43
  * A visual representation of data proportions in a circular format.
@@ -1,4 +1,4 @@
1
1
  export type { BarChartProps, StackBarChartProps, HorizontalStackBarChartProps, HorizontalBarChartProps, TBarChart, TStackBarChart, THorizontalStackBarChart, THorizontalBarChart, } from './BarChartProps';
2
2
  export type { LineChartProps, TLineChart } from './LineChartProps';
3
- export type { SingleValueChartProps, TSingleValueChart } from './SingleValueChartProps';
4
3
  export type { PieChartProps, TPieChart } from './PieChartProps';
4
+ export type { DonutChartProps, TDonutChart } from './DonutChartProps';
@@ -1,3 +1,3 @@
1
1
  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__';
2
- export type { BarChartProps, StackBarChartProps, HorizontalStackBarChartProps, HorizontalBarChartProps, LineChartProps, SingleValueChartProps, PieChartProps, TBarChart, TStackBarChart, THorizontalStackBarChart, THorizontalBarChart, TLineChart, TSingleValueChart, TPieChart, } from './components/charts';
2
+ export type { BarChartProps, StackBarChartProps, HorizontalStackBarChartProps, HorizontalBarChartProps, LineChartProps, DonutChartProps, PieChartProps, TBarChart, TStackBarChart, THorizontalStackBarChart, THorizontalBarChart, TLineChart, TDonutChart, TPieChart, } from './components/charts';
3
3
  export type { ChartColorTokens } from './types';
@@ -1,4 +1,3 @@
1
- import type { ChartColorTokens } from '../../types';
2
1
  export type BarChartProps = {
3
2
  /**
4
3
  * The static width of the chart in pixels. If this is not specified, the width is responsive.
@@ -14,10 +13,6 @@ export type BarChartProps = {
14
13
  * 2. An [array of objects](https://developer.atlassian.com/platform/forge/ui-kit/components/bar-chart/#2--array-of-objects).
15
14
  */
16
15
  data: unknown[];
17
- /**
18
- * Boolean to display the chart border. Defaults to `false`.
19
- */
20
- showBorder?: boolean;
21
16
  /**
22
17
  * Accessor to define the x-axis values. This can be a numerical or string index.
23
18
  * For more information on all accessors, see [Data](https://developer.atlassian.com/platform/forge/ui-kit/components/bar-chart/#data).
@@ -39,11 +34,6 @@ export type BarChartProps = {
39
34
  * A string value that represents the subtitle of the chart. This appears below the title.
40
35
  */
41
36
  subtitle?: string;
42
- /**
43
- * An array of [chart color tokens](https://atlassian.design/components/tokens/all-tokens#color-chart).
44
- * This is utilized to render each bar with the specified colors, based on the color grouping given by colorAccessor.
45
- */
46
- colors?: ChartColorTokens[];
47
37
  };
48
38
  type StackChartProps = BarChartProps & {
49
39
  /**
@@ -0,0 +1,15 @@
1
+ import { type PieChartProps } from './PieChartProps';
2
+ export type DonutChartProps = PieChartProps & {
3
+ /**
4
+ * The radius of the inner circle of the donut chart in pixels. If this is not specified, the radius is responsive.
5
+ */
6
+ innerRadius?: number;
7
+ /**
8
+ * The radius of the outer circle of the donut chart in pixels. If this is not specified, the radius is responsive.
9
+ */
10
+ outerRadius?: number;
11
+ };
12
+ /**
13
+ * A visual representation of data proportions in a donut format.
14
+ */
15
+ export type TDonutChart<T> = (props: DonutChartProps) => T;
@@ -1,4 +1,3 @@
1
- import type { ChartColorTokens } from '../../types';
2
1
  export type LineChartProps = {
3
2
  /**
4
3
  * The static width of the chart in pixels. If this is not specified, the width is responsive.
@@ -14,7 +13,6 @@ export type LineChartProps = {
14
13
  * 2. An [array of objects](https://developer.atlassian.com/platform/forge/ui-kit/components/line-chart/#2--array-of-objects).
15
14
  */
16
15
  data: unknown[];
17
- showBorder?: boolean;
18
16
  /**
19
17
  * Accessor to define the x-axis values. This can be a numerical or string index.
20
18
  * For more information on all accessors, see [Data](https://developer.atlassian.com/platform/forge/ui-kit/components/line-chart/#data).
@@ -36,11 +34,6 @@ export type LineChartProps = {
36
34
  * A string value that represents the subtitle of the chart. This appears below the title.
37
35
  */
38
36
  subtitle?: string;
39
- /**
40
- * An array of [chart color tokens](https://atlassian.design/components/tokens/all-tokens#color-chart).
41
- * This is utilized to render each line with the specified colors, based on the color grouping given by colorAccessor.
42
- */
43
- colors?: ChartColorTokens[];
44
37
  };
45
38
  /**
46
39
  * A visual representation of data showing trends.
@@ -1,4 +1,3 @@
1
- import type { ChartColorTokens } from '../../types';
2
1
  export type PieChartProps = {
3
2
  /**
4
3
  * The static width of the chart in pixels. If this is not specified, the width is responsive.
@@ -14,10 +13,6 @@ export type PieChartProps = {
14
13
  * 2. [Array of objects](https://developer.atlassian.com/platform/forge/ui-kit/components/pie-chart/#2--array-of-objects).
15
14
  */
16
15
  data: unknown[];
17
- /**
18
- * Boolean to display the chart border. Defaults to `false`.
19
- */
20
- showBorder?: boolean;
21
16
  /**
22
17
  * Accessor to define the color grouping. This can be a numerical or string index.
23
18
  * For more information on all accessors, see [Data](https://developer.atlassian.com/platform/forge/ui-kit/components/pie-chart/#data).
@@ -39,19 +34,10 @@ export type PieChartProps = {
39
34
  * A string value that represents the subtitle of the chart. This appears below the title.
40
35
  */
41
36
  subtitle?: string;
42
- /**
43
- * Boolean to render the pie as the donut variation. Defaults to `false`.
44
- */
45
- isDonut?: boolean;
46
37
  /**
47
38
  * Boolean to display labels on top of each slice. Defaults to `false`.
48
39
  */
49
40
  showMarkLabels?: boolean;
50
- /**
51
- * An array of [chart color tokens](https://atlassian.design/components/tokens/all-tokens#color-chart).
52
- * This is utilized to render each slice with the specified colors, based on the color grouping given by colorAccessor.
53
- */
54
- colors?: ChartColorTokens[];
55
41
  };
56
42
  /**
57
43
  * A visual representation of data proportions in a circular format.
@@ -1,4 +1,4 @@
1
1
  export type { BarChartProps, StackBarChartProps, HorizontalStackBarChartProps, HorizontalBarChartProps, TBarChart, TStackBarChart, THorizontalStackBarChart, THorizontalBarChart, } from './BarChartProps';
2
2
  export type { LineChartProps, TLineChart } from './LineChartProps';
3
- export type { SingleValueChartProps, TSingleValueChart } from './SingleValueChartProps';
4
3
  export type { PieChartProps, TPieChart } from './PieChartProps';
4
+ export type { DonutChartProps, TDonutChart } from './DonutChartProps';
@@ -1,3 +1,3 @@
1
1
  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__';
2
- export type { BarChartProps, StackBarChartProps, HorizontalStackBarChartProps, HorizontalBarChartProps, LineChartProps, SingleValueChartProps, PieChartProps, TBarChart, TStackBarChart, THorizontalStackBarChart, THorizontalBarChart, TLineChart, TSingleValueChart, TPieChart, } from './components/charts';
2
+ export type { BarChartProps, StackBarChartProps, HorizontalStackBarChartProps, HorizontalBarChartProps, LineChartProps, DonutChartProps, PieChartProps, TBarChart, TStackBarChart, THorizontalStackBarChart, THorizontalBarChart, TLineChart, TDonutChart, TPieChart, } from './components/charts';
3
3
  export type { ChartColorTokens } from './types';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/forge-react-types",
3
- "version": "0.38.0",
3
+ "version": "0.39.1",
4
4
  "description": "Component types for Forge UI Kit React components",
5
5
  "publishConfig": {
6
6
  "registry": "https://registry.npmjs.org/"
@@ -25,7 +25,7 @@
25
25
  },
26
26
  "dependencies": {
27
27
  "@atlaskit/badge": "^18.1.0",
28
- "@atlaskit/button": "^21.1.0",
28
+ "@atlaskit/button": "^22.0.0",
29
29
  "@atlaskit/calendar": "^17.1.0",
30
30
  "@atlaskit/checkbox": "^17.0.0",
31
31
  "@atlaskit/code": "^16.1.0",
@@ -37,7 +37,7 @@
37
37
  "@atlaskit/inline-edit": "^15.1.0",
38
38
  "@atlaskit/lozenge": "^12.2.0",
39
39
  "@atlaskit/modal-dialog": "^14.0.0",
40
- "@atlaskit/popup": "^2.0.0",
40
+ "@atlaskit/popup": "^3.0.0",
41
41
  "@atlaskit/primitives": "^14.2.0",
42
42
  "@atlaskit/progress-bar": "^4.0.0",
43
43
  "@atlaskit/progress-tracker": "^10.0.0",
@@ -1,5 +1,3 @@
1
- import type { ChartColorTokens } from '../../types';
2
-
3
1
  export type BarChartProps = {
4
2
  /**
5
3
  * The static width of the chart in pixels. If this is not specified, the width is responsive.
@@ -15,10 +13,6 @@ export type BarChartProps = {
15
13
  * 2. An [array of objects](https://developer.atlassian.com/platform/forge/ui-kit/components/bar-chart/#2--array-of-objects).
16
14
  */
17
15
  data: unknown[];
18
- /**
19
- * Boolean to display the chart border. Defaults to `false`.
20
- */
21
- showBorder?: boolean;
22
16
  /**
23
17
  * Accessor to define the x-axis values. This can be a numerical or string index.
24
18
  * For more information on all accessors, see [Data](https://developer.atlassian.com/platform/forge/ui-kit/components/bar-chart/#data).
@@ -40,11 +34,6 @@ export type BarChartProps = {
40
34
  * A string value that represents the subtitle of the chart. This appears below the title.
41
35
  */
42
36
  subtitle?: string;
43
- /**
44
- * An array of [chart color tokens](https://atlassian.design/components/tokens/all-tokens#color-chart).
45
- * This is utilized to render each bar with the specified colors, based on the color grouping given by colorAccessor.
46
- */
47
- colors?: ChartColorTokens[];
48
37
  };
49
38
 
50
39
  type StackChartProps = BarChartProps & {
@@ -0,0 +1,17 @@
1
+ import { type PieChartProps } from './PieChartProps';
2
+
3
+ export type DonutChartProps = PieChartProps & {
4
+ /**
5
+ * The radius of the inner circle of the donut chart in pixels. If this is not specified, the radius is responsive.
6
+ */
7
+ innerRadius?: number;
8
+ /**
9
+ * The radius of the outer circle of the donut chart in pixels. If this is not specified, the radius is responsive.
10
+ */
11
+ outerRadius?: number;
12
+ };
13
+
14
+ /**
15
+ * A visual representation of data proportions in a donut format.
16
+ */
17
+ export type TDonutChart<T> = (props: DonutChartProps) => T;
@@ -1,5 +1,3 @@
1
- import type { ChartColorTokens } from '../../types';
2
-
3
1
  export type LineChartProps = {
4
2
  /**
5
3
  * The static width of the chart in pixels. If this is not specified, the width is responsive.
@@ -15,7 +13,6 @@ export type LineChartProps = {
15
13
  * 2. An [array of objects](https://developer.atlassian.com/platform/forge/ui-kit/components/line-chart/#2--array-of-objects).
16
14
  */
17
15
  data: unknown[];
18
- showBorder?: boolean;
19
16
  /**
20
17
  * Accessor to define the x-axis values. This can be a numerical or string index.
21
18
  * For more information on all accessors, see [Data](https://developer.atlassian.com/platform/forge/ui-kit/components/line-chart/#data).
@@ -37,11 +34,6 @@ export type LineChartProps = {
37
34
  * A string value that represents the subtitle of the chart. This appears below the title.
38
35
  */
39
36
  subtitle?: string;
40
- /**
41
- * An array of [chart color tokens](https://atlassian.design/components/tokens/all-tokens#color-chart).
42
- * This is utilized to render each line with the specified colors, based on the color grouping given by colorAccessor.
43
- */
44
- colors?: ChartColorTokens[];
45
37
  };
46
38
 
47
39
  /**
@@ -1,5 +1,3 @@
1
- import type { ChartColorTokens } from '../../types';
2
-
3
1
  export type PieChartProps = {
4
2
  /**
5
3
  * The static width of the chart in pixels. If this is not specified, the width is responsive.
@@ -15,10 +13,6 @@ export type PieChartProps = {
15
13
  * 2. [Array of objects](https://developer.atlassian.com/platform/forge/ui-kit/components/pie-chart/#2--array-of-objects).
16
14
  */
17
15
  data: unknown[];
18
- /**
19
- * Boolean to display the chart border. Defaults to `false`.
20
- */
21
- showBorder?: boolean;
22
16
  /**
23
17
  * Accessor to define the color grouping. This can be a numerical or string index.
24
18
  * For more information on all accessors, see [Data](https://developer.atlassian.com/platform/forge/ui-kit/components/pie-chart/#data).
@@ -40,19 +34,10 @@ export type PieChartProps = {
40
34
  * A string value that represents the subtitle of the chart. This appears below the title.
41
35
  */
42
36
  subtitle?: string;
43
- /**
44
- * Boolean to render the pie as the donut variation. Defaults to `false`.
45
- */
46
- isDonut?: boolean;
47
37
  /**
48
38
  * Boolean to display labels on top of each slice. Defaults to `false`.
49
39
  */
50
40
  showMarkLabels?: boolean;
51
- /**
52
- * An array of [chart color tokens](https://atlassian.design/components/tokens/all-tokens#color-chart).
53
- * This is utilized to render each slice with the specified colors, based on the color grouping given by colorAccessor.
54
- */
55
- colors?: ChartColorTokens[];
56
41
  };
57
42
 
58
43
  /**
@@ -10,5 +10,5 @@ export type {
10
10
  } from './BarChartProps';
11
11
 
12
12
  export type { LineChartProps, TLineChart } from './LineChartProps';
13
- export type { SingleValueChartProps, TSingleValueChart } from './SingleValueChartProps';
14
13
  export type { PieChartProps, TPieChart } from './PieChartProps';
14
+ export type { DonutChartProps, TDonutChart } from './DonutChartProps';
package/src/index.ts CHANGED
@@ -131,14 +131,14 @@ export type {
131
131
  HorizontalStackBarChartProps,
132
132
  HorizontalBarChartProps,
133
133
  LineChartProps,
134
- SingleValueChartProps,
134
+ DonutChartProps,
135
135
  PieChartProps,
136
136
  TBarChart,
137
137
  TStackBarChart,
138
138
  THorizontalStackBarChart,
139
139
  THorizontalBarChart,
140
140
  TLineChart,
141
- TSingleValueChart,
141
+ TDonutChart,
142
142
  TPieChart,
143
143
  } from './components/charts';
144
144
 
@@ -1 +0,0 @@
1
- "use strict";
@@ -1,33 +0,0 @@
1
- export type SingleValueChartProps = {
2
- /**
3
- * Data can be one of two formats:
4
- * 1. A **number** - The value that is displayed, abbreviated at the thousand, millions, trillions and billions.
5
- * 2. An **array of numbers**: The first number in the array is used as the display value, the second number in the array is used to calculate the increase/decrease percentage relative to the first number.
6
- */
7
- data: number | number[];
8
- /**
9
- * The static width of the chart in pixels. If this is not specified, the width is responsive.
10
- */
11
- width?: number;
12
- /**
13
- * The static height of the chart in pixels. Defaults to `120`.
14
- */
15
- height?: number;
16
- /**
17
- * Boolean to display the chart border. Defaults to `false`.
18
- */
19
- showBorder?: boolean;
20
- /**
21
- * A string value that represents the title of the chart.
22
- */
23
- title?: string;
24
- /**
25
- * A string value that represents the subtitle of the chart. This appears below the metric value.
26
- */
27
- subtitle?: string;
28
- };
29
- /**
30
- * A visualization representation of information with a single value as its metrics.
31
- * The metric can be displayed with a increase/decrease indicator to display trends or changes over time.
32
- */
33
- export type TSingleValueChart<T> = (props: SingleValueChartProps) => T;
@@ -1,33 +0,0 @@
1
- export type SingleValueChartProps = {
2
- /**
3
- * Data can be one of two formats:
4
- * 1. A **number** - The value that is displayed, abbreviated at the thousand, millions, trillions and billions.
5
- * 2. An **array of numbers**: The first number in the array is used as the display value, the second number in the array is used to calculate the increase/decrease percentage relative to the first number.
6
- */
7
- data: number | number[];
8
- /**
9
- * The static width of the chart in pixels. If this is not specified, the width is responsive.
10
- */
11
- width?: number;
12
- /**
13
- * The static height of the chart in pixels. Defaults to `120`.
14
- */
15
- height?: number;
16
- /**
17
- * Boolean to display the chart border. Defaults to `false`.
18
- */
19
- showBorder?: boolean;
20
- /**
21
- * A string value that represents the title of the chart.
22
- */
23
- title?: string;
24
- /**
25
- * A string value that represents the subtitle of the chart. This appears below the metric value.
26
- */
27
- subtitle?: string;
28
- };
29
- /**
30
- * A visualization representation of information with a single value as its metrics.
31
- * The metric can be displayed with a increase/decrease indicator to display trends or changes over time.
32
- */
33
- export type TSingleValueChart<T> = (props: SingleValueChartProps) => T;
@@ -1,34 +0,0 @@
1
- export type SingleValueChartProps = {
2
- /**
3
- * Data can be one of two formats:
4
- * 1. A **number** - The value that is displayed, abbreviated at the thousand, millions, trillions and billions.
5
- * 2. An **array of numbers**: The first number in the array is used as the display value, the second number in the array is used to calculate the increase/decrease percentage relative to the first number.
6
- */
7
- data: number | number[];
8
- /**
9
- * The static width of the chart in pixels. If this is not specified, the width is responsive.
10
- */
11
- width?: number;
12
- /**
13
- * The static height of the chart in pixels. Defaults to `120`.
14
- */
15
- height?: number;
16
- /**
17
- * Boolean to display the chart border. Defaults to `false`.
18
- */
19
- showBorder?: boolean;
20
- /**
21
- * A string value that represents the title of the chart.
22
- */
23
- title?: string;
24
- /**
25
- * A string value that represents the subtitle of the chart. This appears below the metric value.
26
- */
27
- subtitle?: string;
28
- };
29
-
30
- /**
31
- * A visualization representation of information with a single value as its metrics.
32
- * The metric can be displayed with a increase/decrease indicator to display trends or changes over time.
33
- */
34
- export type TSingleValueChart<T> = (props: SingleValueChartProps) => T;