Skip to content

Upadated documentation on how to control breadcrumbs on start page #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 3, 2025
Merged

Upadated documentation on how to control breadcrumbs on start page #32

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 13 additions & 10 deletions docs/PxWeb2/documentation/customization.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,7 @@ Open `config/config.js` and set `apiUrl`:
baseApplicationPath: '/',
apiUrl: "https://your.api.server/PxWeb/api/v2",
maxDataCells: 100000,
showBreadCrumbOnStartPage: false,
specialCharacters: ['.', '..', ':', '-', '...', '*'],
variableFilterExclusionList: {
en: [
Expand Down Expand Up @@ -199,6 +200,7 @@ In `config/config.js`:
baseApplicationPath: '/',
apiUrl: "https://your.api.server/PxWeb/api/v2",
maxDataCells: 100000,
showBreadCrumbOnStartPage: false,
specialCharacters: ['.', '..', ':', '-', '...', '*'],
variableFilterExclusionList: {
en: [
Expand Down Expand Up @@ -254,6 +256,14 @@ By default you will come to the PxWeb start page when clicking the logo. However
},
```

### Show breadcrumb on start page
You can set if breadcrumbs should be shown on start page
Set `showBreadCrumbOnStartPage` in `config/config.js`. Example:

```js
showBreadCrumbOnStartPage: true,
```

### Adjust or fix text / translations

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

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

```sh
Expand All @@ -430,18 +440,14 @@ root/content

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

**Structure overview:**

```json
{
"startPage": {
"breadCrumb": {
"enabled": false,
"items": []
},
"detailsSection": {
"enabled": true,
"detailHeader": "More about PxWeb",
Expand Down Expand Up @@ -493,9 +499,6 @@ root/content
}
```

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