@atlaskit/forge-react-types 0.37.7 → 0.37.9

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 (125) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/dist/types/components/__generated__/ButtonGroupProps.codegen.d.ts +3 -3
  3. package/dist/types/components/__generated__/ButtonProps.codegen.d.ts +5 -2
  4. package/dist/types/components/__generated__/CheckboxGroupProps.codegen.d.ts +21 -2
  5. package/dist/types/components/__generated__/DatePickerProps.codegen.d.ts +3 -3
  6. package/dist/types/components/__generated__/ErrorMessageProps.codegen.d.ts +4 -3
  7. package/dist/types/components/__generated__/FormFooterProps.codegen.d.ts +12 -4
  8. package/dist/types/components/__generated__/FormHeaderProps.codegen.d.ts +5 -3
  9. package/dist/types/components/__generated__/FormProps.codegen.d.ts +14 -2
  10. package/dist/types/components/__generated__/FormSectionProps.codegen.d.ts +4 -3
  11. package/dist/types/components/__generated__/HelperMessageProps.codegen.d.ts +4 -3
  12. package/dist/types/components/__generated__/IconProps.codegen.d.ts +22 -2
  13. package/dist/types/components/__generated__/InlineEditProps.codegen.d.ts +6 -2
  14. package/dist/types/components/__generated__/InlineProps.codegen.d.ts +3 -3
  15. package/dist/types/components/__generated__/LabelProps.codegen.d.ts +3 -3
  16. package/dist/types/components/__generated__/LinkButtonProps.codegen.d.ts +5 -2
  17. package/dist/types/components/__generated__/ListItemProps.codegen.d.ts +3 -2
  18. package/dist/types/components/__generated__/ListProps.codegen.d.ts +14 -2
  19. package/dist/types/components/__generated__/LoadingButtonProps.codegen.d.ts +3 -3
  20. package/dist/types/components/__generated__/ModalBodyProps.codegen.d.ts +3 -3
  21. package/dist/types/components/__generated__/ModalFooterProps.codegen.d.ts +4 -3
  22. package/dist/types/components/__generated__/ModalHeaderProps.codegen.d.ts +3 -3
  23. package/dist/types/components/__generated__/ModalTitleProps.codegen.d.ts +3 -3
  24. package/dist/types/components/__generated__/ModalTransitionProps.codegen.d.ts +3 -3
  25. package/dist/types/components/__generated__/PopupProps.codegen.d.ts +15 -2
  26. package/dist/types/components/__generated__/SelectProps.codegen.d.ts +6 -2
  27. package/dist/types/components/__generated__/StackProps.codegen.d.ts +3 -3
  28. package/dist/types/components/__generated__/TabListProps.codegen.d.ts +3 -3
  29. package/dist/types/components/__generated__/TabPanelProps.codegen.d.ts +3 -3
  30. package/dist/types/components/__generated__/TabProps.codegen.d.ts +3 -3
  31. package/dist/types/components/__generated__/TextAreaProps.codegen.d.ts +6 -2
  32. package/dist/types/components/__generated__/TextfieldProps.codegen.d.ts +6 -2
  33. package/dist/types/components/__generated__/TimePickerProps.codegen.d.ts +3 -3
  34. package/dist/types/components/__generated__/TooltipProps.codegen.d.ts +3 -3
  35. package/dist/types/components/__generated__/ValidMessageProps.codegen.d.ts +4 -3
  36. package/dist/types/components/__generated__/index.d.ts +65 -58
  37. package/dist/types/components/charts/BarChartProps.d.ts +92 -3
  38. package/dist/types/components/charts/LineChartProps.d.ts +35 -0
  39. package/dist/types/components/charts/PieChartProps.d.ts +44 -0
  40. package/dist/types/components/charts/SingleValueChartProps.d.ts +25 -0
  41. package/dist/types/components/charts/index.d.ts +4 -4
  42. package/dist/types/index.d.ts +1 -1
  43. package/dist/types-ts4.5/components/__generated__/ButtonGroupProps.codegen.d.ts +3 -3
  44. package/dist/types-ts4.5/components/__generated__/ButtonProps.codegen.d.ts +5 -2
  45. package/dist/types-ts4.5/components/__generated__/CheckboxGroupProps.codegen.d.ts +21 -2
  46. package/dist/types-ts4.5/components/__generated__/DatePickerProps.codegen.d.ts +3 -3
  47. package/dist/types-ts4.5/components/__generated__/ErrorMessageProps.codegen.d.ts +4 -3
  48. package/dist/types-ts4.5/components/__generated__/FormFooterProps.codegen.d.ts +12 -4
  49. package/dist/types-ts4.5/components/__generated__/FormHeaderProps.codegen.d.ts +5 -3
  50. package/dist/types-ts4.5/components/__generated__/FormProps.codegen.d.ts +14 -2
  51. package/dist/types-ts4.5/components/__generated__/FormSectionProps.codegen.d.ts +4 -3
  52. package/dist/types-ts4.5/components/__generated__/HelperMessageProps.codegen.d.ts +4 -3
  53. package/dist/types-ts4.5/components/__generated__/IconProps.codegen.d.ts +22 -2
  54. package/dist/types-ts4.5/components/__generated__/InlineEditProps.codegen.d.ts +6 -2
  55. package/dist/types-ts4.5/components/__generated__/InlineProps.codegen.d.ts +3 -3
  56. package/dist/types-ts4.5/components/__generated__/LabelProps.codegen.d.ts +3 -3
  57. package/dist/types-ts4.5/components/__generated__/LinkButtonProps.codegen.d.ts +5 -2
  58. package/dist/types-ts4.5/components/__generated__/ListItemProps.codegen.d.ts +3 -2
  59. package/dist/types-ts4.5/components/__generated__/ListProps.codegen.d.ts +14 -2
  60. package/dist/types-ts4.5/components/__generated__/LoadingButtonProps.codegen.d.ts +3 -3
  61. package/dist/types-ts4.5/components/__generated__/ModalBodyProps.codegen.d.ts +3 -3
  62. package/dist/types-ts4.5/components/__generated__/ModalFooterProps.codegen.d.ts +4 -3
  63. package/dist/types-ts4.5/components/__generated__/ModalHeaderProps.codegen.d.ts +3 -3
  64. package/dist/types-ts4.5/components/__generated__/ModalTitleProps.codegen.d.ts +3 -3
  65. package/dist/types-ts4.5/components/__generated__/ModalTransitionProps.codegen.d.ts +3 -3
  66. package/dist/types-ts4.5/components/__generated__/PopupProps.codegen.d.ts +15 -2
  67. package/dist/types-ts4.5/components/__generated__/SelectProps.codegen.d.ts +6 -2
  68. package/dist/types-ts4.5/components/__generated__/StackProps.codegen.d.ts +3 -3
  69. package/dist/types-ts4.5/components/__generated__/TabListProps.codegen.d.ts +3 -3
  70. package/dist/types-ts4.5/components/__generated__/TabPanelProps.codegen.d.ts +3 -3
  71. package/dist/types-ts4.5/components/__generated__/TabProps.codegen.d.ts +3 -3
  72. package/dist/types-ts4.5/components/__generated__/TextAreaProps.codegen.d.ts +6 -2
  73. package/dist/types-ts4.5/components/__generated__/TextfieldProps.codegen.d.ts +6 -2
  74. package/dist/types-ts4.5/components/__generated__/TimePickerProps.codegen.d.ts +3 -3
  75. package/dist/types-ts4.5/components/__generated__/TooltipProps.codegen.d.ts +3 -3
  76. package/dist/types-ts4.5/components/__generated__/ValidMessageProps.codegen.d.ts +4 -3
  77. package/dist/types-ts4.5/components/__generated__/index.d.ts +65 -58
  78. package/dist/types-ts4.5/components/charts/BarChartProps.d.ts +92 -3
  79. package/dist/types-ts4.5/components/charts/LineChartProps.d.ts +35 -0
  80. package/dist/types-ts4.5/components/charts/PieChartProps.d.ts +44 -0
  81. package/dist/types-ts4.5/components/charts/SingleValueChartProps.d.ts +25 -0
  82. package/dist/types-ts4.5/components/charts/index.d.ts +4 -4
  83. package/dist/types-ts4.5/index.d.ts +1 -1
  84. package/package.json +4 -4
  85. package/src/components/__generated__/ButtonGroupProps.codegen.tsx +3 -3
  86. package/src/components/__generated__/ButtonProps.codegen.tsx +5 -2
  87. package/src/components/__generated__/CheckboxGroupProps.codegen.tsx +26 -3
  88. package/src/components/__generated__/DatePickerProps.codegen.tsx +3 -3
  89. package/src/components/__generated__/ErrorMessageProps.codegen.tsx +4 -3
  90. package/src/components/__generated__/FormFooterProps.codegen.tsx +12 -4
  91. package/src/components/__generated__/FormHeaderProps.codegen.tsx +5 -3
  92. package/src/components/__generated__/FormProps.codegen.tsx +14 -2
  93. package/src/components/__generated__/FormSectionProps.codegen.tsx +4 -3
  94. package/src/components/__generated__/HelperMessageProps.codegen.tsx +4 -3
  95. package/src/components/__generated__/IconProps.codegen.tsx +22 -2
  96. package/src/components/__generated__/InlineEditProps.codegen.tsx +8 -3
  97. package/src/components/__generated__/InlineProps.codegen.tsx +3 -3
  98. package/src/components/__generated__/LabelProps.codegen.tsx +3 -3
  99. package/src/components/__generated__/LinkButtonProps.codegen.tsx +5 -2
  100. package/src/components/__generated__/ListItemProps.codegen.tsx +5 -3
  101. package/src/components/__generated__/ListProps.codegen.tsx +16 -3
  102. package/src/components/__generated__/LoadingButtonProps.codegen.tsx +17 -5
  103. package/src/components/__generated__/ModalBodyProps.codegen.tsx +3 -3
  104. package/src/components/__generated__/ModalFooterProps.codegen.tsx +4 -3
  105. package/src/components/__generated__/ModalHeaderProps.codegen.tsx +3 -3
  106. package/src/components/__generated__/ModalTitleProps.codegen.tsx +3 -3
  107. package/src/components/__generated__/ModalTransitionProps.codegen.tsx +3 -3
  108. package/src/components/__generated__/PopupProps.codegen.tsx +18 -3
  109. package/src/components/__generated__/SelectProps.codegen.tsx +8 -3
  110. package/src/components/__generated__/StackProps.codegen.tsx +3 -3
  111. package/src/components/__generated__/TabListProps.codegen.tsx +3 -3
  112. package/src/components/__generated__/TabPanelProps.codegen.tsx +3 -3
  113. package/src/components/__generated__/TabProps.codegen.tsx +3 -3
  114. package/src/components/__generated__/TextAreaProps.codegen.tsx +8 -3
  115. package/src/components/__generated__/TextfieldProps.codegen.tsx +8 -3
  116. package/src/components/__generated__/TimePickerProps.codegen.tsx +3 -3
  117. package/src/components/__generated__/TooltipProps.codegen.tsx +3 -3
  118. package/src/components/__generated__/ValidMessageProps.codegen.tsx +4 -3
  119. package/src/components/__generated__/index.ts +67 -59
  120. package/src/components/charts/BarChartProps.tsx +101 -3
  121. package/src/components/charts/LineChartProps.tsx +36 -0
  122. package/src/components/charts/PieChartProps.tsx +45 -0
  123. package/src/components/charts/SingleValueChartProps.tsx +26 -0
  124. package/src/components/charts/index.ts +7 -3
  125. package/src/index.ts +59 -0
