piral-breadcrumbs 1.4.0-beta.6276 → 1.4.0-beta.6280
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/README.md +25 -0
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -73,6 +73,15 @@ export function setup(piral: PiletApi) {
|
|
|
73
73
|
}
|
|
74
74
|
```
|
|
75
75
|
|
|
76
|
+
### Rendering Breadcrumbs
|
|
77
|
+
|
|
78
|
+
While there are several options to render breadcrumbs in a pilet, Piral provides a built-in extension called `piral-breadcrumbs` which handles everything for you:
|
|
79
|
+
|
|
80
|
+
```tsx
|
|
81
|
+
// Within any pilet:
|
|
82
|
+
<piral-extension name="piral-breadcrumbs"></piral-extension>
|
|
83
|
+
```
|
|
84
|
+
|
|
76
85
|
:::
|
|
77
86
|
|
|
78
87
|
::: summary: For Piral instance developers
|
|
@@ -119,6 +128,22 @@ const instance = createInstance({
|
|
|
119
128
|
});
|
|
120
129
|
```
|
|
121
130
|
|
|
131
|
+
### Rendering Breadcrumbs
|
|
132
|
+
|
|
133
|
+
From within a Piral instance, you can render the current breadcrumbs via the `Breadcrumbs` component:
|
|
134
|
+
|
|
135
|
+
```tsx
|
|
136
|
+
import { Breadcrumbs } from 'piral-breadcrumbs';
|
|
137
|
+
|
|
138
|
+
// Render it via:
|
|
139
|
+
return (
|
|
140
|
+
<>
|
|
141
|
+
<Breadcrumbs />
|
|
142
|
+
{otherContent}
|
|
143
|
+
</>
|
|
144
|
+
);
|
|
145
|
+
```
|
|
146
|
+
|
|
122
147
|
### Customizing
|
|
123
148
|
|
|
124
149
|
You can customize the breadcrumbs settings.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "piral-breadcrumbs",
|
|
3
|
-
"version": "1.4.0-beta.
|
|
3
|
+
"version": "1.4.0-beta.6280",
|
|
4
4
|
"description": "Plugin for creating a breadcrumb manager in Piral.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"piral",
|
|
@@ -63,9 +63,9 @@
|
|
|
63
63
|
"devDependencies": {
|
|
64
64
|
"@types/react": "^18.0.0",
|
|
65
65
|
"@types/react-router": "^5.1.8",
|
|
66
|
-
"piral-core": "1.4.0-beta.
|
|
66
|
+
"piral-core": "1.4.0-beta.6280",
|
|
67
67
|
"react": "^18.0.0",
|
|
68
68
|
"react-router": "^5.2.0"
|
|
69
69
|
},
|
|
70
|
-
"gitHead": "
|
|
70
|
+
"gitHead": "8402e4d3d6f5de2e76c48bcc5ce79279a3c957e4"
|
|
71
71
|
}
|