@atlaskit/forge-react-types 0.37.7 → 0.37.8

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 (110) hide show
  1. package/CHANGELOG.md +8 -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/index.d.ts +1 -1
  38. package/dist/types-ts4.5/components/__generated__/ButtonGroupProps.codegen.d.ts +3 -3
  39. package/dist/types-ts4.5/components/__generated__/ButtonProps.codegen.d.ts +5 -2
  40. package/dist/types-ts4.5/components/__generated__/CheckboxGroupProps.codegen.d.ts +21 -2
  41. package/dist/types-ts4.5/components/__generated__/DatePickerProps.codegen.d.ts +3 -3
  42. package/dist/types-ts4.5/components/__generated__/ErrorMessageProps.codegen.d.ts +4 -3
  43. package/dist/types-ts4.5/components/__generated__/FormFooterProps.codegen.d.ts +12 -4
  44. package/dist/types-ts4.5/components/__generated__/FormHeaderProps.codegen.d.ts +5 -3
  45. package/dist/types-ts4.5/components/__generated__/FormProps.codegen.d.ts +14 -2
  46. package/dist/types-ts4.5/components/__generated__/FormSectionProps.codegen.d.ts +4 -3
  47. package/dist/types-ts4.5/components/__generated__/HelperMessageProps.codegen.d.ts +4 -3
  48. package/dist/types-ts4.5/components/__generated__/IconProps.codegen.d.ts +22 -2
  49. package/dist/types-ts4.5/components/__generated__/InlineEditProps.codegen.d.ts +6 -2
  50. package/dist/types-ts4.5/components/__generated__/InlineProps.codegen.d.ts +3 -3
  51. package/dist/types-ts4.5/components/__generated__/LabelProps.codegen.d.ts +3 -3
  52. package/dist/types-ts4.5/components/__generated__/LinkButtonProps.codegen.d.ts +5 -2
  53. package/dist/types-ts4.5/components/__generated__/ListItemProps.codegen.d.ts +3 -2
  54. package/dist/types-ts4.5/components/__generated__/ListProps.codegen.d.ts +14 -2
  55. package/dist/types-ts4.5/components/__generated__/LoadingButtonProps.codegen.d.ts +3 -3
  56. package/dist/types-ts4.5/components/__generated__/ModalBodyProps.codegen.d.ts +3 -3
  57. package/dist/types-ts4.5/components/__generated__/ModalFooterProps.codegen.d.ts +4 -3
  58. package/dist/types-ts4.5/components/__generated__/ModalHeaderProps.codegen.d.ts +3 -3
  59. package/dist/types-ts4.5/components/__generated__/ModalTitleProps.codegen.d.ts +3 -3
  60. package/dist/types-ts4.5/components/__generated__/ModalTransitionProps.codegen.d.ts +3 -3
  61. package/dist/types-ts4.5/components/__generated__/PopupProps.codegen.d.ts +15 -2
  62. package/dist/types-ts4.5/components/__generated__/SelectProps.codegen.d.ts +6 -2
  63. package/dist/types-ts4.5/components/__generated__/StackProps.codegen.d.ts +3 -3
  64. package/dist/types-ts4.5/components/__generated__/TabListProps.codegen.d.ts +3 -3
  65. package/dist/types-ts4.5/components/__generated__/TabPanelProps.codegen.d.ts +3 -3
  66. package/dist/types-ts4.5/components/__generated__/TabProps.codegen.d.ts +3 -3
  67. package/dist/types-ts4.5/components/__generated__/TextAreaProps.codegen.d.ts +6 -2
  68. package/dist/types-ts4.5/components/__generated__/TextfieldProps.codegen.d.ts +6 -2
  69. package/dist/types-ts4.5/components/__generated__/TimePickerProps.codegen.d.ts +3 -3
  70. package/dist/types-ts4.5/components/__generated__/TooltipProps.codegen.d.ts +3 -3
  71. package/dist/types-ts4.5/components/__generated__/ValidMessageProps.codegen.d.ts +4 -3
  72. package/dist/types-ts4.5/components/__generated__/index.d.ts +65 -58
  73. package/dist/types-ts4.5/index.d.ts +1 -1
  74. package/package.json +2 -2
  75. package/src/components/__generated__/ButtonGroupProps.codegen.tsx +3 -3
  76. package/src/components/__generated__/ButtonProps.codegen.tsx +5 -2
  77. package/src/components/__generated__/CheckboxGroupProps.codegen.tsx +26 -3
  78. package/src/components/__generated__/DatePickerProps.codegen.tsx +3 -3
  79. package/src/components/__generated__/ErrorMessageProps.codegen.tsx +4 -3
  80. package/src/components/__generated__/FormFooterProps.codegen.tsx +12 -4
  81. package/src/components/__generated__/FormHeaderProps.codegen.tsx +5 -3
  82. package/src/components/__generated__/FormProps.codegen.tsx +14 -2
  83. package/src/components/__generated__/FormSectionProps.codegen.tsx +4 -3
  84. package/src/components/__generated__/HelperMessageProps.codegen.tsx +4 -3
  85. package/src/components/__generated__/IconProps.codegen.tsx +22 -2
  86. package/src/components/__generated__/InlineEditProps.codegen.tsx +8 -3
  87. package/src/components/__generated__/InlineProps.codegen.tsx +3 -3
  88. package/src/components/__generated__/LabelProps.codegen.tsx +3 -3
  89. package/src/components/__generated__/LinkButtonProps.codegen.tsx +5 -2
  90. package/src/components/__generated__/ListItemProps.codegen.tsx +5 -3
  91. package/src/components/__generated__/ListProps.codegen.tsx +16 -3
  92. package/src/components/__generated__/LoadingButtonProps.codegen.tsx +17 -5
  93. package/src/components/__generated__/ModalBodyProps.codegen.tsx +3 -3
  94. package/src/components/__generated__/ModalFooterProps.codegen.tsx +4 -3
  95. package/src/components/__generated__/ModalHeaderProps.codegen.tsx +3 -3
  96. package/src/components/__generated__/ModalTitleProps.codegen.tsx +3 -3
  97. package/src/components/__generated__/ModalTransitionProps.codegen.tsx +3 -3
  98. package/src/components/__generated__/PopupProps.codegen.tsx +18 -3
  99. package/src/components/__generated__/SelectProps.codegen.tsx +8 -3
  100. package/src/components/__generated__/StackProps.codegen.tsx +3 -3
  101. package/src/components/__generated__/TabListProps.codegen.tsx +3 -3
  102. package/src/components/__generated__/TabPanelProps.codegen.tsx +3 -3
  103. package/src/components/__generated__/TabProps.codegen.tsx +3 -3
  104. package/src/components/__generated__/TextAreaProps.codegen.tsx +8 -3
  105. package/src/components/__generated__/TextfieldProps.codegen.tsx +8 -3
  106. package/src/components/__generated__/TimePickerProps.codegen.tsx +3 -3
  107. package/src/components/__generated__/TooltipProps.codegen.tsx +3 -3
  108. package/src/components/__generated__/ValidMessageProps.codegen.tsx +4 -3
  109. package/src/components/__generated__/index.ts +67 -59
  110. package/src/index.ts +59 -0
