@ui5/webcomponents 0.0.0-8db0ce01a → 0.0.0-a3eca7ade

package/src/Table.js

@@ -2,21 +2,37 @@ import UI5Element from "@ui5/webcomponents-base/dist/UI5Element.js";
 import litRender from "@ui5/webcomponents-base/dist/renderer/LitRenderer.js";
 import ResizeHandler from "@ui5/webcomponents-base/dist/delegate/ResizeHandler.js";
 import ItemNavigation from "@ui5/webcomponents-base/dist/delegate/ItemNavigation.js";
+import Integer from "@ui5/webcomponents-base/dist/types/Integer.js";
 import NavigationMode from "@ui5/webcomponents-base/dist/types/NavigationMode.js";
 import { isIE } from "@ui5/webcomponents-base/dist/Device.js";
-import { isSpace, isEnter } from "@ui5/webcomponents-base/dist/Keys.js";
-import { fetchI18nBundle, getI18nBundle } from "@ui5/webcomponents-base/dist/i18nBundle.js";
+import {
+	isSpace,
+	isEnter,
+	isCtrlA,
+	isUpAlt,
+	isDownAlt,
+	isUpShift,
+	isDownShift,
+	isHomeCtrl,
+	isEndCtrl,
+	isHomeShift,
+	isEndShift,
+} from "@ui5/webcomponents-base/dist/Keys.js";
+import { getTabbableElements } from "@ui5/webcomponents-base/dist/util/TabbableElements.js";
+import { getI18nBundle } from "@ui5/webcomponents-base/dist/i18nBundle.js";
 import debounce from "@ui5/webcomponents-base/dist/util/debounce.js";
 import isElementInView from "@ui5/webcomponents-base/dist/util/isElementInView.js";
 import TableGrowingMode from "./types/TableGrowingMode.js";
 import BusyIndicator from "./BusyIndicator.js";
 import TableMode from "./types/TableMode.js";
+import CheckBox from "./CheckBox.js"; // Ensure the dependency as it is being used in the renderer
 
 // Texts
 import {
 	LOAD_MORE_TEXT,
 	ARIA_LABEL_SELECT_ALL_CHECKBOX,
 	TABLE_HEADER_ROW_TEXT,
+	TABLE_ROW_POSITION,
 } from "./generated/i18n/i18n-defaults.js";
 
 // Template
