@akinon/ui-breadcrumb 0.5.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (9) hide show
  1. package/dist/cjs/index.d.ts +10 -1
  2. package/dist/cjs/index.d.ts.map +1 -1
  3. package/dist/cjs/index.js +18 -8
  4. package/dist/cjs/types.d.ts +136 -24
  5. package/dist/esm/index.d.ts +10 -1
  6. package/dist/esm/index.d.ts.map +1 -1
  7. package/dist/esm/index.js +18 -8
  8. package/dist/esm/types.d.ts +136 -24
  9. package/package.json +5 -5
package/dist/cjs/index.d.ts CHANGED
@@ -1,5 +1,14 @@
1
1
  import * as React from 'react';
2
2
  import type { BreadcrumbProps } from './types';
3
- export type { BreadcrumbProps } from './types';
3
+ /**
4
+ * Breadcrumb component is used to display a breadcrumb navigation trail, which helps users understand the hierarchy and navigate through the structure of the application.
5
+ * It provides support for custom breadcrumb items, separators, routing parameters, and event handlers for item clicks.
6
+ *
7
+ * - The `onAnyItemClick` event allows custom handling when any breadcrumb item is clicked.
8
+ * - Custom renderers and item definitions can be provided through the `itemRender` and `items` props.
9
+ * - Supports hierarchical navigation with `path` and `href` options for breadcrumb items.
10
+ *
11
+ */
4
12
  export declare const Breadcrumb: (props: BreadcrumbProps) => React.JSX.Element;
13
+ export type * from './types';
5
14
  //# sourceMappingURL=index.d.ts.map
package/dist/cjs/index.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.tsx"],"names":[],"mappings":"AAGA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,KAAK,EAAE,eAAe,EAAY,MAAM,SAAS,CAAC;AAEzD,YAAY,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAE/C,eAAO,MAAM,UAAU,UAAW,eAAe,sBAgGhD,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.tsx"],"names":[],"mappings":"AAGA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,KAAK,EAAsB,eAAe,EAAE,MAAM,SAAS,CAAC;AAEnE;;;;;;;;GAQG;AAEH,eAAO,MAAM,UAAU,UAAW,eAAe,sBAiGhD,CAAC;AAEF,mBAAmB,SAAS,CAAC"}
package/dist/cjs/index.js CHANGED
@@ -5,6 +5,15 @@ const ui_theme_1 = require("@akinon/ui-theme");
5
5
  const cssinjs_1 = require("@ant-design/cssinjs");
6
6
  const antd_1 = require("antd");
7
7
  const React = require("react");