@@ -3,16 +3,16 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - ModalTransitionProps
5
5
  *
6
- * @codegen <<SignedSource::9d4490cd7b1938efec7181c83258a4c5>>
6
+ * @codegen <<SignedSource::fbd2e79db623371d79d173ce8c807737>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/modal/__generated__/modal-transition.partial.tsx <<SignedSource::7f1f7ea64369d3e65533dffbbcec26d7>>
8
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/modal/__generated__/modal-transition.partial.tsx <<SignedSource::9a5d35aaedbe614414c801acffdbeeff>>
9
9
  */
10
10
  import React from 'react';
11
11
  import { ModalTransition as PlatformModalTransition } from '@atlaskit/modal-dialog';
12
12
  type PlatformModalTransitionProps = React.ComponentProps<typeof PlatformModalTransition>;
13
13
  export type ModalTransitionProps = Pick<PlatformModalTransitionProps, 'children'>;
14
14
  /**
15
- * A modal dialog displays content that requires user interaction, in a layer above the page.
15
+ * A modal transition wraps a modal to provide a fluid transition upon opening and closing.
16
16
  */
17
17
  export type TModalTransition<T> = (props: ModalTransitionProps) => T;
18
18
  export {};
@@ -3,14 +3,27 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - PopupProps
5
5
  *
