@forge/react 11.0.0 → 11.0.1-next.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +12 -0
- package/out/components/jira/custom-field-edit.d.ts +1 -0
- package/out/components/jira/custom-field-edit.d.ts.map +1 -1
- package/out/components/ui-kit-components.d.ts +335 -61
- package/out/components/ui-kit-components.d.ts.map +1 -1
- package/out/components/ui-kit-components.js +281 -0
- package/package.json +8 -4
- package/tsconfig.tsbuildinfo +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,17 @@
|
|
|
1
1
|
# @forge/react
|
|
2
2
|
|
|
3
|
+
## 11.0.1-next.1
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- ec4bda5: Add JSDoc comment support for UI Kit component
|
|
8
|
+
|
|
9
|
+
## 11.0.1-next.0
|
|
10
|
+
|
|
11
|
+
### Patch Changes
|
|
12
|
+
|
|
13
|
+
- c8e9fa0: Updated CustomFieldEdit component with new disableSubmitOnBlur prop
|
|
14
|
+
|
|
3
15
|
## 11.0.0
|
|
4
16
|
|
|
5
17
|
### Major Changes
|
|
@@ -4,6 +4,7 @@ interface CustomFieldEditProps {
|
|
|
4
4
|
children: React.ReactNode;
|
|
5
5
|
hideActionButtons?: boolean;
|
|
6
6
|
disableSubmitOnEnter?: boolean;
|
|
7
|
+
disableSubmitOnBlur?: boolean;
|
|
7
8
|
onSubmit: () => void;
|
|
8
9
|
}
|
|
9
10
|
export declare const CustomFieldEdit: (props: CustomFieldEditProps) => ForgeElement;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"custom-field-edit.d.ts","sourceRoot":"","sources":["../../../src/components/jira/custom-field-edit.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAE3C,UAAU,oBAAoB;IAC5B,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC;IAC1B,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,QAAQ,EAAE,MAAM,IAAI,CAAC;CACtB;AAED,eAAO,MAAM,eAAe,UAA2C,oBAAoB,KAAK,YAAY,CAAC"}
|
|
1
|
+
{"version":3,"file":"custom-field-edit.d.ts","sourceRoot":"","sources":["../../../src/components/jira/custom-field-edit.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAE3C,UAAU,oBAAoB;IAC5B,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC;IAC1B,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,QAAQ,EAAE,MAAM,IAAI,CAAC;CACtB;AAED,eAAO,MAAM,eAAe,UAA2C,oBAAoB,KAAK,YAAY,CAAC"}
|
|
@@ -1,65 +1,339 @@
|
|
|
1
1
|
/// <reference types="react" />
|
|
2
2
|
import { ForgeElement } from '../types/index';
|
|
3
|
-
import type {
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
export declare const
|
|
10
|
-
|
|
11
|
-
export declare const
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
export declare const
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
export declare const
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
export declare const
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
export declare const
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
export declare const
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
export declare const
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
export declare const
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
export declare const
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
3
|
+
import type { TBadge, TBarChart, TBox, TButton, TButtonGroup, TCalendar, TCheckbox, TCode, TCodeBlock, TDatePicker, TErrorMessage, THeading, THelperMessage, THorizontalBarChart, THorizontalStackBarChart, TInline, TLabel, TList, TListItem, TLozenge, TLineChart, TLinkButton, TModal, TModalHeader, TModalBody, TModalFooter, TModalTitle, TModalTransition, TPieChart, TProgressBar, TProgressTracker, TRadio, TRadioGroup, TRange, TSectionMessage, TSectionMessageAction, TSingleValueChart, TSpinner, TStack, TStackBarChart, TTabs, TTab, TTabList, TTabPanel, TTag, TTagGroup, TTimePicker, TForm, TFormHeader, TFormFooter, TFormSection, TTooltip, TTextArea, TTextfield, TToggle, TValidMessage, TLoadingButton, TSelect, TIcon, TEmptyState } from '@atlaskit/forge-react-types';
|
|
4
|
+
/**
|
|
5
|
+
* A badge is a visual indicator for numeric values such as tallies and scores.
|
|
6
|
+
*
|
|
7
|
+
* @see [Badge](https://developer.atlassian.com/platform/forge/ui-kit/components/badge/) in UI Kit documentation for more information
|
|
8
|
+
*/
|
|
9
|
+
export declare const Badge: TBadge<ForgeElement<Record<string, any>>>;
|
|
10
|
+
/** A visual representation of data using rectangular bars of varying heights to compare different categories or values. */
|
|
11
|
+
export declare const BarChart: TBarChart<ForgeElement<Record<string, any>>>;
|
|
12
|
+
/**
|
|
13
|
+
* A box is a generic container that provides managed access to design tokens.
|
|
14
|
+
*
|
|
15
|
+
* @see [Box](https://developer.atlassian.com/platform/forge/ui-kit/components/box/) in UI Kit documentation for more information
|
|
16
|
+
*/
|
|
17
|
+
export declare const Box: TBox<ForgeElement<Record<string, any>>>;
|
|
18
|
+
/**
|
|
19
|
+
* A button triggers an event or action. They let users know what will happen next.
|
|
20
|
+
*
|
|
21
|
+
* @see [Button](https://developer.atlassian.com/platform/forge/ui-kit/components/button/) in UI Kit documentation for more information
|
|
22
|
+
*/
|
|
23
|
+
export declare const Button: TButton<ForgeElement<Record<string, any>>>;
|
|
24
|
+
/**
|
|
25
|
+
* A button group gives users access to frequently performed, related actions.
|
|
26
|
+
*
|
|
27
|
+
* @see [ButtonGroup](https://developer.atlassian.com/platform/forge/ui-kit/components/button-group/) in UI Kit documentation for more information
|
|
28
|
+
*/
|
|
29
|
+
export declare const ButtonGroup: TButtonGroup<ForgeElement<Record<string, any>>>;
|
|
30
|
+
/**
|
|
31
|
+
* An interactive calendar for date selection experiences.
|
|
32
|
+
*
|
|
33
|
+
* @see [Calendar](https://developer.atlassian.com/platform/forge/ui-kit/components/calendar/) in UI Kit documentation for more information
|
|
34
|
+
*/
|
|
35
|
+
export declare const Calendar: TCalendar<ForgeElement<Record<string, any>>>;
|
|
36
|
+
/**
|
|
37
|
+
* A checkbox is an input control that allows a user to select one or more options from a number of choices.
|
|
38
|
+
*
|
|
39
|
+
* @see [Checkbox](https://developer.atlassian.com/platform/forge/ui-kit/components/checkbox/) in UI Kit documentation for more information
|
|
40
|
+
*/
|
|
41
|
+
export declare const Checkbox: TCheckbox<ForgeElement<Record<string, any>>>;
|
|
42
|
+
/**
|
|
43
|
+
* Code highlights short strings of code snippets inline with body text.
|
|
44
|
+
*
|
|
45
|
+
* @see [Code](https://developer.atlassian.com/platform/forge/ui-kit/components/code/) in UI Kit documentation for more information
|
|
46
|
+
*/
|
|
47
|
+
export declare const Code: TCode<ForgeElement<Record<string, any>>>;
|
|
48
|
+
/**
|
|
49
|
+
* Code highlights short strings of code snippets inline with body text.
|
|
50
|
+
*
|
|
51
|
+
* @see [CodeBlock](https://developer.atlassian.com/platform/forge/ui-kit/components/code-block/) in UI Kit documentation for more information
|
|
52
|
+
*/
|
|
53
|
+
export declare const CodeBlock: TCodeBlock<ForgeElement<Record<string, any>>>;
|
|
54
|
+
/**
|
|
55
|
+
* A date picker allows the user to select a particular date.
|
|
56
|
+
*
|
|
57
|
+
* @see [DatePicker](https://developer.atlassian.com/platform/forge/ui-kit/components/date-picker/) in UI Kit documentation for more information
|
|
58
|
+
*/
|
|
59
|
+
export declare const DatePicker: TDatePicker<ForgeElement<Record<string, any>>>;
|
|
60
|
+
/**
|
|
61
|
+
* An empty state appears when there is no data to display and describes what the user can do next.
|
|
62
|
+
*
|
|
63
|
+
* @see [EmptyState](https://developer.atlassian.com/platform/forge/ui-kit/components/empty-state/) in UI Kit documentation for more information
|
|
64
|
+
*/
|
|
65
|
+
export declare const EmptyState: TEmptyState<ForgeElement<Record<string, any>>>;
|
|
66
|
+
/**
|
|
67
|
+
* An error message is used to tell a user that the field input is invalid.
|
|
68
|
+
* For example, an error message could be "Invalid username, needs to be more than 4 characters".
|
|
69
|
+
*
|
|
70
|
+
* @see [ErrorMessage](https://developer.atlassian.com/platform/forge/ui-kit/components/form/#error-message) in UI Kit documentation for more information
|
|
71
|
+
*/
|
|
72
|
+
export declare const ErrorMessage: TErrorMessage<ForgeElement<Record<string, any>>>;
|
|
73
|
+
/**
|
|
74
|
+
* A form allows users to input information.
|
|
75
|
+
*
|
|
76
|
+
* @see [Form](https://developer.atlassian.com/platform/forge/ui-kit/components/form/) in UI Kit documentation for more information
|
|
77
|
+
*/
|
|
78
|
+
export declare const Form: TForm<ForgeElement<Record<string, any>>>;
|
|
79
|
+
/**
|
|
80
|
+
* Use a form footer to set the content at the end of the form. This is used for a button that submits the form.
|
|
81
|
+
*
|
|
82
|
+
* This is positioned after the last field in the form.
|
|
83
|
+
*
|
|
84
|
+
* @see [FormFooter](https://developer.atlassian.com/platform/forge/ui-kit/components/form/#form-footer) in UI Kit documentation for more information
|
|
85
|
+
*/
|
|
86
|
+
export declare const FormFooter: TFormFooter<ForgeElement<Record<string, any>>>;
|
|
87
|
+
/**
|
|
88
|
+
* Use a form header to describe the contents of the form. This is the title and description of the form.
|
|
89
|
+
* If your form contains required fields, the form header is also where you should include a legend
|
|
90
|
+
* for sighted users to know that * indicates a required field.
|
|
91
|
+
*
|
|
92
|
+
* @see [FormHeader](https://developer.atlassian.com/platform/forge/ui-kit/components/form/#form-header) in UI Kit documentation for more information
|
|
93
|
+
*/
|
|
94
|
+
export declare const FormHeader: TFormHeader<ForgeElement<Record<string, any>>>;
|
|
95
|
+
/**
|
|
96
|
+
* Use a form section to group related information together, so that longer forms are easier to understand.
|
|
97
|
+
* There can be multiple form sections in one form.
|
|
98
|
+
*
|
|
99
|
+
* @see [FormSection](https://developer.atlassian.com/platform/forge/ui-kit/components/form/#form-section) in UI Kit documentation for more information
|
|
100
|
+
*/
|
|
101
|
+
export declare const FormSection: TFormSection<ForgeElement<Record<string, any>>>;
|
|
102
|
+
/**
|
|
103
|
+
* A heading is a typography component used to display text in different sizes and formats.
|
|
104
|
+
*
|
|
105
|
+
* @see [Heading](https://developer.atlassian.com/platform/forge/ui-kit/components/heading/) in UI Kit documentation for more information
|
|
106
|
+
*/
|
|
107
|
+
export declare const Heading: THeading<ForgeElement<Record<string, any>>>;
|
|
108
|
+
/**
|
|
109
|
+
* A helper message tells the user what kind of input the field takes.
|
|
110
|
+
* For example, a helper message could be "Password should be more than 4 characters".
|
|
111
|
+
*
|
|
112
|
+
* @see [HelperMessage](https://developer.atlassian.com/platform/forge/ui-kit/components/form/#helper-message) in UI Kit documentation for more information
|
|
113
|
+
*/
|
|
114
|
+
export declare const HelperMessage: THelperMessage<ForgeElement<Record<string, any>>>;
|
|
115
|
+
/** A visual representation of data using horizontal rectangular bars of varying lengths to compare different categories or values. */
|
|
116
|
+
export declare const HorizontalBarChart: THorizontalBarChart<ForgeElement<Record<string, any>>>;
|
|
117
|
+
/** A visual representation of data using horizontal rectangular bars of varying lengths to demonstrate comparisons between categories of data. */
|
|
118
|
+
export declare const HorizontalStackBarChart: THorizontalStackBarChart<ForgeElement<Record<string, any>>>;
|
|
119
|
+
/**
|
|
120
|
+
* An icon is a visual representation of a command, device, directory, or common action.
|
|
121
|
+
*
|
|
122
|
+
* @see [Icon](https://developer.atlassian.com/platform/forge/ui-kit/components/icon/) in UI Kit documentation for more information
|
|
123
|
+
*/
|
|
124
|
+
export declare const Icon: TIcon<ForgeElement<Record<string, any>>>;
|
|
125
|
+
/**
|
|
126
|
+
* An inline manages the horizontal layout of direct children using flexbox.
|
|
127
|
+
*
|
|
128
|
+
* @see [Inline](https://developer.atlassian.com/platform/forge/ui-kit/components/inline/) in UI Kit documentation for more information
|
|
129
|
+
*/
|
|
130
|
+
export declare const Inline: TInline<ForgeElement<Record<string, any>>>;
|
|
131
|
+
/**
|
|
132
|
+
* A label represents a caption for an item in a user interface.
|
|
133
|
+
*
|
|
134
|
+
* @see [Label](https://developer.atlassian.com/platform/forge/ui-kit/components/form/#label) in UI Kit documentation for more information
|
|
135
|
+
*/
|
|
136
|
+
export declare const Label: TLabel<ForgeElement<Record<string, any>>>;
|
|
137
|
+
/** A visual representation of data showing trends. */
|
|
138
|
+
export declare const LineChart: TLineChart<ForgeElement<Record<string, any>>>;
|
|
139
|
+
/**
|
|
140
|
+
* Renders a link in the style of a button.
|
|
141
|
+
*
|
|
142
|
+
* @see [LinkButton](https://developer.atlassian.com/platform/forge/ui-kit/components/button/#linkbutton-props) in UI Kit documentation for more information
|
|
143
|
+
*/
|
|
144
|
+
export declare const LinkButton: TLinkButton<ForgeElement<Record<string, any>>>;
|
|
145
|
+
/**
|
|
146
|
+
* An unordered (bulleted) or ordered (numbered) list.
|
|
147
|
+
*
|
|
148
|
+
* @see [List](https://developer.atlassian.com/platform/forge/ui-kit/components/list/) in UI Kit documentation for more information
|
|
149
|
+
*/
|
|
150
|
+
export declare const List: TList<ForgeElement<Record<string, any>>>;
|
|
151
|
+
export declare const ListItem: TListItem<ForgeElement<Record<string, any>>>;
|
|
152
|
+
/**
|
|
153
|
+
* A button that shows an spinner as an overlay on the button when you set an isLoading prop to true.
|
|
154
|
+
*
|
|
155
|
+
* @see [LoadingButton](https://developer.atlassian.com/platform/forge/ui-kit/components/button/#loadingbutton-props) in UI Kit documentation for more information
|
|
156
|
+
*/
|
|
157
|
+
export declare const LoadingButton: TLoadingButton<ForgeElement<Record<string, any>>>;
|
|
158
|
+
/**
|
|
159
|
+
* A lozenge is a visual indicator used to highlight an item's status for quick recognition.
|
|
160
|
+
*
|
|
161
|
+
* @see [Lozenge](https://developer.atlassian.com/platform/forge/ui-kit/components/lozenge/) in UI Kit documentation for more information
|
|
162
|
+
*/
|
|
163
|
+
export declare const Lozenge: TLozenge<ForgeElement<Record<string, any>>>;
|
|
164
|
+
/**
|
|
165
|
+
* A modal dialog displays content that requires user interaction, in a layer above the page.
|
|
166
|
+
*
|
|
167
|
+
* @see [Modal](https://developer.atlassian.com/platform/forge/ui-kit/components/modal/) in UI Kit documentation for more information
|
|
168
|
+
*/
|
|
169
|
+
export declare const Modal: TModal<ForgeElement<Record<string, any>>>;
|
|
170
|
+
/**
|
|
171
|
+
* A modal body is used to display the main content of a modal.
|
|
172
|
+
*
|
|
173
|
+
* @see [ModalBody](https://developer.atlassian.com/platform/forge/ui-kit/components/modal/#body) in UI Kit documentation for more information
|
|
174
|
+
*/
|
|
175
|
+
export declare const ModalBody: TModalBody<ForgeElement<Record<string, any>>>;
|
|
176
|
+
/**
|
|
177
|
+
* A modal footer often contains a primary action and the ability to cancel and close the dialog,
|
|
178
|
+
* though can contain any React element.
|
|
179
|
+
*
|
|
180
|
+
* @see [ModalFooter](https://developer.atlassian.com/platform/forge/ui-kit/components/modal/#footer) in UI Kit documentation for more information
|
|
181
|
+
*/
|
|
182
|
+
export declare const ModalFooter: TModalFooter<ForgeElement<Record<string, any>>>;
|
|
183
|
+
/**
|
|
184
|
+
* A modal header contains the title of the modal and can contain other React elements such as a close button.
|
|
185
|
+
*
|
|
186
|
+
* @see [ModalHeader](https://developer.atlassian.com/platform/forge/ui-kit/components/modal/#header) in UI Kit documentation for more information
|
|
187
|
+
*/
|
|
188
|
+
export declare const ModalHeader: TModalHeader<ForgeElement<Record<string, any>>>;
|
|
189
|
+
/**
|
|
190
|
+
* A modal title is used to display a title within a modal.
|
|
191
|
+
*
|
|
192
|
+
* @see [ModalTitle](https://developer.atlassian.com/platform/forge/ui-kit/components/modal/#title) in UI Kit documentation for more information
|
|
193
|
+
*/
|
|
194
|
+
export declare const ModalTitle: TModalTitle<ForgeElement<Record<string, any>>>;
|
|
195
|
+
/**
|
|
196
|
+
* A modal transition wraps a modal to provide a fluid transition upon opening and closing.
|
|
197
|
+
*
|
|
198
|
+
* @see [ModalTransition](https://developer.atlassian.com/platform/forge/ui-kit/components/modal/#modal-transition) in UI Kit documentation for more information
|
|
199
|
+
*/
|
|
200
|
+
export declare const ModalTransition: TModalTransition<ForgeElement<Record<string, any>>>;
|
|
201
|
+
/** A visual representation of data proportions in a circular format. */
|
|
202
|
+
export declare const PieChart: TPieChart<ForgeElement<Record<string, any>>>;
|
|
203
|
+
/**
|
|
204
|
+
* A progress bar communicates the status of a system process.
|
|
205
|
+
*
|
|
206
|
+
* @see [ProgressBar](https://developer.atlassian.com/platform/forge/ui-kit/components/progress-bar/) in UI Kit documentation for more information
|
|
207
|
+
*/
|
|
208
|
+
export declare const ProgressBar: TProgressBar<ForgeElement<Record<string, any>>>;
|
|
209
|
+
/**
|
|
210
|
+
* A progress tracker displays the steps and progress through a journey.
|
|
211
|
+
*
|
|
212
|
+
* @see [ProgressTracker](https://developer.atlassian.com/platform/forge/ui-kit/components/progress-tracker/) in UI Kit documentation for more information
|
|
213
|
+
*/
|
|
214
|
+
export declare const ProgressTracker: TProgressTracker<ForgeElement<Record<string, any>>>;
|
|
215
|
+
/**
|
|
216
|
+
* A radio input allows users to select only one option from a number of choices. Radio is generally displayed in a radio group.
|
|
217
|
+
*
|
|
218
|
+
* @see [Radio](https://developer.atlassian.com/platform/forge/ui-kit/components/radio/) in UI Kit documentation for more information
|
|
219
|
+
*/
|
|
220
|
+
export declare const Radio: TRadio<ForgeElement<Record<string, any>>>;
|
|
221
|
+
/**
|
|
222
|
+
* A radio input allows users to select only one option from a number of choices. Radio is generally displayed in a radio group.
|
|
223
|
+
*
|
|
224
|
+
* @see [RadioGroup](https://developer.atlassian.com/platform/forge/ui-kit/components/radio-group/) in UI Kit documentation for more information
|
|
225
|
+
*/
|
|
226
|
+
export declare const RadioGroup: TRadioGroup<ForgeElement<Record<string, any>>>;
|
|
227
|
+
/**
|
|
228
|
+
* A range lets users choose an approximate value on a slider.
|
|
229
|
+
*
|
|
230
|
+
* @see [Range](https://developer.atlassian.com/platform/forge/ui-kit/components/range/) in UI Kit documentation for more information
|
|
231
|
+
*/
|
|
232
|
+
export declare const Range: TRange<ForgeElement<Record<string, any>>>;
|
|
233
|
+
/**
|
|
234
|
+
* Select allows users to make a single selection or multiple selections from a list of options.
|
|
235
|
+
*
|
|
236
|
+
* @see [Select](https://developer.atlassian.com/platform/forge/ui-kit/components/select/) in UI Kit documentation for more information
|
|
237
|
+
*/
|
|
238
|
+
export declare const Select: TSelect<ForgeElement<Record<string, any>>>;
|
|
239
|
+
/**
|
|
240
|
+
* A section message is used to alert users to a particular section of the screen.
|
|
241
|
+
*
|
|
242
|
+
* @see [SectionMessage](https://developer.atlassian.com/platform/forge/ui-kit/components/section-message/) in UI Kit documentation for more information
|
|
243
|
+
*/
|
|
244
|
+
export declare const SectionMessage: TSectionMessage<ForgeElement<Record<string, any>>>;
|
|
245
|
+
/**
|
|
246
|
+
* A section message is used to alert users to a particular section of the screen.
|
|
247
|
+
*
|
|
248
|
+
* @see [SectionMessageAction](https://developer.atlassian.com/platform/forge/ui-kit/components/section-message/#section-message-action) in UI Kit documentation for more information
|
|
249
|
+
*/
|
|
250
|
+
export declare const SectionMessageAction: TSectionMessageAction<ForgeElement<Record<string, any>>>;
|
|
251
|
+
/**
|
|
252
|
+
* A visualization representation of information with a single value as its metrics.
|
|
253
|
+
* The metric can be displayed with a increase/decrease indicator to display trends or changes over time.
|
|
254
|
+
*/
|
|
255
|
+
export declare const SingleValueChart: TSingleValueChart<ForgeElement<Record<string, any>>>;
|
|
256
|
+
/**
|
|
257
|
+
* A spinner is an animated spinning icon that lets users know content is being loaded.
|
|
258
|
+
*
|
|
259
|
+
* @see [Spinner](https://developer.atlassian.com/platform/forge/ui-kit/components/spinner/) in UI Kit documentation for more information
|
|
260
|
+
*/
|
|
261
|
+
export declare const Spinner: TSpinner<ForgeElement<Record<string, any>>>;
|
|
262
|
+
/**
|
|
263
|
+
* A stack manages the vertical layout of direct children using flexbox.
|
|
264
|
+
*
|
|
265
|
+
* @see [Stack](https://developer.atlassian.com/platform/forge/ui-kit/components/stack/) in UI Kit documentation for more information
|
|
266
|
+
*/
|
|
267
|
+
export declare const Stack: TStack<ForgeElement<Record<string, any>>>;
|
|
268
|
+
/** A visual representation of data using rectangular bars of varying heights to demonstrate comparisons between categories of data. */
|
|
269
|
+
export declare const StackBarChart: TStackBarChart<ForgeElement<Record<string, any>>>;
|
|
270
|
+
/**
|
|
271
|
+
* `Tab` represents an individual tab displayed in a TabList.
|
|
272
|
+
*
|
|
273
|
+
* @see [Tab](https://developer.atlassian.com/platform/forge/ui-kit/components/tabs/) in UI Kit documentation for more information
|
|
274
|
+
*/
|
|
275
|
+
export declare const Tab: TTab<ForgeElement<Record<string, any>>>;
|
|
276
|
+
/**
|
|
277
|
+
* A `TabList` groups `Tab` components together.
|
|
278
|
+
*
|
|
279
|
+
* @see [TabList](https://developer.atlassian.com/platform/forge/ui-kit/components/tab-list/) in UI Kit documentation for more information
|
|
280
|
+
*/
|
|
281
|
+
export declare const TabList: TTabList<ForgeElement<Record<string, any>>>;
|
|
282
|
+
/**
|
|
283
|
+
* A `TabPanel` houses the contents of a `Tab`.
|
|
284
|
+
*
|
|
285
|
+
* @see [TabPanel](https://developer.atlassian.com/platform/forge/ui-kit/components/tabs/) in UI Kit documentation for more information
|
|
286
|
+
*/
|
|
287
|
+
export declare const TabPanel: TTabPanel<ForgeElement<Record<string, any>>>;
|
|
288
|
+
/**
|
|
289
|
+
* Tabs are used to organize content by grouping similar information on the same page.
|
|
290
|
+
*
|
|
291
|
+
* @see [Tabs](https://developer.atlassian.com/platform/forge/ui-kit/components/tabs/) in UI Kit documentation for more information
|
|
292
|
+
*/
|
|
293
|
+
export declare const Tabs: TTabs<ForgeElement<Record<string, any>>>;
|
|
294
|
+
export declare const Tag: TTag<ForgeElement<Record<string, any>>>;
|
|
295
|
+
/**
|
|
296
|
+
* A tag group controls the layout and alignment for a collection of tags.
|
|
297
|
+
*
|
|
298
|
+
* @see [TagGroup](https://developer.atlassian.com/platform/forge/ui-kit/components/tag-group/) in UI Kit documentation for more information
|
|
299
|
+
*/
|
|
300
|
+
export declare const TagGroup: TTagGroup<ForgeElement<Record<string, any>>>;
|
|
301
|
+
/**
|
|
302
|
+
* A text area lets users enter long form text which spans over multiple lines.
|
|
303
|
+
*
|
|
304
|
+
* @see [TextArea](https://developer.atlassian.com/platform/forge/ui-kit/components/text-area/) in UI Kit documentation for more information
|
|
305
|
+
*/
|
|
306
|
+
export declare const TextArea: TTextArea<ForgeElement<Record<string, any>>>;
|
|
307
|
+
/**
|
|
308
|
+
* A text field is an input that allows a user to write or edit text.
|
|
309
|
+
*
|
|
310
|
+
* @see [Textfield](https://developer.atlassian.com/platform/forge/ui-kit/components/textfield/) in UI Kit documentation for more information
|
|
311
|
+
*/
|
|
312
|
+
export declare const Textfield: TTextfield<ForgeElement<Record<string, any>>>;
|
|
313
|
+
/**
|
|
314
|
+
* A time picker allows the user to select a specific time.
|
|
315
|
+
*
|
|
316
|
+
* @see [TimePicker](https://developer.atlassian.com/platform/forge/ui-kit/components/time-picker/) in UI Kit documentation for more information
|
|
317
|
+
*/
|
|
318
|
+
export declare const TimePicker: TTimePicker<ForgeElement<Record<string, any>>>;
|
|
319
|
+
/**
|
|
320
|
+
* A toggle is used to view or switch between enabled or disabled states.
|
|
321
|
+
*
|
|
322
|
+
* @see [Toggle](https://developer.atlassian.com/platform/forge/ui-kit/components/toggle/) in UI Kit documentation for more information
|
|
323
|
+
*/
|
|
324
|
+
export declare const Toggle: TToggle<ForgeElement<Record<string, any>>>;
|
|
325
|
+
/**
|
|
326
|
+
* A `Tooltip` is a floating, non-actionable label used to explain a user interface element or feature.
|
|
327
|
+
*
|
|
328
|
+
* @see [Tooltip](https://developer.atlassian.com/platform/forge/ui-kit/components/tooltip/) in UI Kit documentation for more information
|
|
329
|
+
*/
|
|
330
|
+
export declare const Tooltip: TTooltip<ForgeElement<Record<string, any>>>;
|
|
331
|
+
/**
|
|
332
|
+
* A valid message is used to tell a user that the field input is valid.
|
|
333
|
+
* For example, a helper message could be "Nice one, this username is available".
|
|
334
|
+
*
|
|
335
|
+
* @see [ValidMessage](https://developer.atlassian.com/platform/forge/ui-kit/components/form/#validation-message) in UI Kit documentation for more information
|
|
336
|
+
*/
|
|
337
|
+
export declare const ValidMessage: TValidMessage<ForgeElement<Record<string, any>>>;
|
|
64
338
|
export declare const RequiredAsterisk: () => JSX.Element;
|
|
65
339
|
//# sourceMappingURL=ui-kit-components.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ui-kit-components.d.ts","sourceRoot":"","sources":["../../src/components/ui-kit-components.ts"],"names":[],"mappings":";
|
|
1
|
+
{"version":3,"file":"ui-kit-components.d.ts","sourceRoot":"","sources":["../../src/components/ui-kit-components.ts"],"names":[],"mappings":";AAQA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,KAAK,EACV,MAAM,EACN,SAAS,EACT,IAAI,EACJ,OAAO,EACP,YAAY,EACZ,SAAS,EACT,SAAS,EACT,KAAK,EACL,UAAU,EACV,WAAW,EACX,aAAa,EACb,QAAQ,EACR,cAAc,EACd,mBAAmB,EACnB,wBAAwB,EACxB,OAAO,EACP,MAAM,EACN,KAAK,EACL,SAAS,EACT,QAAQ,EACR,UAAU,EACV,WAAW,EACX,MAAM,EACN,YAAY,EACZ,UAAU,EACV,YAAY,EACZ,WAAW,EACX,gBAAgB,EAChB,SAAS,EACT,YAAY,EACZ,gBAAgB,EAChB,MAAM,EACN,WAAW,EACX,MAAM,EACN,eAAe,EACf,qBAAqB,EACrB,iBAAiB,EACjB,QAAQ,EACR,MAAM,EACN,cAAc,EACd,KAAK,EACL,IAAI,EACJ,QAAQ,EACR,SAAS,EACT,IAAI,EACJ,SAAS,EACT,WAAW,EACX,KAAK,EACL,WAAW,EACX,WAAW,EACX,YAAY,EACZ,QAAQ,EACR,SAAS,EACT,UAAU,EACV,OAAO,EACP,aAAa,EACb,cAAc,EACd,OAAO,EACP,KAAK,EACL,WAAW,EACZ,MAAM,6BAA6B,CAAC;AAErC;;;;GAIG;AACH,eAAO,MAAM,KAAK,2CAA6C,CAAC;AAChE,2HAA2H;AAC3H,eAAO,MAAM,QAAQ,8CAAmD,CAAC;AACzE;;;;GAIG;AACH,eAAO,MAAM,GAAG,yCAAyC,CAAC;AAC1D;;;;GAIG;AACH,eAAO,MAAM,MAAM,4CAA+C,CAAC;AACnE;;;;GAIG;AACH,eAAO,MAAM,WAAW,iDAAyD,CAAC;AAClF;;;;GAIG;AACH,eAAO,MAAM,QAAQ,8CAAmD,CAAC;AACzE;;;;GAIG;AACH,eAAO,MAAM,QAAQ,8CAAmD,CAAC;AACzE;;;;GAIG;AACH,eAAO,MAAM,IAAI,0CAA2C,CAAC;AAC7D;;;;GAIG;AACH,eAAO,MAAM,SAAS,+CAAqD,CAAC;AAC5E;;;;GAIG;AACH,eAAO,MAAM,UAAU,gDAAuD,CAAC;AAC/E;;;;GAIG;AACH,eAAO,MAAM,UAAU,gDAAuD,CAAC;AAC/E;;;;;GAKG;AACH,eAAO,MAAM,YAAY,kDAA2D,CAAC;AACrF;;;;GAIG;AACH,eAAO,MAAM,IAAI,0CAA2C,CAAC;AAC7D;;;;;;GAMG;AACH,eAAO,MAAM,UAAU,gDAAuD,CAAC;AAC/E;;;;;;GAMG;AACH,eAAO,MAAM,UAAU,gDAAuD,CAAC;AAC/E;;;;;GAKG;AACH,eAAO,MAAM,WAAW,iDAAyD,CAAC;AAClF;;;;GAIG;AACH,eAAO,MAAM,OAAO,6CAAiD,CAAC;AACtE;;;;;GAKG;AACH,eAAO,MAAM,aAAa,mDAA6D,CAAC;AACxF,sIAAsI;AACtI,eAAO,MAAM,kBAAkB,wDAAuE,CAAC;AACvG,kJAAkJ;AAClJ,eAAO,MAAM,uBAAuB,6DAAiF,CAAC;AACtH;;;;GAIG;AACH,eAAO,MAAM,IAAI,0CAA2C,CAAC;AAC7D;;;;GAIG;AACH,eAAO,MAAM,MAAM,4CAA+C,CAAC;AACnE;;;;GAIG;AACH,eAAO,MAAM,KAAK,2CAA6C,CAAC;AAChE,sDAAsD;AACtD,eAAO,MAAM,SAAS,+CAAqD,CAAC;AAC5E;;;;GAIG;AACH,eAAO,MAAM,UAAU,gDAAuD,CAAC;AAC/E;;;;GAIG;AACH,eAAO,MAAM,IAAI,0CAA2C,CAAC;AAC7D,eAAO,MAAM,QAAQ,8CAAmD,CAAC;AACzE;;;;GAIG;AACH,eAAO,MAAM,aAAa,mDAA6D,CAAC;AACxF;;;;GAIG;AACH,eAAO,MAAM,OAAO,6CAAiD,CAAC;AACtE;;;;GAIG;AACH,eAAO,MAAM,KAAK,2CAA6C,CAAC;AAChE;;;;GAIG;AACH,eAAO,MAAM,SAAS,+CAAqD,CAAC;AAC5E;;;;;GAKG;AACH,eAAO,MAAM,WAAW,iDAAyD,CAAC;AAClF;;;;GAIG;AACH,eAAO,MAAM,WAAW,iDAAyD,CAAC;AAClF;;;;GAIG;AACH,eAAO,MAAM,UAAU,gDAAuD,CAAC;AAC/E;;;;GAIG;AACH,eAAO,MAAM,eAAe,qDAAiE,CAAC;AAC9F,wEAAwE;AACxE,eAAO,MAAM,QAAQ,8CAAmD,CAAC;AACzE;;;;GAIG;AACH,eAAO,MAAM,WAAW,iDAAyD,CAAC;AAClF;;;;GAIG;AACH,eAAO,MAAM,eAAe,qDAAiE,CAAC;AAC9F;;;;GAIG;AACH,eAAO,MAAM,KAAK,2CAA6C,CAAC;AAChE;;;;GAIG;AACH,eAAO,MAAM,UAAU,gDAAuD,CAAC;AAC/E;;;;GAIG;AACH,eAAO,MAAM,KAAK,2CAA6C,CAAC;AAChE;;;;GAIG;AACH,eAAO,MAAM,MAAM,4CAA+C,CAAC;AACnE;;;;GAIG;AACH,eAAO,MAAM,cAAc,oDAA+D,CAAC;AAC3F;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,0DAA2E,CAAC;AAC7G;;;GAGG;AACH,eAAO,MAAM,gBAAgB,sDAAmE,CAAC;AACjG;;;;GAIG;AACH,eAAO,MAAM,OAAO,6CAAiD,CAAC;AACtE;;;;GAIG;AACH,eAAO,MAAM,KAAK,2CAA6C,CAAC;AAChE,uIAAuI;AACvI,eAAO,MAAM,aAAa,mDAA6D,CAAC;AACxF;;;;GAIG;AACH,eAAO,MAAM,GAAG,yCAAyC,CAAC;AAC1D;;;;GAIG;AACH,eAAO,MAAM,OAAO,6CAAiD,CAAC;AACtE;;;;GAIG;AACH,eAAO,MAAM,QAAQ,8CAAmD,CAAC;AACzE;;;;GAIG;AACH,eAAO,MAAM,IAAI,0CAA2C,CAAC;AAC7D,eAAO,MAAM,GAAG,yCAAyC,CAAC;AAC1D;;;;GAIG;AACH,eAAO,MAAM,QAAQ,8CAAmD,CAAC;AACzE;;;;GAIG;AACH,eAAO,MAAM,QAAQ,8CAAmD,CAAC;AACzE;;;;GAIG;AACH,eAAO,MAAM,SAAS,+CAAqD,CAAC;AAC5E;;;;GAIG;AACH,eAAO,MAAM,UAAU,gDAAuD,CAAC;AAC/E;;;;GAIG;AACH,eAAO,MAAM,MAAM,4CAA+C,CAAC;AACnE;;;;GAIG;AACH,eAAO,MAAM,OAAO,6CAAiD,CAAC;AACtE;;;;;GAKG;AACH,eAAO,MAAM,YAAY,kDAA2D,CAAC;AAErF,eAAO,MAAM,gBAAgB,QAA0C,WAAW,CAAC"}
|