Skip to content
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

Add docs for widget container height option #27922

Merged
merged 3 commits into from
Aug 27, 2024
Merged

Add docs for widget container height option #27922

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f05b269
Add docs for widget container height option
dbkr Aug 15, 2024
0935e48
Prettier
dbkr Aug 15, 2024
1e9112a
Fix sample config value
dbkr Aug 16, 2024
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
1 change: 1 addition & 0 deletions config.sample.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
"https://scalar-staging.vector.im/api",
"https://scalar-staging.riot.im/scalar/api"
],
"default_widget_height": 280,
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This key seems to have the wrong name, since the documentation and implementation both use default_widget_container_height instead.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh, good spot, although the correct way to report these is by filing bugs. In general, people won't be looking at old, closed PRs unless they happen to see it in notifications.

"default_country_code": "GB",
"show_labs_settings": false,
"features": {},
Expand Down
6 changes: 6 additions & 0 deletions docs/config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -452,6 +452,12 @@ If you would like to use Scalar, the integration manager maintained by Element,
}
```

For widgets in general (from an integration manager or not) there is also:

- `default_widget_container_height`

This controls the height that the top widget panel initially appears as and is the height in pixels, default 280.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doesn't match the value in the config sample, is the default 280 or 280px?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oops, good spot, thanks


## Administrative options

If you would like to include a custom message when someone is reporting an event, set the following Markdown-capable field:
Expand Down
Loading