8
+ /**
9
+ * Breadcrumb component is used to display a breadcrumb navigation trail, which helps users understand the hierarchy and navigate through the structure of the application.
10
+ * It provides support for custom breadcrumb items, separators, routing parameters, and event handlers for item clicks.
11
+ *
12
+ * - The `onAnyItemClick` event allows custom handling when any breadcrumb item is clicked.
13
+ * - Custom renderers and item definitions can be provided through the `itemRender` and `items` props.
14
+ * - Supports hierarchical navigation with `path` and `href` options for breadcrumb items.
15
+ *
16
+ */
8
17
  const Breadcrumb = (props) => {
9
18
  const { onAnyItemClick, items } = props;
10
19
  const { getPrefixCls, theme } = React.useContext(antd_1.ConfigProvider.ConfigContext);
@@ -18,6 +27,7 @@ const Breadcrumb = (props) => {
18
27
  }, () => {
19
28
  const prefixCls = `:where(.${hashId}).${getPrefixCls()}-breadcrumb`;
20
29
  const prefixClsWithoutHash = `.${getPrefixCls()}-breadcrumb`;
30
+ const customTokens = theme.CustomTokens || {};
21
31
  return {
22
32
  [prefixCls]: {
23
33
  paddingBottom: breadcrumbToken.paddingBottom,
@@ -35,23 +45,23 @@ const Breadcrumb = (props) => {
35
45
  paddingRight: breadcrumbToken.paddingRight,
36
46
  [`li ${prefixClsWithoutHash}-link`]: {
37
47
  ['&:hover']: {
38
- cursor: 'pointer'
48
+ cursor: customTokens.others.cursorPointer
39
49
  }
40
50
  },
41
51
  [`li:last-child ${prefixClsWithoutHash}-link`]: {
42
52
  ['&:hover']: {
43
- cursor: 'unset'
53
+ cursor: customTokens.others.valueUnset
44
54
  }
45
55
  },
46
56
  ['a']: {
47
57
  color: breadcrumbToken.itemColor,
48
- paddingLeft: 0,
49
- paddingRight: 0,
50
- marginInline: breadcrumbToken.marginInline,
51
- height: breadcrumbToken.height,
58
+ paddingLeft: customTokens.sizing.valueZero,
59
+ paddingRight: customTokens.sizing.valueZero,
60
+ marginInline: customTokens.sizing.valueZero,
61
+ height: customTokens.sizing.valueAuto,
52
62
  ['&:hover']: {
53
- color: 'unset',
54
- backgroundColor: 'unset'
63
+ color: customTokens.others.valueUnset,
64
+ backgroundColor: customTokens.others.valueUnset
55
65
  }
56
66
  },
57
67
  [`${prefixClsWithoutHash}-separator`]: {
package/dist/cjs/types.d.ts CHANGED
@@ -1,94 +1,206 @@
1
- export type BreadcrumbProps = Omit<
2
- AntBreadcrumbProps,
3
- 'prefixCls' | 'style' | 'styles' | 'separator'
4
- > & {
5
- /**
6
- * This is a custom event that is triggered when any breadcrumb item is clicked. It takes href of the clicked item as parameter.
7
- */
8
- onAnyItemClick?: ({ href }: { href: string }) => void;
9
- };
10
-
11
- type PropertyKey = string | number | symbol;
1
+ import { DO_NOT_USE_OR_YOU_WILL_BE_FIRED_INTERNAL_STYLE } from '@akinon/ui-theme';
12
2
 
3
+ /**
4
+ * Defines properties for separators used in breadcrumb navigation.
5
+ */
13
6
  export interface SeparatorType {
7
+ /**
8
+ * Custom separator element for breadcrumb items.
9
+ */
14
10
  separator?: React.ReactNode;
11
+
12
+ /**
13
+ * Unique key for the separator.
14
+ */
15
15
  key?: React.Key;
16
16
  }
17
17
 
18
+ /**
19
+ * Represents individual menu items in a breadcrumb.
20
+ */
18
21
  interface MenuItem {
22
+ /**
23
+ * Unique key for the menu item.
24
+ */
19
25
  key?: React.Key;
26
+
27
+ /**
28
+ * Title of the menu item.
29
+ */
20
30
  title?: React.ReactNode;
31
+
32
+ /**
33
+ * Label for the menu item.
34
+ */
21
35
  label?: React.ReactNode;
36
+
37
+ /**
38
+ * Path associated with the menu item.
39
+ */
22
40
  path?: string;
41
+
42
+ /**
43
+ * URL to navigate when the menu item is clicked.
44
+ */
23
45
  href?: string;
24
46
  }
25
47
 
48
+ /**
49
+ * Properties for individual breadcrumb items.
50
+ */
26
51
  export interface BreadcrumbItemProps extends SeparatorType {
27
- prefixCls?: string;
52
+ /**
53
+ * URL for the breadcrumb item.
54
+ */
28
55
  href?: string;
56
+
57
+ /**
58
+ * Callback triggered when the breadcrumb item is clicked.
59
+ */
29
60
  onClick?: React.MouseEventHandler<HTMLAnchorElement | HTMLSpanElement>;
61
+
62
+ /**
63
+ * Additional CSS class for the breadcrumb item.
64
+ */
30
65
  className?: string;
66
+
67
+ /**
68
+ * Children elements inside the breadcrumb item.
69
+ */
31
70
  children?: React.ReactNode;
32
71
  }
33
72
 
73
+ /**
74
+ * Defines the structure of an individual breadcrumb item.
75
+ */
34
76
  export interface BreadcrumbItemType {
77
+ /**
78
+ * Unique key for the breadcrumb item.
79
+ */
35
80
  key?: React.Key;
81
+
36
82
  /**
37
83
  * Different with `path`. Directly set the link of this item.
38
84
  */
39
85
  href?: string;
86
+
40
87
  /**
41
88
  * Different with `href`. It will concat all prev `path` to the current one.
42
89
  */
43
90
  path?: string;
91
+
92
+ /**
93
+ * Title or label of the breadcrumb item.
94
+ */
44
95
  title?: React.ReactNode;
96
+
97
+ /**
98
+ * Name displayed in the breadcrumb.
99
+ */
45
100
  breadcrumbName?: string;
101
+
102
+ /**
103
+ * Additional CSS class for the breadcrumb item.
104
+ */
46
105
  className?: string;
106
+
107
+ /**
108
+ * Callback triggered when the breadcrumb item is clicked.
109
+ */
47
110
  onClick?: React.MouseEventHandler<HTMLAnchorElement | HTMLSpanElement>;
48
111
  }
49
112
 
113
+ /**
114
+ * Defines the structure of a separator in the breadcrumb.
115
+ */
50
116
  export interface BreadcrumbSeparatorType {
117
+ /**
118
+ * Specifies that the item is a separator.
119
+ */
51
120
  type: 'separator';
121
+
122
+ /**
123
+ * Custom separator element.
124
+ */
52
125
  separator?: React.ReactNode;
53
126
  }
54
127
 
55
- export type ItemType = Partial<BreadcrumbItemType & BreadcrumbSeparatorType>;
128
+ /**
129
+ * Represents an individual item or separator in the breadcrumb.
130
+ */
131
+ export type BreadcrumbItemType = Partial<
132
+ BreadcrumbItemType & BreadcrumbSeparatorType
133
+ >;
56
134
 
135
+ /**
136
+ * Defines the internal structure of routing information in the breadcrumb.
137
+ */
57
138
  export type InternalRouteType = Partial<
58
139
  BreadcrumbItemType & BreadcrumbSeparatorType
59
140
  >;
60
141
 
61
- export interface AntBreadcrumbProps<
62
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
63
- T extends Record<PropertyKey, any> = Record<PropertyKey, any>
64
- > {
65
- prefixCls?: string;
142
+ /**
143
+ * Properties for the main `Breadcrumb` component.
144
+ */
145
+ export interface BreadcrumbProps {
66
146
  /**
67
147
  * Routing parameters. <code>object</code><br /><br />
68
148
  */
69
- params?: T;
149
+ params?: {
150
+ [key: string]: unknown;
151
+ };
152
+
153
+ /**
154
+ * Custom separator element for the breadcrumb.
155
+ */
70
156
  separator?: React.ReactNode;
71
- style?: React.CSSProperties;
157
+
158
+ /**
159
+ * Inline styles for the breadcrumb.
160
+ * @ignore
161
+ */
162
+ style?: DO_NOT_USE_OR_YOU_WILL_BE_FIRED_INTERNAL_STYLE;
163
+
72
164
  /**
73
165
  * The additional css class
74
166
  */
75
167
  className?: string;
168
+
76
169
  /**
77
170
  * ClassName on the root element
78
171
  */
79
172
  rootClassName?: string;
173
+
174
+ /**
175
+ * Children elements inside the breadcrumb.
176
+ */
80
177
  children?: React.ReactNode;
178
+
81
179
  /**
82
180
  * The routing stack information of router
83
181
  */
84
- items?: ItemType[];
182
+ items?: BreadcrumbItemType[];
183
+
85
184
  /**
86
185
  * Custom item renderer. <code>(route, params, routes, paths) => ReactNode</code><br /><br />
186
+ *
187
+ * @param route - The current breadcrumb item.
188
+ * @param params - Routing parameters.
189
+ * @param routes - All breadcrumb items.
190
+ * @param paths - The accumulated paths.
191
+ * @returns - Custom rendered breadcrumb item.
87
192
  */
88
193
  itemRender?: (
89
- route: ItemType,
90
- params: T,
91
- routes: ItemType[],
194
+ route: BreadcrumbItemType,
195
+ params: {
196
+ [key: string]: unknown;
197
+ },
198
+ routes: BreadcrumbItemType[],
92
199
  paths: string[]
93
200
  ) => React.ReactNode;
201
+
202
+ /**
203
+ * This is a custom event that is triggered when any breadcrumb item is clicked. It takes href of the clicked item as parameter.
204
+ */
205
+ onAnyItemClick?: ({ href }: { href: string }) => void;
94
206
  }
package/dist/esm/index.d.ts CHANGED
@@ -1,5 +1,14 @@
1
1
  import * as React from 'react';
2
2
  import type { BreadcrumbProps } from './types';
3
- export type { BreadcrumbProps } from './types';
3
+ /**
4
+ * Breadcrumb component is used to display a breadcrumb navigation trail, which helps users understand the hierarchy and navigate through the structure of the application.
5
+ * It provides support for custom breadcrumb items, separators, routing parameters, and event handlers for item clicks.
6
+ *
7
+ * - The `onAnyItemClick` event allows custom handling when any breadcrumb item is clicked.
8
+ * - Custom renderers and item definitions can be provided through the `itemRender` and `items` props.
9
+ * - Supports hierarchical navigation with `path` and `href` options for breadcrumb items.
10
+ *
11
+ */
4
12
  export declare const Breadcrumb: (props: BreadcrumbProps) => React.JSX.Element;
13
+ export type * from './types';
5
14
  //# sourceMappingURL=index.d.ts.map
package/dist/esm/index.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.tsx"],"names":[],"mappings":"AAGA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,KAAK,EAAE,eAAe,EAAY,MAAM,SAAS,CAAC;AAEzD,YAAY,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAE/C,eAAO,MAAM,UAAU,UAAW,eAAe,sBAgGhD,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.tsx"],"names":[],"mappings":"AAGA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,KAAK,EAAsB,eAAe,EAAE,MAAM,SAAS,CAAC;AAEnE;;;;;;;;GAQG;AAEH,eAAO,MAAM,UAAU,UAAW,eAAe,sBAiGhD,CAAC;AAEF,mBAAmB,SAAS,CAAC"}
package/dist/esm/index.js CHANGED
@@ -2,6 +2,15 @@ import { useToken } from '@akinon/ui-theme';
2
2
  import { useStyleRegister } from '@ant-design/cssinjs';
3
3
  import { Breadcrumb as AntBreadcrumb, ConfigProvider } from 'antd';
4
4
  import * as React from 'react';
5
+ /**
6
+ * Breadcrumb component is used to display a breadcrumb navigation trail, which helps users understand the hierarchy and navigate through the structure of the application.
7
+ * It provides support for custom breadcrumb items, separators, routing parameters, and event handlers for item clicks.
8
+ *
9
+ * - The `onAnyItemClick` event allows custom handling when any breadcrumb item is clicked.
10
+ * - Custom renderers and item definitions can be provided through the `itemRender` and `items` props.
11
+ * - Supports hierarchical navigation with `path` and `href` options for breadcrumb items.
12
+ *
13
+ */
5
14
  export const Breadcrumb = (props) => {
6
15
  const { onAnyItemClick, items } = props;
7
16
  const { getPrefixCls, theme } = React.useContext(ConfigProvider.ConfigContext);
@@ -15,6 +24,7 @@ export const Breadcrumb = (props) => {
15
24
  }, () => {
16
25
  const prefixCls = `:where(.${hashId}).${getPrefixCls()}-breadcrumb`;
17
26
  const prefixClsWithoutHash = `.${getPrefixCls()}-breadcrumb`;
27
+ const customTokens = theme.CustomTokens || {};
18
28
  return {
19
29
  [prefixCls]: {
20
30
  paddingBottom: breadcrumbToken.paddingBottom,
@@ -32,23 +42,23 @@ export const Breadcrumb = (props) => {
32
42
  paddingRight: breadcrumbToken.paddingRight,
33
43
  [`li ${prefixClsWithoutHash}-link`]: {
34
44
  ['&:hover']: {
35
- cursor: 'pointer'
45
+ cursor: customTokens.others.cursorPointer
36
46
  }
37
47
  },
38
48
  [`li:last-child ${prefixClsWithoutHash}-link`]: {
39
49
  ['&:hover']: {
40
- cursor: 'unset'
50
+ cursor: customTokens.others.valueUnset
41
51
  }
42
52
  },
43
53
  ['a']: {
44
54
  color: breadcrumbToken.itemColor,
45
- paddingLeft: 0,
46
- paddingRight: 0,
47
- marginInline: breadcrumbToken.marginInline,
48
- height: breadcrumbToken.height,
55
+ paddingLeft: customTokens.sizing.valueZero,
56
+ paddingRight: customTokens.sizing.valueZero,
57
+ marginInline: customTokens.sizing.valueZero,
58
+ height: customTokens.sizing.valueAuto,
49
59
  ['&:hover']: {
50
- color: 'unset',
51
- backgroundColor: 'unset'
60
+ color: customTokens.others.valueUnset,
61
+ backgroundColor: customTokens.others.valueUnset
52
62
  }
53
63
  },
54
64
  [`${prefixClsWithoutHash}-separator`]: {
package/dist/esm/types.d.ts CHANGED
@@ -1,94 +1,206 @@
1
- export type BreadcrumbProps = Omit<
2
- AntBreadcrumbProps,
3
- 'prefixCls' | 'style' | 'styles' | 'separator'
4
- > & {
5
- /**
6
- * This is a custom event that is triggered when any breadcrumb item is clicked. It takes href of the clicked item as parameter.
7
- */
8
- onAnyItemClick?: ({ href }: { href: string }) => void;
9
- };
10
-
11
- type PropertyKey = string | number | symbol;
1
+ import { DO_NOT_USE_OR_YOU_WILL_BE_FIRED_INTERNAL_STYLE } from '@akinon/ui-theme';
12
2
 
3
+ /**
4
+ * Defines properties for separators used in breadcrumb navigation.
5
+ */
13
6
  export interface SeparatorType {
7
+ /**
8
+ * Custom separator element for breadcrumb items.
9
+ */
14
10
  separator?: React.ReactNode;
11
+
12
+ /**
13
+ * Unique key for the separator.
14
+ */
15
15
  key?: React.Key;
16
16
  }
17
17
 
18
+ /**
19
+ * Represents individual menu items in a breadcrumb.
20
+ */
18
21
  interface MenuItem {
22
+ /**
23
+ * Unique key for the menu item.
24
+ */
19
25
  key?: React.Key;
26
+
27
+ /**
28
+ * Title of the menu item.
29
+ */
20
30
  title?: React.ReactNode;
31
+
32
+ /**
33
+ * Label for the menu item.
34
+ */
21
35
  label?: React.ReactNode;
36
+
37
+ /**
38
+ * Path associated with the menu item.
39
+ */
22
40
  path?: string;
41
+
42
+ /**
43
+ * URL to navigate when the menu item is clicked.
44
+ */
23
45
  href?: string;
24
46
  }
25
47
 
48
+ /**
49
+ * Properties for individual breadcrumb items.
50
+ */
26
51
  export interface BreadcrumbItemProps extends SeparatorType {
27
- prefixCls?: string;
52
+ /**
53
+ * URL for the breadcrumb item.
54
+ */
28
55
  href?: string;
56
+
57
+ /**
58
+ * Callback triggered when the breadcrumb item is clicked.
59
+ */
29
60
  onClick?: React.MouseEventHandler<HTMLAnchorElement | HTMLSpanElement>;
61
+
62
+ /**
63
+ * Additional CSS class for the breadcrumb item.
64
+ */
30
65
  className?: string;
66
+
67
+ /**
68
+ * Children elements inside the breadcrumb item.
69
+ */
31
70
  children?: React.ReactNode;
32
71
  }
33
72
 
73
+ /**
74
+ * Defines the structure of an individual breadcrumb item.
75
+ */
34
76
  export interface BreadcrumbItemType {
77
+ /**
78
+ * Unique key for the breadcrumb item.
79
+ */
35
80
  key?: React.Key;
81
+
36
82
  /**
37
83
  * Different with `path`. Directly set the link of this item.
38
84
  */
39
85
  href?: string;
86
+
40
87
  /**
41
88
  * Different with `href`. It will concat all prev `path` to the current one.
42
89
  */
43
90
  path?: string;
91
+
92
+ /**
93
+ * Title or label of the breadcrumb item.
94
+ */
44
95
  title?: React.ReactNode;
96
+
97
+ /**
98
+ * Name displayed in the breadcrumb.
99
+ */
45
100
  breadcrumbName?: string;
101
+
102
+ /**
103
+ * Additional CSS class for the breadcrumb item.
104
+ */
46
105
  className?: string;
106
+
107
+ /**
108
+ * Callback triggered when the breadcrumb item is clicked.
109
+ */
47
110
  onClick?: React.MouseEventHandler<HTMLAnchorElement | HTMLSpanElement>;
48
111
  }
49
112
 
113
+ /**
114
+ * Defines the structure of a separator in the breadcrumb.
115
+ */
50
116
  export interface BreadcrumbSeparatorType {
117
+ /**
118
+ * Specifies that the item is a separator.
119
+ */
51
120
  type: 'separator';
121
+
122
+ /**
123
+ * Custom separator element.
124
+ */
52
125
  separator?: React.ReactNode;
53
126
  }
54
127
 
55
- export type ItemType = Partial<BreadcrumbItemType & BreadcrumbSeparatorType>;
128
+ /**
129
+ * Represents an individual item or separator in the breadcrumb.
130
+ */
131
+ export type BreadcrumbItemType = Partial<
132
+ BreadcrumbItemType & BreadcrumbSeparatorType
133
+ >;
56
134
 
135
+ /**
136
+ * Defines the internal structure of routing information in the breadcrumb.
137
+ */
57
138
  export type InternalRouteType = Partial<
58
139
  BreadcrumbItemType & BreadcrumbSeparatorType
59
140
  >;
60
141
 
61
- export interface AntBreadcrumbProps<
62
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
63
- T extends Record<PropertyKey, any> = Record<PropertyKey, any>
64
- > {
65
- prefixCls?: string;
142
+ /**
143
+ * Properties for the main `Breadcrumb` component.
144
+ */
145
+ export interface BreadcrumbProps {
66
146
  /**
67
147
  * Routing parameters. <code>object</code><br /><br />
68
148
  */
69
- params?: T;
149
+ params?: {
150
+ [key: string]: unknown;
151
+ };
152
+
153
+ /**
154
+ * Custom separator element for the breadcrumb.
155
+ */
70
156
  separator?: React.ReactNode;
71
- style?: React.CSSProperties;
157
+
158
+ /**
159
+ * Inline styles for the breadcrumb.
160
+ * @ignore
161
+ */
162
+ style?: DO_NOT_USE_OR_YOU_WILL_BE_FIRED_INTERNAL_STYLE;
163
+
72
164
  /**
73
165
  * The additional css class
74
166
  */
75
167
  className?: string;
168
+
76
169
  /**
77
170
  * ClassName on the root element
78
171
  */
79
172
  rootClassName?: string;
173
+
174
+ /**
175
+ * Children elements inside the breadcrumb.
176
+ */
80
177
  children?: React.ReactNode;
178
+
81
179
  /**
82
180
  * The routing stack information of router
83
181
  */
84
- items?: ItemType[];
182
+ items?: BreadcrumbItemType[];
183
+
85
184
  /**
86
185
  * Custom item renderer. <code>(route, params, routes, paths) => ReactNode</code><br /><br />
186
+ *
187
+ * @param route - The current breadcrumb item.
188
+ * @param params - Routing parameters.
189
+ * @param routes - All breadcrumb items.
190
+ * @param paths - The accumulated paths.
191
+ * @returns - Custom rendered breadcrumb item.
87
192
  */
88
193
  itemRender?: (
89
- route: ItemType,
90
- params: T,
91
- routes: ItemType[],
194
+ route: BreadcrumbItemType,
195
+ params: {
196
+ [key: string]: unknown;
197
+ },
198
+ routes: BreadcrumbItemType[],
92
199
  paths: string[]
93
200
  ) => React.ReactNode;
201
+
202
+ /**
203
+ * This is a custom event that is triggered when any breadcrumb item is clicked. It takes href of the clicked item as parameter.
204
+ */
205
+ onAnyItemClick?: ({ href }: { href: string }) => void;
94
206
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@akinon/ui-breadcrumb",
3
- "version": "0.5.0",
3
+ "version": "1.0.1",
4
4
  "private": false,
5
5
  "description": "A basic button react component.",
6
6
  "type": "module",
@@ -10,15 +10,15 @@
10
10
  "dist"
11
11
  ],
12
12
  "dependencies": {
13
- "antd": "5.17.0",
14
- "@akinon/ui-theme": "0.7.0"
13
+ "antd": "5.22.6",
14
+ "@akinon/ui-theme": "1.0.1"
15
15
  },
16
16
  "devDependencies": {
17
17
  "clean-package": "2.2.0",
18
18
  "copyfiles": "^2.4.1",
19
19
  "rimraf": "^5.0.5",
20
- "typescript": "^5.2.2",
21
- "@akinon/typescript-config": "0.4.0"
20
+ "typescript": "*",
21
+ "@akinon/typescript-config": "1.0.1"
22
22
  },
23
23
  "peerDependencies": {
24
24
  "react": ">=18",