smart-webcomponents 18.0.0 → 18.0.1

package/source/react/tabs/tabs.jsx

@@ -0,0 +1,766 @@
+import React from "react";
+import { TabItem } from './tabitem';
+import { TabItemsGroup } from './tabitemsgroup';
+export { TabItem } from './tabitem';
+export { TabItemsGroup } from './tabitemsgroup';
+/**
+ Tabs organize content across different screens, data sets, and other interactions. Tabs can be paired with components like top app bars. Tabs can be displayed horizontally or vertically.
+*/
+export class Tabs extends React.Component {
+	// Gets the id of the React component.
+	get id() {
+		if (!this._id) {
+			this._id =  'Tabs' + Math.floor((1 + Math.random()) * 0x10000).toString(16).substring(1);
+		}
+
+		return this._id;
+	}
+	/** Sets or gets whether the "Add new tab" button (+) is displayed.
+	*	Property type: boolean
+	*/
+	get addNewTab() {
+		return this.nativeElement ? this.nativeElement.addNewTab : undefined;
+	}
+	set addNewTab(value) {
+		if (this.nativeElement) {
+			this.nativeElement.addNewTab = value;
+		}
+	}
+
+	/** Allows toggle. If set to true, **selectedIndex** can be set to null (no selected tab).
+	*	Property type: boolean
+	*/
+	get allowToggle() {
+		return this.nativeElement ? this.nativeElement.allowToggle : undefined;
+	}
+	set allowToggle(value) {
+		if (this.nativeElement) {
+			this.nativeElement.allowToggle = value;
+		}
+	}
+
+	/** Sets or gets the animation mode. Animation is disabled when the property is set to 'none'
+	*	Property type: Animation | string
+	*/
+	get animation() {
+		return this.nativeElement ? this.nativeElement.animation : undefined;
+	}
+	set animation(value) {
+		if (this.nativeElement) {
+			this.nativeElement.animation = value;
+		}
+	}
+
+	/** Sets or gets the close button mode.
+	*	Property type: TabsCloseButtonMode | string
+	*/
+	get closeButtonMode() {
+		return this.nativeElement ? this.nativeElement.closeButtonMode : undefined;
+	}
+	set closeButtonMode(value) {
+		if (this.nativeElement) {
+			this.nativeElement.closeButtonMode = value;
+		}
+	}
+
+	/** Sets or gets whether close buttons are displayed.
+	*	Property type: boolean
+	*/
+	get closeButtons() {
+		return this.nativeElement ? this.nativeElement.closeButtons : undefined;
+	}
+	set closeButtons(value) {
+		if (this.nativeElement) {
+			this.nativeElement.closeButtons = value;
+		}
+	}
+
+	/** Sets or gets whether the Tabs content section is collapsed.
+	*	Property type: boolean
+	*/
+	get collapsed() {
+		return this.nativeElement ? this.nativeElement.collapsed : undefined;
+	}
+	set collapsed(value) {
+		if (this.nativeElement) {
+			this.nativeElement.collapsed = value;
+		}
+	}
+
+	/** Enables or disables the collapsible feature.
+	*	Property type: boolean
+	*/
+	get collapsible() {
+		return this.nativeElement ? this.nativeElement.collapsible : undefined;
+	}
+	set collapsible(value) {
+		if (this.nativeElement) {
+			this.nativeElement.collapsible = value;
+		}
+	}
+
+	/** Determines the data source that will be loaded to the Tabs.
+	*	Property type: any
+	*/
+	get dataSource() {
+		return this.nativeElement ? this.nativeElement.dataSource : undefined;
+	}
+	set dataSource(value) {
+		if (this.nativeElement) {
+			this.nativeElement.dataSource = value;
+		}
+	}
+
+	/** Enables or disables the element.
+	*	Property type: boolean
+	*/
+	get disabled() {
+		return this.nativeElement ? this.nativeElement.disabled : undefined;
+	}
+	set disabled(value) {
+		if (this.nativeElement) {
+			this.nativeElement.disabled = value;
+		}
+	}
+
+	/** Enables or disables scrolling using the mouse wheel through overflowing tab labels in the tab strip. 
+	*	Property type: boolean
+	*/
+	get enableMouseWheelAction() {
+		return this.nativeElement ? this.nativeElement.enableMouseWheelAction : undefined;
+	}
+	set enableMouseWheelAction(value) {
+		if (this.nativeElement) {
+			this.nativeElement.enableMouseWheelAction = value;
+		}
+	}
+
+	/** Sets or gets the locale. Used in conjunction with the property messages. 
+	*	Property type: string
+	*/
+	get locale() {
+		return this.nativeElement ? this.nativeElement.locale : undefined;
+	}
+	set locale(value) {
+		if (this.nativeElement) {
+			this.nativeElement.locale = value;
+		}
+	}
+
+	/** Callback, related to localization module. 
+	*	Property type: any
+	*/
+	get localizeFormatFunction() {
+		return this.nativeElement ? this.nativeElement.localizeFormatFunction : undefined;
+	}
+	set localizeFormatFunction(value) {
+		if (this.nativeElement) {
+			this.nativeElement.localizeFormatFunction = value;
+		}
+	}
+
+	/** Sets or gets an object specifying strings used in the widget that can be localized. Used in conjunction with the property locale. 
+	*	Property type: any
+	*/
+	get messages() {
+		return this.nativeElement ? this.nativeElement.messages : undefined;
+	}
+	set messages(value) {
+		if (this.nativeElement) {
+			this.nativeElement.messages = value;
+		}
+	}
+
+	/** Sets or gets the widget's name.
+	*	Property type: string
+	*/
+	get name() {
+		return this.nativeElement ? this.nativeElement.name : undefined;
+	}
+	set name(value) {
+		if (this.nativeElement) {
+			this.nativeElement.name = value;
+		}
+	}
+
+	/** Sets or gets the Tabs scroll buttons behavior. Applicable only when tabLayout is 'scroll'.
+	*	Property type: Overflow | string
+	*/
+	get overflow() {
+		return this.nativeElement ? this.nativeElement.overflow : undefined;
+	}
+	set overflow(value) {
+		if (this.nativeElement) {
+			this.nativeElement.overflow = value;
+		}
+	}
+
+	/** Disables user interaction with the element.
+	*	Property type: boolean
+	*/
+	get readonly() {
+		return this.nativeElement ? this.nativeElement.readonly : undefined;
+	}
+	set readonly(value) {
+		if (this.nativeElement) {
+			this.nativeElement.readonly = value;
+		}
+	}
+
+	/** Enables or disables the reorder feature. When this feature is enabled, the end-user can drag a tab and drop it over another tab. As a result the tabs will be reordered.
+	*	Property type: boolean
+	*/
+	get reorder() {
+		return this.nativeElement ? this.nativeElement.reorder : undefined;
+	}
+	set reorder(value) {
+		if (this.nativeElement) {
+			this.nativeElement.reorder = value;
+		}
+	}
+
+	/** Sets or gets whether tab labels can be resized by dragging with the mouse.
+	*	Property type: boolean
+	*/
+	get resize() {
+		return this.nativeElement ? this.nativeElement.resize : undefined;
+	}
+	set resize(value) {
+		if (this.nativeElement) {
+			this.nativeElement.resize = value;
+		}
+	}
+
+	/** Sets or gets the value indicating whether the element is aligned to support locales using right-to-left fonts.
+	*	Property type: boolean
+	*/
+	get rightToLeft() {
+		return this.nativeElement ? this.nativeElement.rightToLeft : undefined;
+	}
+	set rightToLeft(value) {
+		if (this.nativeElement) {
+			this.nativeElement.rightToLeft = value;
+		}
+	}
+
+	/** Sets or gets the position of the scroll buttons.
+	*	Property type: LayoutPosition | string
+	*/
+	get scrollButtonsPosition() {
+		return this.nativeElement ? this.nativeElement.scrollButtonsPosition : undefined;
+	}
+	set scrollButtonsPosition(value) {
+		if (this.nativeElement) {
+			this.nativeElement.scrollButtonsPosition = value;
+		}
+	}
+
+	/** Sets or gets the behavior when scrolling the tab strip via the scroll buttons.
+	*	Property type: TabsScrollMode | string
+	*/
+	get scrollMode() {
+		return this.nativeElement ? this.nativeElement.scrollMode : undefined;
+	}
+	set scrollMode(value) {
+		if (this.nativeElement) {
+			this.nativeElement.scrollMode = value;
+		}
+	}
+
+	/** Sets or gets which tab is selected.
+	*	Property type: number | null
+	*/
+	get selectedIndex() {
+		return this.nativeElement ? this.nativeElement.selectedIndex : undefined;
+	}
+	set selectedIndex(value) {
+		if (this.nativeElement) {
+			this.nativeElement.selectedIndex = value;
+		}
+	}
+
+	/** Determines the way the user can switch between tabs.
+	*	Property type: TabSelectionMode | string
+	*/
+	get selectionMode() {
+		return this.nativeElement ? this.nativeElement.selectionMode : undefined;
+	}
+	set selectionMode(value) {
+		if (this.nativeElement) {
+			this.nativeElement.selectionMode = value;
+		}
+	}
+
+	/** Applies one of four behaviors when the element is not wide enough to display all tab labels.
+	*	Property type: TabsTabLayout | string
+	*/
+	get tabLayout() {
+		return this.nativeElement ? this.nativeElement.tabLayout : undefined;
+	}
+	set tabLayout(value) {
+		if (this.nativeElement) {
+			this.nativeElement.tabLayout = value;
+		}
+	}
+
+	/** Sets or gets where the tab strip is positioned.
+	*	Property type: TabPosition | string
+	*/
+	get tabPosition() {
+		return this.nativeElement ? this.nativeElement.tabPosition : undefined;
+	}
+	set tabPosition(value) {
+		if (this.nativeElement) {
+			this.nativeElement.tabPosition = value;
+		}
+	}
+
+	/** Sets or gets the orientation of the text in the tabs.
+	*	Property type: Orientation | string
+	*/
+	get tabTextOrientation() {
+		return this.nativeElement ? this.nativeElement.tabTextOrientation : undefined;
+	}
+	set tabTextOrientation(value) {
+		if (this.nativeElement) {
+			this.nativeElement.tabTextOrientation = value;
+		}
+	}
+
+	/** Determines the theme. Theme defines the look of the element
+	*	Property type: string
+	*/
+	get theme() {
+		return this.nativeElement ? this.nativeElement.theme : undefined;
+	}
+	set theme(value) {
+		if (this.nativeElement) {
+			this.nativeElement.theme = value;
+		}
+	}
+
+	/** If is set to true, the element cannot be focused.
+	*	Property type: boolean
+	*/
+	get unfocusable() {
+		return this.nativeElement ? this.nativeElement.unfocusable : undefined;
+	}
+	set unfocusable(value) {
+		if (this.nativeElement) {
+			this.nativeElement.unfocusable = value;
+		}
+	}
+
+
+	// Gets the properties of the React component.
+	get properties() {
+		return ["addNewTab","allowToggle","animation","closeButtonMode","closeButtons","collapsed","collapsible","dataSource","disabled","enableMouseWheelAction","locale","localizeFormatFunction","messages","name","overflow","readonly","reorder","resize","rightToLeft","scrollButtonsPosition","scrollMode","selectedIndex","selectionMode","tabLayout","tabPosition","tabTextOrientation","theme","unfocusable"];
+	}
+	/**  This event is triggered when the addNewTab is enabled and is clicked.
+	*  @param event. The custom event. 	*/
+	_onAddNewTabClick = null;	get onAddNewTabClick() {
+		return this._onAddNewTabClick;
+	}
+	set onAddNewTabClick(value) {
+		this._onAddNewTabClick = value;
+	}
+	/**  This event is triggered when the tab selection is changed.
+	*  @param event. The custom event. 	Custom event was created with: event.detail(	index, 	oldIndex)
+	*   index - The tab's index.
+	*   oldIndex - The tab's old index.
+	*/
+	_onChange = null;	get onChange() {
+		return this._onChange;
+	}
+	set onChange(value) {
+		this._onChange = value;
+	}
+	/**  This event is triggered when a tab is closed.
+	*  @param event. The custom event. 	Custom event was created with: event.detail(	index)
+	*   index - The tab's index.
+	*/
+	_onClose = null;	get onClose() {
+		return this._onClose;
+	}
+	set onClose(value) {
+		this._onClose = value;
+	}
+	/**  This event is triggered when a tab is about to be closed. The closing operation can be canceled by calling event.preventDefault() in the event handler function.
+	*  @param event. The custom event. 	Custom event was created with: event.detail(	index)
+	*   index - The tab's index.
+	*/
+	_onClosing = null;	get onClosing() {
+		return this._onClosing;
+	}
+	set onClosing(value) {
+		this._onClosing = value;
+	}
+	/**  This event is triggered when a drag operation has ended.
+	*  @param event. The custom event. 	Custom event was created with: event.detail(	left, 	top, 	index, 	label)
+	*   left - The tab's left position.
+	*   top - The tab's top position.
+	*   index - The tab's index.
+	*   label - The tab's label.
+	*/
+	_onDragEnd = null;	get onDragEnd() {
+		return this._onDragEnd;
+	}
+	set onDragEnd(value) {
+		this._onDragEnd = value;
+	}
+	/**  This event is triggered when a drag operation has started.
+	*  @param event. The custom event. 	Custom event was created with: event.detail(	left, 	top, 	index, 	label)
+	*   left - The tab's left position.
+	*   top - The tab's top position.
+	*   index - The tab's index.
+	*   label - The tab's label.
+	*/
+	_onDragStart = null;	get onDragStart() {
+		return this._onDragStart;
+	}
+	set onDragStart(value) {
+		this._onDragStart = value;
+	}
+	/**  This event is triggered when tabs have been reordered.
+	*  @param event. The custom event. 	Custom event was created with: event.detail(	index, 	oldIndex)
+	*   index - The tab's index.
+	*   oldIndex - The tab's old index.
+	*/
+	_onReorder = null;	get onReorder() {
+		return this._onReorder;
+	}
+	set onReorder(value) {
+		this._onReorder = value;
+	}
+
+	// Gets the events of the React component.
+	get eventListeners() {
+		return ["onAddNewTabClick","onChange","onClose","onClosing","onDragEnd","onDragStart","onReorder"];
+	}
+	/** Collapses the content section. 
+	*/
+    collapse(){
+        if (this.nativeElement.isRendered) {
+            this.nativeElement.collapse();
+        }
+        else
+        {
+            this.nativeElement.whenRendered(() => {
+                this.nativeElement.collapse();
+            });
+        }
+    }
+
+	/** Returns the label of a Tab at given index. 
+	* @param {number} index. The index of the tab.
+	* @returns {string}
+  */
+	getTabLabel(index) {
+        const result = this.nativeElement.getTabLabel(index);
+        return result;
+    }
+
+	/** Returns the content of a Tab at given index. 
+	* @param {number} index. The index of the tab.
+	* @returns {HTMLElement}
+  */
+	getTabContent(index) {
+        const result = this.nativeElement.getTabContent(index);
+        return result;
+    }
+
+	/** Makes sure a tab is visible by scrolling to it. 
+	* @param {number} index. The index of the tab to scroll to.
+	*/
+    ensureVisible(index){
+        if (this.nativeElement.isRendered) {
+            this.nativeElement.ensureVisible(index);
+        }
+        else
+        {
+            this.nativeElement.whenRendered(() => {
+                this.nativeElement.ensureVisible(index);
+            });
+        }
+    }
+
+	/** Expands the content section. 
+	*/
+    expand(){
+        if (this.nativeElement.isRendered) {
+            this.nativeElement.expand();
+        }
+        else
+        {
+            this.nativeElement.whenRendered(() => {
+                this.nativeElement.expand();
+            });
+        }
+    }
+
+	/** Returns an array of the TabItems inside the element. 
+	* @returns {TabItem[]}
+  */
+	getTabs() {
+        const result = this.nativeElement.getTabs();
+        return result;
+    }
+
+	/** Returns the offset of the tab item container (smart-tab-item element) from the edge of the Tabs (smart-tabs element) where the tab strip is positioned. 
+	* @param {number} index. The index of the tab item.
+	* @returns {number}
+  */
+	getOffsetFromEdgeOfElement(index) {
+        const result = this.nativeElement.getOffsetFromEdgeOfElement(index);
+        return result;
+    }
+
+	/** Inserts a new tab and an associated content section. 
+	* @param {number} index. The index to insert a new tab at.
+	* @param {any} details. An Object with the fields "label", "labelSize", "content" and "group".
+	*/
+    insert(index, details){
+        if (this.nativeElement.isRendered) {
+            this.nativeElement.insert(index, details);
+        }
+        else
+        {
+            this.nativeElement.whenRendered(() => {
+                this.nativeElement.insert(index, details);
+            });
+        }
+    }
+
+	/** Refreshes the Tabs header section. Useful when the header contains elements (such as images) loaded slower than the Tabs itself. 
+	*/
+    refreshTabHeader(){
+        if (this.nativeElement.isRendered) {
+            this.nativeElement.refreshTabHeader();
+        }
+        else
+        {
+            this.nativeElement.whenRendered(() => {
+                this.nativeElement.refreshTabHeader();
+            });
+        }
+    }
+
+	/** Removes a tab and its associated content section. 
+	* @param {number} index. The index of the tab to remove.
+	*/
+    removeAt(index){
+        if (this.nativeElement.isRendered) {
+            this.nativeElement.removeAt(index);
+        }
+        else
+        {
+            this.nativeElement.whenRendered(() => {
+                this.nativeElement.removeAt(index);
+            });
+        }
+    }
+
+	/** Selects a tab. 
+	* @param {number} index. The index of the tab to select.
+	*/
+    select(index){
+        if (this.nativeElement.isRendered) {
+            this.nativeElement.select(index);
+        }
+        else
+        {
+            this.nativeElement.whenRendered(() => {
+                this.nativeElement.select(index);
+            });
+        }
+    }
+
+	/** Updates a tab and its associated content section. 
+	* @param {number} index. The index of the tab to update.
+	* @param {string} label. The new label of the tab. The value can be the id of an HTMLTemplateElement
+	* @param {string | HTMLElement} content. The new content of the tab.
+	*/
+    update(index, label, content){
+        if (this.nativeElement.isRendered) {
+            this.nativeElement.update(index, label, content);
+        }
+        else
+        {
+            this.nativeElement.whenRendered(() => {
+                this.nativeElement.update(index, label, content);
+            });
+        }
+    }
+
+
+
+	constructor(props) {
+		super(props);
+		this.componentRef = React.createRef();
+	}
+
+	componentDidRender(initialize) {
+		const that = this;
+		const props = {};
+		const events = {};
+		let styles = null;
+		const stringifyCircularJSON = obj => {
+		  const seen = new WeakSet();
+		  return JSON.stringify(obj, (k, v) => {
+			if (v !== null && typeof v === 'object') {
+			  if (seen.has(v)) return;
+			  seen.add(v);
+			}
+			
+			if (k === 'Smart') {
+				return v;
+			}
+			
+			return v;
+		  });
+		};
+		
+		for(let prop in that.props) {
+			if (prop === 'children') {
+				continue;
+			}
+
+			if (prop === 'style') {
+				styles = that.props[prop];
+				continue;
+			}
+
+			if (prop.startsWith('on') && that.properties.indexOf(prop) === -1) {
+				events[prop] = that.props[prop];
+				continue;
+			}
+
+			props[prop] = that.props[prop];
+		}
+
+		if (initialize) {
+			that.nativeElement = this.componentRef.current;
+			if (that.nativeElement && !that.nativeElement.isCompleted) {
+				that.nativeElement.reactStateProps = JSON.parse(stringifyCircularJSON(props));
+			}
+		}
+
+		if (initialize && that.nativeElement && that.nativeElement.isCompleted) {
+		//	return;
+		}
+
+
+		for(let prop in props) {
+			if (prop === 'class' || prop === 'className') {
+				const classNames = props[prop].trim().split(' ');
+				
+				if (that.nativeElement._classNames) {
+					const oldClassNames = that.nativeElement._classNames;
+					for(let className in oldClassNames) {
+						if (that.nativeElement.classList.contains(oldClassNames[className]) && oldClassNames[className] !== "") {
+							that.nativeElement.classList.remove(oldClassNames[className]);
+						}
+					}
+				}
+				
+				that.nativeElement._classNames = classNames;
+				
+				for(let className in classNames) {
+					if (!that.nativeElement.classList.contains(classNames[className]) && classNames[className] !== "") {
+						that.nativeElement.classList.add(classNames[className]);
+					}
+				}
+
+				continue;
+			}
+
+			if (props[prop] !== that.nativeElement[prop]) {
+				const normalizeProp = (str) => {
+					return str.replace(/-([a-z])/g, function (g) {
+						return g[1].toUpperCase();
+					});
+				}
+
+				if (prop === 'hover' || prop === 'active' || prop === 'focus' || prop === 'selected') {
+					that.nativeElement.setAttribute(prop, '');
+				}
+				
+				const normalizedProp = normalizeProp(prop);
+
+				if (that.nativeElement[normalizedProp] === undefined) {
+				    that.nativeElement.setAttribute(prop, props[prop]);
+				}
+
+				if (props[prop] !== undefined) {
+					if (typeof props[prop] === 'object' && that.nativeElement.reactStateProps && !initialize) {
+						if (stringifyCircularJSON(props[prop]) === stringifyCircularJSON(that.nativeElement.reactStateProps[normalizedProp])) {
+							continue;
+						}
+					}
+					
+					that.nativeElement[normalizedProp] = props[prop];
+				}
+			}
+		}
+
+		
+		for(let eventName in events) {
+			that[eventName] = events[eventName];
+			that.nativeElement[eventName.toLowerCase()] = events[eventName];
+        }
+
+		if (initialize) {
+			Smart.Render();
+	
+			if (that.onCreate) {
+				that.onCreate();
+			}
+
+			that.nativeElement.whenRendered(() => {
+				if (that.onReady) {
+					that.onReady();
+				}
+			});
+		}
+
+		// setup styles.
+
+		if (styles) {
+			for(let styleName in styles) {
+				that.nativeElement.style[styleName] = styles[styleName];
+			}
+		}
+	}
+
+	componentDidMount() {
+		this.componentDidRender(true);
+    }
+
+	componentDidUpdate() {
+		this.componentDidRender(false);
+    }
+
+	componentWillUnmount() {
+		const that = this;
+
+		if (!that.nativeElement) {
+			return;
+		}
+		
+		that.nativeElement.whenRenderedCallbacks = [];
+		
+		for(let i = 0; i < that.eventListeners.length; i++){
+			const eventName = that.eventListeners[i];
+
+			that.nativeElement.removeEventListener(eventName.substring(2).toLowerCase(), that[eventName]);
+		}
+	}
+
+	render() {
+		return (
+			React.createElement("smart-tabs", { ref: this.componentRef }, this.props.children)
+		)
+	}
+}
+
+export default Tabs;