@stacksjs/stx
Version:
A performant UI Framework. Powered by Bun.
40 lines • 1.22 kB
TypeScript
/**
* Create a loading indicator instance (composable-style)
*/
export declare function useLoadingIndicator(userOptions?: LoadingIndicatorOptions): LoadingIndicatorInstance;
/**
* Initialize automatic loading indicator for page navigation
* Call this once in your app to enable automatic loading on route changes
*/
export declare function initLoadingIndicator(userOptions?: LoadingIndicatorOptions): void;
/**
* Generate the HTML for the loading indicator component
* This is used by the STX compiler for <stx-loading-indicator />
*/
export declare function generateLoadingIndicatorHtml(options?: LoadingIndicatorOptions): string;
export declare interface LoadingIndicatorOptions {
color?: string
initialColor?: string
height?: string
duration?: number
throttle?: number
autoFinish?: boolean
zIndex?: number
}
export declare interface LoadingIndicatorState {
isLoading: boolean
progress: number
error: boolean
}
export declare interface LoadingIndicatorInstance {
start: () => void
set: (value: number) => void
finish: () => void
clear: () => void
state: LoadingIndicatorState
}
export default {
useLoadingIndicator,
initLoadingIndicator,
generateLoadingIndicatorHtml,
};