@ldkj/web-ui 0.14.0 → 0.15.0

package/README.md

@@ -1,27 +1,31 @@
-# @ldkj/web-ui
-
-由 shadcn-ui, Tailwind CSS 和 VitePress 构建的 React 组件库.
-
-## 立即开始
-
-```bash
-pnpm add @ldkj/web-ui
-```
-
-## 使用示例
-
-```tsx
-import "@ldkj/web-ui/style.css";
-import { Button, Chip } from "@ldkj/web-ui";
-
-export default function App() {
-  return (
-    <div className="p-4">
-      <Button variant="primary">Hello World</Button>
-      <Chip variant="success" size="sm">
-        Ready
-      </Chip>
-    </div>
-  );
-}
-```
+# @ldkj/web-ui
+
+由 shadcn-ui, Tailwind CSS 和 VitePress 构建的 React 组件库.
+
+## 立即开始
+
+```bash
+pnpm add @ldkj/web-ui
+```
+
+## 使用示例
+
+```tsx
+import "@ldkj/web-ui/style.css";
+import { Button, Chip } from "@ldkj/web-ui";
+
+// 可选：如需启用设计系统基础重置（全局样式），再额外引入
+// import "@ldkj/web-ui/reset.css";
+
+export default function App() {
+  return (
+    <div className="p-4">
+      <Button variant="primary">Hello World</Button>
+      <Chip variant="success" size="sm">
+        Ready
+      </Chip>
+    </div>
+  );
+}
+```
+

package/components/data-display/badge/Badge.d.ts

@@ -0,0 +1,14 @@
+import * as React from "react";
+import { type SxProps } from "@/styling";
+export type BadgeVariant = "neutral" | "primary" | "success" | "warning" | "danger";
+export type BadgeProps = React.HTMLAttributes<HTMLSpanElement> & {
+    class?: string;
+    sx?: SxProps;
+    badgeContent?: React.ReactNode;
+    dot?: boolean;
+    light?: boolean;
+    showZero?: boolean;
+    max?: number;
+    variant?: BadgeVariant;
+};
+export declare function Badge(props: BadgeProps): import("react/jsx-runtime").JSX.Element;

package/components/data-display/badge/index.d.ts

@@ -0,0 +1 @@
+export * from "./Badge";

package/components/data-display/empty/Empty.d.ts

@@ -0,0 +1,7 @@
+import * as React from "react";
+import { type BoxProps } from "@/components/layout/box";
+export type EmptyProps = BoxProps<"div"> & {
+    description?: React.ReactNode;
+    image?: React.ReactNode;
+};
+export declare function Empty(props: EmptyProps): import("react/jsx-runtime").JSX.Element;

package/components/data-display/empty/index.d.ts

@@ -0,0 +1 @@
+export * from "./Empty";

package/components/data-display/image/Image.d.ts

@@ -0,0 +1,74 @@
+import * as React from "react";
+import { type SxProps } from "@/styling";
+type ImageStatus = "idle" | "loading" | "loaded" | "error";
+type ImageLoader = (src: string, options: {
+    width?: number;
+    quality?: number;
+    format?: string;
+    crop?: boolean;
+    height?: number;
+}) => string;
+type ImageSource = {
+    media?: string;
+    srcSet: string;
+    type?: string;
+    sizes?: string;
+};
+export type ImageRenderState = {
+    status: ImageStatus;
+    loading: boolean;
+    error: boolean;
+    loaded: boolean;
+    previewOpen: boolean;
+    src?: string;
+};
+type ImageFormat = "webp" | "avif";
+export type ImageProps = Omit<React.ImgHTMLAttributes<HTMLImageElement>, "placeholder" | "children"> & {
+    class?: string;
+    sx?: SxProps;
+    fallback?: React.ReactNode;
+    fallbackSrc?: string;
+    loadingFallback?: React.ReactNode;
+    fit?: React.CSSProperties["objectFit"];
+    position?: React.CSSProperties["objectPosition"];
+    aspectRatio?: number | string;
+    placeholder?: "blur";
+    blurDataURL?: string;
+    retry?: number;
+    retryDelay?: number;
+    onLoadingChange?: (loading: boolean) => void;
+    loader?: ImageLoader;
+    quality?: number;
+    format?: string;
+    crop?: boolean;
+    sources?: ImageSource[];
+    formats?: ImageFormat[];
+    responsiveWidths?: number[];
+    preview?: boolean;
+    children?: (state: ImageRenderState) => React.ReactNode;
+};
+export declare const Image: React.ForwardRefExoticComponent<Omit<React.ImgHTMLAttributes<HTMLImageElement>, "children" | "placeholder"> & {
+    class?: string;
+    sx?: SxProps;
+    fallback?: React.ReactNode;
+    fallbackSrc?: string;
+    loadingFallback?: React.ReactNode;
+    fit?: React.CSSProperties["objectFit"];
+    position?: React.CSSProperties["objectPosition"];
+    aspectRatio?: number | string;
+    placeholder?: "blur";
+    blurDataURL?: string;
+    retry?: number;
+    retryDelay?: number;
+    onLoadingChange?: (loading: boolean) => void;
+    loader?: ImageLoader;
+    quality?: number;
+    format?: string;
+    crop?: boolean;
+    sources?: ImageSource[];
+    formats?: ImageFormat[];
+    responsiveWidths?: number[];
+    preview?: boolean;
+    children?: (state: ImageRenderState) => React.ReactNode;
+} & React.RefAttributes<HTMLImageElement>>;
+export {};

