Skip to content

Commit 39875a5

Browse files
committed
update components /1
1 parent 80e58e2 commit 39875a5

File tree

17 files changed

+24
-125
lines changed

17 files changed

+24
-125
lines changed
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
// Generated file - do not change manually!
2+
3+
import ToolbarItemOverflowBehavior from '@ui5/webcomponents/dist/types/ToolbarItemOverflowBehavior.js';
4+
5+
export { ToolbarItemOverflowBehavior };

packages/main/src/enums/index.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,7 @@ export * from './TitleLevel.js';
8787
export * from './ToastPlacement.js';
8888
export * from './ToolbarAlign.js';
8989
export * from './ToolbarDesign.js';
90+
export * from './ToolbarItemOverflowBehavior.js';
9091
export * from './ToolbarStyle.js';
9192
export * from './UploadCollectionDnDOverlayMode.js';
9293
export * from './UploadState.js';

packages/main/src/webComponents/Bar/index.tsx

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,6 @@ import type { UI5WCSlotsNode } from '../../types/index.js';
1010
interface BarAttributes {
1111
/**
1212
* Defines the component's design.
13-
*
14-
* **Note:** Available options are:
15-
*
16-
* * `Header`
17-
* * `Subheader`
18-
* * `Footer`
19-
* * `FloatingFooter`
2013
*/
2114
design?: BarDesign | keyof typeof BarDesign;
2215
}
@@ -25,11 +18,11 @@ export interface BarDomRef extends BarAttributes, Ui5DomRef {}
2518

