outsystems-ui/src/scripts/OSFramework/OSUI/Feature/Balloon/IBalloon.ts

OutSystems UI Framework

// eslint-disable-next-line @typescript-eslint/no-unused-vars
namespace OSFramework.OSUI.Feature.Balloon {
	/**
	 * Defines the interface for OutSystemsUI Balloon Pattern
	 *
	 * @export
	 * @interface IBalloon
	 * @extends {Feature.IFeature}
	 * @extends {Interface.IOpenable}
	 */
	export interface IBalloon extends Feature.IFeature, Interface.IOpenable {
		/**
		 * Overload the open method.
		 *
		 * @param {boolean} [isOpenedByApi]
		 * @param {boolean} [arrowKeyPressed]
		 * @memberof IBalloon
		 */
		open(
			isOpenedByApi?: boolean,
			arrowKeyPressed?: GlobalEnum.Keycodes.ArrowDown | GlobalEnum.Keycodes.ArrowUp
		): void;

		/**
		 * Method to set the Balloon border shape
		 *
		 * @param {GlobalEnum.ShapeTypes} [shape]
		 * @memberof IBalloon
		 */
		setBalloonShape(shape?: GlobalEnum.ShapeTypes): void;

		/**
		 * Method to update the Balloon position
		 *
		 * @param {GlobalEnum.FloatingPosition} position
		 * @memberof IBalloon
		 */
		updatePositionOption(position: GlobalEnum.FloatingPosition): void;
	}
}