6
- * @codegen <<SignedSource::46e22c91b6503926afe0f721c99196ea>>
6
+ * @codegen <<SignedSource::9c82b51dc6635d8638a1f1f24ceaec66>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/popup/index.tsx <<SignedSource::0708f76a6f3ffe765ff242a9104f7d42>>
8
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/popup/index.tsx <<SignedSource::cafa3868628edc1953d996c860801ed5>>
9
9
  */
10
10
  import React from 'react';
11
11
  import { default as PlatformPopup } from '@atlaskit/popup';
12
+ /**
13
+ * Design decisions made:
14
+ * `zIndex` and `offset` are excluded to constrain the appearance of the popup.
15
+ *
16
+ * `boundary` has been changed as the ADS type can also expect an HTMLElement to be passed in, which cannot work with Forge.
17
+ *
18
+ * `popupComponent` is excluded as the same customisation can be done with `Box` in content
19
+ *
20
+ */
12
21
  export type PopupProps = Omit<React.ComponentProps<typeof PlatformPopup>, 'popupComponent' | 'zIndex' | 'offset' | 'boundary'> & {
13
22
  boundary?: 'clippingParents';
14
23
  content: () => React.ReactNode;
15
24
  trigger: () => React.ReactNode;
16
25
  };
26
+ /**
27
+ * A popup displays brief content in an overlay.
28
+ */
29
+ export type TPopup<T> = (props: PopupProps) => T;
@@ -3,9 +3,13 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - SelectProps
5
5
  *
6
- * @codegen <<SignedSource::124f2ef00704a09ec7335b035929681c>>
6
+ * @codegen <<SignedSource::27434c8de7f2e3082a44901a80c594a9>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/select/index.tsx <<SignedSource::a2510e0de095c3d94007eb9c6488aa55>>
8
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/select/index.tsx <<SignedSource::f7eed13874b04c56ded5f3434e03c70e>>
9
9
  */
10
10
  import type { SelectProps as PlatformSelectProps } from '@atlaskit/select';
11
11
  export type SelectProps = Pick<PlatformSelectProps<any, true | false>, 'appearance' | 'autoFocus' | 'closeMenuOnScroll' | 'closeMenuOnSelect' | 'defaultInputValue' | 'defaultMenuIsOpen' | 'defaultValue' | 'id' | 'inputId' | 'inputValue' | 'isClearable' | 'isDisabled' | 'isInvalid' | 'isLoading' | 'isMulti' | 'isSearchable' | 'menuIsOpen' | 'openMenuOnFocus' | 'name' | 'onBlur' | 'onChange' | 'onFocus' | 'onInputChange' | 'options' | 'placeholder' | 'spacing' | 'testId' | 'value' | 'isRequired'>;
12
+ /**
13
+ * Select allows users to make a single selection or multiple selections from a list of options.
14
+ */
15
+ export type TSelect<T> = (props: SelectProps) => T;
@@ -3,16 +3,16 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - StackProps
5
5
  *
6
- * @codegen <<SignedSource::0e61f7285631ab35f3a77bb1d42d43aa>>
6
+ * @codegen <<SignedSource::d2ba0849ecf2dcab0851f9678f03e102>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/stack/__generated__/index.partial.tsx <<SignedSource::63880622ee058ba54ea3754cbc1910f4>>
8
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/stack/__generated__/index.partial.tsx <<SignedSource::191f725f0992bea2117b07b99f6444de>>
9
9
  */
10
10
  import React from 'react';
11
11
  import { Stack as PlatformStack } from '@atlaskit/primitives';
12
12
  type PlatformStackProps = React.ComponentProps<typeof PlatformStack>;
13
13
  export type StackProps = Pick<PlatformStackProps, 'children' | 'alignBlock' | 'alignInline' | 'grow' | 'space' | 'spread' | 'testId'>;
14
14
  /**
15
- * Primitives are token-backed low-level building blocks.
15
+ * A stack manages the vertical layout of direct children using flexbox.
16
16
  */
17
17
  export type TStack<T> = (props: StackProps) => T;
18
18
  export {};
@@ -3,16 +3,16 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - TabListProps
5
5
  *
6
- * @codegen <<SignedSource::0b10d2d919012771dcb780ff32d5cfd2>>
6
+ * @codegen <<SignedSource::2ac5252a55c5b4f8bbdf29439ab10dcf>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/tabs/__generated__/tablist.partial.tsx <<SignedSource::4ada894a5d94a305fa30eb45a6759915>>
8
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/tabs/__generated__/tablist.partial.tsx <<SignedSource::fbd3384538b87c1a820790b55241ee21>>
9
9
  */
