🔍 Code Extractor

Base class for UI components that provides common notification functionality for displaying error, success, warning, and info messages.

Purpose

BaseUIComponent serves as a foundation class for building UI components with standardized notification capabilities. It inherits from param.Parameterized to leverage Panel's parameter system and provides a consistent interface for displaying messages to users. The class delegates notification display to a parent application if available, otherwise falls back to logging. This design pattern enables loose coupling between UI components and the notification system while ensuring messages are always captured.

Source Code

class BaseUIComponent(param.Parameterized):
    """Base class for UI components with common functionality."""
    
    def __init__(self, parent_app=None, **params):
        super().__init__(**params)
        self.parent_app = parent_app
        self.notification_area = None
    
    def show_error(self, message: str):
        """Show an error message."""
        if self.parent_app and hasattr(self.parent_app, 'show_notification'):
            self.parent_app.show_notification(message, level="error")
        else:
            logger.error(f"UI Error: {message}")
    
    def show_success(self, message: str):
        """Show a success message."""
        if self.parent_app and hasattr(self.parent_app, 'show_notification'):
            self.parent_app.show_notification(message, level="success")
        else:
            logger.info(f"UI Success: {message}")
    
    def show_warning(self, message: str):
        """Show a warning message."""
        if self.parent_app and hasattr(self.parent_app, 'show_notification'):
            self.parent_app.show_notification(message, level="warning")
        else:
            logger.warning(f"UI Warning: {message}")
    
    def show_info(self, message: str):
        """Show an info message."""
        if self.parent_app and hasattr(self.parent_app, 'show_notification'):
            self.parent_app.show_notification(message, level="info")
        else:
            logger.info(f"UI Info: {message}")

Parameters

Parameter Details

parent_app: Optional reference to the parent application object that should implement a 'show_notification' method. If provided, notifications will be delegated to this parent; if None, messages will be logged instead. Expected to have a show_notification(message, level) method.

**params: Additional keyword arguments passed to the param.Parameterized base class constructor, allowing for parameter initialization and configuration of the Parameterized system.

Return Value

Instantiation returns a BaseUIComponent object with initialized parent_app and notification_area attributes. The notification methods (show_error, show_success, show_warning, show_info) do not return values (implicit None return), they perform side effects by displaying notifications or logging messages.

Class Interface

Methods

Attributes

Dependencies

• param
• panel
• logging

Required Imports

import param
import panel as pn
import logging

Usage Example

import param
import panel as pn
import logging

logger = logging.getLogger(__name__)

# Example parent app with notification support
class MyApp:
    def show_notification(self, message, level):
        print(f"[{level.upper()}] {message}")

# Instantiate with parent app
parent = MyApp()
component = BaseUIComponent(parent_app=parent)
component.show_success("Operation completed successfully")
component.show_error("An error occurred")

# Instantiate without parent app (falls back to logging)
standalone_component = BaseUIComponent()
standalone_component.show_warning("This will be logged")
standalone_component.show_info("Information message")

Best Practices

• Always ensure a logger is configured in the module before instantiating this class to handle fallback logging
• When creating subclasses, call super().__init__(parent_app=parent_app, **params) to properly initialize the base class
• If providing a parent_app, ensure it implements the show_notification(message, level) method with support for 'error', 'success', 'warning', and 'info' levels
• Use this as a base class for UI components that need consistent notification behavior across an application
• The notification_area attribute is initialized to None but can be set by subclasses if they need to manage their own notification display
• This class follows the delegation pattern - it delegates notification display to the parent app when available, promoting loose coupling
• Methods can be called in any order as they are independent and stateless (no method dependencies)
• Consider this class as an abstract base - it's designed to be inherited rather than used directly

Tags

Similar Components

AI-powered semantic similarity - components with related functionality:

• class AdminPanel 50.5% similar

  Admin configuration interface component

  From: /tf/active/vicechatdev/CDocs/ui/admin_panel.py

• class ApprovalPanel 50.0% similar

  Approval management interface component

  From: /tf/active/vicechatdev/CDocs/ui/approval_panel_bis.py

• class NotificationManager 49.8% similar

  Central manager class for handling in-app and email notifications within the application, providing methods for creating, managing, and sending notifications to users.

  From: /tf/active/vicechatdev/CDocs/utils/notifications.py

• class ProgressIndicator 48.7% similar

  Abstract base class for progress indicators that display task completion as a percentage, providing a framework for implementing custom progress tracking mechanisms.

  From: /tf/active/vicechatdev/patches/util.py

• class ApprovalPanel_v1 48.7% similar

  Approval management interface component

  From: /tf/active/vicechatdev/CDocs/ui/approval_panel.py