@@ -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,3 +1,3 @@
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, TBox, TAdfRenderer, } from './components/__generated__';
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
2
  export type { BarChartProps, StackBarChartProps, HorizontalStackBarChartProps, HorizontalBarChartProps, LineChartProps, SingleValueChartProps, PieChartProps, } from './components/charts';
3
3
  export type { ChartColorTokens } from './types';
@@ -3,9 +3,9 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - ButtonGroupProps
5
5
  *
6
- * @codegen <<SignedSource::4daf3a960cc3108bbbc8ad0ede3b7011>>
6
+ * @codegen <<SignedSource::cfcaf362cef2884ded73338c52c8f437>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/button/__generated__/button-group.partial.tsx <<SignedSource::728cab6df690811513a66ea4bacb89c9>>
8
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/button/__generated__/button-group.partial.tsx <<SignedSource::83622155981d05f77224a32bab4969b5>>
9
9
  */
10
10
  import type { ButtonGroupProps as PlatformButtonGroupProps } from '@atlaskit/button';
11
11
  import type { ButtonProps } from '@atlaskit/button';
@@ -13,6 +13,6 @@ export type ButtonGroupProps = Pick<PlatformButtonGroupProps, 'children' | 'test
13
13
  appearance?: ButtonProps['appearance'];