@@ -33,10 +49,11 @@ const GROWING_WITH_SCROLL_DEBOUNCE_RATE = 250; // ms
 const metadata = {
 	tag: "ui5-table",
 	managedSlots: true,
+	fastNavigation: true,
 	slots: /** @lends sap.ui.webcomponents.main.Table.prototype */ {
 
 		/**
-		 * Defines the <code>ui5-table</code> rows.
+		 * Defines the component rows.
 		 * <br><br>
 		 * <b>Note:</b> Use <code>ui5-table-row</code> for the intended design.
 		 *
@@ -48,10 +65,11 @@ const metadata = {
 			propertyName: "rows",
 			type: HTMLElement,
 			individualSlots: true,
+			invalidateOnChildChange: true,
 		},
 
 		/**
-		 * Defines the configuration for the columns of the <code>ui5-table</code>.
+		 * Defines the configuration for the columns of the component.
 		 * <br><br>
 		 * <b>Note:</b> Use <code>ui5-table-column</code> for the intended design.
 		 *
@@ -71,7 +89,7 @@ const metadata = {
 	properties: /** @lends sap.ui.webcomponents.main.Table.prototype */ {
 
 		/**
-		 * Defines the text that will be displayed when there is no data and <code>showNoData</code> is present.
+		 * Defines the text that will be displayed when there is no data and <code>hideNoData</code> is not present.
 		 *
 		 * @type {string}
 		 * @defaultvalue ""
@@ -82,7 +100,7 @@ const metadata = {
 		},
 
 		/**
-		 * Defines the text that will be displayed inside the <code>More</code> button at the bottom of the table,
+		 * Defines the text that will be displayed inside the growing button at the bottom of the table,
 		 * meant for loading more rows upon press.
 		 *
 		 * <br><br>
@@ -92,25 +110,25 @@ const metadata = {
 		 *
 		 * @type {string}
 		 * @defaultvalue ""
-		 * @since 1.0.0-rc.11
+		 * @since 1.0.0-rc.15
 		 * @public
 		 */
-		moreText: {
+		growingButtonText: {
 			type: String,
 		},
 
 		/**
-		 * Defines the subtext that will be displayed under the <code>moreText</code>.
+		 * Defines the subtext that will be displayed under the <code>growingButtonText</code>.
 		 *
 		 * <br><br>
 		 * <b>Note:</b> This property takes effect if <code>growing</code> is set to <code>Button</code>.
 		 *
 		 * @type {string}
 		 * @defaultvalue ""
-		 * @since 1.0.0-rc.11
+		 * @since 1.0.0-rc.15
 		 * @public
 		 */
-		moreSubtext: {
+		 growingButtonSubtext: {
 			type: String,
 		},
 
@@ -120,8 +138,9 @@ const metadata = {
 		 * @type {boolean}
 		 * @defaultvalue false
 		 * @public
+		 * @since 1.0.0-rc.15
 		 */
-		showNoData: {
+		hideNoData: {
 			type: Boolean,
 		},
 
@@ -139,7 +158,7 @@ const metadata = {
 		 * <code>None</code> (default) - The growing is off.
 		 * <br><br>
 		 *
-		 * <b>Limitations:</b> <code>growing="Scroll"</code> is not supported for Internet Explorer,
+		 * <b>Restrictions:</b> <code>growing="Scroll"</code> is not supported for Internet Explorer,
 		 * and the component will fallback to <code>growing="Button"</code>.
 		 * @type {TableGrowingMode}
 		 * @defaultvalue "None"
@@ -166,11 +185,23 @@ const metadata = {
 			type: Boolean,
 		},
 
+		/**
+		 * Defines the delay in milliseconds, after which the busy indicator will show up for this component.
+		 *
+		 * @type {Integer}
+		 * @defaultValue 1000
+		 * @public
+		 */
+		busyDelay: {
+			type: Integer,
+			defaultValue: 1000,
+		},
+
 		/**
 		 * Determines whether the column headers remain fixed at the top of the page during
 		 * vertical scrolling as long as the Web Component is in the viewport.
 		 * <br><br>
-		 * <b>Limitations:</b>
+		 * <b>Restrictions:</b>
 		 * <ul>
 		 * <li>Browsers that do not support this feature:
 		 * <ul>
@@ -197,7 +228,7 @@ const metadata = {
 		},
 
 		/**
-		 * Defines the mode of the <code>ui5-table</code>.
+		 * Defines the mode of the component.
 		 * <br><br>
 		 * Available options are:
 		 * <ul>
@@ -250,7 +281,7 @@ const metadata = {
 
 		/**
 		 * Defines whether all rows are selected or not when table is in MultiSelect mode.
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @defaultvalue false
 		 * @since 1.0.0-rc.15
 		 * @private
@@ -274,7 +305,7 @@ const metadata = {
 		},
 
 		/**
-		 * Fired when the <code>ui5-table-column</code> is shown as a pop-in instead of hiding it.
+		 * Fired when <code>ui5-table-column</code> is shown as a pop-in instead of hiding it.
 		 *
 		 * @event sap.ui.webcomponents.main.Table#popin-change
 		 * @param {Array} poppedColumns popped-in columns.
@@ -348,6 +379,26 @@ const metadata = {
  * <br><br>
  * <b>Note:</b> Currently, when a column is shown as a pop-in, the visual indication for selection is not presented over it.
  *
+ * <h3>Keyboard Handling</h3>
+ *
+ * <h4>Fast Navigation</h4>
+ * This component provides a build in fast navigation group which can be used via <code>F6 / Shift + F6</code> or <code> Ctrl + Alt(Option) + Down /  Ctrl + Alt(Option) + Up</code>.
+ * In order to use this functionality, you need to import the following module:
+ * <code>import "@ui5/webcomponents-base/dist/features/F6Navigation.js"</code>
+ * <br><br>
+ * Furthermore, you can interact with <code>ui5-table</code> via the following keys.
+ * <br>
+ *
+ * <ul>
+ * <li>[F7] - If focus is on an interactive control inside an item, moves focus to the corresponding item.</li>
+ * <li>[CTRL]+[A] - Selects all items, if MultiSelect mode is enabled.</li>
+ * <li>[HOME]/[END] - Focuses the first/last item.</li>
+ * <li>[PAGEUP]/[PAGEDOWN] - Moves focus up/down by page size (20 items by default).</li>
+ * <li>[ALT]+[DOWN]/[UP] - Switches focus between header, last focused item, and More button (if applies) in either direction.</li>
+ * <li>[SHIFT]+[DOWN]/[UP] - Selects the next/previous item in a MultiSelect table, if the current item is selected (Range selection). Otherwise, deselects them (Range deselection).</li>
+ * <li>[SHIFT]+[HOME]/[END] - Range selection to the first/last item of the List.</li>
+ * <li>[CTRL]+[HOME]/[END] - Same behavior as HOME & END.</li> * </ul>
+ *
  * <h3>ES6 Module Import</h3>
  *
  * <code>import "@ui5/webcomponents/dist/Table.js";</code>
@@ -363,7 +414,7 @@ const metadata = {
  * @alias sap.ui.webcomponents.main.Table
  * @extends sap.ui.webcomponents.base.UI5Element
  * @tagname ui5-table
- * @appenddocs TableColumn TableRow TableCell
+ * @appenddocs TableColumn TableRow TableGroupRow TableCell
  * @public
  */
 class Table extends UI5Element {
@@ -384,11 +435,11 @@ class Table extends UI5Element {
 	}
 
 	static get dependencies() {
-		return [BusyIndicator];
+		return [BusyIndicator, CheckBox];
 	}
 
 	static async onDefine() {
-		await fetchI18nBundle("@ui5/webcomponents");
+		Table.i18nBundle = await getI18nBundle("@ui5/webcomponents");
 	}
 
 	constructor() {
@@ -404,28 +455,33 @@ class Table extends UI5Element {
 			navigationMode: NavigationMode.Vertical,
 			affectedPropertiesNames: ["_columnHeader"],
 			getItemsCallback: () => [this._columnHeader, ...this.rows],
+			skipItemsSize: 20,
 		});
 
 		this.fnOnRowFocused = this.onRowFocused.bind(this);
 
 		this._handleResize = this.popinContent.bind(this);
 
-		this.i18nBundle = getI18nBundle("@ui5/webcomponents");
-
 		this.tableEndObserved = false;
+
 		this.addEventListener("ui5-selection-requested", this._handleSelect.bind(this));
+
+		this._prevNestedElementIndex = 0;
 	}
 
 	onBeforeRendering() {
 		const columnSettings = this.getColumnPropagationSettings();
 		const columnSettingsString = JSON.stringify(columnSettings);
+		const rowsCount = this.rows.length;
+		const selectedRows = this.selectedRows;
 
-		this.rows.forEach(row => {
+		this.rows.forEach((row, index) => {
 			if (row._columnsInfoString !== columnSettingsString) {
 				row._columnsInfo = columnSettings;
 				row._columnsInfoString = JSON.stringify(row._columnsInfo);
 			}
 
+			row._ariaPosition = Table.i18nBundle.getText(TABLE_ROW_POSITION, index + 1, rowsCount);
 			row._busy = this.busy;
 			row.removeEventListener("ui5-_focused", this.fnOnRowFocused);
 			row.addEventListener("ui5-_focused", this.fnOnRowFocused);
@@ -433,12 +489,15 @@ class Table extends UI5Element {
 		});
 
 		this.visibleColumns = this.columns.filter((column, index) => {
-			column.sticky = this.stickyColumnHeader;
 			return !this._hiddenColumns[index];
 		});
 
-		this._noDataDisplayed = !this.rows.length && this.showNoData;
+		this._noDataDisplayed = !this.rows.length && !this.hideNoData;
 		this.visibleColumnsCount = this.visibleColumns.length;
+
+		this._allRowsSelected = selectedRows.length === this.rows.length;
+
+		this._previousFocusedRow = this._previousFocusedRow || this.rows[0] || null;
 	}
 
 	onAfterRendering() {
@@ -455,6 +514,16 @@ class Table extends UI5Element {
 		}
 
 		ResizeHandler.register(this.getDomRef(), this._handleResize);
+
+		this._itemNavigation.setCurrentItem(this.rows.length ? this.rows[0] : this._columnHeader);
+
+		this.rows.forEach((row, index) => {
+			row._tabbableElements = getTabbableElements(row);
+
+			if (index > 0) {
+				row._tabbableElements.forEach(el => el.setAttribute("tabindex", "-1"));
+			}
+		});
 	}
 
 	onExitDOM() {
@@ -467,6 +536,182 @@ class Table extends UI5Element {
 		}
 	}
 
+	_onkeydown(event) {
+		if (isCtrlA(event)) {
+			event.preventDefault();
+			this.isMultiSelect && this._selectAll(event);
+			return;
+		}
+
+		const isAltUp = isUpAlt(event);
+
+		if (isAltUp || isDownAlt(event)) {
+			return this._handleArrowAlt(isAltUp, event.target);
+		}
+
+		if ((isUpShift(event) || isDownShift(event)) && this.isMultiSelect) {
+			this._handleArrowNav(event);
+		}
+
+		if (isHomeCtrl(event)) {
+			event.preventDefault();
+
+			this._itemNavigation._handleHome(event);
+			this._itemNavigation._applyTabIndex();
+			this._itemNavigation._focusCurrentItem();
+		}
+
+		if (isEndCtrl(event)) {
+			event.preventDefault();
+
+			this._itemNavigation._handleEnd(event);
+			this._itemNavigation._applyTabIndex();
+			this._itemNavigation._focusCurrentItem();
+		}
+
+		if ((isHomeShift(event) || isEndShift(event)) && this.isMultiSelect) {
+			this._handleHomeEndSelection(event);
+		}
+	}
+
+	_handleArrowNav(event) {
+		const isRowFocused = this.currentElement.localName === "tr";
+
+		if (!isRowFocused) {
+			return;
+		}
+
+		const previouslySelectedRows = this.selectedRows;
+		const currentItem = this.currentItem;
+		const currentItemIdx = this.currentItemIdx;
+
+		const prevItemIdx = currentItemIdx - 1;
+		const nextItemIdx = currentItemIdx + 1;
+
+		const prevItem = this.rows[prevItemIdx];
+		const nextItem = this.rows[nextItemIdx];
+		const wasSelected = currentItem.selected;
+
+		if ((isUpShift(event) && !prevItem) || (isDownShift(event) && !nextItem)) {
+			return;
+		}
+
+		if (isUpShift(event)) {
+			currentItem.selected = currentItem.selected && !prevItem.selected;
+			prevItem.selected = currentItem.selected || (wasSelected && !currentItem.selected);
+
+			prevItem.focus();
+		}
+
+		if (isDownShift(event)) {
+			currentItem.selected = currentItem.selected && !nextItem.selected;
+			nextItem.selected = currentItem.selected || (wasSelected && !currentItem.selected);
+
+			nextItem.focus();
+		}
+
+		const selectedRows = this.selectedRows;
+
+		this.fireEvent("selection-change", {
+			selectedRows,
+			previouslySelectedRows,
+		});
+	}
+
+	_handleHomeEndSelection(event) {
+		const isRowFocused = this.currentElement.localName === "tr";
+
+		if (!isRowFocused) {
+			return;
+		}
+		const rows = this.rows;
+		const previouslySelectedRows = this.selectedRows;
+		const currentItemIdx = this.currentItemIdx;
+
+		if (isHomeShift(event)) {
+			rows.slice(0, currentItemIdx + 1).forEach(item => {
+				item.selected = true;
+			});
+			rows[0].focus();
+		}
+
+		if (isEndShift(event)) {
+			rows.slice(currentItemIdx).forEach(item => {
+				item.selected = true;
+			});
+			rows[rows.length - 1].focus();
+		}
+
+		const selectedRows = this.selectedRows;
+
+		this.fireEvent("selection-change", {
+			selectedRows,
+			previouslySelectedRows,
+		});
+	}
+
+	/**
+	 * Handles Alt + Up/Down.
+	 * Switches focus between column header, last focused item, and "More" button (if applicable).
+	 * @private
+	 * @param {boolean} shouldMoveUp Whether to move focus upward
+	 * @param {object} focusedElement The element currently in focus
+	 */
+	_handleArrowAlt(shouldMoveUp, focusedElement) {
+		const focusedElementType = this.getFocusedElementType(focusedElement);
+		const moreButton = this.getMoreButton();
+
+		if (shouldMoveUp) {
+			switch (focusedElementType) {
+			case "tableRow":
+				this._previousFocusedRow = focusedElement;
+				return this._onColumnHeaderClick();
+			case "columnHeader":
+				return moreButton ? moreButton.focus() : this._previousFocusedRow.focus();
+			case "moreButton":
+				return this._previousFocusedRow ? this._previousFocusedRow.focus() : this._onColumnHeaderClick();
+			}
+		} else {
+			switch (focusedElementType) {
+			case "tableRow":
+				this._previousFocusedRow = focusedElement;
+				return moreButton ? moreButton.focus() : this._onColumnHeaderClick();
+			case "columnHeader":
+				if (this._previousFocusedRow) {
+					return this._previousFocusedRow.focus();
+				}
+
+				if (moreButton) {
+					return moreButton.focus();
+				}
+
+				return;
+			case "moreButton":
+				return this._onColumnHeaderClick();
+			}
+		}
+	}
+
+	/**
+	 * Determines the type of the currently focused element.
+	 * @private
+	 * @param {object} element The object representation of the DOM element
+	 * @returns {("columnHeader"|"tableRow"|"moreButton")} A string identifier
+	 */
+	getFocusedElementType(element) {
+		if (element === this.getColumnHeader()) {
+			return "columnHeader";
+		}
+
+		if (element === this.getMoreButton()) {
+			return "moreButton";
+		}
+
+		if (this.rows.includes(element)) {
+			return "tableRow";
+		}
+	}
+
 	onRowFocused(event) {
 		this._itemNavigation.setCurrentItem(event.target);
 	}
@@ -476,6 +721,13 @@ class Table extends UI5Element {
 		this._itemNavigation.setCurrentItem(this._columnHeader);
 	}
 
+	_onColumnHeaderKeydown(event) {
+		if (isSpace(event)) {
+			event.preventDefault();
+			this.isMultiSelect && this._selectAll();
+		}
+	}
+
 	_onLoadMoreKeydown(event) {
 		if (isSpace(event)) {
 			event.preventDefault();
@@ -558,7 +810,7 @@ class Table extends UI5Element {
 	}
 
 	_selectAll(event) {
-		const bAllSelected = event.target.checked;
+		const bAllSelected = !this._allRowsSelected;
 		const previouslySelectedRows = this.rows.filter(row => row.selected);
 
 		this._allRowsSelected = bAllSelected;
@@ -593,6 +845,10 @@ class Table extends UI5Element {
 		return this.getDomRef() && this.getDomRef().querySelector(`#${this._id}-columnHeader`);
 	}
 
+	getMoreButton() {
+		return this.growsWithButton && this.getDomRef() && this.getDomRef().querySelector(`#${this._id}-growingButton`);
+	}
+
 	handleResize(event) {
 		this.checkTableInViewport();
 		this.popinContent(event);
@@ -691,12 +947,12 @@ class Table extends UI5Element {
 		return !isIE() && this.growing === TableGrowingMode.Scroll;
 	}
 
-	get _moreText() {
-		return this.moreText || this.i18nBundle.getText(LOAD_MORE_TEXT);
+	get _growingButtonText() {
+		return this.growingButtonText || Table.i18nBundle.getText(LOAD_MORE_TEXT);
 	}
 
 	get ariaLabelText() {
-		const headerRowText = this.i18nBundle.getText(TABLE_HEADER_ROW_TEXT);
+		const headerRowText = Table.i18nBundle.getText(TABLE_HEADER_ROW_TEXT);
 		const columnsTitle = this.columns.map(column => {
 			return column.textContent.trim();
 		}).join(" ");
@@ -705,15 +961,15 @@ class Table extends UI5Element {
 	}
 
 	get ariaLabelSelectAllText() {
-		return this.i18nBundle.getText(ARIA_LABEL_SELECT_ALL_CHECKBOX);
+		return Table.i18nBundle.getText(ARIA_LABEL_SELECT_ALL_CHECKBOX);
 	}
 
 	get loadMoreAriaLabelledBy() {
 		if (this.moreDataText) {
-			return `${this._id}-showMore-text ${this._id}-showMore-desc`;
+			return `${this._id}-growingButton-text ${this._id}-growingButton-subtext`;
 		}
 
-		return `${this._id}-showMore-text`;
+		return `${this._id}-growingButton-text`;
 	}
 
 	get tableEndDOM() {
@@ -735,6 +991,18 @@ class Table extends UI5Element {
 	get selectedRows() {
 		return this.rows.filter(row => row.selected);
 	}
+
+	get currentItemIdx() {
+		return this.rows.indexOf(this.currentItem);
+	}
+
+	get currentItem() {
+		return this.getRootNode().activeElement;
+	}
+
+	get currentElement() {
+		return this._itemNavigation._getCurrentItem();
+	}
 }
 
 Table.define();

package/src/TableCell.js

@@ -12,7 +12,7 @@ const metadata = {
 	tag: "ui5-table-cell",
 	slots: /** @lends sap.ui.webcomponents.main.TableCell.prototype */ {
 		/**
-		 * Specifies the content of the <code>ui5-table-cell</code>.
+		 * Specifies the content of the component.
 		 *
 		 * @type {Node[]}
 		 * @slot

package/src/TableColumn.js

@@ -27,7 +27,7 @@ const metadata = {
 		 * Defines the minimum table width required to display this column. By default it is always displayed.
 		 * <br><br>
 		 * The responsive behavior of the <code>ui5-table</code> is determined by this property. As an example, by setting
-		 * <code>minWidth</code> property to <code>40em</code> shows this column on tablet (and desktop) but hides it on mobile.
+		 * <code>minWidth</code> property to <code>400</code> sets the minimum width to 400 pixels, and	shows this column on tablet (and desktop) but hides it on mobile.
 		 * <br>
 		 * For further responsive design options, see <code>demandPopin</code> property.
 		 *
@@ -52,7 +52,7 @@ const metadata = {
 		},
 
 		/**
-		 * According to your <code>minWidth</code> settings, the <code>ui5-table-column</code> can be hidden
+		 * According to your <code>minWidth</code> settings, the component can be hidden
 		 * in different screen sizes.
 		 * <br><br>
 		 * Setting this property to <code>true</code>, shows this column as pop-in instead of hiding it.
@@ -78,13 +78,6 @@ const metadata = {
 		last: {
 			type: Boolean,
 		},
-
-		/**
-		 * @private
-		 */
-		sticky: {
-			type: Boolean,
-		},
 	},
 };
 

package/src/TableGroupRow.hbs

@@ -0,0 +1,13 @@
+<tr
+	class="ui5-table-group-row-root"
+	part="group-row"
+	role="row"
+	aria-label={{ariaLabelText}}
+	tabindex="{{_tabIndex}}"
+	dir="{{effectiveDir}}"
+	@focusin="{{_onfocusin}}"
+>
+	<td colspan={{colSpan}}>
+		<slot></slot>
+	</td>
+</tr>