outsystems-ui/src/scripts/OSFramework/OSUI/Pattern/Accordion/Accordion.ts

OutSystems UI Framework

/* eslint-disable @typescript-eslint/no-unused-vars */
namespace OSFramework.OSUI.Patterns.Accordion {
	/**
	 * Defines the interface for OutSystemsUI Patterns
	 */
	export class Accordion extends AbstractParent<AccordionConfig, AccordionItem.IAccordionItem> implements IAccordion {
		constructor(uniqueId: string, configs: JSON) {
			super(uniqueId, new AccordionConfig(configs));
		}

		/**
		 * Method to set the A11Y properties when the pattern is built.
		 *
		 * @protected
		 * @memberof OSFramework.Patterns.Accordion.Accordion
		 */
		protected setA11YProperties(): void {
			console.log(GlobalEnum.WarningMessages.MethodNotImplemented);
		}

		/**
		 * This method has no implementation on this pattern context!
		 *
		 * @protected
		 * @memberof OSFramework.Patterns.Accordion.Accordion
		 */
		protected setCallbacks(): void {
			console.log(GlobalEnum.WarningMessages.MethodNotImplemented);
		}

		/**
		 * This method has no implementation on this pattern context!
		 *
		 * @protected
		 * @memberof OSFramework.Patterns.Accordion.Accordion
		 */
		protected setHtmlElements(): void {
			console.log(GlobalEnum.WarningMessages.MethodNotImplemented);
		}

		/**
		 * This method has no implementation on this pattern context!
		 *
		 * @protected
		 * @memberof OSFramework.Patterns.Accordion.Accordion
		 */
		protected unsetCallbacks(): void {
			console.log(GlobalEnum.WarningMessages.MethodNotImplemented);
		}

		/**
		 * This method has no implementation on this pattern context!
		 *
		 * @protected
		 * @memberof OSFramework.Patterns.Accordion.Accordion
		 */
		protected unsetHtmlElements(): void {
			console.log(GlobalEnum.WarningMessages.MethodNotImplemented);
		}

		/**
		 * Method to add a new accordionItem
		 *
		 * @param {AccordionItem.IAccordionItem} childItem
		 * @memberof OSFramework.Patterns.Accordion.Accordion
		 */
		public addAccordionItem(childItem: AccordionItem.IAccordionItem): void {
			if (this.getChild(childItem.uniqueId)) {
				throw new Error(
					`${ErrorCodes.Accordion.FailSetNewChildItem}: There is already a ${GlobalEnum.PatternName.AccordionItem} under Id: '${childItem.widgetId}' added to ${GlobalEnum.PatternName.Accordion} with uniqueId: ${this.uniqueId}.`
				);
			} else {
				// Store Child Item
				this.setChild(childItem);
			}

			// If we're adding to an accordion w/Multiple Items set to false & this item is expanded,
			// we have to close all the other items
			if (childItem.isOpen) {
				this.triggerAccordionItemClose(childItem.uniqueId);
			}
		}

		/**
		 * Method used to be notified by a given ChildId about a given action and act accordingly
		 *
		 * @param childId Child Item Id to be stored/managed
		 * @param notifiedTo {Enum.ChildNotifyActionType} triggered notification type
		 * @memberof OSFramework.Patterns.Accordion.Accordion
		 */
		public beNotifiedByChild(
			childItem: AccordionItem.IAccordionItem,
			notifiedTo: Enum.ChildNotifyActionType
		): void {
			switch (notifiedTo) {
				case Enum.ChildNotifyActionType.Add:
					this.addAccordionItem(childItem);
					break;
				case Enum.ChildNotifyActionType.Click:
					this.triggerAccordionItemClose(childItem.uniqueId);
					break;
				case Enum.ChildNotifyActionType.Removed:
					this.removeAccordionItem(childItem.uniqueId);
					break;
				default:
					throw new Error(
						`${ErrorCodes.Accordion.FailToSetChildItemAction}: There no exist a '${notifiedTo}' notification type.`
					);
			}
		}