2619
export interface BarPropTypes extends BarAttributes, CommonProps {
2720
/**
28-
* Defines the content in the middle of the bar
21+
* Defines the content in the middle of the bar.
2922
*/
3023
children?: ReactNode | ReactNode[];
3124
/**
32-
* Defines the content at the end of the bar
25+
* Defines the content at the end of the bar.
3326
*
3427
* __Note:__ This prop will be rendered as [slot](https://www.w3schools.com/tags/tag_slot.asp) (`slot="endContent"`).
3528
* Since you can't change the DOM order of slots when declaring them within a prop, it might prove beneficial to manually mount them as part of the component's children, especially when facing problems with the reading order of screen readers.
@@ -39,7 +32,7 @@ export interface BarPropTypes extends BarAttributes, CommonProps {
3932
*/
4033
endContent?: UI5WCSlotsNode | UI5WCSlotsNode[];
4134
/**
42-
* Defines the content at the start of the bar
35+
* Defines the content at the start of the bar.
4336
*
4437
* __Note:__ This prop will be rendered as [slot](https://www.w3schools.com/tags/tag_slot.asp) (`slot="startContent"`).
4538
* Since you can't change the DOM order of slots when declaring them within a prop, it might prove beneficial to manually mount them as part of the component's children, especially when facing problems with the reading order of screen readers.

packages/main/src/webComponents/Button/index.tsx

Lines changed: 0 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,6 @@ interface ButtonAttributes {
1717
accessibleNameRef?: string;
1818
/**
1919
* Defines the component design.
20-
*
21-
* **The available values are:**
22-
*
23-
* * `Default`
24-
* * `Emphasized`
25-
* * `Positive`
26-
* * `Negative`
27-
* * `Transparent`
28-
* * `Attention`
2920
*/
3021
design?: ButtonDesign | keyof typeof ButtonDesign;
3122
/**
@@ -58,14 +49,6 @@ interface ButtonAttributes {
5849
/**
5950
* Defines whether the button has special form-related functionality.
6051
*
61-
* **The available values are:**
62-
*
63-
* * `Button`
64-
* * `Submit`
65-
* * `Reset`
66-
*
67-
*
68-
*
6952
* **Note:** For the `type` property to have effect, you must add the following import to your project: `import "@ui5/webcomponents/dist/features/InputElementsFormSupport.js";`
7053
*/
7154
type?: ButtonType | keyof typeof ButtonType;

packages/main/src/webComponents/DatePicker/index.tsx

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -55,14 +55,6 @@ interface DatePickerAttributes {
5555
value?: string;
5656
/**
5757
* Defines the value state of the component.
58-
*
59-
* Available options are:
60-
*
61-
* * `None`
62-
* * `Error`
63-
* * `Warning`
64-
* * `Success`
65-
* * `Information`
6658
*/
6759
valueState?: ValueState | keyof typeof ValueState;
6860
/**

packages/main/src/webComponents/DateRangePicker/index.tsx

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -62,14 +62,6 @@ interface DateRangePickerAttributes {
6262
value?: string;
6363
/**
6464
* Defines the value state of the component.
65-
*
66-
* Available options are:
67-
*
68-
* * `None`
69-
* * `Error`
70-
* * `Warning`
71-
* * `Success`
72-
* * `Information`
7365
*/
7466
valueState?: ValueState | keyof typeof ValueState;
7567
/**

packages/main/src/webComponents/DateTimePicker/index.tsx

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -58,14 +58,6 @@ interface DateTimePickerAttributes {
5858
value?: string;
5959
/**
6060
* Defines the value state of the component.
61-
*
62-
* Available options are:
63-
*
64-
* * `None`
65-
* * `Error`
66-
* * `Warning`
67-
* * `Success`
68-
* * `Information`
6961
*/
7062
valueState?: ValueState | keyof typeof ValueState;
7163
/**

packages/main/src/webComponents/Dialog/index.tsx

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,6 @@ interface DialogAttributes {
3232
resizable?: boolean;
3333
/**
3434
* Defines the state of the `Dialog`.
35-
*
36-
* Available options are: `"None"` (by default), `"Success"`, `"Warning"`, `"Information"` and `"Error"`.
37-
*
3835
* **Note:** If `"Error"` and `"Warning"` state is set, it will change the accessibility role to "alertdialog", if the accessibleRole property is set to `"Dialog"`.
3936
*/
4037
state?: ValueState | keyof typeof ValueState;

packages/main/src/webComponents/FileUploader/index.tsx

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -47,14 +47,6 @@ interface FileUploaderAttributes {
4747
value?: string;
4848
/**
4949
* Defines the value state of the component.
50-
*
51-
* Available options are:
52-
*
53-
* * `None`
54-
* * `Error`
55-
* * `Warning`
56-
* * `Success`
57-
* * `Information`
5850
*/
5951
valueState?: ValueState | keyof typeof ValueState;
6052
}

packages/main/src/webComponents/Input/index.tsx

Lines changed: 5 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ interface InputAttributes {
6969
*/
7070
showSuggestions?: boolean;
7171
/**
72-
* Defines the HTML type of the component. Available options are: `Text`, `Email`, `Number`, `Password`, `Tel`, and `URL`.
72+
* Defines the HTML type of the component.
7373
*
7474
* **Notes:**
7575
*
@@ -85,14 +85,6 @@ interface InputAttributes {
8585
value?: string;
8686
/**
8787
* Defines the value state of the component.
88-
*
89-
* Available options are:
90-
*
91-
* * `None`
92-
* * `Error`
93-
* * `Warning`
94-
* * `Success`
95-
* * `Information`
9688
*/
9789
valueState?: ValueState | keyof typeof ValueState;
9890
}
@@ -114,14 +106,10 @@ export interface InputPropTypes extends InputAttributes, Omit<CommonProps, 'onCh
114106
*
115107
* Example:
116108
*
117-
* <pre>
118-
* <code>
119-
* &lt;Input showSuggestions><br />
120-
* &nbsp;&nbsp;&lt;SuggestionItem text="Item #1" /><br />
121-
* &nbsp;&nbsp;&lt;SuggestionItem text="Item #2" /><br />
122-
* &lt;/Input>
123-
* </code>
124-
* </pre>
109+
* <Input show-suggestions>
110+
*     <SuggestionItem text="Item #1"></SuggestionItem>
111+
*     <SuggestionItem text="Item #2"></SuggestionItem>
112+
* </Input>
125113
*
126114
*
127115
* **Note:** The suggestions would be displayed only if the `showSuggestions` property is set to `true`.

packages/main/src/webComponents/MultiInput/index.tsx

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ interface MultiInputAttributes {
7474
*/
7575
showSuggestions?: boolean;
7676
/**
77-
* Defines the HTML type of the component. Available options are: `Text`, `Email`, `Number`, `Password`, `Tel`, and `URL`.
77+
* Defines the HTML type of the component.
7878
*
7979
* **Notes:**
8080
*
@@ -90,14 +90,6 @@ interface MultiInputAttributes {
9090
value?: string;
9191
/**
9292
* Defines the value state of the component.
93-
*
94-
* Available options are:
95-
*
96-
* * `None`
97-
* * `Error`
98-
* * `Warning`
99-
* * `Success`
100-
* * `Information`
10193
*/
10294
valueState?: ValueState | keyof typeof ValueState;
10395
}

packages/main/src/webComponents/SplitButton/index.tsx

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,6 @@ interface SplitButtonAttributes {
1717
activeIcon?: string;
1818
/**
1919
* Defines the component design.
20-
*
21-
* **The available values are:**
22-
*
23-
* * `Default`
24-
* * `Emphasized`
25-
* * `Positive`
26-
* * `Negative`
27-
* * `Transparent`
28-
* * `Attention`
2920
*/
3021
design?: ButtonDesign | keyof typeof ButtonDesign;
3122
/**

packages/main/src/webComponents/StepInput/index.tsx

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -63,14 +63,6 @@ interface StepInputAttributes {
6363
valuePrecision?: number;
6464
/**
6565
* Defines the value state of the component.
66-
*
67-
* Available options are:
68-
*
69-
* * `None`
70-
* * `Error`
71-
* * `Warning`
72-
* * `Success`
73-
* * `Information`
7466
*/
7567
valueState?: ValueState | keyof typeof ValueState;
7668
}

packages/main/src/webComponents/TimePicker/TimePickerDomRef.json

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,12 @@
66
"type": "Date",
77
"description": "Currently selected time represented as JavaScript Date instance"
88
},
9-
{ "name": "closePicker", "visibility": "public", "description": "Closes the picker" },
9+
{
10+
"name": "closePicker",
11+
"visibility": "public",
12+
"returnValue": { "type": "Promise", "description": "Resolves when the picker is closed" },
13+
"description": "Closes the picker"
14+
},
1015
{
1116
"name": "formatValue",
1217
"visibility": "public",

packages/main/src/webComponents/TimePicker/index.tsx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,9 @@ export interface TimePickerDomRef extends TimePickerAttributes, Ui5DomRef {
5151
readonly dateValue: Date;
5252
/**
5353
* Closes the picker
54+
* @returns {Promise<void>} Resolves when the picker is closed
5455
*/
55-
closePicker: () => void;
56+
closePicker: () => Promise<void>;
5657
/**
5758
* Formats a Java Script date object into a string representing a locale date and time according to the `formatPattern` property of the TimePicker instance
5859
* @param {Date} date - A Java Script date object to be formatted as string

packages/main/src/webComponents/ToggleButton/index.tsx

Lines changed: 0 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,6 @@ interface ToggleButtonAttributes {
2121
accessibleNameRef?: string;
2222
/**
2323
* Defines the component design.
24-
*
25-
* **The available values are:**
26-
*
27-
* * `Default`
28-
* * `Emphasized`
29-
* * `Positive`
30-
* * `Negative`
31-
* * `Transparent`
32-
* * `Attention`
3324
*/
3425
design?: ButtonDesign | keyof typeof ButtonDesign;
3526
/**
@@ -62,14 +53,6 @@ interface ToggleButtonAttributes {
6253
/**
6354
* Defines whether the button has special form-related functionality.
6455
*
65-
* **The available values are:**
66-
*
67-
* * `Button`
68-
* * `Submit`
69-
* * `Reset`
70-
*
71-
*
72-
*
7356
* **Note:** For the `type` property to have effect, you must add the following import to your project: `import "@ui5/webcomponents/dist/features/InputElementsFormSupport.js";`
7457
*/
7558
type?: ButtonType | keyof typeof ButtonType;

packages/main/src/webComponents/ToolbarV2/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface ToolbarV2DomRef extends ToolbarV2Attributes, Ui5DomRef {}
2828

2929
export interface ToolbarV2PropTypes extends ToolbarV2Attributes, CommonProps {
3030
/**
31-
* Defines the items of the component.
31+
* Defines the items of the component. **Note:** Currently only `ToolbarButton`, `ToolbarSelect`, `ToolbarSeparatorV2` and `ToolbarSpacerV2` are allowed here.
3232
*/
3333
children?: ReactNode | ReactNode[];
3434
}

0 commit comments

Comments
 (0)