react-shadcn-kit 0.2.4 → 0.2.5

package/dist/hooks/use-aria-live.d.ts

@@ -0,0 +1,22 @@
+/**
+ * useAriaLive
+ *
+ * Provides a simple way to announce dynamic content to screen readers using an
+ * `aria-live` region. The hook returns a ref that should be attached to a hidden
+ * element and a function to update the live message.
+ *
+ * Example usage:
+ * ```tsx
+ * const { liveRef, announce } = useAriaLive();
+ * return (
+ *   <>
+ *     <div ref={liveRef} aria-live="polite" className="sr-only" />
+ *     <button onClick={() => announce('Item added')}>Add</button>
+ *   </>
+ * );
+ * ```
+ */
+export declare function useAriaLive(): {
+    readonly liveRef: import('react').RefObject<HTMLDivElement | null>;
+    readonly announce: (message: string) => void;
+};

package/dist/hooks/use-browser-cache-image.d.ts

@@ -0,0 +1,4 @@
+export declare function useBrowserCachedImage(imageUrl: string, cacheName?: string): {
+    src: string | null;
+    loading: boolean;
+};

package/dist/hooks/use-focus-visible.d.ts

@@ -0,0 +1,15 @@
+/**
+ * useFocusVisible
+ *
+ * Detects when the user is navigating via keyboard (focus-visible) and provides a
+ * boolean flag that can be used to apply a visual focus style only for keyboard
+ * users. This mirrors the behavior of the `:focus-visible` CSS pseudo‑class but
+ * works in browsers that lack native support.
+ *
+ * Example usage:
+ * ```tsx
+ * const isFocusVisible = useFocusVisible();
+ * return <button className={isFocusVisible ? 'focus-visible' : ''}>Click</button>;
+ * ```
+ */
+export declare function useFocusVisible(): boolean;

package/dist/hooks/use-mobile.d.ts

@@ -0,0 +1 @@
+export declare function useIsMobile(): boolean;

package/dist/hooks/use-screen-reader-only.d.ts

@@ -0,0 +1,14 @@
+/**
+ * useScreenReaderOnly
+ *
+ * Provides a utility hook that returns a className string for visually hidden
+ * elements that are still accessible to screen readers. It mirrors the common
+ * `sr-only` utility from Tailwind but can be used without Tailwind.
+ *
+ * Example usage:
+ * ```tsx
+ * const srOnly = useScreenReaderOnly();
+ * return <span className={srOnly}>Only for screen readers</span>;
+ * ```
+ */
+export declare function useScreenReaderOnly(): string;

package/dist/hooks/use-theme.d.ts

@@ -0,0 +1,7 @@
+export declare function useTheme(): {
+    theme: string | undefined;
+    setTheme: import('react').Dispatch<import('react').SetStateAction<string>>;
+    systemTheme: "light" | "dark" | undefined;
+    toggleTheme: () => void;
+    isDark: boolean;
+};

package/dist/index.d.ts

