svelte-5-ui-lib/dist/sidebar/type.d.ts

Svelte 5 UI Lib is a UI library built from scratch to leverage Svelte 5's runes system, creating smooth, reactive components.

import { type Writable } from 'svelte/store';
import type { Snippet } from 'svelte';
import type { HTMLAttributes, HTMLButtonAttributes, HTMLAnchorAttributes } from 'svelte/elements';
import type { TransitionFunc, ParamsType } from '../types';
type SidebarCtxType = {
    closeSidebar?: () => void;
    activeClass?: string;
    nonActiveClass?: string;
    isSingle?: boolean;
    selected?: Writable<object>;
    activeUrl?: string;
};
type BreakpointType = 'sm' | 'md' | 'lg' | 'xl' | '2xl' | undefined;
type PosisionType = 'fixed' | 'absolute' | 'static' | undefined;
interface SidebarProps extends HTMLAttributes<HTMLElement> {
    children: Snippet;
    isOpen?: boolean;
    closeSidebar?: () => void;
    activateClickOutside?: boolean;
    isSingle?: boolean;
    breakpoint?: BreakpointType;
    position?: PosisionType;
    ariaLabel?: string;
    divClass?: string;
    nonActiveClass?: string;
    activeClass?: string;
    params?: ParamsType;
    transition?: TransitionFunc;
    backdrop?: boolean;
    backdropClass?: string;
    activeUrl?: string;
    class?: string;
}
interface SidebarButtonProps extends HTMLButtonAttributes {
    breakpoint?: BreakpointType;
    class?: string;
}
interface SidebarCtaProps extends HTMLAttributes<HTMLDivElement> {
    children: Snippet;
    icon?: Snippet;
    divClass?: string;
    spanClass?: string;
    label: string;
    class?: string;
}
interface SiteType {
    name?: string;
    href?: string;
    img?: string;
}
interface SidebarBrandProps extends HTMLAnchorAttributes {
    children?: Snippet;
    site?: SiteType;
    imgClass?: string;
    spanClass?: string;
    class?: string;
}
interface SidebarDropdownWrapperProps extends HTMLButtonAttributes {
    children: Snippet;
    arrowup?: Snippet;
    arrowdown?: Snippet;
    iconSlot?: Snippet;
    isOpen?: boolean | undefined;
    btnClass?: string;
    label: string | undefined;
    spanClass?: string;
    ulClass?: string;
    params?: ParamsType;
    transition?: TransitionFunc;
    svgClass?: string;
    onclick?: () => void;
    isSingle?: boolean;
    class?: string;
}
interface SidebarGroupProps extends HTMLAttributes<HTMLUListElement> {
    children: Snippet;
    borderClass?: string;
    border?: boolean;
}
interface SidebarItemProps extends HTMLAnchorAttributes {
    iconSlot?: Snippet;
    subtext?: Snippet;
    label?: string;
    spanClass?: string;
    activeClass?: string;
    nonActiveClass?: string;
    aClass?: string;
    active?: boolean;
}
export type { SidebarProps, SidebarDropdownWrapperProps, SidebarGroupProps, SidebarItemProps, SidebarCtxType, SidebarButtonProps, SidebarCtaProps, SidebarBrandProps, BreakpointType, PosisionType };