Variable defaultConst

Type declaration

• BaseComponent: typeof BaseComponent

• components: Map<string, ComponentConstructor>

• config: VelocityConfig

• DataSource: typeof DataSource

• DateUtils: typeof DateUtils

• DOMUtils: typeof DOMUtils

• EventManager: typeof EventManager

• StringUtils: typeof StringUtils

• ThemeManager: typeof ThemeManager

• ValidationUtils: typeof ValidationUtils

• Validator: typeof Validator

• version: "1.0.0"

• create: function

  • create(
        name: string,
        element: string | HTMLElement,
        options?: Record<string, any>,
    ): null | ComponentInstance

    Create component instance

    Parameters

    • name: string

      Component name
    • element: string | HTMLElement

      Target element
    • options: Record<string, any> = {}

      Component options

    Returns null | ComponentInstance

    Component instance or null

• destroy: function

  • destroy(context?: HTMLElement | Document): void

    Destroy all component instances in context

    Parameters

    • context: HTMLElement | Document = document

      Context element

    Returns void

• getComponent: function

  • getComponent(name: string): null | ComponentConstructor

    Get a registered component

    Parameters

    • name: string

      Component name

    Returns null | ComponentConstructor

    Component class or null

• getConfig: function

  • getConfig<K extends keyof VelocityConfig>(
        key?: K,
    ): K extends undefined ? VelocityConfig : VelocityConfig[K]

    Get global configuration

    Type Parameters

    • K extends keyof VelocityConfig

    Parameters

    • Optionalkey: K

      Configuration key

    Returns K extends undefined ? VelocityConfig : VelocityConfig[K]

    Configuration value

• getTheme: function

  • getTheme(): string

    Get current theme

    Returns string

    Current theme name

• init: function

  • init(context?: HTMLElement | Document): void

    Initialize components from data attributes

    Parameters

    • context: HTMLElement | Document = document

      Context element (default: document)

    Returns void

• isReady: function

  • isReady(): boolean

    Check if VelocityUI is ready

    Returns boolean

    True if ready

• ready: function

  • ready(callback: () => void): void

    Execute callback when VelocityUI is ready

    Parameters

    • callback: () => void

      Callback function

    Returns void

• register: function

  • register(name: string, componentClass: ComponentConstructor): void

    Register a component

    Parameters

    • name: string

      Component name
    • componentClass: ComponentConstructor

      Component class

    Returns void

• setConfig: function

  • setConfig(key: string | Partial<VelocityConfig>, value?: any): void

    Set global configuration

    Parameters

    • key: string | Partial<VelocityConfig>

      Configuration key or object
    • Optionalvalue: any

      Configuration value

    Returns void

• setTheme: function

  • setTheme(theme: string): void

    Set global theme

    Parameters

    • theme: string

      Theme name

    Returns void