14
14
  };
15
15
  /**
16
- * A button triggers an event or action. They let users know what will happen next.
16
+ * A button group gives users access to frequently performed, related actions.
17
17
  */
18
18
  export type TButtonGroup<T> = (props: ButtonGroupProps) => T;
@@ -3,9 +3,9 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - ButtonProps
5
5
  *
6
- * @codegen <<SignedSource::333890773f42cacce17cee560686b34c>>
6
+ * @codegen <<SignedSource::77d1847e88419084fc81129d7637b40b>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/button/__generated__/index.partial.tsx <<SignedSource::c3a07cf50f9f4f166b94a72b4c2d5784>>
8
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/button/__generated__/index.partial.tsx <<SignedSource::f9a16b36e0a307a53ee30a009373ab49>>
9
9
  */
10
10
  import type { ButtonProps as PlatformButtonProps } from '@atlaskit/button/new';
11
11
  export type Icon = 'activity' | 'add' | 'add-circle' | 'add-item' | 'addon' | 'app-access' | 'app-switcher' | 'archive' | 'arrow-down' | 'arrow-down-circle' | 'arrow-left' | 'arrow-left-circle' | 'arrow-right' | 'arrow-right-circle' | 'arrow-up' | 'arrow-up-circle' | 'attachment' | 'audio' | 'audio-circle' | 'backlog' | 'billing' | 'billing-filled' | 'bitbucket-branches' | 'bitbucket-builds' | 'bitbucket-clone' | 'bitbucket-commits' | 'bitbucket-compare' | 'bitbucket-forks' | 'bitbucket-output' | 'bitbucket-pipelines' | 'bitbucket-pullrequests' | 'bitbucket-repos' | 'bitbucket-snippets' | 'bitbucket-source' | 'board' | 'book' | 'bullet-list' | 'calendar' | 'calendar-filled' | 'camera' | 'camera-filled' | 'camera-rotate' | 'camera-take-picture' | 'canvas' | 'check' | 'check-circle' | 'check-circle-outline' | 'checkbox' | 'checkbox-indeterminate' | 'chevron-down' | 'chevron-down-circle' | 'chevron-left' | 'chevron-left-circle' | 'chevron-left-large' | 'chevron-right' | 'chevron-right-circle' | 'chevron-right-large' | 'chevron-up' | 'chevron-up-circle' | 'child-issues' | 'code' | 'comment' | 'component' | 'copy' | 'creditcard' | 'creditcard-filled' | 'cross' | 'cross-circle' | 'dashboard' | 'decision' | 'department' | 'detail-view' | 'discover' | 'discover-filled' | 'document' | 'document-filled' | 'documents' | 'download' | 'drag-handler' | 'dropbox' | 'edit' | 'edit-filled' | 'editor-add' | 'editor-addon' | 'editor-advanced' | 'editor-align-center' | 'editor-align-image-center' | 'editor-align-image-left' | 'editor-align-image-right' | 'editor-align-left' | 'editor-align-right' | 'editor-attachment' | 'editor-background-color' | 'editor-bold' | 'editor-bullet-list' | 'editor-close' | 'editor-code' | 'editor-collapse' | 'editor-date' | 'editor-decision' | 'editor-divider' | 'editor-done' | 'editor-edit' | 'editor-emoji' | 'editor-error' | 'editor-expand' | 'editor-feedback' | 'editor-file' | 'editor-file-preview' | 'editor-help' | 'editor-hint' | 'editor-horizontal-rule' | 'editor-image' | 'editor-image-border' | 'editor-image-resize' | 'editor-indent' | 'editor-info' | 'editor-italic' | 'editor-layout-single' | 'editor-layout-three-equal' | 'editor-layout-three-with-sidebars' | 'editor-layout-two-equal' | 'editor-layout-two-left-sidebar' | 'editor-layout-two-right-sidebar' | 'editor-link' | 'editor-media-center' | 'editor-media-full-width' | 'editor-media-wide' | 'editor-media-wrap-left' | 'editor-media-wrap-right' | 'editor-mention' | 'editor-more' | 'editor-note' | 'editor-number-list' | 'editor-open' | 'editor-outdent' | 'editor-panel' | 'editor-photo' | 'editor-quote' | 'editor-recent' | 'editor-redo' | 'editor-remove' | 'editor-remove-emoji' | 'editor-search' | 'editor-settings' | 'editor-strikethrough' | 'editor-success' | 'editor-table' | 'editor-table-display-options' | 'editor-task' | 'editor-text-color' | 'editor-text-style' | 'editor-underline' | 'editor-undo' | 'editor-unlink' | 'editor-warning' | 'email' | 'emoji' | 'emoji-add' | 'emoji-activity' | 'emoji-atlassian' | 'emoji-custom' | 'emoji-emoji' | 'emoji-flags' | 'emoji-food' | 'emoji-frequent' | 'emoji-keyboard' | 'emoji-nature' | 'emoji-objects' | 'emoji-people' | 'emoji-productivity' | 'emoji-symbols' | 'emoji-travel' | 'error' | 'export' | 'feedback' | 'file' | 'filter' | 'flag-filled' | 'folder' | 'folder-filled' | 'followers' | 'following' | 'googledrive' | 'graph-bar' | 'graph-line' | 'gsuite' | 'highlights' | 'hipchat-audio-only' | 'hipchat-chevron-double-down' | 'hipchat-chevron-double-up' | 'hipchat-chevron-down' | 'hipchat-chevron-up' | 'hipchat-dial-out' | 'hipchat-lobby' | 'hipchat-media-attachment-count' | 'hipchat-outgoing-sound' | 'hipchat-sd-video' | 'home' | 'home-circle' | 'image' | 'image-border' | 'image-resize' | 'info' | 'invite-team' | 'issue' | 'issue-raise' | 'issues' | 'jira-capture' | 'jira-failed-build-status' | 'jira-labs' | 'jira-test-session' | 'label' | 'lightbulb' | 'lightbulb-filled' | 'like' | 'link' | 'link-filled' | 'list' | 'location' | 'lock' | 'lock-circle' | 'lock-filled' | 'marketplace' | 'media-services-actual-size' | 'media-services-add-comment' | 'media-services-annotate' | 'media-services-arrow' | 'media-services-audio' | 'media-services-blur' | 'media-services-brush' | 'media-services-button-option' | 'media-services-code' | 'media-services-document' | 'media-services-filter' | 'media-services-fit-to-page' | 'media-services-full-screen' | 'media-services-grid' | 'media-services-image' | 'media-services-line' | 'media-services-line-thickness' | 'media-services-no-image' | 'media-services-open-mediaviewer' | 'media-services-oval' | 'media-services-pdf' | 'media-services-preselected' | 'media-services-presentation' | 'media-services-rectangle' | 'media-services-scale-large' | 'media-services-scale-small' | 'media-services-spreadsheet' | 'media-services-text' | 'media-services-unknown' | 'media-services-video' | 'media-services-zip' | 'media-services-zoom-in' | 'media-services-zoom-out' | 'mention' | 'menu' | 'menu-expand' | 'mobile' | 'more' | 'more-vertical' | 'notification' | 'notification-all' | 'notification-direct' | 'office-building' | 'office-building-filled' | 'open' | 'overview' | 'page' | 'page-filled' | 'pdf' | 'people' | 'people-group' | 'person' | 'person-circle' | 'person-with-circle' | 'person-with-cross' | 'person-with-tick' | 'portfolio' | 'preferences' | 'premium' | 'presence-active' | 'presence-busy' | 'presence-unavailable' | 'question' | 'question-circle' | 'questions' | 'queues' | 'quote' | 'radio' | 'recent' | 'redo' | 'refresh' | 'retry' | 'roadmap' | 'room-menu' | 'schedule' | 'schedule-filled' | 'screen' | 'search' | 'select-clear' | 'send' | 'settings' | 'share' | 'ship' | 'shortcut' | 'sign-in' | 'sign-out' | 'sprint' | 'star' | 'star-filled' | 'star-large' | 'status' | 'stopwatch' | 'subtask' | 'suitcase' | 'switcher' | 'table' | 'task' | 'teams' | 'trash' | 'tray' | 'undo' | 'unlink' | 'unlock' | 'unlock-circle' | 'unlock-filled' | 'upload' | 'user-avatar-circle' | 'vid-audio-muted' | 'vid-audio-on' | 'vid-backward' | 'vid-camera-off' | 'vid-camera-on' | 'vid-connection-circle' | 'vid-forward' | 'vid-full-screen-off' | 'vid-full-screen-on' | 'vid-hang-up' | 'vid-hd-circle' | 'vid-pause' | 'vid-play' | 'vid-raised-hand' | 'vid-share-screen' | 'vid-speaking-circle' | 'vid-volume-full' | 'vid-volume-half' | 'vid-volume-muted' | 'video-circle' | 'video-filled' | 'warning' | 'watch' | 'watch-filled' | 'world' | 'world-small';
