Skip to content

add documentation on frontend statusBanner config#92

Open
omkar-ethz wants to merge 2 commits intoSciCatProject:masterfrom
omkar-ethz:patch-1
Open

add documentation on frontend statusBanner config#92
omkar-ethz wants to merge 2 commits intoSciCatProject:masterfrom
omkar-ethz:patch-1

Conversation

@omkar-ethz
Copy link
Member

No description provided.

@omkar-ethz omkar-ethz marked this pull request as ready for review March 11, 2026 12:30
omkar-ethz added a commit to SciCatProject/frontend that referenced this pull request Mar 13, 2026
## Description
Add a status banner similar to one on Landing Page with configurable
message and statusCode.

Configure using these two keys (updated in docs PR):
```json
{
  "statusBannerMessage": "Some SciCat update to be displayed on the dismissible banner", // Optional
  "statusBannerCode": "INFO" // Optional, "WARN" or "INFO" - affects the styling of status banner, defaults to INFO
}
```
## Motivation

#2158

## Fixes:
Please provide a list of the fixes implemented in this PR

* None

## Changes:
Please provide a list of the changes implemented by this PR

* changes made

## Screen recording
it's fairly responsive:
[Screencast from 03-11-2026 11:07:11
AM.webm](https://github.com/user-attachments/assets/009840eb-a9f6-4fa5-a2db-c59a0c54fd49)


## Tests included
- [x] Included for each change/fix?
- [x] Passing? (Merge will not be approved unless this is checked) 

## Documentation
- [ ] swagger documentation updated \[required\]
- [x] official documentation updated \[nice-to-have\]

### official documentation info
If you have updated the official documentation, please provide PR # and
URL of the pages where the updates are included

SciCatProject/documentation#92

## Backend version
- [ ] Does it require a specific version of the backend
- which version of the backend is required:

## Summary by Sourcery

Add a configurable status banner to the application header that displays
environment messages based on app configuration.

New Features:
- Introduce a status banner component that shows a dismissible message
at the top of the application.
- Extend application configuration to support a status banner message
and code for informational or warning states.

---------

Co-authored-by: junjiequan <a331998513@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant