flowbite-angular
Version:
<div align="center"> <h1>:construction: flowbite-angular (unreleased) :construction:</h1> <p> <a href="https://flowbite.com"> <img alt="Flowbite - Tailwind CSS components" width="350" src="https://flowbite.s3.amazonaws.com/github/logo-github
115 lines (114 loc) • 4.78 kB
TypeScript
import type { ScrollTopClass, ScrollTopColors, ScrollTopPositions } from './scroll-top.theme';
import { ScrollTopThemeService } from './scroll-top.theme.service';
import { BaseComponent } from 'flowbite-angular';
import { IconRegistry } from 'flowbite-angular/icon';
import type { OnInit, TemplateRef } from '@angular/core';
import { InjectionToken } from '@angular/core';
import { DomSanitizer } from '@angular/platform-browser';
import * as i0 from "@angular/core";
export declare const FLOWBITE_SCROLL_TOP_COLOR_DEFAULT_VALUE: InjectionToken<keyof ScrollTopColors>;
export declare const FLOWBITE_SCROLL_TOP_POSITION_DEFAULT_VALUE: InjectionToken<keyof ScrollTopPositions>;
export declare const FLOWBITE_SCROLL_TOP_ICON_DEFAULT_VALUE: InjectionToken<TemplateRef<unknown> | undefined>;
export declare const FLOWBITE_SCROLL_TOP_CUSTOM_STYLE_DEFAULT_VALUE: InjectionToken<{
root?: {
base?: string | undefined;
color?: {
[x: string]: string | undefined;
primary?: string | undefined;
dark?: string | undefined;
blue?: string | undefined;
gray?: string | undefined;
green?: string | undefined;
lime?: string | undefined;
purple?: string | undefined;
red?: string | undefined;
} | undefined;
position?: {
[x: string]: string | undefined;
'bottom-left'?: string | undefined;
'bottom-right'?: string | undefined;
'bottom-center'?: string | undefined;
'top-left'?: string | undefined;
'top-center'?: string | undefined;
'top-right'?: string | undefined;
'center-left'?: string | undefined;
'center-right'?: string | undefined;
} | undefined;
} | undefined;
}>;
export declare const scrollTopDefaultValueProvider: import("@angular/core").EnvironmentProviders;
/**
* Provide a way to go at the top of the page via a button
*/
export declare class ScrollTopComponent extends BaseComponent<ScrollTopClass> implements OnInit {
/**
* Service injected used to generate class
*/
readonly themeService: ScrollTopThemeService;
/**
* `IconRegistry` service
*/
readonly iconRegistry: IconRegistry;
/**
* `DomSanitizer` service
*/
readonly domSanitizer: DomSanitizer;
/**
* Set the scroll top color
*
* @default primary
*/
color: import("@angular/core").ModelSignal<keyof ScrollTopColors>;
/**
* Set the scroll top position
*
* @default bottom-right
*/
position: import("@angular/core").ModelSignal<keyof ScrollTopPositions>;
/**
* Set the scroll top icon
*
* @default undefined
*/
icon: import("@angular/core").ModelSignal<TemplateRef<unknown> | undefined>;
/**
* Set the custom style for this scroll top
*
* @default {}
*/
customStyle: import("@angular/core").ModelSignal<{
root?: {
base?: string | undefined;
color?: {
[x: string]: string | undefined;
primary?: string | undefined;
dark?: string | undefined;
blue?: string | undefined;
gray?: string | undefined;
green?: string | undefined;
lime?: string | undefined;
purple?: string | undefined;
red?: string | undefined;
} | undefined;
position?: {
[x: string]: string | undefined;
'bottom-left'?: string | undefined;
'bottom-right'?: string | undefined;
'bottom-center'?: string | undefined;
'top-left'?: string | undefined;
'top-center'?: string | undefined;
'top-right'?: string | undefined;
'center-left'?: string | undefined;
'center-right'?: string | undefined;
} | undefined;
} | undefined;
}>;
fetchClass(): ScrollTopClass;
init(): void;
/**
* Navigate to the top of the page
*/
onClick(): void;
static ɵfac: i0.ɵɵFactoryDeclaration<ScrollTopComponent, never>;
static ɵcmp: i0.ɵɵComponentDeclaration<ScrollTopComponent, "flowbite-scroll-top", never, { "color": { "alias": "color"; "required": false; "isSignal": true; }; "position": { "alias": "position"; "required": false; "isSignal": true; }; "icon": { "alias": "icon"; "required": false; "isSignal": true; }; "customStyle": { "alias": "customStyle"; "required": false; "isSignal": true; }; }, { "color": "colorChange"; "position": "positionChange"; "icon": "iconChange"; "customStyle": "customStyleChange"; }, never, never, true, never>;
}