package/components/data-display/image/index.d.ts

@@ -0,0 +1 @@
+export * from "./Image";

package/components/data-display/list/List.d.ts

@@ -0,0 +1,8 @@
+import * as React from "react";
+import { type SxProps } from "@/styling";
+export type ListProps = React.HTMLAttributes<HTMLUListElement> & {
+    class?: string;
+    sx?: SxProps;
+    bordered?: boolean;
+};
+export declare function List(props: ListProps): import("react/jsx-runtime").JSX.Element;

package/components/data-display/list/index.d.ts

@@ -0,0 +1 @@
+export * from "./List";

package/components/form/auto-complete/AutoComplete.d.ts

@@ -0,0 +1,9 @@
+import { type InputProps } from "@/components/form/input";
+export type AutoCompleteOption = {
+    label: string;
+    value: string;
+};
+export type AutoCompleteProps = Omit<InputProps, "list"> & {
+    options?: AutoCompleteOption[];
+};
+export declare function AutoComplete(props: AutoCompleteProps): import("react/jsx-runtime").JSX.Element;

package/components/form/auto-complete/index.d.ts

@@ -0,0 +1 @@
+export * from "./AutoComplete";

package/components/form/cascader/Cascader.d.ts

@@ -0,0 +1,12 @@
+export type CascaderOption = {
+    label: string;
+    value: string;
+    children?: CascaderOption[];
+};
+export type CascaderProps = {
+    options?: CascaderOption[];
+    value?: string;
+    placeholder?: string;
+    onValueChange?: (value: string) => void;
+};
+export declare function Cascader(props: CascaderProps): import("react/jsx-runtime").JSX.Element;

package/components/form/cascader/index.d.ts

@@ -0,0 +1 @@
+export * from "./Cascader";

package/components/form/form-v2/FormV2.d.ts

@@ -0,0 +1,5 @@
+import * as React from "react";
+export type FormV2Props = React.FormHTMLAttributes<HTMLFormElement> & {
+    class?: string;
+};
+export declare function FormV2(props: FormV2Props): import("react/jsx-runtime").JSX.Element;

package/components/form/form-v2/index.d.ts

@@ -0,0 +1 @@
+export * from "./FormV2";

package/components/form/input-number/InputNumber.d.ts

@@ -0,0 +1,7 @@
+import { type InputProps } from "@/components/form/input";
+export type InputNumberProps = Omit<InputProps, "type" | "inputMode"> & {
+    min?: number;
+    max?: number;
+    step?: number;
+};
+export declare function InputNumber(props: InputNumberProps): import("react/jsx-runtime").JSX.Element;

package/components/form/input-number/index.d.ts

@@ -0,0 +1 @@
+export * from "./InputNumber";

package/components/form/input-opt/InputOPT.d.ts

@@ -0,0 +1,9 @@
+export type InputOPTProps = {
+    value?: string;
+    length?: number;
+    disabled?: boolean;
+    className?: string;
+    class?: string;
+    onChange?: (value: string) => void;
+};
+export declare function InputOPT(props: InputOPTProps): import("react/jsx-runtime").JSX.Element;

package/components/form/input-opt/index.d.ts

@@ -0,0 +1 @@
+export * from "./InputOPT";

package/components/form/rate/Rate.d.ts

@@ -0,0 +1,9 @@
+export type RateProps = {
+    value?: number;
+    count?: number;
+    disabled?: boolean;
+    className?: string;
+    class?: string;
+    onChange?: (value: number) => void;
+};
+export declare function Rate(props: RateProps): import("react/jsx-runtime").JSX.Element;

package/components/form/rate/index.d.ts

@@ -0,0 +1 @@
+export * from "./Rate";

package/components/form/required/Required.d.ts

@@ -0,0 +1,4 @@
+import * as React from "react";
+export declare function Required({ children }: {
+    children?: React.ReactNode;
+}): import("react/jsx-runtime").JSX.Element;