@@ -15,5 +15,8 @@ export type ButtonProps = Pick<PlatformButtonProps, 'children' | 'autoFocus' | '
15
15
  iconAfter?: IconType;
16
16
  spacing?: PlatformButtonProps['spacing'] | 'none';
17
17
  };
18
+ /**
19
+ * A button triggers an event or action. They let users know what will happen next.
20
+ */
18
21
  export type TButton<T> = (props: ButtonProps) => T;
19
22
  export {};
@@ -3,19 +3,38 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - CheckboxGroupProps
5
5
  *
6
- * @codegen <<SignedSource::293ea13e93c4a78fe93d7192e0bdaddb>>
6
+ * @codegen <<SignedSource::89e98a25ac16f92b5d18b061bb6fce57>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/checkboxgroup/index.tsx <<SignedSource::e4f95cf79182924e927523227eebf6fc>>
8
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/checkboxgroup/index.tsx <<SignedSource::4db9e0c029805d1c1fd28b923f3dbae3>>
9
9
  */
10
10
  export interface CheckboxGroupProps {
11
+ /**
12
+ * Sets the name prop on each of the Checkbox elements in the group.
13
+ */
11
14
  name: string;
15
+ /**
16
+ * An array of objects, each object is mapped onto a Checkbox element within the group.
17
+ */
12
18
  options: {
13
19
  label: string;
14
20
  value: string;
15
21
  isDisabled?: boolean;
16
22
  }[];
23
+ /**
24
+ * Once set, controls the selected value on the `CheckboxGroup`.
25
+ */
17
26
  value?: string[];
18
27
  onChange?: (values: string[]) => void;
28
+ /**
29
+ * Sets the initial selected value on the `CheckboxGroup`.
30
+ */
19
31
  defaultValue?: string[];
32
+ /**
33
+ * Sets the disabled state of all Checkbox elements in the group.
34
+ */
20
35
  isDisabled?: boolean;
21
36
  }