		/**
		 * Method to build the Accordion
		 *
		 * @memberof OSFramework.Patterns.Accordion.Accordion
		 */
		public build(): void {
			super.build();

			this.finishBuild();
		}

		/**
		 * Method to change the value of configs/current state.
		 *
		 * @param {string} propertyName
		 * @param {*} propertyValue
		 * @memberof OSFramework.Patterns.Accordion.Accordion
		 */
		public changeProperty(propertyName: string, propertyValue: unknown): void {
			super.changeProperty(propertyName, propertyValue);

			if (this.isBuilt) {
				switch (propertyName) {
					case Enum.Properties.MultipleItems:
						// If we're now not having multiple items, let's collapse everything.
						if (!this.configs.MultipleItems) this.collapseAllItems();
						break;
				}
			}
		}

		/**
		 * Method to close all accordionItems
		 *
		 * @memberof OSFramework.Patterns.Accordion.Accordion
		 */
		public collapseAllItems(): void {
			// Filter all items that are open and not disabled
			const itemsToClose = this.getChildItems().filter((item) => item.isOpen && !item.isDisabled);

			// Close all of them
			itemsToClose.forEach((item) => {
				item.close();
			});
		}

		/**
		 * Method to destroy accordion instance
		 *
		 * @memberof OSFramework.Patterns.Accordion.Accordion
		 */
		public dispose(): void {
			super.dispose();
		}

		/**
		 * Method to open all accordionItems
		 *
		 * @memberof OSFramework.Patterns.Accordion.Accordion
		 */
		public expandAllItems(): void {
			//If this accordion does not have multiple items, it means we can't expand all.
			if (this.configs.MultipleItems) {
				// Filter all items that are open and not disabled
				const itemsToOpen = this.getChildItems().filter((item) => !item.isOpen && !item.isDisabled);

				// Go through each item and open it!
				itemsToOpen.forEach((item) => {
					item.open();
				});
			} else {
				console.warn(
					`${GlobalEnum.PatternName.Accordion} (${this.widgetId}): if ${Enum.Properties.MultipleItems} parameter is set to false, this action doesn't work. Set the ${Enum.Properties.MultipleItems} parameter to true.`
				);
			}
		}

		/**
		 * Method to remove an accordionItem
		 *
		 * @param {string} accordionItemId
		 * @memberof OSFramework.Patterns.Accordion.Accordion
		 */
		public removeAccordionItem(childId: string): void {
			// Check if the given ChildId exist at childList
			if (this.getChild(childId)) {
				// Remove item
				this.unsetChild(childId);
			} else {
				throw new Error(
					`${ErrorCodes.Accordion.FailUnsetNewChildItem}: The ${GlobalEnum.PatternName.AccordionItem} under uniqueId: '${childId}' does not exist as an ${GlobalEnum.PatternName.AccordionItem} from ${GlobalEnum.PatternName.Accordion} with Id: ${this.widgetId}.`
				);
			}
		}

		/**
		 * Method to close all accordionItems but one
		 *
		 * @param {string} accordionItemId
		 * @return {*}  {void}
		 * @memberof OSFramework.Patterns.Accordion.Accordion
		 */
		public triggerAccordionItemClose(childId: string): void {
			//If this accordion has multiple items, it means we don't want to close the other items.
			if (this.configs.MultipleItems) {
				return;
			}

			const childReference = this.getChild(childId);
			// Check if the given ChildId exist as an child item
			if (childReference) {
				// Close all other open items
				this.getChildItems().forEach((item) => {
					if (item.uniqueId !== childId) {
						if (item.isOpen) {
							item.close();
						}
					}
				});
			} else {
				throw new Error(
					`${ErrorCodes.Accordion.FailChildItemClicked}: The ${GlobalEnum.PatternName.AccordionItem} under uniqueId: '${childId}' does not exist as an ${GlobalEnum.PatternName.AccordionItem} from ${GlobalEnum.PatternName.Accordion} with Id: ${this.widgetId}.`
				);
			}
		}
	}
}