10
10
  import React from 'react';
11
11
  import { TabList as PlatformTabList } from '@atlaskit/tabs';
12
12
  type PlatformTabListProps = React.ComponentProps<typeof PlatformTabList>;
13
13
  export type TabListProps = Pick<PlatformTabListProps, 'children'>;
14
14
  /**
15
- * Tabs are used to organize content by grouping similar information on the same page.
15
+ * A `TabList` groups `Tab` components together.
16
16
  */
17
17
  export type TTabList<T> = (props: TabListProps) => T;
18
18
  export {};
@@ -3,16 +3,16 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - TabPanelProps
5
5
  *
6
- * @codegen <<SignedSource::d880c7eaf445179245b8aea2d70ea39e>>
6
+ * @codegen <<SignedSource::6ff302a008a6520f4b1b03de50bfe530>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/tabs/__generated__/tabpanel.partial.tsx <<SignedSource::1bbc05ad9425e3df25423076ab0a0acf>>
8
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/tabs/__generated__/tabpanel.partial.tsx <<SignedSource::e7936c96c90f8f4682c85a00f85a23f4>>
9
9
  */
10
10
  import React from 'react';
11
11
  import { TabPanel as PlatformTabPanel } from '@atlaskit/tabs';
12
12
  type PlatformTabPanelProps = React.ComponentProps<typeof PlatformTabPanel>;
13
13
  export type TabPanelProps = Pick<PlatformTabPanelProps, 'children' | 'testId'>;
14
14
  /**
15
- * Tabs are used to organize content by grouping similar information on the same page.
15
+ * A `TabPanel` houses the contents of a `Tab`.
16
16
  */
17
17
  export type TTabPanel<T> = (props: TabPanelProps) => T;
18
18
  export {};
@@ -3,16 +3,16 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - TabProps
5
5
  *
6
- * @codegen <<SignedSource::6b0d6b725c7692c9bfcddf45f3ca4f1f>>
6
+ * @codegen <<SignedSource::d69181ff464555d27568e977900710b6>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/tabs/__generated__/tab.partial.tsx <<SignedSource::f5363c279366b51358d257738457c7d5>>
8
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/tabs/__generated__/tab.partial.tsx <<SignedSource::05b588ddfb6bfa200363a1127660dce4>>
9
9
  */
10
10
  import React from 'react';
11
11
  import { Tab as PlatformTab } from '@atlaskit/tabs';
12
12
  type PlatformTabProps = React.ComponentProps<typeof PlatformTab>;
13
13
  export type TabProps = Pick<PlatformTabProps, 'children' | 'testId'>;
14
14
  /**
15
- * Tabs are used to organize content by grouping similar information on the same page.
15
+ * `Tab` represents an individual tab displayed in a TabList.
16
16
  */
17
17
  export type TTab<T> = (props: TabProps) => T;
18
18
  export {};
@@ -3,13 +3,17 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - TextAreaProps
5
5
  *
6
- * @codegen <<SignedSource::9a728b21f878b7d2411d9ea96c367054>>
6
+ * @codegen <<SignedSource::4735e4d09b0b6c4a75fe1c08151b6054>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/textarea/index.tsx <<SignedSource::cb1d758c7c2bb0e325bf9f7e3d6ae09d>>
8
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/textarea/index.tsx <<SignedSource::282c20421c108bd52e5341ba0ee4293c>>
9
9
  */
10
10
  import React from 'react';
11
11
  import PlatformTextarea from '@atlaskit/textarea';
12
12
  import type { EventHandlerProps } from './types.codegen';
13
13
  type PlatformTextareaProps = React.ComponentProps<typeof PlatformTextarea>;
14
14
  export type TextAreaProps = Pick<PlatformTextareaProps, 'appearance' | 'defaultValue' | 'isCompact' | 'isMonospaced' | 'isReadOnly' | 'maxHeight' | 'minimumRows' | 'placeholder' | 'resize' | 'spellCheck' | 'testId' | 'maxLength' | 'minLength' | 'autoFocus' | 'id' | 'isRequired' | 'isDisabled' | 'isInvalid' | 'value' | 'aria-invalid' | 'aria-labelledby' | 'name'> & Pick<EventHandlerProps, 'onChange' | 'onBlur' | 'onFocus'>;
15
+ /**
16
+ * A text area lets users enter long form text which spans over multiple lines.
17
+ */
18
+ export type TTextArea<T> = (props: TextAreaProps) => T;
15
19
  export {};
@@ -3,13 +3,17 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - TextfieldProps
5
5
  *
6
- * @codegen <<SignedSource::53927afe8c8adcca03f0cfa65f9b44dc>>
6
+ * @codegen <<SignedSource::4f0a7b04b3a23a5889553b2bfaf7f454>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/textfield/index.tsx <<SignedSource::3cab13a24ee050b7fe926e8e6a19858b>>
8
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/textfield/index.tsx <<SignedSource::03b967815639a5a5aae4f79da283d410>>
9
9
  */
10
10
  import React from 'react';
11
11
  import PlatformTextfield from '@atlaskit/textfield';
12
12
  import type { EventHandlerProps } from './types.codegen';
13
13
  type PlatformTextfieldProps = React.ComponentProps<typeof PlatformTextfield>;
14
14
  export type TextfieldProps = Pick<PlatformTextfieldProps, 'appearance' | 'elemAfterInput' | 'elemBeforeInput' | 'isCompact' | 'autoFocus' | 'isReadOnly' | 'isMonospaced' | 'placeholder' | 'testId' | 'width' | 'type' | 'defaultValue' | 'min' | 'max' | 'maxLength' | 'minLength' | 'pattern' | 'id' | 'isRequired' | 'isDisabled' | 'isInvalid' | 'value' | 'aria-invalid' | 'aria-labelledby' | 'name'> & Pick<EventHandlerProps, 'onChange' | 'onBlur' | 'onFocus'>;
