Skip to content

Commit 0c4fdf1

Browse files
authored
Merge pull request #32 from PxTools/Update-doc-breadcrumbs-config
Upadated documentation on how to control breadcrumbs on start page
2 parents 68a87a1 + a670b7f commit 0c4fdf1

File tree

1 file changed

+13
-10
lines changed

1 file changed

+13
-10
lines changed

docs/PxWeb2/documentation/customization.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,7 @@ Open `config/config.js` and set `apiUrl`:
106106
baseApplicationPath: '/',
107107
apiUrl: "https://your.api.server/PxWeb/api/v2",
108108
maxDataCells: 100000,
109+
showBreadCrumbOnStartPage: false,
109110
specialCharacters: ['.', '..', ':', '-', '...', '*'],
110111
variableFilterExclusionList: {
111112
en: [
@@ -199,6 +200,7 @@ In `config/config.js`:
199200
baseApplicationPath: '/',
200201
apiUrl: "https://your.api.server/PxWeb/api/v2",
201202
maxDataCells: 100000,
203+
showBreadCrumbOnStartPage: false,
202204
specialCharacters: ['.', '..', ':', '-', '...', '*'],
203205
variableFilterExclusionList: {
204206
en: [
@@ -254,6 +256,14 @@ By default you will come to the PxWeb start page when clicking the logo. However
254256
},
255257
```
256258

259+
### Show breadcrumb on start page
260+
You can set if breadcrumbs should be shown on start page
261+
Set `showBreadCrumbOnStartPage` in `config/config.js`. Example:
262+
263+
```js
264+
showBreadCrumbOnStartPage: true,
265+
```
266+
257267
### Adjust or fix text / translations
258268

259269
Edit the relevant `locales/<lang>/translation.json`.
@@ -352,6 +362,7 @@ Toggle:
352362
baseApplicationPath: '/',
353363
apiUrl: "https://your.api.server/PxWeb/api/v2",
354364
maxDataCells: 100000,
365+
showBreadCrumbOnStartPage: false,
355366
specialCharacters: ['.', '..', ':', '-', '...', '*'],
356367
variableFilterExclusionList: {
357368
en: [
@@ -412,8 +423,7 @@ know the side effects (they are used for logical extremes).
412423

413424
The `content.json` file defines customizable text and links that appear in
414425
**PxWeb’s user interface** This file allows you to configure localized UI
415-
content: you can add or change the **breadcrumb navigation** on the start page,
416-
add a **detailsSection** after the ingress on the start page, or update the
426+
content: you can add a **detailsSection** after the ingress on the start page, or update the
417427
**footer** content for the application.
418428

419429
```sh
@@ -430,18 +440,14 @@ root/content
430440

431441
- Each language folder contains its own `content.json`.
432442
- The active language determines which file is loaded at runtime.
433-
- This makes it possible to have different breadcrumbs, footer links, or details
443+
- This makes it possible to have different footer links, or details
434444
text depending on the selected language.
435445

436446
**Structure overview:**
437447

438448
```json
439449
{
440450
"startPage": {
441-
"breadCrumb": {
442-
"enabled": false,
443-
"items": []
444-
},
445451
"detailsSection": {
446452
"enabled": true,
447453
"detailHeader": "More about PxWeb",
@@ -493,9 +499,6 @@ root/content
493499
}
494500
```
495501

496-
- **startPage.breadCrumb**
497-
Optional breadcrumb navigation on start page. Enabled with the `enabled` flag.
498-
Each item contains a `label` and an `href`.
499502
- **startPage.detailsSection** – Optional section below the page ingress. When
500503
`enabled` is `true`, the application renders the **`DetailsSection` component**.
501504
This section can contain multiple entries, and each entry may be either a

0 commit comments

Comments
 (0)