velocity-ui
    Preparing search index...

    Class BaseComponent<TOptions>Abstract

    Type Parameters

    • TOptions extends ComponentOptions = ComponentOptions

    Implements

    • ComponentWithErrorHandling
    Index

    Constructors

    • Constructor for base component

      Type Parameters

      • TOptions extends ComponentOptions = ComponentOptions

      Parameters

      • element: string | HTMLElement

        DOM element or selector

      • options: TOptions = ...

        Component configuration options

      Returns BaseComponent<TOptions>

    Properties

    element: HTMLElement
    eventManager: EventManager
    isDestroyed: boolean
    isInitialized: boolean
    options: TOptions

    Accessors

    • get destroyed(): boolean

      Check if component is destroyed

      Returns boolean

      boolean

    Methods

    • Protected

      Hook called after destruction Can be overridden by derived classes

      Returns void

    • Protected

      Hook called after initialization Can be overridden by derived classes

      Returns void

    • Protected

      Apply component options to the UI Can be overridden by derived classes

      Returns void

    • Protected

      Hook called before destruction Can be overridden by derived classes

      Returns void

    • Protected

      Hook called before initialization Can be overridden by derived classes

      Returns void

    • Protected

      Bind event handlers Must be implemented by derived classes

      Returns void

    • Protected

      Clean up DOM modifications Can be overridden by derived classes

      Returns void

    • Protected

      Create the component's DOM structure Must be implemented by derived classes

      Returns void

    • Get default options for the component Must be implemented by derived classes

      Returns TOptions

      Default options

    • Handle errors consistently

      Parameters

      • message: string

        Error message

      • error: Error

        Original error

      Returns void

    • Protected

      Render the component (optional) Can be overridden by derived classes

      Returns void

    • Protected

      Trigger an event

      Parameters

      • eventType: string

        Event type

      • eventData: any = null

        Event data

      Returns void

    • Protected

      Update or re-render parts of the component Can be overridden by derived classes

      Returns void

    • Protected

      Validate component options Can be overridden by derived classes

      Returns void

    • Destroy the component and clean up resources

      Returns void

    • Disable the component

      Returns void

    • Enable the component

      Returns void

    • Get root element (public accessor)

      Returns HTMLElement

      HTMLElement

    • Get option value with fallback

      Type Parameters

      • T = any

      Parameters

      • key: string

        Option key

      • fallback: null | T = null

        Fallback value

      Returns null | T

      Option value

    • Check if component is enabled

      Returns boolean

      True if enabled

    • Unbind an event handler

      Parameters

      • eventType: string

        Event type

      • Optionalhandler: (...args: any[]) => void

        Event handler (optional)

      Returns this

    • Bind an event handler

      Parameters

      • eventType: string

        Event type

      • handler: (...args: any[]) => void

        Event handler

      Returns this

    • Refresh/update the component

      Returns void

    • Set option value and optionally trigger update

      Parameters

      • key: keyof TOptions

        Option key or options object

      • value: TOptions[keyof TOptions]

        Option value (if key is string)

      • Optionalupdate: boolean

        Whether to update the component

      Returns void

    • Set option value and optionally trigger update

      Parameters

      • key: Partial<TOptions>

        Option key or options object

      • Optionalvalue: undefined

        Option value (if key is string)

      • Optionalupdate: boolean

        Whether to update the component

      Returns void