@@ -1,145 +1,14 @@
-import { ClassProp } from 'class-variance-authority/types';
-import { JSX } from 'react/jsx-runtime';
-import * as React_2 from 'react';
-import { VariantProps } from 'class-variance-authority';
-
-export declare const ActionButton: React_2.ForwardRefExoticComponent<ActionButtonProps & React_2.RefAttributes<HTMLButtonElement>>;
-
-export declare interface ActionButtonProps extends CustomButtonProps {
-    action: () => Promise<{
-        error: boolean;
-        message?: string;
-    }>;
-    requireAreYouSure?: boolean;
-    areYouSureTitle?: React_2.ReactNode;
-    areYouSureDescription?: React_2.ReactNode;
-    showSuccessToast?: boolean;
-    showErrorToast?: boolean;
-}
-
-export declare function ComponentSearch({ placeholder, onSearch, onSelect, minQueryLength, debounceMs, className, showOnMobile, }: ComponentSearchProps): JSX.Element;
-
-declare interface ComponentSearchProps {
-    /**
-     * Placeholder text for the search input
-     * @default "Search components..."
-     */
-    placeholder?: string;
-    /**
-     * Async function to fetch search results based on query
-     */
-    onSearch?: (query: string) => Promise<SearchResult[]>;
-    /**
-     * Callback when a search result is selected
-     */
-    onSelect?: (result: SearchResult) => void;
-    /**
-     * Minimum characters required before triggering search
-     * @default 2
-     */
-    minQueryLength?: number;
-    /**
-     * Debounce delay in milliseconds
-     * @default 300
-     */
-    debounceMs?: number;
-    /**
-     * Custom className for the container
-     */
-    className?: string;
-    /**
-     * Whether to show the component on mobile
-     * @default false
-     */
-    showOnMobile?: boolean;
-}
-
-declare interface CustomButtonProps extends React_2.ButtonHTMLAttributes<HTMLButtonElement>, VariantProps<typeof customButtonVariants> {
-    asChild?: boolean;
-    loading?: boolean;
-    loadingText?: string;
-    loadingIcon?: React_2.ElementType;
-    loadingIconPlacement?: "left" | "right";
-    icon?: React_2.ElementType;
-    iconPlacement?: "left" | "right";
-}
-
-declare const customButtonVariants: (props?: ({
-    variant?: "link" | "default" | "destructive" | "outline" | "secondary" | "ghost" | null | undefined;
-    effect?: "none" | "expandIcon" | "ringHover" | "underline" | "hoverUnderline" | null | undefined;
-    size?: "default" | "sm" | "lg" | "icon" | null | undefined;
-} & ClassProp) | undefined) => string;
-
-declare interface SearchResult {
-    id: string;
-    title: string;
-    description?: string;
-    icon?: React.ReactNode;
-    href?: string;
-    category?: string;
-}
-
-declare const Sidebar: React_2.ForwardRefExoticComponent<Omit<React_2.ClassAttributes<HTMLDivElement> & React_2.HTMLAttributes<HTMLDivElement> & {
-    side?: "left" | "right";
-    variant?: "sidebar" | "floating" | "inset";
-    collapsible?: "offcanvas" | "icon" | "none";
-    scrollable?: boolean;
-}, "ref"> & React_2.RefAttributes<HTMLDivElement>>;
-
-/**
- * SidebarWrapper
- *
- * A composable wrapper around the shadcn/ui `Sidebar` components tailored for the
- * `mcomposites` package. It provides a ready‑to‑use layout consisting of a
- * `SidebarProvider`, a `Sidebar` with optional custom trigger, and a content
- * area. The wrapper can be dropped into any page to instantly gain a fully
- * functional, accessible sidebar.
- *
- * Example usage:
- * ```tsx
- * <SidebarWrapper trigger={<MyTrigger />}>...</SidebarWrapper>
- * ```
- */
-export declare function SidebarWrapper({ trigger, children, className, ...sidebarProps }: SidebarWrapperProps): JSX.Element;
-
-export declare interface SidebarWrapperProps extends React_2.ComponentPropsWithoutRef<typeof Sidebar> {
-    /**
-     * Optional custom trigger component. If not provided, a default trigger button is rendered.
-     */
-    trigger?: React_2.ReactNode;
-    /**
-     * Children rendered inside the SidebarContent area.
-     */
-    children: React_2.ReactNode;
-}
-
-export declare function ThemeToggle({ align, side, sideOffset, className, trigger, }: ThemeToggleProps): JSX.Element;
-
-export declare interface ThemeToggleProps {
-    align?: "center" | "start" | "end";
-    side?: "top" | "right" | "bottom" | "left";
-    sideOffset?: number;
-    className?: string;
-    trigger?: React_2.ReactNode;
-}
-
-export declare function UserMenu({ user, items, className }: UserMenuProps): JSX.Element;
-
-export declare interface UserMenuProps {
-    user: {
-        name: string;
-        email: string;
-        avatar?: string;
-    };
-    items?: Array<{
-        label: string;
-        href?: string;
-        onClick?: () => void;
-        icon?: React_2.ComponentType<{
-            className?: string;
-        }>;
-    }>;
-    className?: string;
-}
-
-export { }
+export * from './components/primitives';
+export * from './components/composites';
+export * from './components/marketing';
+export * from './components/data-table';
+export * from './components/kanban';
+export * from './hooks';
+export * from './lib';
+export type * from './components/primitives';
+export type * from './components/composites';
+export type * from './components/marketing';
+export type * from './components/data-table';
+export type * from './components/kanban';
+export type * from './hooks';
+export type * from './lib';

package/dist/lib/browser-image-cache.d.ts

@@ -0,0 +1 @@
+export declare function getCachedImage(cacheName: string, imageUrl: string): Promise<Blob>;

package/dist/lib/utils-enhanced.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Format a date into a human-readable string.
+ * @example "Oct 24, 2023"
+ */
+export declare function formatDate(date: Date | string | number): string;
+/**
+ * Format a date into a long human-readable string with time.
+ * @example "October 24, 2023 at 10:00 AM"
+ */
+export declare function formatDateTime(date: Date | string | number): string;
+/**
+ * Format a date relative to now.
+ * @example "2 days ago"
+ */
+export declare function formatRelative(date: Date | string | number): string;
+/**
+ * Generate a URL-friendly slug from a string.
+ */
+export declare function generateSlug(text: string): string;
+/**
+ * Map database errors to user-friendly messages.
+ * Generic template for common DB constraints.
+ */
+export declare function mapDatabaseError(error: unknown): {
+    error: true;
+    message: string;
+};

package/dist/lib/utils-enhanced.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/lib/utils.d.ts

@@ -0,0 +1,2 @@
+import { ClassValue } from 'clsx';
+export declare function cn(...inputs: ClassValue[]): string;

package/package.json

@@ -2,7 +2,7 @@
   "name": "react-shadcn-kit",
   "author": "Tushar Yadav",
   "private": false,
-  "version": "0.2.4",
+  "version": "0.2.5",
   "type": "module",
   "main": "dist/index.js",
   "module": "dist/index.js",