Skip to content

docs: Fix incorrect info panel docs #2648

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
Feb 1, 2025
Merged

docs: Fix incorrect info panel docs #2648

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
22 changes: 19 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -960,13 +960,29 @@ Examples:
```json
{
"type": "keyValue",
"key": "Last purchase ID",
"key": "Purchase",
"value": "123",
"url": "browser/_User",
"url": "browser/Purchase",
"isRelativeUrl": true
}
```

To navigate to a specific object using a relative URL, the query parameters must be URL encoded:

```js
const objectId = 'abc123';
const className = 'Purchase';
const query = [{ field: 'objectId', constraint: 'eq', compareTo: objectId }];
const url = `browser/Purchase?filters=${JSON.stringify(query)}`;
const item = {
type: 'keyValue',
key: 'Purchase',
value: objectId,
url,
isRelativeUrl: true
}
```

#### Table Item

A table with columns and rows to display data in a structured format.
Expand Down Expand Up @@ -1109,7 +1125,7 @@ Example:
```json
{
"type": "panel",
"text": "Purchase History",
"title": "Purchase History",
"cloudCodeFunction": "getUserPurchaseHistory"
}
```
Expand Down
Loading