@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.
- package/CHANGELOG.md +16 -0
- package/dist/types/components/__generated__/ButtonGroupProps.codegen.d.ts +3 -3
- package/dist/types/components/__generated__/ButtonProps.codegen.d.ts +5 -2
- package/dist/types/components/__generated__/CheckboxGroupProps.codegen.d.ts +21 -2
- package/dist/types/components/__generated__/DatePickerProps.codegen.d.ts +3 -3
- package/dist/types/components/__generated__/ErrorMessageProps.codegen.d.ts +4 -3
- package/dist/types/components/__generated__/FormFooterProps.codegen.d.ts +12 -4
- package/dist/types/components/__generated__/FormHeaderProps.codegen.d.ts +5 -3
- package/dist/types/components/__generated__/FormProps.codegen.d.ts +14 -2
- package/dist/types/components/__generated__/FormSectionProps.codegen.d.ts +4 -3
- package/dist/types/components/__generated__/HelperMessageProps.codegen.d.ts +4 -3
- package/dist/types/components/__generated__/IconProps.codegen.d.ts +22 -2
- package/dist/types/components/__generated__/InlineEditProps.codegen.d.ts +6 -2
- package/dist/types/components/__generated__/InlineProps.codegen.d.ts +3 -3
- package/dist/types/components/__generated__/LabelProps.codegen.d.ts +3 -3
- package/dist/types/components/__generated__/LinkButtonProps.codegen.d.ts +5 -2
- package/dist/types/components/__generated__/ListItemProps.codegen.d.ts +3 -2
- package/dist/types/components/__generated__/ListProps.codegen.d.ts +14 -2
- package/dist/types/components/__generated__/LoadingButtonProps.codegen.d.ts +3 -3
- package/dist/types/components/__generated__/ModalBodyProps.codegen.d.ts +3 -3
- package/dist/types/components/__generated__/ModalFooterProps.codegen.d.ts +4 -3
- package/dist/types/components/__generated__/ModalHeaderProps.codegen.d.ts +3 -3
- package/dist/types/components/__generated__/ModalTitleProps.codegen.d.ts +3 -3
- package/dist/types/components/__generated__/ModalTransitionProps.codegen.d.ts +3 -3
- package/dist/types/components/__generated__/PopupProps.codegen.d.ts +15 -2
- package/dist/types/components/__generated__/SelectProps.codegen.d.ts +6 -2
- package/dist/types/components/__generated__/StackProps.codegen.d.ts +3 -3
- package/dist/types/components/__generated__/TabListProps.codegen.d.ts +3 -3
- package/dist/types/components/__generated__/TabPanelProps.codegen.d.ts +3 -3
- package/dist/types/components/__generated__/TabProps.codegen.d.ts +3 -3
- package/dist/types/components/__generated__/TextAreaProps.codegen.d.ts +6 -2
- package/dist/types/components/__generated__/TextfieldProps.codegen.d.ts +6 -2
- package/dist/types/components/__generated__/TimePickerProps.codegen.d.ts +3 -3
- package/dist/types/components/__generated__/TooltipProps.codegen.d.ts +3 -3
- package/dist/types/components/__generated__/ValidMessageProps.codegen.d.ts +4 -3
- package/dist/types/components/__generated__/index.d.ts +65 -58
- package/dist/types/components/charts/BarChartProps.d.ts +92 -3
- package/dist/types/components/charts/LineChartProps.d.ts +35 -0
- package/dist/types/components/charts/PieChartProps.d.ts +44 -0
- package/dist/types/components/charts/SingleValueChartProps.d.ts +25 -0
- package/dist/types/components/charts/index.d.ts +4 -4
- package/dist/types/index.d.ts +1 -1
- package/dist/types-ts4.5/components/__generated__/ButtonGroupProps.codegen.d.ts +3 -3
- package/dist/types-ts4.5/components/__generated__/ButtonProps.codegen.d.ts +5 -2
- package/dist/types-ts4.5/components/__generated__/CheckboxGroupProps.codegen.d.ts +21 -2
- package/dist/types-ts4.5/components/__generated__/DatePickerProps.codegen.d.ts +3 -3
- package/dist/types-ts4.5/components/__generated__/ErrorMessageProps.codegen.d.ts +4 -3
- package/dist/types-ts4.5/components/__generated__/FormFooterProps.codegen.d.ts +12 -4
- package/dist/types-ts4.5/components/__generated__/FormHeaderProps.codegen.d.ts +5 -3
- package/dist/types-ts4.5/components/__generated__/FormProps.codegen.d.ts +14 -2
- package/dist/types-ts4.5/components/__generated__/FormSectionProps.codegen.d.ts +4 -3
- package/dist/types-ts4.5/components/__generated__/HelperMessageProps.codegen.d.ts +4 -3
- package/dist/types-ts4.5/components/__generated__/IconProps.codegen.d.ts +22 -2
- package/dist/types-ts4.5/components/__generated__/InlineEditProps.codegen.d.ts +6 -2
- package/dist/types-ts4.5/components/__generated__/InlineProps.codegen.d.ts +3 -3
- package/dist/types-ts4.5/components/__generated__/LabelProps.codegen.d.ts +3 -3
- package/dist/types-ts4.5/components/__generated__/LinkButtonProps.codegen.d.ts +5 -2
- package/dist/types-ts4.5/components/__generated__/ListItemProps.codegen.d.ts +3 -2
- package/dist/types-ts4.5/components/__generated__/ListProps.codegen.d.ts +14 -2
- package/dist/types-ts4.5/components/__generated__/LoadingButtonProps.codegen.d.ts +3 -3
- package/dist/types-ts4.5/components/__generated__/ModalBodyProps.codegen.d.ts +3 -3
- package/dist/types-ts4.5/components/__generated__/ModalFooterProps.codegen.d.ts +4 -3
- package/dist/types-ts4.5/components/__generated__/ModalHeaderProps.codegen.d.ts +3 -3
- package/dist/types-ts4.5/components/__generated__/ModalTitleProps.codegen.d.ts +3 -3
- package/dist/types-ts4.5/components/__generated__/ModalTransitionProps.codegen.d.ts +3 -3
- package/dist/types-ts4.5/components/__generated__/PopupProps.codegen.d.ts +15 -2
- package/dist/types-ts4.5/components/__generated__/SelectProps.codegen.d.ts +6 -2
- package/dist/types-ts4.5/components/__generated__/StackProps.codegen.d.ts +3 -3
- package/dist/types-ts4.5/components/__generated__/TabListProps.codegen.d.ts +3 -3
- package/dist/types-ts4.5/components/__generated__/TabPanelProps.codegen.d.ts +3 -3
- package/dist/types-ts4.5/components/__generated__/TabProps.codegen.d.ts +3 -3
- package/dist/types-ts4.5/components/__generated__/TextAreaProps.codegen.d.ts +6 -2
- package/dist/types-ts4.5/components/__generated__/TextfieldProps.codegen.d.ts +6 -2
- package/dist/types-ts4.5/components/__generated__/TimePickerProps.codegen.d.ts +3 -3
- package/dist/types-ts4.5/components/__generated__/TooltipProps.codegen.d.ts +3 -3
- package/dist/types-ts4.5/components/__generated__/ValidMessageProps.codegen.d.ts +4 -3
- package/dist/types-ts4.5/components/__generated__/index.d.ts +65 -58
- package/dist/types-ts4.5/components/charts/BarChartProps.d.ts +92 -3
- package/dist/types-ts4.5/components/charts/LineChartProps.d.ts +35 -0
- package/dist/types-ts4.5/components/charts/PieChartProps.d.ts +44 -0
- package/dist/types-ts4.5/components/charts/SingleValueChartProps.d.ts +25 -0
- package/dist/types-ts4.5/components/charts/index.d.ts +4 -4
- package/dist/types-ts4.5/index.d.ts +1 -1
- package/package.json +4 -4
- package/src/components/__generated__/ButtonGroupProps.codegen.tsx +3 -3
- package/src/components/__generated__/ButtonProps.codegen.tsx +5 -2
- package/src/components/__generated__/CheckboxGroupProps.codegen.tsx +26 -3
- package/src/components/__generated__/DatePickerProps.codegen.tsx +3 -3
- package/src/components/__generated__/ErrorMessageProps.codegen.tsx +4 -3
- package/src/components/__generated__/FormFooterProps.codegen.tsx +12 -4
- package/src/components/__generated__/FormHeaderProps.codegen.tsx +5 -3
- package/src/components/__generated__/FormProps.codegen.tsx +14 -2
- package/src/components/__generated__/FormSectionProps.codegen.tsx +4 -3
- package/src/components/__generated__/HelperMessageProps.codegen.tsx +4 -3
- package/src/components/__generated__/IconProps.codegen.tsx +22 -2
- package/src/components/__generated__/InlineEditProps.codegen.tsx +8 -3
- package/src/components/__generated__/InlineProps.codegen.tsx +3 -3
- package/src/components/__generated__/LabelProps.codegen.tsx +3 -3
- package/src/components/__generated__/LinkButtonProps.codegen.tsx +5 -2
- package/src/components/__generated__/ListItemProps.codegen.tsx +5 -3
- package/src/components/__generated__/ListProps.codegen.tsx +16 -3
- package/src/components/__generated__/LoadingButtonProps.codegen.tsx +17 -5
- package/src/components/__generated__/ModalBodyProps.codegen.tsx +3 -3
- package/src/components/__generated__/ModalFooterProps.codegen.tsx +4 -3
- package/src/components/__generated__/ModalHeaderProps.codegen.tsx +3 -3
- package/src/components/__generated__/ModalTitleProps.codegen.tsx +3 -3
- package/src/components/__generated__/ModalTransitionProps.codegen.tsx +3 -3
- package/src/components/__generated__/PopupProps.codegen.tsx +18 -3
- package/src/components/__generated__/SelectProps.codegen.tsx +8 -3
- package/src/components/__generated__/StackProps.codegen.tsx +3 -3
- package/src/components/__generated__/TabListProps.codegen.tsx +3 -3
- package/src/components/__generated__/TabPanelProps.codegen.tsx +3 -3
- package/src/components/__generated__/TabProps.codegen.tsx +3 -3
- package/src/components/__generated__/TextAreaProps.codegen.tsx +8 -3
- package/src/components/__generated__/TextfieldProps.codegen.tsx +8 -3
- package/src/components/__generated__/TimePickerProps.codegen.tsx +3 -3
- package/src/components/__generated__/TooltipProps.codegen.tsx +3 -3
- package/src/components/__generated__/ValidMessageProps.codegen.tsx +4 -3
- package/src/components/__generated__/index.ts +67 -59
- package/src/components/charts/BarChartProps.tsx +101 -3
- package/src/components/charts/LineChartProps.tsx +36 -0
- package/src/components/charts/PieChartProps.tsx +45 -0
- package/src/components/charts/SingleValueChartProps.tsx +26 -0
- package/src/components/charts/index.ts +7 -3
- package/src/index.ts +59 -0
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
*
|
|
4
4
|
* Extract component prop types from UIKit 2 components - ModalBodyProps
|
|
5
5
|
*
|
|
6
|
-
* @codegen <<SignedSource::
|
|
6
|
+
* @codegen <<SignedSource::8999036a80e16ad1e4655a8fec69ccdd>>
|
|
7
7
|
* @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
|
|
8
|
-
* @codegenDependency ../../../../forge-ui/src/components/UIKit/modal/__generated__/modal-body.partial.tsx <<SignedSource::
|
|
8
|
+
* @codegenDependency ../../../../forge-ui/src/components/UIKit/modal/__generated__/modal-body.partial.tsx <<SignedSource::627540a6559205080b7e35c17eb83204>>
|
|
9
9
|
*/
|
|
10
10
|
/* eslint @repo/internal/codegen/signed-source-integrity: "warn" */
|
|
11
11
|
|
|
@@ -20,6 +20,6 @@ export type ModalBodyProps = Pick<
|
|
|
20
20
|
>;
|
|
21
21
|
|
|
22
22
|
/**
|
|
23
|
-
* A modal
|
|
23
|
+
* A modal body is used to display the main content of a modal.
|
|
24
24
|
*/
|
|
25
25
|
export type TModalBody<T> = (props: ModalBodyProps) => T;
|
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
*
|
|
4
4
|
* Extract component prop types from UIKit 2 components - ModalFooterProps
|
|
5
5
|
*
|
|
6
|
-
* @codegen <<SignedSource::
|
|
6
|
+
* @codegen <<SignedSource::4760b46222d502cf6397bfc1ee866e35>>
|
|
7
7
|
* @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
|
|
8
|
-
* @codegenDependency ../../../../forge-ui/src/components/UIKit/modal/__generated__/modal-footer.partial.tsx <<SignedSource::
|
|
8
|
+
* @codegenDependency ../../../../forge-ui/src/components/UIKit/modal/__generated__/modal-footer.partial.tsx <<SignedSource::0ff399d8f02a70c539a63e9466091768>>
|
|
9
9
|
*/
|
|
10
10
|
/* eslint @repo/internal/codegen/signed-source-integrity: "warn" */
|
|
11
11
|
|
|
@@ -20,6 +20,7 @@ export type ModalFooterProps = Pick<
|
|
|
20
20
|
>;
|
|
21
21
|
|
|
22
22
|
/**
|
|
23
|
-
* A modal
|
|
23
|
+
* A modal footer often contains a primary action and the ability to cancel and close the dialog,
|
|
24
|
+
* though can contain any React element.
|
|
24
25
|
*/
|
|
25
26
|
export type TModalFooter<T> = (props: ModalFooterProps) => T;
|
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
*
|
|
4
4
|
* Extract component prop types from UIKit 2 components - ModalHeaderProps
|
|
5
5
|
*
|
|
6
|
-
* @codegen <<SignedSource::
|
|
6
|
+
* @codegen <<SignedSource::d870076a8f40ef1ca2f514ccccd8d14c>>
|
|
7
7
|
* @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
|
|
8
|
-
* @codegenDependency ../../../../forge-ui/src/components/UIKit/modal/__generated__/modal-header.partial.tsx <<SignedSource::
|
|
8
|
+
* @codegenDependency ../../../../forge-ui/src/components/UIKit/modal/__generated__/modal-header.partial.tsx <<SignedSource::9102fefee5c2fe6cbee65bf860d29652>>
|
|
9
9
|
*/
|
|
10
10
|
/* eslint @repo/internal/codegen/signed-source-integrity: "warn" */
|
|
11
11
|
|
|
@@ -20,6 +20,6 @@ export type ModalHeaderProps = Pick<
|
|
|
20
20
|
>;
|
|
21
21
|
|
|
22
22
|
/**
|
|
23
|
-
* A modal
|
|
23
|
+
* A modal header contains the title of the modal and can contain other React elements such as a close button.
|
|
24
24
|
*/
|
|
25
25
|
export type TModalHeader<T> = (props: ModalHeaderProps) => T;
|
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
*
|
|
4
4
|
* Extract component prop types from UIKit 2 components - ModalTitleProps
|
|
5
5
|
*
|
|
6
|
-
* @codegen <<SignedSource::
|
|
6
|
+
* @codegen <<SignedSource::1742968eb34a6998cf335abcdb9ecd22>>
|
|
7
7
|
* @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
|
|
8
|
-
* @codegenDependency ../../../../forge-ui/src/components/UIKit/modal/__generated__/modal-title.partial.tsx <<SignedSource::
|
|
8
|
+
* @codegenDependency ../../../../forge-ui/src/components/UIKit/modal/__generated__/modal-title.partial.tsx <<SignedSource::8f0848e3fabd3cf3660c08e2b1863bd9>>
|
|
9
9
|
*/
|
|
10
10
|
/* eslint @repo/internal/codegen/signed-source-integrity: "warn" */
|
|
11
11
|
|
|
@@ -20,6 +20,6 @@ export type ModalTitleProps = Pick<
|
|
|
20
20
|
>;
|
|
21
21
|
|
|
22
22
|
/**
|
|
23
|
-
* A modal
|
|
23
|
+
* A modal title is used to display a title within a modal.
|
|
24
24
|
*/
|
|
25
25
|
export type TModalTitle<T> = (props: ModalTitleProps) => T;
|
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
*
|
|
4
4
|
* Extract component prop types from UIKit 2 components - ModalTransitionProps
|
|
5
5
|
*
|
|
6
|
-
* @codegen <<SignedSource::
|
|
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::
|
|
8
|
+
* @codegenDependency ../../../../forge-ui/src/components/UIKit/modal/__generated__/modal-transition.partial.tsx <<SignedSource::9a5d35aaedbe614414c801acffdbeeff>>
|
|
9
9
|
*/
|
|
10
10
|
/* eslint @repo/internal/codegen/signed-source-integrity: "warn" */
|
|
11
11
|
|
|
@@ -20,6 +20,6 @@ export type ModalTransitionProps = Pick<
|
|
|
20
20
|
>;
|
|
21
21
|
|
|
22
22
|
/**
|
|
23
|
-
* A modal
|
|
23
|
+
* A modal transition wraps a modal to provide a fluid transition upon opening and closing.
|
|
24
24
|
*/
|
|
25
25
|
export type TModalTransition<T> = (props: ModalTransitionProps) => T;
|
|
@@ -3,15 +3,25 @@
|
|
|
3
3
|
*
|
|
4
4
|
* Extract component prop types from UIKit 2 components - PopupProps
|
|
5
5
|
*
|
|
6
|
-
* @codegen <<SignedSource::
|
|
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::
|
|
8
|
+
* @codegenDependency ../../../../forge-ui/src/components/UIKit/popup/index.tsx <<SignedSource::cafa3868628edc1953d996c860801ed5>>
|
|
9
9
|
*/
|
|
10
10
|
/* eslint @repo/internal/codegen/signed-source-integrity: "warn" */
|
|
11
11
|
|
|
12
12
|
import React from 'react';
|
|
13
13
|
import { default as PlatformPopup } from '@atlaskit/popup';
|
|
14
14
|
|
|
15
|
+
/**
|
|
16
|
+
* Design decisions made:
|
|
17
|
+
* `zIndex` and `offset` are excluded to constrain the appearance of the popup.
|
|
18
|
+
*
|
|
19
|
+
* `boundary` has been changed as the ADS type can also expect an HTMLElement to be passed in, which cannot work with Forge.
|
|
20
|
+
*
|
|
21
|
+
* `popupComponent` is excluded as the same customisation can be done with `Box` in content
|
|
22
|
+
*
|
|
23
|
+
*/
|
|
24
|
+
// Public API
|
|
15
25
|
export type PopupProps = Omit<
|
|
16
26
|
React.ComponentProps<typeof PlatformPopup>,
|
|
17
27
|
'popupComponent' | 'zIndex' | 'offset' | 'boundary'
|
|
@@ -19,4 +29,9 @@ export type PopupProps = Omit<
|
|
|
19
29
|
boundary?: 'clippingParents';
|
|
20
30
|
content: () => React.ReactNode;
|
|
21
31
|
trigger: () => React.ReactNode;
|
|
22
|
-
};
|
|
32
|
+
};
|
|
33
|
+
|
|
34
|
+
/**
|
|
35
|
+
* A popup displays brief content in an overlay.
|
|
36
|
+
*/
|
|
37
|
+
export type TPopup<T> = (props: PopupProps) => T;
|
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
*
|
|
4
4
|
* Extract component prop types from UIKit 2 components - SelectProps
|
|
5
5
|
*
|
|
6
|
-
* @codegen <<SignedSource::
|
|
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::
|
|
8
|
+
* @codegenDependency ../../../../forge-ui/src/components/UIKit/select/index.tsx <<SignedSource::f7eed13874b04c56ded5f3434e03c70e>>
|
|
9
9
|
*/
|
|
10
10
|
/* eslint @repo/internal/codegen/signed-source-integrity: "warn" */
|
|
11
11
|
|
|
@@ -43,4 +43,9 @@ export type SelectProps = Pick<
|
|
|
43
43
|
| 'testId'
|
|
44
44
|
| 'value'
|
|
45
45
|
| 'isRequired'
|
|
46
|
-
>;
|
|
46
|
+
>;
|
|
47
|
+
|
|
48
|
+
/**
|
|
49
|
+
* Select allows users to make a single selection or multiple selections from a list of options.
|
|
50
|
+
*/
|
|
51
|
+
export type TSelect<T> = (props: SelectProps) => T;
|
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
*
|
|
4
4
|
* Extract component prop types from UIKit 2 components - StackProps
|
|
5
5
|
*
|
|
6
|
-
* @codegen <<SignedSource::
|
|
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::
|
|
8
|
+
* @codegenDependency ../../../../forge-ui/src/components/UIKit/stack/__generated__/index.partial.tsx <<SignedSource::191f725f0992bea2117b07b99f6444de>>
|
|
9
9
|
*/
|
|
10
10
|
/* eslint @repo/internal/codegen/signed-source-integrity: "warn" */
|
|
11
11
|
|
|
@@ -20,6 +20,6 @@ export type StackProps = Pick<
|
|
|
20
20
|
>;
|
|
21
21
|
|
|
22
22
|
/**
|
|
23
|
-
*
|
|
23
|
+
* A stack manages the vertical layout of direct children using flexbox.
|
|
24
24
|
*/
|
|
25
25
|
export type TStack<T> = (props: StackProps) => T;
|
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
*
|
|
4
4
|
* Extract component prop types from UIKit 2 components - TabListProps
|
|
5
5
|
*
|
|
6
|
-
* @codegen <<SignedSource::
|
|
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::
|
|
8
|
+
* @codegenDependency ../../../../forge-ui/src/components/UIKit/tabs/__generated__/tablist.partial.tsx <<SignedSource::fbd3384538b87c1a820790b55241ee21>>
|
|
9
9
|
*/
|
|
10
10
|
/* eslint @repo/internal/codegen/signed-source-integrity: "warn" */
|
|
11
11
|
|
|
@@ -20,6 +20,6 @@ export type TabListProps = Pick<
|
|
|
20
20
|
>;
|
|
21
21
|
|
|
22
22
|
/**
|
|
23
|
-
*
|
|
23
|
+
* A `TabList` groups `Tab` components together.
|
|
24
24
|
*/
|
|
25
25
|
export type TTabList<T> = (props: TabListProps) => T;
|
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
*
|
|
4
4
|
* Extract component prop types from UIKit 2 components - TabPanelProps
|
|
5
5
|
*
|
|
6
|
-
* @codegen <<SignedSource::
|
|
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::
|
|
8
|
+
* @codegenDependency ../../../../forge-ui/src/components/UIKit/tabs/__generated__/tabpanel.partial.tsx <<SignedSource::e7936c96c90f8f4682c85a00f85a23f4>>
|
|
9
9
|
*/
|
|
10
10
|
/* eslint @repo/internal/codegen/signed-source-integrity: "warn" */
|
|
11
11
|
|
|
@@ -20,6 +20,6 @@ export type TabPanelProps = Pick<
|
|
|
20
20
|
>;
|
|
21
21
|
|
|
22
22
|
/**
|
|
23
|
-
*
|
|
23
|
+
* A `TabPanel` houses the contents of a `Tab`.
|
|
24
24
|
*/
|
|
25
25
|
export type TTabPanel<T> = (props: TabPanelProps) => T;
|
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
*
|
|
4
4
|
* Extract component prop types from UIKit 2 components - TabProps
|
|
5
5
|
*
|
|
6
|
-
* @codegen <<SignedSource::
|
|
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::
|
|
8
|
+
* @codegenDependency ../../../../forge-ui/src/components/UIKit/tabs/__generated__/tab.partial.tsx <<SignedSource::05b588ddfb6bfa200363a1127660dce4>>
|
|
9
9
|
*/
|
|
10
10
|
/* eslint @repo/internal/codegen/signed-source-integrity: "warn" */
|
|
11
11
|
|
|
@@ -20,6 +20,6 @@ export type TabProps = Pick<
|
|
|
20
20
|
>;
|
|
21
21
|
|
|
22
22
|
/**
|
|
23
|
-
*
|
|
23
|
+
* `Tab` represents an individual tab displayed in a TabList.
|
|
24
24
|
*/
|
|
25
25
|
export type TTab<T> = (props: TabProps) => T;
|
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
*
|
|
4
4
|
* Extract component prop types from UIKit 2 components - TextAreaProps
|
|
5
5
|
*
|
|
6
|
-
* @codegen <<SignedSource::
|
|
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::
|
|
8
|
+
* @codegenDependency ../../../../forge-ui/src/components/UIKit/textarea/index.tsx <<SignedSource::282c20421c108bd52e5341ba0ee4293c>>
|
|
9
9
|
*/
|
|
10
10
|
/* eslint @repo/internal/codegen/signed-source-integrity: "warn" */
|
|
11
11
|
|
|
@@ -40,4 +40,9 @@ export type TextAreaProps = Pick<
|
|
|
40
40
|
| 'aria-labelledby'
|
|
41
41
|
| 'name'
|
|
42
42
|
> &
|
|
43
|
-
Pick<EventHandlerProps, 'onChange' | 'onBlur' | 'onFocus'>;
|
|
43
|
+
Pick<EventHandlerProps, 'onChange' | 'onBlur' | 'onFocus'>;
|
|
44
|
+
|
|
45
|
+
/**
|
|
46
|
+
* A text area lets users enter long form text which spans over multiple lines.
|
|
47
|
+
*/
|
|
48
|
+
export type TTextArea<T> = (props: TextAreaProps) => T;
|
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
*
|
|
4
4
|
* Extract component prop types from UIKit 2 components - TextfieldProps
|
|
5
5
|
*
|
|
6
|
-
* @codegen <<SignedSource::
|
|
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::
|
|
8
|
+
* @codegenDependency ../../../../forge-ui/src/components/UIKit/textfield/index.tsx <<SignedSource::03b967815639a5a5aae4f79da283d410>>
|
|
9
9
|
*/
|
|
10
10
|
/* eslint @repo/internal/codegen/signed-source-integrity: "warn" */
|
|
11
11
|
|
|
@@ -43,4 +43,9 @@ export type TextfieldProps = Pick<
|
|
|
43
43
|
| 'aria-labelledby'
|
|
44
44
|
| 'name'
|
|
45
45
|
> &
|
|
46
|
-
Pick<EventHandlerProps, 'onChange' | 'onBlur' | 'onFocus'>;
|
|
46
|
+
Pick<EventHandlerProps, 'onChange' | 'onBlur' | 'onFocus'>;
|
|
47
|
+
|
|
48
|
+
/**
|
|
49
|
+
* A text field is an input that allows a user to write or edit text.
|
|
50
|
+
*/
|
|
51
|
+
export type TTextfield<T> = (props: TextfieldProps) => T;
|
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
*
|
|
4
4
|
* Extract component prop types from UIKit 2 components - TimePickerProps
|
|
5
5
|
*
|
|
6
|
-
* @codegen <<SignedSource::
|
|
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::
|
|
8
|
+
* @codegenDependency ../../../../forge-ui/src/components/UIKit/timepicker/__generated__/index.partial.tsx <<SignedSource::8f1c6ab03a29e7279ed2d3e82b086ab0>>
|
|
9
9
|
*/
|
|
10
10
|
/* eslint @repo/internal/codegen/signed-source-integrity: "warn" */
|
|
11
11
|
|
|
@@ -50,6 +50,6 @@ export type TimePickerProps = {
|
|
|
50
50
|
} & Partial<Omit<FieldProps, 'onChange'>>;
|
|
51
51
|
|
|
52
52
|
/**
|
|
53
|
-
* A
|
|
53
|
+
* A time picker allows the user to select a specific time.
|
|
54
54
|
*/
|
|
55
55
|
export type TTimePicker<T> = (props: TimePickerProps) => T;
|
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
*
|
|
4
4
|
* Extract component prop types from UIKit 2 components - TooltipProps
|
|
5
5
|
*
|
|
6
|
-
* @codegen <<SignedSource::
|
|
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::
|
|
8
|
+
* @codegenDependency ../../../../forge-ui/src/components/UIKit/tooltip/__generated__/index.partial.tsx <<SignedSource::e3e388170520502310149f23b8defa27>>
|
|
9
9
|
*/
|
|
10
10
|
/* eslint @repo/internal/codegen/signed-source-integrity: "warn" */
|
|
11
11
|
|
|
@@ -20,6 +20,6 @@ export type TooltipProps = Pick<
|
|
|
20
20
|
>;
|
|
21
21
|
|
|
22
22
|
/**
|
|
23
|
-
* A
|
|
23
|
+
* A `Tooltip` is a floating, non-actionable label used to explain a user interface element or feature.
|
|
24
24
|
*/
|
|
25
25
|
export type TTooltip<T> = (props: TooltipProps) => T;
|
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
*
|
|
4
4
|
* Extract component prop types from UIKit 2 components - ValidMessageProps
|
|
5
5
|
*
|
|
6
|
-
* @codegen <<SignedSource::
|
|
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::
|
|
8
|
+
* @codegenDependency ../../../../forge-ui/src/components/UIKit/form/__generated__/valid-message.partial.tsx <<SignedSource::7c24bfd118e399bb212709c31585209b>>
|
|
9
9
|
*/
|
|
10
10
|
/* eslint @repo/internal/codegen/signed-source-integrity: "warn" */
|
|
11
11
|
|
|
@@ -20,6 +20,7 @@ export type ValidMessageProps = Pick<
|
|
|
20
20
|
>;
|
|
21
21
|
|
|
22
22
|
/**
|
|
23
|
-
* A
|
|
23
|
+
* A valid message is used to tell a user that the field input is valid.
|
|
24
|
+
* For example, a helper message could be "Nice one, this username is available".
|
|
24
25
|
*/
|
|
25
26
|
export type TValidMessage<T> = (props: ValidMessageProps) => T;
|
|
@@ -1,66 +1,74 @@
|
|
|
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
|
|
|
63
63
|
// Forge UI supports the value "strike" for the "as" prop of the Text component, to have a migration path
|
|
64
64
|
// off using <Strike>. The native ADS Text component does not support it, so we patched it to support it.
|
|
65
|
-
import type { TextProps as OriginalTextProps } from './TextProps.codegen'
|
|
65
|
+
import type { TextProps as OriginalTextProps } from './TextProps.codegen';
|
|
66
66
|
export type TextProps = Omit<OriginalTextProps, 'as'> & { as?: OriginalTextProps['as'] | 'strike' };
|
|
67
|
+
|
|
68
|
+
/**
|
|
69
|
+
* A typography component used to display body text.
|
|
70
|
+
* It can also include inline components such as
|
|
71
|
+
* [Badge](https://developer.atlassian.com/platform/forge/ui-kit/components/badge/) and
|
|
72
|
+
* [Lozenge](https://developer.atlassian.com/platform/forge/ui-kit/components/lozenge/).
|
|
73
|
+
*/
|
|
74
|
+
export type TText<T> = (props: TextProps) => T;
|
|
@@ -1,22 +1,120 @@
|
|
|
1
1
|
import type { ChartColorTokens } from '../../types';
|
|
2
2
|
|
|
3
3
|
export type BarChartProps = {
|
|
4
|
+
/**
|
|
5
|
+
* The static width of the chart in pixels. If this is not specified, the width is responsive.
|
|
6
|
+
*/
|
|
4
7
|
width?: number;
|
|
8
|
+
/**
|
|
9
|
+
* The static height of the chart in pixels. Defaults to `400`.
|
|
10
|
+
*/
|
|
5
11
|
height?: number;
|
|
12
|
+
/**
|
|
13
|
+
* Data can be one of two formats:
|
|
14
|
+
* 1. An [array of arrays](https://developer.atlassian.com/platform/forge/ui-kit/components/bar-chart/#1--array-of-arrays).
|
|
15
|
+
* 2. An [array of objects](https://developer.atlassian.com/platform/forge/ui-kit/components/bar-chart/#2--array-of-objects).
|
|
16
|
+
*/
|
|
6
17
|
data: unknown[];
|
|
18
|
+
/**
|
|
19
|
+
* Boolean to display the chart border. Defaults to `false`.
|
|
20
|
+
*/
|
|
7
21
|
showBorder?: boolean;
|
|
22
|
+
/**
|
|
23
|
+
* Accessor to define the x-axis values. This can be a numerical or string index.
|
|
24
|
+
* For more information on all accessors, see [Data](https://developer.atlassian.com/platform/forge/ui-kit/components/bar-chart/#data).
|
|
25
|
+
*/
|
|
8
26
|
xAccessor: number | string;
|
|
27
|
+
/**
|
|
28
|
+
* Accessor to define the y-axis values.
|
|
29
|
+
*/
|
|
9
30
|
yAccessor: number | string;
|
|
31
|
+
/**
|
|
32
|
+
* Accessor to define the color grouping.
|
|
33
|
+
*/
|
|
10
34
|
colorAccessor?: number | string;
|
|
35
|
+
/**
|
|
36
|
+
* A string value that represents the title of the chart.
|
|
37
|
+
*/
|
|
11
38
|
title?: string;
|
|
39
|
+
/**
|
|
40
|
+
* A string value that represents the subtitle of the chart. This appears below the title.
|
|
41
|
+
*/
|
|
12
42
|
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
|
+
*/
|
|
13
47
|
colors?: ChartColorTokens[];
|
|
14
48
|
};
|
|
15
49
|
|
|
16
50
|
type StackChartProps = BarChartProps & {
|
|
51
|
+
/**
|
|
52
|
+
* Accessor to define the color grouping.
|
|
53
|
+
*/
|
|
17
54
|
colorAccessor: number | string;
|
|
18
55
|
};
|
|
19
56
|
|
|
20
|
-
export type HorizontalBarChartProps = BarChartProps
|
|
21
|
-
|
|
22
|
-
|
|
57
|
+
export type HorizontalBarChartProps = BarChartProps & {
|
|
58
|
+
/**
|
|
59
|
+
* Data can be one of two formats:
|
|
60
|
+
* 1. An [array of arrays](https://developer.atlassian.com/platform/forge/ui-kit/components/horizontal-bar-chart/#1--array-of-arrays).
|
|
61
|
+
* 2. An [array of objects](https://developer.atlassian.com/platform/forge/ui-kit/components/horizontal-bar-chart/#2--array-of-objects).
|
|
62
|
+
*/
|
|
63
|
+
data: unknown[];
|
|
64
|
+
|
|
65
|
+
/**
|
|
66
|
+
* Accessor to define the x-axis values. This can be a numerical or string index.
|
|
67
|
+
* For more information on all accessors, see [Data](https://developer.atlassian.com/platform/forge/ui-kit/components/horizontal-bar-chart/#data).
|
|
68
|
+
*/
|
|
69
|
+
xAccessor: number | string;
|
|
70
|
+
};
|
|
71
|
+
|
|
72
|
+
export type StackBarChartProps = StackChartProps & {
|
|
73
|
+
/**
|
|
74
|
+
* Data can be one of two formats:
|
|
75
|
+
* 1. An [array of arrays](https://developer.atlassian.com/platform/forge/ui-kit/components/stack-bar-chart/#1--array-of-arrays).
|
|
76
|
+
* 2. An [array of objects](https://developer.atlassian.com/platform/forge/ui-kit/components/stack-bar-chart/#2--array-of-objects).
|
|
77
|
+
*/
|
|
78
|
+
data: unknown[];
|
|
79
|
+
|
|
80
|
+
/**
|
|
81
|
+
* Accessor to define the x-axis values. This can be a numerical or string index.
|
|
82
|
+
* For more information on all accessors, see [Data](https://developer.atlassian.com/platform/forge/ui-kit/components/stack-bar-chart/#data).
|
|
83
|
+
*/
|
|
84
|
+
xAccessor: number | string;
|
|
85
|
+
};
|
|
86
|
+
|
|
87
|
+
export type HorizontalStackBarChartProps = StackChartProps & {
|
|
88
|
+
/**
|
|
89
|
+
* Data can be one of two formats:
|
|
90
|
+
* 1. An [array of arrays](https://developer.atlassian.com/platform/forge/ui-kit/components/horizontal-stack-bar-chart/#1--array-of-arrays).
|
|
91
|
+
* 2. An [array of objects](https://developer.atlassian.com/platform/forge/ui-kit/components/horizontal-stack-bar-chart/#2--array-of-objects).
|
|
92
|
+
*/
|
|
93
|
+
data: unknown[];
|
|
94
|
+
|
|
95
|
+
/**
|
|
96
|
+
* Accessor to define the x-axis values. This can be a numerical or string index.
|
|
97
|
+
* For more information on all accessors, see [Data](https://developer.atlassian.com/platform/forge/ui-kit/components/horizontal-stack-bar-chart/#data).
|
|
98
|
+
*/
|
|
99
|
+
xAccessor: number | string;
|
|
100
|
+
};
|
|
101
|
+
|
|
102
|
+
/**
|
|
103
|
+
* A visual representation of data using rectangular bars of varying heights to compare different categories or values.
|
|
104
|
+
*/
|
|
105
|
+
export type TBarChart<T> = (props: BarChartProps) => T;
|
|
106
|
+
|
|
107
|
+
/**
|
|
108
|
+
* A visual representation of data using horizontal rectangular bars of varying lengths to compare different categories or values.
|
|
109
|
+
*/
|
|
110
|
+
export type THorizontalBarChart<T> = (props: HorizontalBarChartProps) => T;
|
|
111
|
+
|
|
112
|
+
/**
|
|
113
|
+
* A visual representation of data using rectangular bars of varying heights to demonstrate comparisons between categories of data.
|
|
114
|
+
*/
|
|
115
|
+
export type TStackBarChart<T> = (props: StackBarChartProps) => T;
|
|
116
|
+
|
|
117
|
+
/**
|
|
118
|
+
* A visual representation of data using horizontal rectangular bars of varying lengths to demonstrate comparisons between categories of data.
|
|
119
|
+
*/
|
|
120
|
+
export type THorizontalStackBarChart<T> = (props: HorizontalStackBarChartProps) => T;
|