@yamada-ui/breadcrumb 0.2.4 → 0.2.5
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.
- package/dist/breadcrumb.d.mts +59 -0
- package/dist/index.d.mts +2 -0
- package/package.json +3 -3
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
import * as _yamada_ui_core from '@yamada-ui/core';
|
|
2
|
+
import { HTMLUIProps, ThemeProps, CSSUIProps } from '@yamada-ui/core';
|
|
3
|
+
|
|
4
|
+
type BreadcrumbOptions = {
|
|
5
|
+
/**
|
|
6
|
+
* The visual separator between each breadcrumb item.
|
|
7
|
+
*
|
|
8
|
+
* @default '/'
|
|
9
|
+
*/
|
|
10
|
+
separator?: string | JSX.Element;
|
|
11
|
+
/**
|
|
12
|
+
* The left and right margin applied to the separator.
|
|
13
|
+
*
|
|
14
|
+
* @default 'sm'
|
|
15
|
+
*/
|
|
16
|
+
gap?: CSSUIProps['mx'];
|
|
17
|
+
/**
|
|
18
|
+
* Props for ol element.
|
|
19
|
+
*/
|
|
20
|
+
listProps?: HTMLUIProps<'ol'>;
|
|
21
|
+
};
|
|
22
|
+
type BreadcrumbProps = Omit<HTMLUIProps<'nav'>, 'gap'> & ThemeProps<'Breadcrumb'> & BreadcrumbOptions;
|
|
23
|
+
declare const Breadcrumb: _yamada_ui_core.Component<"nav", BreadcrumbProps>;
|
|
24
|
+
type BreadcrumbItemOptions = Pick<BreadcrumbProps, 'separator' | 'gap'> & {
|
|
25
|
+
/**
|
|
26
|
+
* If `true`, change to span element.
|
|
27
|
+
*
|
|
28
|
+
* @default false
|
|
29
|
+
*/
|
|
30
|
+
isCurrentPage?: boolean;
|
|
31
|
+
/**
|
|
32
|
+
* If `true`, not show separator.
|
|
33
|
+
*
|
|
34
|
+
* @default false
|
|
35
|
+
*/
|
|
36
|
+
isLastChild?: boolean;
|
|
37
|
+
};
|
|
38
|
+
type BreadcrumbItemProps = HTMLUIProps<'li'> & BreadcrumbItemOptions;
|
|
39
|
+
declare const BreadcrumbItem: _yamada_ui_core.Component<"li", BreadcrumbItemOptions>;
|
|
40
|
+
type BreadcrumbLinkOptions = {
|
|
41
|
+
/**
|
|
42
|
+
* If `true`, change to span element.
|
|
43
|
+
*
|
|
44
|
+
* @default false
|
|
45
|
+
*/
|
|
46
|
+
isCurrentPage?: boolean;
|
|
47
|
+
};
|
|
48
|
+
type BreadcrumbLinkProps = HTMLUIProps<'a'> & BreadcrumbLinkOptions;
|
|
49
|
+
declare const BreadcrumbLink: _yamada_ui_core.Component<"a", BreadcrumbLinkProps>;
|
|
50
|
+
type BreadcrumbSeparatorOptions = {
|
|
51
|
+
/**
|
|
52
|
+
* The CSS `margin-inline-start`, and `margin-inline-end` property.
|
|
53
|
+
*/
|
|
54
|
+
gap?: CSSUIProps['mx'];
|
|
55
|
+
};
|
|
56
|
+
type BreadcrumbSeparatorProps = HTMLUIProps<'span'> & BreadcrumbSeparatorOptions;
|
|
57
|
+
declare const BreadcrumbSeparator: _yamada_ui_core.Component<"span", BreadcrumbSeparatorProps>;
|
|
58
|
+
|
|
59
|
+
export { Breadcrumb, BreadcrumbItem, BreadcrumbItemProps, BreadcrumbLink, BreadcrumbLinkProps, BreadcrumbProps, BreadcrumbSeparator, BreadcrumbSeparatorProps };
|
package/dist/index.d.mts
ADDED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@yamada-ui/breadcrumb",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.5",
|
|
4
4
|
"description": "Yamada UI breadcrumb component",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"yamada",
|
|
@@ -35,8 +35,8 @@
|
|
|
35
35
|
"url": "https://github.com/hirotomoyamada/yamada-ui/issues"
|
|
36
36
|
},
|
|
37
37
|
"dependencies": {
|
|
38
|
-
"@yamada-ui/core": "0.
|
|
39
|
-
"@yamada-ui/utils": "0.1.
|
|
38
|
+
"@yamada-ui/core": "0.5.0",
|
|
39
|
+
"@yamada-ui/utils": "0.1.3"
|
|
40
40
|
},
|
|
41
41
|
"devDependencies": {
|
|
42
42
|
"react": "^18.0.0",
|