@akinon/ui-breadcrumb 0.4.0 → 0.5.0

package/dist/cjs/types.d.ts

@@ -0,0 +1,94 @@
+export type BreadcrumbProps = Omit<
+  AntBreadcrumbProps,
+  'prefixCls' | 'style' | 'styles' | 'separator'
+> & {
+  /**
+   * This is a custom event that is triggered when any breadcrumb item is clicked. It takes href of the clicked item as parameter.
+   */
+  onAnyItemClick?: ({ href }: { href: string }) => void;
+};
+
+type PropertyKey = string | number | symbol;
+
+export interface SeparatorType {
+  separator?: React.ReactNode;
+  key?: React.Key;
+}
+
+interface MenuItem {
+  key?: React.Key;
+  title?: React.ReactNode;
+  label?: React.ReactNode;
+  path?: string;
+  href?: string;
+}
+
+export interface BreadcrumbItemProps extends SeparatorType {
+  prefixCls?: string;
+  href?: string;
+  onClick?: React.MouseEventHandler<HTMLAnchorElement | HTMLSpanElement>;
+  className?: string;
+  children?: React.ReactNode;
+}
+
+export interface BreadcrumbItemType {
+  key?: React.Key;
+  /**
+   * Different with `path`. Directly set the link of this item.
+   */
+  href?: string;
+  /**
+   * Different with `href`. It will concat all prev `path` to the current one.
+   */
+  path?: string;
+  title?: React.ReactNode;
+  breadcrumbName?: string;
+  className?: string;
+  onClick?: React.MouseEventHandler<HTMLAnchorElement | HTMLSpanElement>;
+}
+
+export interface BreadcrumbSeparatorType {
+  type: 'separator';
+  separator?: React.ReactNode;
+}
+
+export type ItemType = Partial<BreadcrumbItemType & BreadcrumbSeparatorType>;
+
+export type InternalRouteType = Partial<
+  BreadcrumbItemType & BreadcrumbSeparatorType
+>;
+
+export interface AntBreadcrumbProps<
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  T extends Record<PropertyKey, any> = Record<PropertyKey, any>
+> {
+  prefixCls?: string;
+  /**
+   * Routing parameters. <code>object</code><br /><br />
+   */
+  params?: T;
+  separator?: React.ReactNode;
+  style?: React.CSSProperties;
+  /**
+   * The additional css class
+   */
+  className?: string;
+  /**
+   * ClassName on the root element
+   */
+  rootClassName?: string;
+  children?: React.ReactNode;
+  /**
+   * The routing stack information of router
+   */
+  items?: ItemType[];
+  /**
+   * Custom item renderer. <code>(route, params, routes, paths) => ReactNode</code><br /><br />
+   */
+  itemRender?: (
+    route: ItemType,
+    params: T,
+    routes: ItemType[],
+    paths: string[]
+  ) => React.ReactNode;
+}

package/dist/esm/types.d.ts

@@ -0,0 +1,94 @@
+export type BreadcrumbProps = Omit<
+  AntBreadcrumbProps,
+  'prefixCls' | 'style' | 'styles' | 'separator'
+> & {
+  /**
+   * This is a custom event that is triggered when any breadcrumb item is clicked. It takes href of the clicked item as parameter.
+   */
+  onAnyItemClick?: ({ href }: { href: string }) => void;
+};
+
+type PropertyKey = string | number | symbol;
+
+export interface SeparatorType {
+  separator?: React.ReactNode;
+  key?: React.Key;
+}
+
+interface MenuItem {
+  key?: React.Key;
+  title?: React.ReactNode;
+  label?: React.ReactNode;
+  path?: string;
+  href?: string;
+}
+
+export interface BreadcrumbItemProps extends SeparatorType {
+  prefixCls?: string;
+  href?: string;
+  onClick?: React.MouseEventHandler<HTMLAnchorElement | HTMLSpanElement>;
+  className?: string;
+  children?: React.ReactNode;
+}
+
+export interface BreadcrumbItemType {
+  key?: React.Key;
+  /**
+   * Different with `path`. Directly set the link of this item.
+   */
+  href?: string;
+  /**
+   * Different with `href`. It will concat all prev `path` to the current one.
+   */
+  path?: string;
+  title?: React.ReactNode;
+  breadcrumbName?: string;
+  className?: string;
+  onClick?: React.MouseEventHandler<HTMLAnchorElement | HTMLSpanElement>;
+}
+
+export interface BreadcrumbSeparatorType {
+  type: 'separator';
+  separator?: React.ReactNode;
+}
+
+export type ItemType = Partial<BreadcrumbItemType & BreadcrumbSeparatorType>;
+
+export type InternalRouteType = Partial<
+  BreadcrumbItemType & BreadcrumbSeparatorType
+>;
+
+export interface AntBreadcrumbProps<
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  T extends Record<PropertyKey, any> = Record<PropertyKey, any>
+> {
+  prefixCls?: string;
+  /**
+   * Routing parameters. <code>object</code><br /><br />
+   */
+  params?: T;
+  separator?: React.ReactNode;
+  style?: React.CSSProperties;
+  /**
+   * The additional css class
+   */
+  className?: string;
+  /**
+   * ClassName on the root element
+   */
+  rootClassName?: string;
+  children?: React.ReactNode;
+  /**
+   * The routing stack information of router
+   */
+  items?: ItemType[];
+  /**
+   * Custom item renderer. <code>(route, params, routes, paths) => ReactNode</code><br /><br />
+   */
+  itemRender?: (
+    route: ItemType,
+    params: T,
+    routes: ItemType[],
+    paths: string[]
+  ) => React.ReactNode;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@akinon/ui-breadcrumb",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "private": false,
   "description": "A basic button react component.",
   "type": "module",
@@ -11,14 +11,14 @@
   ],
   "dependencies": {
     "antd": "5.17.0",
-    "@akinon/ui-theme": "0.6.0"
+    "@akinon/ui-theme": "0.7.0"
   },
   "devDependencies": {
     "clean-package": "2.2.0",
     "copyfiles": "^2.4.1",
     "rimraf": "^5.0.5",
     "typescript": "^5.2.2",
-    "@akinon/typescript-config": "0.3.0"
+    "@akinon/typescript-config": "0.4.0"
   },
   "peerDependencies": {
     "react": ">=18",
@@ -38,7 +38,7 @@
     "build": "pnpm run build:esm && pnpm run build:commonjs && pnpm run copy:files",
     "build:esm": "tsc --outDir dist/esm",
     "build:commonjs": "tsc --module commonjs --outDir dist/cjs",
-    "copy:files": "copyfiles -u 1 src/**/*.css dist/esm && copyfiles -u 1 src/**/*.css dist/cjs",
+    "copy:files": "copyfiles -u 1 \"src/**/*.!(ts|tsx)\" dist/esm && copyfiles -u 1 \"src/**/*.!(ts|tsx)\" dist/cjs",
     "clean": "rimraf dist/",
     "typecheck": "tsc --noEmit"
   }