@framingui/ui 0.6.2 → 0.6.3

package/dist/templates/index.d.mts

@@ -0,0 +1,142 @@
+import { ComponentType, ReactNode } from 'react';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+
+type ScreenCategory = 'auth' | 'dashboard' | 'form' | 'marketing' | 'feedback';
+type TemplateLayout = 'centered' | 'sidebar' | 'full';
+interface ResponsiveBreakpoints {
+    mobile: number;
+    tablet: number;
+    desktop: number;
+}
+interface ResponsiveLayout {
+    mobile: {
+        padding: string;
+        gap: string;
+        columns: number;
+    };
+    tablet: {
+        padding: string;
+        gap: string;
+        columns: number;
+    };
+    desktop: {
+        padding: string;
+        gap: string;
+        columns: number;
+    };
+}
+interface TemplateLayoutConfig {
+    type: TemplateLayout;
+    responsive: ResponsiveLayout;
+}
+interface SectionTemplate {
+    id: string;
+    name: string;
+    slot: string;
+    required: boolean;
+    Component: ComponentType<any>;
+}
+interface CustomizationBoundaries {
+    texts: string[];
+    optional: string[];
+    slots: string[];
+}
+interface TemplateSkeleton {
+    shell: string;
+    page: string;
+    sections: SectionTemplate[];
+}
+interface ScreenTemplateProps {
+    children?: ReactNode;
+    className?: string;
+    slots?: Record<string, ReactNode>;
+    texts?: Record<string, string>;
+    options?: Record<string, string | boolean | number>;
+}
+interface ScreenTemplate {
+    id: string;
+    name: string;
+    category: ScreenCategory;
+    description: string;
+    skeleton: TemplateSkeleton;
+    layout: TemplateLayoutConfig;
+    customizable: CustomizationBoundaries;
+    requiredComponents: string[];
+    Component: ComponentType<ScreenTemplateProps>;
+    version: string;
+    created: string;
+    updated: string;
+    tags?: string[];
+}
+interface TemplateRegistryEntry {
+    template: ScreenTemplate;
+    metadata: {
+        usageCount: number;
+        lastUsed?: string;
+    };
+}
+declare const DEFAULT_RESPONSIVE_LAYOUT: ResponsiveLayout;
+declare const DEFAULT_BREAKPOINTS: ResponsiveBreakpoints;
+
+declare class TemplateRegistry {
+    private static instance;
+    private templates;
+    private constructor();
+    static getInstance(): TemplateRegistry;
+    register(template: ScreenTemplate): void;
+    registerMany(templates: ScreenTemplate[]): void;
+    get(id: string): ScreenTemplate | undefined;
+    getAll(): ScreenTemplate[];
+    getByCategory(category: ScreenCategory): ScreenTemplate[];
+    findByRequiredComponents(components: string[]): ScreenTemplate[];
+    search(keyword: string): ScreenTemplate[];
+    getMetadata(id: string): TemplateRegistryEntry['metadata'] | undefined;
+    getMostUsed(limit?: number): ScreenTemplate[];
+    getRecentlyUsed(limit?: number): ScreenTemplate[];
+    clear(): void;
+    count(): number;
+    has(id: string): boolean;
+    remove(id: string): boolean;
+}
+declare const templateRegistry: TemplateRegistry;
+
+declare function LoginTemplateComponent({ children, className, slots, texts, options, }: ScreenTemplateProps): react_jsx_runtime.JSX.Element;
+declare const LoginTemplate: ScreenTemplate;
+
+declare function SignupTemplateComponent({ children, className, slots, texts, options, }: ScreenTemplateProps): react_jsx_runtime.JSX.Element;
+declare const SignupTemplate: ScreenTemplate;
+
+declare function ForgotPasswordTemplateComponent({ children, className, slots, texts, }: ScreenTemplateProps): react_jsx_runtime.JSX.Element;
+declare const ForgotPasswordTemplate: ScreenTemplate;
+
+declare function VerificationTemplateComponent({ children, className, slots, texts, options, }: ScreenTemplateProps): react_jsx_runtime.JSX.Element;
+declare const VerificationTemplate: ScreenTemplate;
+
+declare function LandingTemplateComponent({ children, className, slots, texts, }: ScreenTemplateProps): react_jsx_runtime.JSX.Element;
+declare const LandingTemplate: ScreenTemplate;
+
+declare function PreferencesTemplateComponent({ children, className, slots, texts, }: ScreenTemplateProps): react_jsx_runtime.JSX.Element;
+declare const PreferencesTemplate: ScreenTemplate;
+
+declare function ProfileTemplateComponent({ children, className, slots, texts, options, }: ScreenTemplateProps): react_jsx_runtime.JSX.Element;
+declare const ProfileTemplate: ScreenTemplate;
+
+declare function LoadingTemplateComponent({ children, className, slots, texts, options, }: ScreenTemplateProps): react_jsx_runtime.JSX.Element;
+declare const LoadingTemplate: ScreenTemplate;
+
+declare function ErrorTemplateComponent({ children, className, slots, texts, options, }: ScreenTemplateProps): react_jsx_runtime.JSX.Element;
+declare const ErrorTemplate: ScreenTemplate;
+
+declare function EmptyTemplateComponent({ children, className, slots, texts, options, }: ScreenTemplateProps): react_jsx_runtime.JSX.Element;
+declare const EmptyTemplate: ScreenTemplate;
+
+declare function ConfirmationTemplateComponent({ children, className, slots, texts, options, }: ScreenTemplateProps): react_jsx_runtime.JSX.Element;
+declare const ConfirmationTemplate: ScreenTemplate;
+
+declare function SuccessTemplateComponent({ children, className, slots, texts, options, }: ScreenTemplateProps): react_jsx_runtime.JSX.Element;
+declare const SuccessTemplate: ScreenTemplate;
+
+declare function DashboardTemplateComponent({ children, className, slots, texts, }: ScreenTemplateProps): react_jsx_runtime.JSX.Element;
+declare const DashboardTemplate: ScreenTemplate;
+
+export { ConfirmationTemplate, ConfirmationTemplateComponent, type CustomizationBoundaries, DEFAULT_BREAKPOINTS, DEFAULT_RESPONSIVE_LAYOUT, DashboardTemplate, DashboardTemplateComponent, EmptyTemplate, EmptyTemplateComponent, ErrorTemplate, ErrorTemplateComponent, ForgotPasswordTemplate, ForgotPasswordTemplateComponent, LandingTemplate, LandingTemplateComponent, LoadingTemplate, LoadingTemplateComponent, LoginTemplate, LoginTemplateComponent, PreferencesTemplate, PreferencesTemplateComponent, ProfileTemplate, ProfileTemplateComponent, type ResponsiveBreakpoints, type ResponsiveLayout, type ScreenCategory, type ScreenTemplate, type ScreenTemplateProps, type SectionTemplate, SignupTemplate, SignupTemplateComponent, SuccessTemplate, SuccessTemplateComponent, type TemplateLayout, type TemplateLayoutConfig, TemplateRegistry, type TemplateRegistryEntry, type TemplateSkeleton, VerificationTemplate, VerificationTemplateComponent, templateRegistry };