15
+ /**
16
+ * A text field is an input that allows a user to write or edit text.
17
+ */
18
+ export type TTextfield<T> = (props: TextfieldProps) => T;
15
19
  export {};
@@ -3,9 +3,9 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - TimePickerProps
5
5
  *
6
- * @codegen <<SignedSource::bf9a04576bd1f8b348bd5091c9273208>>
6
+ * @codegen <<SignedSource::3f20d9d9bd43c0d792ea07ff9ecc23b1>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/timepicker/__generated__/index.partial.tsx <<SignedSource::aa8817ad383b8e2bce261c520e227b41>>
8
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/timepicker/__generated__/index.partial.tsx <<SignedSource::8f1c6ab03a29e7279ed2d3e82b086ab0>>
9
9
  */
10
10
  import type { DateTimePickerSelectProps } from '@atlaskit/datetime-picker';
11
11
  export interface FieldProps {
@@ -44,7 +44,7 @@ export type TimePickerProps = {
44
44
  selectProps?: DateTimePickerSelectProps;
45
45
  } & Partial<Omit<FieldProps, 'onChange'>>;
46
46
  /**
47
- * A date time picker allows the user to select an associated date and time.
47
+ * A time picker allows the user to select a specific time.
48
48
  */
49
49
  export type TTimePicker<T> = (props: TimePickerProps) => T;
50
50
  export {};
@@ -3,16 +3,16 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - TooltipProps
5
5
  *
6
- * @codegen <<SignedSource::d67c937dcf799eb3d57dc35b62b52bd4>>
6
+ * @codegen <<SignedSource::4b27e1c130769985576ab4c910715b03>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/tooltip/__generated__/index.partial.tsx <<SignedSource::f5b26159e3b08ac61199d599900f523d>>
8
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/tooltip/__generated__/index.partial.tsx <<SignedSource::e3e388170520502310149f23b8defa27>>
9
9
  */
10
10
  import React from 'react';
11
11
  import PlatformTooltip from '@atlaskit/tooltip';
12
12
  type PlatformTooltipProps = React.ComponentProps<typeof PlatformTooltip>;
13
13
  export type TooltipProps = Pick<PlatformTooltipProps, 'children' | 'position' | 'mousePosition' | 'content' | 'truncate' | 'testId' | 'delay'>;
14
14
  /**
15
- * A tooltip is a floating, non-actionable label used to explain a user interface element or feature.
15
+ * A `Tooltip` is a floating, non-actionable label used to explain a user interface element or feature.
16
16
  */
17
17
  export type TTooltip<T> = (props: TooltipProps) => T;
18
18
  export {};
@@ -3,16 +3,17 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - ValidMessageProps
5
5
  *
6
- * @codegen <<SignedSource::40ef2ece49a84181a994ff221e42cc39>>
6
+ * @codegen <<SignedSource::4cc4d2511f92d5cb8969eb03a63cb079>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/form/__generated__/valid-message.partial.tsx <<SignedSource::5460cf891302777898b53c0b4ae8b610>>
8
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/form/__generated__/valid-message.partial.tsx <<SignedSource::7c24bfd118e399bb212709c31585209b>>
9
9
  */
10
10
  import React from 'react';
11
11
  import { ValidMessage as PlatformValidMessage } from '@atlaskit/form';
12
12
  type PlatformValidMessageProps = React.ComponentProps<typeof PlatformValidMessage>;
13
13
  export type ValidMessageProps = Pick<PlatformValidMessageProps, 'children' | 'testId'>;
14
14
  /**
15
- * A form allows users to input information.
15
+ * A valid message is used to tell a user that the field input is valid.
16
+ * For example, a helper message could be "Nice one, this username is available".
16
17
  */
17
18
  export type TValidMessage<T> = (props: ValidMessageProps) => T;
18
19
  export {};
@@ -1,65 +1,72 @@
1
1
  export type { BadgeProps, TBadge } from './BadgeProps.codegen';
2
- export type { BleedProps } from './BleedProps.codegen';
2
+ export type { BleedProps, TBleed } from './BleedProps.codegen';
3
3
  export type { BoxProps, TBox } from './BoxProps.codegen';
4
- export type { ButtonGroupProps } from './ButtonGroupProps.codegen';
5
- export type { ButtonProps } from './ButtonProps.codegen';
6
- export type { CheckboxProps } from './CheckboxProps.codegen';
7
- export type { CalendarProps } from './CalendarProps.codegen';
8
- export type { CheckboxGroupProps } from './CheckboxGroupProps.codegen';
9
- export type { CodeBlockProps } from './CodeBlockProps.codegen';
10
- export type { CodeProps } from './CodeProps.codegen';
11
- export type { DatePickerProps } from './DatePickerProps.codegen';
12
- export type { DynamicTableProps } from './DynamicTableProps.codegen';
13
- export type { EmptyStateProps } from './EmptyStateProps.codegen';
14
- export type { ErrorMessageProps } from './ErrorMessageProps.codegen';
15
- export type { FlexProps } from './FlexProps.codegen';
16
- export type { FormFooterProps } from './FormFooterProps.codegen';
17
- export type { FormHeaderProps } from './FormHeaderProps.codegen';
18
- export type { FormProps } from './FormProps.codegen';
19
- export type { FormSectionProps } from './FormSectionProps.codegen';
20
- export type { GridProps } from './GridProps.codegen';
21
- export type { HeadingProps } from './HeadingProps.codegen';
22
- export type { HelperMessageProps } from './HelperMessageProps.codegen';
23
- export type { IconProps } from './IconProps.codegen';
24
- export type { InlineProps } from './InlineProps.codegen';
25
- export type { InlineEditProps } from './InlineEditProps.codegen';
26
- export type { LabelProps } from './LabelProps.codegen';
27
- export type { LinkButtonProps } from './LinkButtonProps.codegen';
28
- export type { ListProps } from './ListProps.codegen';
29
- export type { ListItemProps } from './ListItemProps.codegen';
30
- export type { LoadingButtonProps } from './LoadingButtonProps.codegen';
31
- export type { LozengeProps } from './LozengeProps.codegen';
32
- export type { ModalBodyProps } from './ModalBodyProps.codegen';
33
- export type { ModalFooterProps } from './ModalFooterProps.codegen';
34
- export type { ModalHeaderProps } from './ModalHeaderProps.codegen';
35
- export type { ModalProps } from './ModalProps.codegen';
36
- export type { ModalTitleProps } from './ModalTitleProps.codegen';
37
- export type { ModalTransitionProps } from './ModalTransitionProps.codegen';
38
- export type { ProgressBarProps } from './ProgressBarProps.codegen';
39
- export type { ProgressTrackerProps } from './ProgressTrackerProps.codegen';
40
- export type { RadioGroupProps } from './RadioGroupProps.codegen';
41
- export type { RadioProps } from './RadioProps.codegen';
42
- export type { RangeProps } from './RangeProps.codegen';
43
- export type { SectionMessageActionProps } from './SectionMessageActionProps.codegen';
44
- export type { SectionMessageProps } from './SectionMessageProps.codegen';
45
- export type { SelectProps } from './SelectProps.codegen';
46
- export type { SpinnerProps } from './SpinnerProps.codegen';
47
- export type { StackProps } from './StackProps.codegen';
48
- export type { TabListProps } from './TabListProps.codegen';
49
- export type { TabPanelProps } from './TabPanelProps.codegen';
50
- export type { TabProps } from './TabProps.codegen';
51
- export type { TabsProps } from './TabsProps.codegen';
52
- export type { TagGroupProps } from './TagGroupProps.codegen';
53
- export type { SimpleTagProps as TagProps } from './TagProps.codegen';
54
- export type { TextAreaProps } from './TextAreaProps.codegen';
55
- export type { TextfieldProps } from './TextfieldProps.codegen';
56
- export type { TimePickerProps } from './TimePickerProps.codegen';
57
- export type { ToggleProps } from './ToggleProps.codegen';
58
- export type { TooltipProps } from './TooltipProps.codegen';
59
- export type { ValidMessageProps } from './ValidMessageProps.codegen';
60
- export type { PopupProps } from './PopupProps.codegen';
4
+ export type { ButtonGroupProps, TButtonGroup } from './ButtonGroupProps.codegen';
5
+ export type { ButtonProps, TButton } from './ButtonProps.codegen';
6
+ export type { CheckboxProps, TCheckbox } from './CheckboxProps.codegen';
7
+ export type { CalendarProps, TCalendar } from './CalendarProps.codegen';
8
+ export type { CheckboxGroupProps, TCheckboxGroup } from './CheckboxGroupProps.codegen';
9
+ export type { CodeBlockProps, TCodeBlock } from './CodeBlockProps.codegen';
10
+ export type { CodeProps, TCode } from './CodeProps.codegen';
11
+ export type { DatePickerProps, TDatePicker } from './DatePickerProps.codegen';
12
+ export type { DynamicTableProps, TDynamicTable } from './DynamicTableProps.codegen';
13
+ export type { EmptyStateProps, TEmptyState } from './EmptyStateProps.codegen';
14
+ export type { ErrorMessageProps, TErrorMessage } from './ErrorMessageProps.codegen';
15
+ export type { FlexProps, TFlex } from './FlexProps.codegen';
16
+ export type { FormFooterProps, TFormFooter } from './FormFooterProps.codegen';
17
+ export type { FormHeaderProps, TFormHeader } from './FormHeaderProps.codegen';
18
+ export type { FormProps, TForm } from './FormProps.codegen';
19
+ export type { FormSectionProps, TFormSection } from './FormSectionProps.codegen';
20
+ export type { GridProps, TGrid } from './GridProps.codegen';
21
+ export type { HeadingProps, THeading } from './HeadingProps.codegen';
22
+ export type { HelperMessageProps, THelperMessage } from './HelperMessageProps.codegen';
23
+ export type { IconProps, TIcon } from './IconProps.codegen';
24
+ export type { InlineProps, TInline } from './InlineProps.codegen';
25
+ export type { InlineEditProps, TInlineEdit } from './InlineEditProps.codegen';
26
+ export type { LabelProps, TLabel } from './LabelProps.codegen';
27
+ export type { LinkButtonProps, TLinkButton } from './LinkButtonProps.codegen';
28
+ export type { ListProps, TList } from './ListProps.codegen';
29
+ export type { ListItemProps, TListItem } from './ListItemProps.codegen';
30
+ export type { LoadingButtonProps, TLoadingButton } from './LoadingButtonProps.codegen';
31
+ export type { LozengeProps, TLozenge } from './LozengeProps.codegen';
32
+ export type { ModalBodyProps, TModalBody } from './ModalBodyProps.codegen';
33
+ export type { ModalFooterProps, TModalFooter } from './ModalFooterProps.codegen';
34
+ export type { ModalHeaderProps, TModalHeader } from './ModalHeaderProps.codegen';
35
+ export type { ModalProps, TModal } from './ModalProps.codegen';
36
+ export type { ModalTitleProps, TModalTitle } from './ModalTitleProps.codegen';
37
+ export type { ModalTransitionProps, TModalTransition } from './ModalTransitionProps.codegen';
38
+ export type { ProgressBarProps, TProgressBar } from './ProgressBarProps.codegen';
39
+ export type { ProgressTrackerProps, TProgressTracker } from './ProgressTrackerProps.codegen';
40
+ export type { RadioGroupProps, TRadioGroup } from './RadioGroupProps.codegen';
41
+ export type { RadioProps, TRadio } from './RadioProps.codegen';
42
+ export type { RangeProps, TRange } from './RangeProps.codegen';
43
+ export type { SectionMessageActionProps, TSectionMessageAction } from './SectionMessageActionProps.codegen';
44
+ export type { SectionMessageProps, TSectionMessage } from './SectionMessageProps.codegen';
45
+ export type { SelectProps, TSelect } from './SelectProps.codegen';
46
+ export type { SpinnerProps, TSpinner } from './SpinnerProps.codegen';
47
+ export type { StackProps, TStack } from './StackProps.codegen';
48
+ export type { TabListProps, TTabList } from './TabListProps.codegen';
49
+ export type { TabPanelProps, TTabPanel } from './TabPanelProps.codegen';
50
+ export type { TabProps, TTab } from './TabProps.codegen';
51
+ export type { TabsProps, TTabs } from './TabsProps.codegen';
52
+ export type { TagGroupProps, TTagGroup } from './TagGroupProps.codegen';
53
+ export type { SimpleTagProps as TagProps, TSimpleTag as TTag } from './TagProps.codegen';
54
+ export type { TextAreaProps, TTextArea } from './TextAreaProps.codegen';
55
+ export type { TextfieldProps, TTextfield } from './TextfieldProps.codegen';
56
+ export type { TimePickerProps, TTimePicker } from './TimePickerProps.codegen';
57
+ export type { ToggleProps, TToggle } from './ToggleProps.codegen';
58
+ export type { TooltipProps, TTooltip } from './TooltipProps.codegen';
59
+ export type { ValidMessageProps, TValidMessage } from './ValidMessageProps.codegen';
60
+ export type { PopupProps, TPopup } from './PopupProps.codegen';
61
61
  export type { AdfRendererProps, TAdfRenderer } from './AdfRendererProps.codegen';
62
62
  import type { TextProps as OriginalTextProps } from './TextProps.codegen';
63
63
  export type TextProps = Omit<OriginalTextProps, 'as'> & {
64
64
  as?: OriginalTextProps['as'] | 'strike';
65
65
  };
66
+ /**
67
+ * A typography component used to display body text.
68
+ * It can also include inline components such as
69
+ * [Badge](https://developer.atlassian.com/platform/forge/ui-kit/components/badge/) and
70
+ * [Lozenge](https://developer.atlassian.com/platform/forge/ui-kit/components/lozenge/).
71
+ */
72
+ export type TText<T> = (props: TextProps) => T;
@@ -1,20 +1,109 @@
1
1
  import type { ChartColorTokens } from '../../types';
2
2
  export type BarChartProps = {
3
+ /**
4
+ * The static width of the chart in pixels. If this is not specified, the width is responsive.
5
+ */
3
6
  width?: number;
7
+ /**
8
+ * The static height of the chart in pixels. Defaults to `400`.
9
+ */
4
10
  height?: number;
11
+ /**
12
+ * Data can be one of two formats:
13
+ * 1. An [array of arrays](https://developer.atlassian.com/platform/forge/ui-kit/components/bar-chart/#1--array-of-arrays).
14
+ * 2. An [array of objects](https://developer.atlassian.com/platform/forge/ui-kit/components/bar-chart/#2--array-of-objects).
15
+ */
5
16
  data: unknown[];
17
+ /**
18
+ * Boolean to display the chart border. Defaults to `false`.
19
+ */
6
20
  showBorder?: boolean;
21
+ /**
22
+ * Accessor to define the x-axis values. This can be a numerical or string index.
23
+ * For more information on all accessors, see [Data](https://developer.atlassian.com/platform/forge/ui-kit/components/bar-chart/#data).
24
+ */
7
25
  xAccessor: number | string;
26
+ /**
27
+ * Accessor to define the y-axis values.
28
+ */
8
29
  yAccessor: number | string;
30
+ /**
31
+ * Accessor to define the color grouping.
32
+ */
9
33
  colorAccessor?: number | string;
34
+ /**
35
+ * A string value that represents the title of the chart.
36
+ */
10
37
  title?: string;
38
+ /**
39
+ * A string value that represents the subtitle of the chart. This appears below the title.
40
+ */
11
41
  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
+ */
12
46
  colors?: ChartColorTokens[];
13
47
  };
14
48
  type StackChartProps = BarChartProps & {
49
+ /**
50
+ * Accessor to define the color grouping.
51
+ */
15
52
  colorAccessor: number | string;
16
53
  };
17
- export type HorizontalBarChartProps = BarChartProps;
18
- export type StackBarChartProps = StackChartProps;
19
- export type HorizontalStackBarChartProps = StackChartProps;
54
+ export type HorizontalBarChartProps = BarChartProps & {
55
+ /**
56
+ * Data can be one of two formats:
57
+ * 1. An [array of arrays](https://developer.atlassian.com/platform/forge/ui-kit/components/horizontal-bar-chart/#1--array-of-arrays).
58
+ * 2. An [array of objects](https://developer.atlassian.com/platform/forge/ui-kit/components/horizontal-bar-chart/#2--array-of-objects).
59
+ */
60
+ data: unknown[];
61
+ /**
62
+ * Accessor to define the x-axis values. This can be a numerical or string index.
63
+ * For more information on all accessors, see [Data](https://developer.atlassian.com/platform/forge/ui-kit/components/horizontal-bar-chart/#data).
64
+ */
65
+ xAccessor: number | string;
66
+ };
67
+ export type StackBarChartProps = StackChartProps & {
68
+ /**
69
+ * Data can be one of two formats:
70
+ * 1. An [array of arrays](https://developer.atlassian.com/platform/forge/ui-kit/components/stack-bar-chart/#1--array-of-arrays).
71
+ * 2. An [array of objects](https://developer.atlassian.com/platform/forge/ui-kit/components/stack-bar-chart/#2--array-of-objects).
72
+ */
73
+ data: unknown[];
74
+ /**
75
+ * Accessor to define the x-axis values. This can be a numerical or string index.
76
+ * For more information on all accessors, see [Data](https://developer.atlassian.com/platform/forge/ui-kit/components/stack-bar-chart/#data).
77
+ */
78
+ xAccessor: number | string;
79
+ };
80
+ export type HorizontalStackBarChartProps = StackChartProps & {
81
+ /**
82
+ * Data can be one of two formats:
83
+ * 1. An [array of arrays](https://developer.atlassian.com/platform/forge/ui-kit/components/horizontal-stack-bar-chart/#1--array-of-arrays).
84
+ * 2. An [array of objects](https://developer.atlassian.com/platform/forge/ui-kit/components/horizontal-stack-bar-chart/#2--array-of-objects).
85
+ */
86
+ data: unknown[];
87
+ /**
88
+ * Accessor to define the x-axis values. This can be a numerical or string index.
89
+ * For more information on all accessors, see [Data](https://developer.atlassian.com/platform/forge/ui-kit/components/horizontal-stack-bar-chart/#data).
90
+ */
91
+ xAccessor: number | string;
92
+ };
93
+ /**
94
+ * A visual representation of data using rectangular bars of varying heights to compare different categories or values.
95
+ */
96
+ export type TBarChart<T> = (props: BarChartProps) => T;
97
+ /**
98
+ * A visual representation of data using horizontal rectangular bars of varying lengths to compare different categories or values.
99
+ */
100
+ export type THorizontalBarChart<T> = (props: HorizontalBarChartProps) => T;
101
+ /**
102
+ * A visual representation of data using rectangular bars of varying heights to demonstrate comparisons between categories of data.
103
+ */
104
+ export type TStackBarChart<T> = (props: StackBarChartProps) => T;
105
+ /**
106
+ * A visual representation of data using horizontal rectangular bars of varying lengths to demonstrate comparisons between categories of data.
107
+ */
108
+ export type THorizontalStackBarChart<T> = (props: HorizontalStackBarChartProps) => T;
20
109
  export {};
@@ -1,13 +1,48 @@
1
1
  import type { ChartColorTokens } from '../../types';
2
2
  export type LineChartProps = {
3
+ /**
4
+ * The static width of the chart in pixels. If this is not specified, the width is responsive.
5
+ */
3
6
  width?: number;
7
+ /**
8
+ * The static height of the chart in pixels. Defaults to `400`.
9
+ */
4
10
  height?: number;
11
+ /**
12
+ * Data can be one of two formats:
13
+ * 1. An [array of arrays](https://developer.atlassian.com/platform/forge/ui-kit/components/line-chart/#1--array-of-arrays).
14
+ * 2. An [array of objects](https://developer.atlassian.com/platform/forge/ui-kit/components/line-chart/#2--array-of-objects).
15
+ */
5
16
  data: unknown[];
6
17
  showBorder?: boolean;
18
+ /**
19
+ * Accessor to define the x-axis values. This can be a numerical or string index.
20
+ * For more information on all accessors, see [Data](https://developer.atlassian.com/platform/forge/ui-kit/components/line-chart/#data).
21
+ */
7
22
  xAccessor: number | string;
23
+ /**
24
+ * Accessor to define the y-axis values.
25
+ */
8
26
  yAccessor: number | string;
27
+ /**
28
+ * Accessor to define the color grouping.
29
+ */
9
30
  colorAccessor?: number | string;
31
+ /**
32
+ * A string value that represents the title of the chart.
33
+ */
10
34
  title?: string;
35
+ /**
36
+ * A string value that represents the subtitle of the chart. This appears below the title.
37
+ */
11
38
  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
+ */
12
43
  colors?: ChartColorTokens[];
13
44
  };
45
+ /**
46
+ * A visual representation of data showing trends.
47
+ */
48
+ export type TLineChart<T> = (props: LineChartProps) => T;
@@ -1,15 +1,59 @@
1
1
  import type { ChartColorTokens } from '../../types';
2
2
  export type PieChartProps = {
3
+ /**
4
+ * The static width of the chart in pixels. If this is not specified, the width is responsive.
5
+ */
3
6
  width?: number;
7
+ /**
8
+ * The static height of the chart in pixels. Defaults to `400`.
9
+ */
4
10
  height?: number;
11
+ /**
12
+ * Data can be one of two formats:
13
+ * 1. [Array of arrays](https://developer.atlassian.com/platform/forge/ui-kit/components/pie-chart/#1--array-of-arrays).
14
+ * 2. [Array of objects](https://developer.atlassian.com/platform/forge/ui-kit/components/pie-chart/#2--array-of-objects).
15
+ */
5
16
  data: unknown[];
17
+ /**
18
+ * Boolean to display the chart border. Defaults to `false`.
19
+ */
6
20
  showBorder?: boolean;
21
+ /**
22
+ * Accessor to define the color grouping. This can be a numerical or string index.
23
+ * For more information on all accessors, see [Data](https://developer.atlassian.com/platform/forge/ui-kit/components/pie-chart/#data).
24
+ */
7
25
  colorAccessor: number | string;
26
+ /**
27
+ * Accessor to define the angle of arcs in a pie.
28
+ */
8
29
  valueAccessor: number | string;
30
+ /**
31
+ * Accessor to define the labels.
32
+ */
9
33
  labelAccessor: number | string;
34
+ /**
35
+ * A string value that represents the title of the chart.
36
+ */
10
37
  title?: string;
38
+ /**
39
+ * A string value that represents the subtitle of the chart. This appears below the title.
40
+ */
11
41
  subtitle?: string;
42
+ /**
43
+ * Boolean to render the pie as the donut variation. Defaults to `false`.
44
+ */
12
45
  isDonut?: boolean;
46
+ /**
47
+ * Boolean to display labels on top of each slice. Defaults to `false`.
48
+ */
13
49
  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
+ */
14
54
  colors?: ChartColorTokens[];
15
55
  };
56
+ /**
57
+ * A visual representation of data proportions in a circular format.
58
+ */
59
+ export type TPieChart<T> = (props: PieChartProps) => T;