@fundamental-ngx/ui5-webcomponents 0.58.0-rc.1

package/file-uploader/index.d.ts

@@ -0,0 +1,97 @@
+import * as _angular_core from '@angular/core';
+import { AfterViewInit, ElementRef, Injector } from '@angular/core';
+import _FileUploader from '@ui5/webcomponents/dist/FileUploader.js';
+import { UI5CustomEvent } from '@ui5/webcomponents-base';
+import * as i1 from '@fundamental-ngx/ui5-webcomponents/utils';
+
+declare class FileUploader implements AfterViewInit {
+    /**
+     * Comma-separated list of file types that the component should accept.
+  
+  **Note:** Please make sure you are adding the `.` in front on the file type, e.g. `.png` in case you want to accept png's only.
+     */
+    accept: _angular_core.InputSignal<string | undefined>;
+    /**
+     * If set to "true", the input field of component will not be rendered. Only the default slot that is passed will be rendered.
+  
+  **Note:** Use this property in combination with the default slot to achieve a button-only file uploader design.
+     */
+    hideInput: _angular_core.InputSignalWithTransform<boolean, unknown>;
+    /**
+     * Defines whether the component is in disabled state.
+  
+  **Note:** A disabled component is completely noninteractive.
+     */
+    disabled: _angular_core.InputSignalWithTransform<boolean, unknown>;
+    /**
+     * Allows multiple files to be chosen.
+     */
+    multiple: _angular_core.InputSignalWithTransform<boolean, unknown>;
+    /**
+     * Determines the name by which the component will be identified upon submission in an HTML form.
+  
+  **Note:** This property is only applicable within the context of an HTML Form element.
+     */
+    name: _angular_core.InputSignal<string | undefined>;
+    /**
+     * Defines a short hint intended to aid the user with data entry when the component has no value.
+     */
+    placeholder: _angular_core.InputSignal<string | undefined>;
+    /**
+     * Defines the name/names of the file/files to upload.
+     */
+    value: _angular_core.InputSignal<string | undefined>;
+    /**
+     * Defines the maximum file size in megabytes which prevents the upload if at least one file exceeds it.
+     */
+    maxFileSize: _angular_core.InputSignal<number | undefined>;
+    /**
+     * Defines the value state of the component.
+     */
+    valueState: _angular_core.InputSignal<"None" | "Positive" | "Critical" | "Negative" | "Information" | undefined>;
+    /**
+     * Defines whether the component is required.
+     */
+    required: _angular_core.InputSignalWithTransform<boolean, unknown>;
+    /**
+     * Defines the accessible ARIA name of the component.
+     */
+    accessibleName: _angular_core.InputSignal<string | undefined>;
+    /**
+     * Receives id(or many ids) of the elements that label the input.
+     */
+    accessibleNameRef: _angular_core.InputSignal<string | undefined>;
+    /**
+     * Defines the accessible description of the component.
+     */
+    accessibleDescription: _angular_core.InputSignal<string | undefined>;
+    /**
+     * Receives id(or many ids) of the elements that describe the input.
+     */
+    accessibleDescriptionRef: _angular_core.InputSignal<string | undefined>;
+    /**
+     * FileList of all selected files.
+     * @readonly This property is managed by the web component and updates reactively.
+     * Based on schema: readonly field that updates via change event parameters.
+     */
+    files: _angular_core.Signal<FileList | null>;
+    /**
+     * Event is fired when the value of the file path has been changed.
+  
+  **Note:** Keep in mind that because of the HTML input element of type file, the event is also fired in Chrome browser when the Cancel button of the uploads window is pressed.
+     */
+    ui5Change: _angular_core.OutputEmitterRef<UI5CustomEvent<_FileUploader, "change">>;
+    /**
+     * Event is fired when the size of a file is above the `maxFileSize` property value.
+     */
+    ui5FileSizeExceed: _angular_core.OutputEmitterRef<UI5CustomEvent<_FileUploader, "file-size-exceed">>;
+    elementRef: ElementRef<_FileUploader>;
+    injector: Injector;
+    private _filesSignal;
+    get element(): _FileUploader;
+    ngAfterViewInit(): void;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<FileUploader, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<FileUploader, "ui5-file-uploader, [ui5-file-uploader]", ["ui5FileUploader"], { "accept": { "alias": "accept"; "required": false; "isSignal": true; }; "hideInput": { "alias": "hideInput"; "required": false; "isSignal": true; }; "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; "multiple": { "alias": "multiple"; "required": false; "isSignal": true; }; "name": { "alias": "name"; "required": false; "isSignal": true; }; "placeholder": { "alias": "placeholder"; "required": false; "isSignal": true; }; "value": { "alias": "value"; "required": false; "isSignal": true; }; "maxFileSize": { "alias": "maxFileSize"; "required": false; "isSignal": true; }; "valueState": { "alias": "valueState"; "required": false; "isSignal": true; }; "required": { "alias": "required"; "required": false; "isSignal": true; }; "accessibleName": { "alias": "accessibleName"; "required": false; "isSignal": true; }; "accessibleNameRef": { "alias": "accessibleNameRef"; "required": false; "isSignal": true; }; "accessibleDescription": { "alias": "accessibleDescription"; "required": false; "isSignal": true; }; "accessibleDescriptionRef": { "alias": "accessibleDescriptionRef"; "required": false; "isSignal": true; }; }, { "ui5Change": "ui5Change"; "ui5FileSizeExceed": "ui5FileSizeExceed"; }, never, ["*"], true, [{ directive: typeof i1.GenericControlValueAccessor; inputs: {}; outputs: {}; }]>;
+}
+
+export { FileUploader };

package/form/index.d.ts

@@ -0,0 +1,84 @@
+import * as _angular_core from '@angular/core';
+import { AfterViewInit, ElementRef, Injector } from '@angular/core';
+import _Form from '@ui5/webcomponents/dist/Form.js';
+
+declare class Form implements AfterViewInit {
+    /**
+     * Defines the accessible ARIA name of the component.
+     */
+    accessibleName: _angular_core.InputSignal<string | undefined>;
+    /**
+     * Defines id (or many ids) of the element (or elements) that label the component.
+     */
+    accessibleNameRef: _angular_core.InputSignal<string | undefined>;
+    /**
+     * Defines the accessibility mode of the component in "edit" and "display" use-cases.
+  
+  Based on the mode, the component renders different HTML elements and ARIA attributes,
+  which are appropriate for the use-case.
+  
+  **Usage:**
+  - Set this property to "Display", when the form consists of non-editable (e.g. texts) form items.
+  - Set this property to "Edit", when the form consists of editable (e.g. input fields) form items.
+     */
+    accessibleMode: _angular_core.InputSignal<"Display" | "Edit" | undefined>;
+    /**
+     * Defines the number of columns to distribute the form content by breakpoint.
+  
+  Supported values:
+  - `S` - 1 column by default (1 column is recommended)
+  - `M` - 1 column by default (up to 2 columns are recommended)
+  - `L` - 2 columns by default (up to 3 columns are recommended)
+  - `XL` - 3 columns by default (up to 6 columns  are recommended)
+     */
+    layout: _angular_core.InputSignal<string | undefined>;
+    /**
+     * Defines the width proportion of the labels and fields of a form item by breakpoint.
+  
+  By default, the labels take 4/12 (or 1/3) of the form item in M,L and XL sizes,
+  and 12/12 in S size, e.g in S the label is on top of its associated field.
+  
+  The supported values are between 1 and 12. Greater the number, more space the label will use.
+  
+  **Note:** If "12" is set, the label will be displayed on top of its assosiated field.
+     */
+    labelSpan: _angular_core.InputSignal<string | undefined>;
+    /**
+     * Defines the number of cells that are empty at the end of each form item, configurable by breakpoint.
+  
+  By default, a form item spans 12 cells, fully divided between its label (4 cells) and field (8 cells), with no empty space at the end.
+  The `emptySpan` provides additional layout flexibility by defining empty space at the form item’s end.
+  
+  **Note:**
+  - The maximum allowable empty space is 10 cells. At least 1 cell each must remain for the label and the field.
+  - When `emptySpan` is specified (greater than 0), ensure that the combined value of `emptySpan` and `labelSpan` does not exceed 11. This guarantees a minimum of 1 cell for the field.
+     */
+    emptySpan: _angular_core.InputSignal<string | undefined>;
+    /**
+     * Defines the header text of the component.
+  
+  **Note:** The property gets overridden by the `header` slot.
+     */
+    headerText: _angular_core.InputSignal<string | undefined>;
+    /**
+     * Defines the compoennt heading level,
+  set by the `headerText`.
+     */
+    headerLevel: _angular_core.InputSignal<"H1" | "H2" | "H3" | "H4" | "H5" | "H6" | undefined>;
+    /**
+     * Defines the vertical spacing between form items.
+  
+  **Note:** If the Form is meant to be switched between "display"("non-edit") and "edit" modes,
+  we recommend using "Large" item spacing in "display"("non-edit") mode, and "Normal" - for "edit" mode,
+  to avoid "jumping" effect, caused by the hight difference between texts in "display"("non-edit") mode and the input fields in "edit" mode.
+     */
+    itemSpacing: _angular_core.InputSignal<"Normal" | "Large" | undefined>;
+    elementRef: ElementRef<_Form>;
+    injector: Injector;
+    get element(): _Form;
+    ngAfterViewInit(): void;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<Form, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<Form, "ui5-form, [ui5-form]", ["ui5Form"], { "accessibleName": { "alias": "accessibleName"; "required": false; "isSignal": true; }; "accessibleNameRef": { "alias": "accessibleNameRef"; "required": false; "isSignal": true; }; "accessibleMode": { "alias": "accessibleMode"; "required": false; "isSignal": true; }; "layout": { "alias": "layout"; "required": false; "isSignal": true; }; "labelSpan": { "alias": "labelSpan"; "required": false; "isSignal": true; }; "emptySpan": { "alias": "emptySpan"; "required": false; "isSignal": true; }; "headerText": { "alias": "headerText"; "required": false; "isSignal": true; }; "headerLevel": { "alias": "headerLevel"; "required": false; "isSignal": true; }; "itemSpacing": { "alias": "itemSpacing"; "required": false; "isSignal": true; }; }, {}, never, ["*"], true, never>;
+}
+
+export { Form };

package/form-group/index.d.ts

@@ -0,0 +1,36 @@
+import * as _angular_core from '@angular/core';
+import { AfterViewInit, ElementRef, Injector } from '@angular/core';
+import _FormGroup from '@ui5/webcomponents/dist/FormGroup.js';
+
+declare class FormGroup implements AfterViewInit {
+    /**
+     * Defines header text of the component.
+     */
+    headerText: _angular_core.InputSignal<string | undefined>;
+    /**
+     * Defines the compoennt heading level,
+  set by the `headerText`.
+     */
+    headerLevel: _angular_core.InputSignal<"H1" | "H2" | "H3" | "H4" | "H5" | "H6" | undefined>;
+    /**
+     * Defines column span of the component,
+  e.g how many columns the group should span to.
+     */
+    columnSpan: _angular_core.InputSignal<number | undefined>;
+    /**
+     * Defines the accessible ARIA name of the component.
+     */
+    accessibleName: _angular_core.InputSignal<string | undefined>;
+    /**
+     * Defines id (or many ids) of the element (or elements) that label the component.
+     */
+    accessibleNameRef: _angular_core.InputSignal<string | undefined>;
+    elementRef: ElementRef<_FormGroup>;
+    injector: Injector;
+    get element(): _FormGroup;
+    ngAfterViewInit(): void;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<FormGroup, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<FormGroup, "ui5-form-group, [ui5-form-group]", ["ui5FormGroup"], { "headerText": { "alias": "headerText"; "required": false; "isSignal": true; }; "headerLevel": { "alias": "headerLevel"; "required": false; "isSignal": true; }; "columnSpan": { "alias": "columnSpan"; "required": false; "isSignal": true; }; "accessibleName": { "alias": "accessibleName"; "required": false; "isSignal": true; }; "accessibleNameRef": { "alias": "accessibleNameRef"; "required": false; "isSignal": true; }; }, {}, never, ["*"], true, never>;
+}
+
+export { FormGroup };

package/form-item/index.d.ts

@@ -0,0 +1,23 @@
+import * as i0 from '@angular/core';
+import { AfterViewInit, ElementRef, Injector } from '@angular/core';
+import _FormItem from '@ui5/webcomponents/dist/FormItem.js';
+
+declare class FormItem implements AfterViewInit {
+    /**
+     * Defines the column span of the component,
+  e.g how many columns the component should span to.
+  
+  **Note:** The column span should be a number between 1 and the available columns of the FormGroup (when items are placed in a group)
+  or the Form. The available columns can be affected by the FormGroup#columnSpan and/or the Form#layout.
+  A number bigger than the available columns won't take effect.
+     */
+    columnSpan: i0.InputSignal<number | undefined>;
+    elementRef: ElementRef<_FormItem>;
+    injector: Injector;
+    get element(): _FormItem;
+    ngAfterViewInit(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<FormItem, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<FormItem, "ui5-form-item, [ui5-form-item]", ["ui5FormItem"], { "columnSpan": { "alias": "columnSpan"; "required": false; "isSignal": true; }; }, {}, never, ["*"], true, never>;
+}
+
+export { FormItem };

package/icon/index.d.ts

@@ -0,0 +1,67 @@
+import * as _angular_core from '@angular/core';
+import { AfterViewInit, ElementRef, Injector } from '@angular/core';
+import _Icon from '@ui5/webcomponents/dist/Icon.js';
+import { UI5CustomEvent } from '@ui5/webcomponents-base';
+
+declare class Icon implements AfterViewInit {
+    /**
+     * Defines the component semantic design.
+     */
+    design: _angular_core.InputSignal<"Contrast" | "Critical" | "Default" | "Information" | "Negative" | "Neutral" | "NonInteractive" | "Positive" | undefined>;
+    /**
+     * Defines the unique identifier (icon name) of the component.
+  
+  To browse all available icons, see the
+  [SAP Icons](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html),
+  [SAP Fiori Tools](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html#/overview/SAP-icons-TNT) and
+  [SAP Business Suite](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html)
+  
+  Example:
+  `name='add'`, `name='delete'`, `name='employee'`.
+  
+  **Note:** To use the SAP Fiori Tools icons,
+  you need to set the `tnt` prefix in front of the icon's name.
+  
+  Example:
+  `name='tnt/antenna'`, `name='tnt/actor'`, `name='tnt/api'`.
+  
+  **Note:** To use the SAP Business Suite icons,
+  you need to set the `business-suite` prefix in front of the icon's name.
+  
+  Example:
+  `name='business-suite/3d'`, `name='business-suite/1x2-grid-layout'`, `name='business-suite/4x4-grid-layout'`.
+     */
+    name: _angular_core.InputSignal<string | undefined>;
+    /**
+     * Defines the text alternative of the component.
+  If not provided a default text alternative will be set, if present.
+  
+  **Note:** Every icon should have a text alternative in order to
+  calculate its accessible name.
+     */
+    accessibleName: _angular_core.InputSignal<string | undefined>;
+    /**
+     * Defines whether the component should have a tooltip.
+  
+  **Note:** The tooltip text should be provided via the `accessible-name` property.
+     */
+    showTooltip: _angular_core.InputSignalWithTransform<boolean, unknown>;
+    /**
+     * Defines the mode of the component.
+     */
+    mode: _angular_core.InputSignal<"Image" | "Decorative" | "Interactive" | undefined>;
+    /**
+     * Fired on mouseup, `SPACE` and `ENTER`.
+  - on mouse click, the icon fires native `click` event
+  - on `SPACE` and `ENTER`, the icon fires custom `click` event
+     */
+    ui5Click: _angular_core.OutputEmitterRef<UI5CustomEvent<_Icon, "click">>;
+    elementRef: ElementRef<_Icon>;
+    injector: Injector;
+    get element(): _Icon;
+    ngAfterViewInit(): void;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<Icon, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<Icon, "ui5-icon, [ui5-icon]", ["ui5Icon"], { "design": { "alias": "design"; "required": false; "isSignal": true; }; "name": { "alias": "name"; "required": false; "isSignal": true; }; "accessibleName": { "alias": "accessibleName"; "required": false; "isSignal": true; }; "showTooltip": { "alias": "showTooltip"; "required": false; "isSignal": true; }; "mode": { "alias": "mode"; "required": false; "isSignal": true; }; }, { "ui5Click": "ui5Click"; }, never, ["*"], true, never>;
+}
+
+export { Icon };