diditui 0.0.1 → 0.0.2

package/dist/diditui.d.ts

@@ -1,16 +1,178 @@
 import { ClassProp } from 'class-variance-authority/types';
 import { ComponentProps } from 'react';
+import { Config } from 'tailwindcss';
+import { default as default_2 } from 'react';
+import { FC } from 'react';
 import { JSX as JSX_2 } from 'react/jsx-runtime';
+import { Props } from 'react-modal';
 import { VariantProps } from 'class-variance-authority';
 
-export declare function Button({ size, variant, colorScheme, className, children, ...props }: ButtonProps): JSX_2.Element;
+declare type AsProp<C extends default_2.ElementType> = {
+    /**
+     * An override of the default HTML tag.
+     * Can also be another React component.
+     */
+    as?: C;
+};
 
-declare type ButtonProps = ComponentProps<'button'> & VariantProps<typeof buttonStyles>;
+export declare function Button({ size, variant, icon, isLoading, disabled, className, children, ...props }: ButtonProps): JSX_2.Element;
 
-declare const buttonStyles: (props?: ({
-    variant?: "solid" | "outline" | "ghost" | null | undefined;
-    size?: "sm" | "md" | "lg" | null | undefined;
-    colorScheme?: "primary" | "secondary" | "danger" | null | undefined;
+declare type ButtonProps = ComponentProps<'button'> & {
+    variant?: 'default' | 'primary' | 'soft';
+    size?: 'md' | 'lg';
+    icon?: IconType;
+    isLoading?: boolean;
+};
+
+export declare function Card({ className, padding, shadow, children, ...props }: CardProps): JSX_2.Element;
+
+declare type CardProps = ComponentProps<'div'> & VariantProps<typeof cardStyles>;
+
+declare const cardStyles: (props?: ({
+    padding?: "sm" | "md" | "lg" | "none" | null | undefined;
+    shadow?: boolean | null | undefined;
+} & ClassProp) | undefined) => string;
+
+export declare const didituiConfig: Config;
+
+/**
+ * Allows for extending a set of props (`ExtendedProps`) by an overriding set of props
+ * (`OverrideProps`), ensuring that any duplicates are overridden by the overriding
+ * set of props.
+ */
+declare type ExtendableProps<ExtendedProps = {}, OverrideProps = {}> = OverrideProps & Omit<ExtendedProps, keyof OverrideProps>;
+
+export declare function Icon({ type, size, className, ...props }: IconProps): JSX_2.Element;
+
+export declare function IconButton({ icon, label, size, className, ...props }: IconButtonProps): JSX_2.Element;
+
+declare type IconButtonProps = ComponentProps<'button'> & VariantProps<typeof iconButtonStyles> & {
+    icon?: IconType;
+    label?: string;
+};
+
+declare const iconButtonStyles: (props?: ({
+    size?: "xs" | "sm" | "md" | "lg" | null | undefined;
+} & ClassProp) | undefined) => string;
+
+declare type IconProps = ComponentProps<'span'> & VariantProps<typeof iconStyles> & {
+    type?: IconType;
+};
+
+declare const iconStyles: (props?: ({
+    size?: "xs" | "sm" | "md" | "lg" | "xl" | null | undefined;
+} & ClassProp) | undefined) => string;
+
+export declare type IconType = 'settings' | 'info' | 'arrowRight' | 'scan' | 'warning' | 'check' | 'copy' | 'connect' | 'passKey' | 'didit' | 'close';
+
+/**
+ * Allows for inheriting the props from the specified element type so that
+ * props like children, className & style work, as well as element-specific
+ * attributes like aria roles. The component (`C`) must be passed in.
+ */
+declare type InheritableElementProps<C extends default_2.ElementType, Props = {}> = ExtendableProps<PropsOf<C>, Props>;
+
+export declare function Modal({ children, contentLabel, overlayClassName, className, onRequestClose, ...props }: Props): JSX_2.Element;
+
+/**
+ * A more sophisticated version of `InheritableElementProps` where
+ * the passed in `as` prop will determine which props can be included
+ */
+declare type PolymorphicComponentProps<C extends default_2.ElementType, Props = {}> = InheritableElementProps<C, Props & AsProp<C>>;
+
+declare type PolymorphicComponentPropsWithRef<C extends default_2.ElementType, Props = {}> = PolymorphicComponentProps<C, Props> & {
+    ref?: PolymorphicRef<C>;
+};
+
+declare type PolymorphicRef<C extends default_2.ElementType> = default_2.ComponentPropsWithRef<C>['ref'];
+
+declare type PropsOf<C extends keyof JSX.IntrinsicElements | default_2.JSXElementConstructor<unknown>> = JSX.LibraryManagedAttributes<C, default_2.ComponentPropsWithoutRef<C>>;
+
+export declare function QrCode({ uri, size, color, iconName, className, ...props }: QrCodeProps): JSX_2.Element;
+
+declare type QrCodeProps = ComponentProps<'div'> & {
+    uri: string;
+    size?: 'sm' | 'md' | 'lg' | number;
+    color?: string;
+    iconName?: IconType;
+};
+
+export declare function Spinner({ size, variant, className, ...props }: SpinnerProps): JSX_2.Element;
+
+declare type SpinnerProps = ComponentProps<'span'> & VariantProps<typeof spinnerStyles>;
+
+declare const spinnerStyles: (props?: ({
+    variant?: "default" | "primary" | "soft" | "accent" | null | undefined;
+    size?: "xs" | "sm" | "md" | "lg" | "xl" | null | undefined;
+} & ClassProp) | undefined) => string;
+
+declare type SVGIcon = FC<React.SVGProps<SVGElement>>;
+
+export declare const svgOptions: Record<IconType, SVGIcon>;
+
+declare const Text_2: TextComponent;
+export { Text_2 as Text }
+
+declare type TextComponent = <C extends React.ElementType = 'span'>(props: TextProps<C>) => React.ReactElement | null;
+
+declare type TextProps<C extends React.ElementType> = PolymorphicComponentPropsWithRef<C, VariantProps<typeof textStyles>>;
+
+declare const textStyles: (props?: ({
+    variant?: "H1" | "H2" | "H3" | "H4" | "H5" | "H6" | "P1" | "P2" | "P3" | "Label1" | "Label2" | "Label3" | "Label4" | "StyledLabel" | null | undefined;
+    align?: "center" | "left" | "right" | null | undefined;
+    italic?: boolean | null | undefined;
+    underline?: boolean | null | undefined;
 } & ClassProp) | undefined) => string;
 
+export declare function useLgMediaQuery(): boolean;
+
+export declare function useMdMediaQuery(): boolean;
+
+/**
+ * Custom hook that tracks the state of a media query using the [`Match Media API`](https://developer.mozilla.org/en-US/docs/Web/API/Window/matchMedia).
+ * @param {string} query - The media query to track.
+ * @param {?UseMediaQueryOptions} [options] - The options for customizing the behavior of the hook (optional).
+ * @returns {boolean} The current state of the media query (true if the query matches, false otherwise).
+ * @public
+ * @see [Documentation](https://usehooks-ts.com/react-hook/use-media-query)
+ * @example
+ * ```tsx
+ * const isSmallScreen = useMediaQuery('(max-width: 600px)');
+ * // Use `isSmallScreen` to conditionally apply styles or logic based on the screen size.
+ * ```
+ */
+export declare function useMediaQuery(query: string, { defaultValue, initializeWithValue }?: UseMediaQueryOptions): boolean;
+
+/** Hook options. */
+declare type UseMediaQueryOptions = {
+    /**
+     * The default value to return if the hook is being run on the server.
+     * @default false
+     */
+    defaultValue?: boolean;
+    /**
+     * If `true` (default), the hook will initialize reading the media query. In SSR, you should set it to `false`, returning `options.defaultValue` or `false` initially.
+     * @default true
+     */
+    initializeWithValue?: boolean;
+};
+
+export declare function UserCard({ name, label, avatar, size, className, ...props }: UserCardProps): JSX_2.Element;
+
+declare type UserCardProps = ComponentProps<'div'> & VariantProps<typeof userCardStyles> & {
+    name: string;
+    label?: string;
+    avatar?: string;
+};
+
+declare const userCardStyles: (props?: ({
+    size?: "xs" | "sm" | "md" | "lg" | null | undefined;
+} & ClassProp) | undefined) => string;
+
+export declare function useSmMediaQuery(): boolean;
+
+export declare function useXlMediaQuery(): boolean;
+
+export declare function useXxlMediaQuery(): boolean;
+
 export { }