37
+ /**
38
+ * A Checkbox group is a list of options where one or more choices can be selected.
39
+ */
40
+ export type TCheckboxGroup<T> = (props: CheckboxGroupProps) => T;
@@ -3,9 +3,9 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - DatePickerProps
5
5
  *
6
- * @codegen <<SignedSource::14d82d10ae64e4333440817918f6e955>>
6
+ * @codegen <<SignedSource::a4fe0c77ab65e00b2bc8ebeadd33e2e3>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/datepicker/__generated__/index.partial.tsx <<SignedSource::6bc5d63c14b9dda11b370e386ccf4955>>
8
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/datepicker/__generated__/index.partial.tsx <<SignedSource::5dcbe693f00f3a2725b9e64932a3309c>>
9
9
  */
10
10
  import type { DateTimePickerSelectProps } from '@atlaskit/datetime-picker';
11
11
  export interface FieldProps {
@@ -48,7 +48,7 @@ export type DatePickerProps = {
48
48
  shouldShowCalendarButton?: boolean;
49
49
  } & Partial<Omit<FieldProps, 'onChange'>>;
50
50
  /**
51
- * A date time picker allows the user to select an associated date and time.
51
+ * A date picker allows the user to select a particular date.
52
52
  */
53
53
  export type TDatePicker<T> = (props: DatePickerProps) => T;
54
54
  export {};
@@ -3,16 +3,17 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - ErrorMessageProps
5
5
  *
6
- * @codegen <<SignedSource::3d3da7aa33a6ac0adb1524f89ee28208>>
6
+ * @codegen <<SignedSource::059ea63aef7f094365447bb300fed9f6>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/form/__generated__/error-message.partial.tsx <<SignedSource::9e1a8d256d8d999a689140fbcda430fa>>
8
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/form/__generated__/error-message.partial.tsx <<SignedSource::3758488a0115c629a624fcaae1f524c7>>
9
9
  */
10
10
  import React from 'react';
11
11
  import { ErrorMessage as PlatformErrorMessage } from '@atlaskit/form';
12
12
  type PlatformErrorMessageProps = React.ComponentProps<typeof PlatformErrorMessage>;
13
13
  export type ErrorMessageProps = Pick<PlatformErrorMessageProps, 'children' | 'testId'>;
14
14
  /**
15
- * A form allows users to input information.
15
+ * An error message is used to tell a user that the field input is invalid.
16
+ * For example, an error message could be "Invalid username, needs to be more than 4 characters".
16
17
  */
17
18
  export type TErrorMessage<T> = (props: ErrorMessageProps) => T;
18
19
  export {};
@@ -3,16 +3,24 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - FormFooterProps
5
5
  *
6
- * @codegen <<SignedSource::cb77ae443b27f1229afcd556eb365acf>>
6
+ * @codegen <<SignedSource::e6d74700f46888d63a013f997339596b>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/form/__generated__/form-footer.partial.tsx <<SignedSource::ff2413efe154db0f89a03200caf50ced>>
8
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/form/__generated__/form-footer.partial.tsx <<SignedSource::0b729df36afbc86cc134984bb4c16b3e>>
9
9
  */
10
10
  import React from 'react';
11
11
  import { FormFooter as PlatformFormFooter } from '@atlaskit/form';
12
- type PlatformFormFooterProps = React.ComponentProps<typeof PlatformFormFooter>;
12
+ type _PlatformFormFooterProps = React.ComponentProps<typeof PlatformFormFooter>;
13
+ export type PlatformFormFooterProps = Omit<_PlatformFormFooterProps, 'align'> & {
14
+ /**
15
+ * Sets the alignment of the footer contents. This is often a button. Defaults to `end`.
16
+ */
17
+ align?: _PlatformFormFooterProps['align'];
18
+ };
13
19
  export type FormFooterProps = Pick<PlatformFormFooterProps, 'children' | 'align'>;
14
20
  /**
15
- * A form allows users to input information.
21
+ * Use a form footer to set the content at the end of the form. This is used for a button that submits the form.
22
+ *
23
+ * This is positioned after the last field in the form.
16
24
  */
17
25
  export type TFormFooter<T> = (props: FormFooterProps) => T;
18
26
  export {};
@@ -3,16 +3,18 @@
3
3
  *
4
4
  * Extract component prop types from UIKit 2 components - FormHeaderProps
5
5
  *
6
- * @codegen <<SignedSource::74a8285c7ae5a0c5db7b8cafa4d8226b>>
6
+ * @codegen <<SignedSource::7ef542fd2e0804c707145ab13db81db1>>
7
7
  * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
8
- * @codegenDependency ../../../../forge-ui/src/components/UIKit/form/__generated__/form-header.partial.tsx <<SignedSource::038ad7a850af23fb1c9b30de39ab0552>>
8
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit/form/__generated__/form-header.partial.tsx <<SignedSource::8791c333c19a64caa8dd6b7461a53082>>
9
9
  */
10
10
  import React from 'react';
11
11
  import { FormHeader as PlatformFormHeader } from '@atlaskit/form';
12
12
  type PlatformFormHeaderProps = React.ComponentProps<typeof PlatformFormHeader>;
13
13
  export type FormHeaderProps = Pick<PlatformFormHeaderProps, 'title' | 'description' | 'children'>;
14
14
  /**
15
- * A form allows users to input information.
15
+ * Use a form header to describe the contents of the form. This is the title and description of the form.
16
+ * If your form contains required fields, the form header is also where you should include a legend
17
+ * for sighted users to know that * indicates a required field.
16
18
  */
17
19
  export type TFormHeader<T> = (props: FormHeaderProps) => T;
18
20
  export {};