Javascript API
This is the javascript module API documentation
All JavaScript modules are exported from a single, pre-bundled package entry point: @ulu/frontend. This modern approach guarantees module singletons (like settings) work correctly and allows for optimal tree-shaking in consumer applications.
You no longer need to import from individual files. Instead, you can import any function or class directly from the main package:
import { dialogInit, Slider, updateSettings } from '@ulu/frontend';While you will only ever import from the main package, the modules are still organized logically into three categories, which is reflected in the navigation menu:
- Core: Foundational, cross-cutting logic for the library.
- UI: Components and scripts that create interactive user interface elements.
- Utils: Helper functions that are used internally but are also exposed for your own custom code.
The full list of available exports is detailed below.
Exports Map
Example Import
All JavaScript modules are exported from the main @ulu/frontend package entry point.
Example Usage:
import { dialogInit, Slider, updateSettings } from '@ulu/frontend';
// Update a library setting
updateSettings({ cssvarPrefix: "my-app" });
// Initialize all dialogs
dialogInit();
// Create a new slider
const slider = new Slider(...);
Exports Map
Core Modules
These exports originate from the lib/js/core/ directory and provide the foundational, cross-cutting logic for the library.
ComponentInitializercreateUluEventdispatchCoreEventgetCoreEventNamegetDefaultSettingsgetSettingsgetSettinggetUluEventNameupdateSettingupdateSettingswrapSettingString
UI Modules
These exports originate from the lib/js/ui/ directory.
BreakpointManagerCollapsibledetailsGroupInitdetailsGroupInitializerdetailsGroupSetupGroupdialogBaseAttributedialogCloseAttributedialogDefaultsdialogGetDialogOptionsdialogInitdialogInitializerdialogSetDefaultsdialogSetupDialogdialogSetupTriggerFlipcardflipcardInitflipcardInitializergridInitgridInitializermodalBuilderBuildModalmodalBuilderDefaultsmodalBuilderInitmodalBuilderInitializermodalBuilderSetDefaultsOverflowScrolleroverflowScrollerCreatePagerpageInitPopoverpopoverGetContentByTriggerpopoverInitpopoverInitializerpopoverInstancespopoverResolveprintDetailsAttrsprintDetailsInitprintInitproxyClickAttachHandlersproxyClickDefaultsproxyClickInitproxyClickInitializerproxyClickSetDefaultsproxyClickSetupProxyResizerscrollSliderInitscrollSliderInitializerScrollpointscrollpointInitscrollpointInitializerSlidersliderInitsliderInitializersliderSetupSlidertabsInittabsInitializertabsInstancestabsSetupthemeToggleDefaultsthemeToggleInitthemeToggleInitializerthemeToggleSetDefaultsthemeToggleSetupToggleTooltiptooltipInittooltipInitializer
Utility Modules
These exports originate from the lib/js/utils/ directory.
classLoggerLogclassLoggerLogErrorclassLoggerLogWarningclassLoggerSetfontAwesomeConfigureIconscreateFloatingUidataAttributeToDatasetKeyensureIdFileSavefloatingUiDefaultsnewIdresolveClassessetPositionClassesyoutubePauseVideosyoutubePrepVideos