package/components/form/required/index.d.ts

@@ -0,0 +1 @@
+export * from "./Required";

package/components/form/slider-v2/SliderV2.d.ts

@@ -0,0 +1,7 @@
+import * as React from "react";
+export type SliderV2Props = Omit<React.InputHTMLAttributes<HTMLInputElement>, "type" | "value" | "onChange"> & {
+    value?: number;
+    class?: string;
+    onValueChange?: (value: number) => void;
+};
+export declare function SliderV2(props: SliderV2Props): import("react/jsx-runtime").JSX.Element;

package/components/form/slider-v2/index.d.ts

@@ -0,0 +1 @@
+export * from "./SliderV2";

package/components/form/uploader/Uploader.d.ts

@@ -0,0 +1,7 @@
+export type UploaderProps = {
+    accept?: string;
+    multiple?: boolean;
+    disabled?: boolean;
+    onChange?: (files: FileList | null) => void;
+};
+export declare function Uploader(props: UploaderProps): import("react/jsx-runtime").JSX.Element;

package/components/form/uploader/index.d.ts

@@ -0,0 +1 @@
+export * from "./Uploader";

package/components/interact/alert/Alert.d.ts

@@ -0,0 +1,9 @@
+import * as React from "react";
+export type AlertVariant = "info" | "success" | "warning" | "error";
+export type AlertProps = React.HTMLAttributes<HTMLDivElement> & {
+    class?: string;
+    variant?: AlertVariant;
+    title?: React.ReactNode;
+    description?: React.ReactNode;
+};
+export declare function Alert(props: AlertProps): import("react/jsx-runtime").JSX.Element;

package/components/interact/alert/index.d.ts

@@ -0,0 +1 @@
+export * from "./Alert";

package/components/interact/drawer/Drawer.d.ts

@@ -0,0 +1,11 @@
+import * as React from "react";
+export type DrawerProps = {
+    open: boolean;
+    title?: React.ReactNode;
+    width?: number | string;
+    className?: string;
+    class?: string;
+    children?: React.ReactNode;
+    onOpenChange?: (open: boolean) => void;
+};
+export declare function Drawer(props: DrawerProps): import("react/jsx-runtime").JSX.Element | null;

package/components/interact/drawer/index.d.ts

@@ -0,0 +1 @@
+export * from "./Drawer";

package/components/interact/loading/Loading.d.ts

@@ -0,0 +1,3 @@
+export declare function Loading({ text }: {
+    text?: string;
+}): import("react/jsx-runtime").JSX.Element;

package/components/interact/loading/index.d.ts

@@ -0,0 +1 @@
+export * from "./Loading";

package/components/interact/notification/Notification.d.ts

@@ -0,0 +1,6 @@
+export declare const notification: {
+    info(message: string): string;
+    success(message: string): string;
+    warn(message: string): string;
+    error(message: string): string;
+};

package/components/interact/notification/index.d.ts

@@ -0,0 +1 @@
+export * from './Notification';

package/components/interact/progress/Progress.d.ts

@@ -0,0 +1,8 @@
+import * as React from "react";
+export type ProgressProps = React.HTMLAttributes<HTMLDivElement> & {
+    value?: number;
+    max?: number;
+    showInfo?: boolean;
+    class?: string;
+};
+export declare function Progress(props: ProgressProps): import("react/jsx-runtime").JSX.Element;

package/components/interact/progress/index.d.ts

@@ -0,0 +1 @@
+export * from "./Progress";

package/components/interact/spin/Spin.d.ts

@@ -0,0 +1,6 @@
+import * as React from "react";
+export type SpinProps = React.HTMLAttributes<HTMLSpanElement> & {
+    size?: number;
+    class?: string;
+};
+export declare function Spin(props: SpinProps): import("react/jsx-runtime").JSX.Element;

package/components/interact/spin/index.d.ts

@@ -0,0 +1 @@
+export * from "./Spin";

package/components/layout/typography/Typography.d.ts

@@ -0,0 +1,13 @@
+import * as React from "react";
+import type { ElementType } from "react";
+import { type SxProps } from "@/styling";
+type TypographyVariant = "h1" | "h2" | "h3" | "body" | "caption";
+export type TypographyProps<T extends ElementType = "p"> = {
+    component?: T;
+    className?: string;
+    class?: string;
+    sx?: SxProps;
+    variant?: TypographyVariant;
+} & Omit<React.ComponentPropsWithoutRef<T>, "as" | "className">;
+export declare function Typography<T extends ElementType = "p">(props: TypographyProps<T>): import("react/jsx-runtime").JSX.Element;
+export {};

package/components/layout/typography/index.d.ts

@@ -0,0 +1 @@
+export * from "./Typography";