@tidy-ui/breadcrumb
Version:
The Breadcrumb is your trusty guide for tracking website navigation, providing a clear path of your current location. Easily navigate between hierarchies. Collapse lengthy breadcrumbs for a clean view, expand for full journey. Customize separators, set ca
303 lines (302 loc) • 11 kB
JSON
[
{
"comment": "/**\n * Interface defining properties for configuring a Breadcrumb component.\n *\n * @interface IBreadcrumbProps\n * @type {IBreadcrumbProps}\n * @public\n * @since 0.47.0\n * @interface IBreadcrumbProps\n */",
"meta": {
"filename": "types.ts",
"lineno": 6,
"columnno": 0,
"path": "/home/runner/work/tidy-ui/tidy-ui/packages/breadcrumb/src",
"code": {}
},
"description": "<p>Interface defining properties for configuring a Breadcrumb component.</p>",
"kind": "interface",
"name": "IBreadcrumbProps",
"type": {
"names": [
"IBreadcrumbProps"
]
},
"access": "public",
"since": "0.47.0",
"longname": "IBreadcrumbProps",
"scope": "global"
},
{
"comment": "/**\n * An optional property that determines whether the last item in the breadcrumb is set as inactive.\n *\n * @type {boolean}\n * @default false\n * @public\n * @since 0.47.0\n * @name IBreadcrumbProps#isLastItemNotActive\n * @optional\n * @type {boolean}\n */",
"meta": {
"filename": "types.ts",
"lineno": 15,
"columnno": 0,
"path": "/home/runner/work/tidy-ui/tidy-ui/packages/breadcrumb/src",
"code": {}
},
"description": "<p>An optional property that determines whether the last item in the breadcrumb is set as inactive.</p>",
"type": {
"names": [
"boolean"
]
},
"defaultvalue": "false",
"access": "public",
"since": "0.47.0",
"name": "isLastItemNotActive",
"tags": [
{
"originalTitle": "optional",
"title": "optional",
"text": ""
}
],
"memberof": "IBreadcrumbProps",
"longname": "IBreadcrumbProps#isLastItemNotActive",
"scope": "instance",
"kind": "member",
"optional": true
},
{
"comment": "/**\n * An optional property that limits the number of items displayed within the breadcrumb.\n *\n * @type {number}\n * @default Number.MAX_SAFE_INTEGER\n * @public\n * @since 0.47.0\n * @name IBreadcrumbProps#limit\n * @optional\n * @type {number}\n */",
"meta": {
"filename": "types.ts",
"lineno": 26,
"columnno": 0,
"path": "/home/runner/work/tidy-ui/tidy-ui/packages/breadcrumb/src",
"code": {}
},
"description": "<p>An optional property that limits the number of items displayed within the breadcrumb.</p>",
"type": {
"names": [
"number"
]
},
"defaultvalue": "Number.MAX_SAFE_INTEGER",
"access": "public",
"since": "0.47.0",
"name": "limit",
"tags": [
{
"originalTitle": "optional",
"title": "optional",
"text": ""
}
],
"memberof": "IBreadcrumbProps",
"longname": "IBreadcrumbProps#limit",
"scope": "instance",
"kind": "member",
"optional": true
},
{
"comment": "/**\n * An optional callback function triggered when the collapsed breadcrumb is expanded.\n *\n * @type {Function}\n * @public\n * @since 0.47.0\n * @name IBreadcrumbProps#onExpand\n * @optional\n * @type {function}\n */",
"meta": {
"filename": "types.ts",
"lineno": 37,
"columnno": 0,
"path": "/home/runner/work/tidy-ui/tidy-ui/packages/breadcrumb/src",
"code": {}
},
"description": "<p>An optional callback function triggered when the collapsed breadcrumb is expanded.</p>",
"type": {
"names": [
"function"
]
},
"access": "public",
"since": "0.47.0",
"name": "onExpand",
"tags": [
{
"originalTitle": "optional",
"title": "optional",
"text": ""
}
],
"memberof": "IBreadcrumbProps",
"longname": "IBreadcrumbProps#onExpand",
"scope": "instance",
"kind": "member",
"optional": true
},
{
"comment": "/**\n * An optional property defining the separator used between breadcrumb items. The default separator is '/'.\n *\n * @type {string | JSX.Element}\n * @default '/'\n * @public\n * @since 0.47.0\n * @name IBreadcrumbProps#separator\n * @optional\n * @type {string | JSX.Element}\n */",
"meta": {
"filename": "types.ts",
"lineno": 47,
"columnno": 0,
"path": "/home/runner/work/tidy-ui/tidy-ui/packages/breadcrumb/src",
"code": {}
},
"description": "<p>An optional property defining the separator used between breadcrumb items. The default separator is '/'.</p>",
"type": {
"names": [
"string",
"JSX.Element"
]
},
"defaultvalue": "'/'",
"access": "public",
"since": "0.47.0",
"name": "separator",
"tags": [
{
"originalTitle": "optional",
"title": "optional",
"text": ""
}
],
"memberof": "IBreadcrumbProps",
"longname": "IBreadcrumbProps#separator",
"scope": "instance",
"kind": "member",
"optional": true
},
{
"comment": "/**\n * An optional property that sets the visual tone for the appearance of the `BreadcrumbItem`.\n *\n * @type {TTone}\n * @public\n * @since 0.47.0\n * @name IBreadcrumbProps#tone\n * @optional\n * @type {TTone}\n */",
"meta": {
"filename": "types.ts",
"lineno": 58,
"columnno": 0,
"path": "/home/runner/work/tidy-ui/tidy-ui/packages/breadcrumb/src",
"code": {}
},
"description": "<p>An optional property that sets the visual tone for the appearance of the <code>BreadcrumbItem</code>.</p>",
"type": {
"names": [
"TTone"
]
},
"access": "public",
"since": "0.47.0",
"name": "tone",
"tags": [
{
"originalTitle": "optional",
"title": "optional",
"text": ""
}
],
"memberof": "IBreadcrumbProps",
"longname": "IBreadcrumbProps#tone",
"scope": "instance",
"kind": "member",
"optional": true
},
{
"comment": "/**\n * Interface defining properties for configuring an individual BreadcrumbItem component.\n *\n * @interface IBreadcrumbItemProps\n * @type {IBreadcrumbItemProps}\n * @public\n * @since 0.47.0\n * @interface IBreadcrumbItemProps\n */",
"meta": {
"filename": "types.ts",
"lineno": 68,
"columnno": 0,
"path": "/home/runner/work/tidy-ui/tidy-ui/packages/breadcrumb/src",
"code": {}
},
"description": "<p>Interface defining properties for configuring an individual BreadcrumbItem component.</p>",
"kind": "interface",
"name": "IBreadcrumbItemProps",
"type": {
"names": [
"IBreadcrumbItemProps"
]
},
"access": "public",
"since": "0.47.0",
"longname": "IBreadcrumbItemProps",
"scope": "global"
},
{
"comment": "/**\n * An optional property that determines whether the current breadcrumb item is set as active.\n *\n * @type {boolean}\n * @default false\n * @public\n * @since 0.47.0\n * @name IBreadcrumbItemProps#isActive\n * @optional\n * @type {boolean}\n */",
"meta": {
"filename": "types.ts",
"lineno": 77,
"columnno": 0,
"path": "/home/runner/work/tidy-ui/tidy-ui/packages/breadcrumb/src",
"code": {}
},
"description": "<p>An optional property that determines whether the current breadcrumb item is set as active.</p>",
"type": {
"names": [
"boolean"
]
},
"defaultvalue": "false",
"access": "public",
"since": "0.47.0",
"name": "isActive",
"tags": [
{
"originalTitle": "optional",
"title": "optional",
"text": ""
}
],
"memberof": "IBreadcrumbItemProps",
"longname": "IBreadcrumbItemProps#isActive",
"scope": "instance",
"kind": "member",
"optional": true
},
{
"comment": "/**\n * An optional property that sets the visual tone for the appearance of the breadcrumb item. The default tone is `neutral`.\n *\n * @type {?TTone}\n * @default neutral\n * @public\n * @since 0.47.0\n * @name IBreadcrumbItemProps#tone\n * @optional\n * @type {TTone}\n */",
"meta": {
"filename": "types.ts",
"lineno": 88,
"columnno": 0,
"path": "/home/runner/work/tidy-ui/tidy-ui/packages/breadcrumb/src",
"code": {}
},
"description": "<p>An optional property that sets the visual tone for the appearance of the breadcrumb item. The default tone is <code>neutral</code>.</p>",
"type": {
"names": [
"TTone"
]
},
"nullable": true,
"defaultvalue": "neutral",
"access": "public",
"since": "0.47.0",
"name": "tone",
"tags": [
{
"originalTitle": "optional",
"title": "optional",
"text": ""
}
],
"memberof": "IBreadcrumbItemProps",
"longname": "IBreadcrumbItemProps#tone",
"scope": "instance",
"kind": "member",
"optional": true
},
{
"comment": "",
"meta": {
"range": [
6,
16
],
"filename": "types.ts",
"lineno": 1,
"columnno": 6,
"path": "/home/runner/work/tidy-ui/tidy-ui/packages/breadcrumb/src",
"code": {
"id": "astnode100000003",
"name": "_____a",
"type": "Literal",
"value": 1
}
},
"undocumented": true,
"name": "_____a",
"longname": "_____a",
"kind": "constant",
"scope": "global",
"params": []
},
{
"kind": "package",
"longname": "package:undefined",
"files": [
"/home/runner/work/tidy-ui/tidy-ui/packages/breadcrumb/src/types.ts"
]
}
]