Note to first-time contributors: Please open a discussion post in Discussions and describe your changes before submitting a pull request.
Before submitting, make sure you've checked the following:
Target branch: Please verify that the pull request targets the dev branch.
Description: Provide a concise description of the changes made in this pull request.
Changelog: Ensure a changelog entry following the format of Keep a Changelog is added at the bottom of the PR description.
Documentation: Have you updated relevant documentation Open WebUI Docs, or other documentation sources?
Dependencies: Are there any new dependencies? Have you updated the dependency versions in the documentation?
Testing: Have you written and run sufficient tests for validating the changes?
Code review: Have you performed a self-review of your code, addressing any coding standard issues and ensuring adherence to the project's coding standards?
Label: To cleary categorize this pull request, assign a relevant label to the pull request title, using one of the following:
BREAKING CHANGE: Significant changes that may affect compatibility
build: Changes that affect the build system or external dependencies
ci: Changes to our continuous integration processes or workflows
chore: Refactor, cleanup, or other non-functional code changes
docs: Documentation update or addition
feat: Introduces a new feature or enhancement to the codebase
fix: Bug fix or error correction
i18n: Internationalization or localization changes
perf: Performance improvement
refactor: Code restructuring for better maintainability, readability, or scalability
style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc.)
test: Adding missing tests or correcting existing tests
WIP: Work in progress, a temporary label for incomplete or ongoing work
Changelog Entry
Description
Adds banners that are persisted into config.json. These can be configured with:
content - the plaintext to display
type - background of banner
info - blue
warning - yellow
error - red
success - green
dismissible - can the user dismiss the banner. stored in localstorage, indexed by the content string.
Banners are set up to be only available to logged in users, as banners may contain sensitive information that shouldn't be publicly accessible.
Added
Notification Banners: Admins can configure banners to show information to users.
Screenshots or Videos
🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.
## 📋 Pull Request Information
**Original PR:** https://github.com/open-webui/open-webui/pull/2499
**Author:** [@cheahjs](https://github.com/cheahjs)
**Created:** 5/22/2024
**Status:** ❌ Closed
**Base:** `banners` ← **Head:** `feat/notification-banner`
---
### 📝 Commits (2)
- [`4c428ff`](https://github.com/open-webui/open-webui/commit/4c428ff1009ff7b6b4894adbb6b218ddce9f49e0) feat: add configurable notification banners
- [`09a62e1`](https://github.com/open-webui/open-webui/commit/09a62e128682b6ab1137f573c49a6eda47b328db) fix: run i18next
### 📊 Changes
**43 files changed** (+555 additions, -1 deletions)
<details>
<summary>View changed files</summary>
📝 `backend/apps/web/main.py` (+2 -0)
📝 `backend/apps/web/routers/configs.py` (+24 -0)
📝 `backend/config.py` (+19 -0)
📝 `src/lib/apis/configs/index.ts` (+58 -0)
➕ `src/lib/components/admin/Settings/Banners.svelte` (+128 -0)
📝 `src/lib/components/admin/SettingsModal.svelte` (+35 -0)
📝 `src/lib/components/chat/Chat.svelte` (+5 -0)
➕ `src/lib/components/common/Banner.svelte` (+33 -0)
📝 `src/lib/i18n/locales/ar-BH/translation.json` (+7 -0)
📝 `src/lib/i18n/locales/bg-BG/translation.json` (+7 -0)
📝 `src/lib/i18n/locales/bn-BD/translation.json` (+7 -0)
📝 `src/lib/i18n/locales/ca-ES/translation.json` (+7 -0)
📝 `src/lib/i18n/locales/de-DE/translation.json` (+7 -0)
📝 `src/lib/i18n/locales/dg-DG/translation.json` (+7 -0)
📝 `src/lib/i18n/locales/en-GB/translation.json` (+7 -0)
📝 `src/lib/i18n/locales/en-US/translation.json` (+7 -0)
📝 `src/lib/i18n/locales/es-ES/translation.json` (+7 -0)
📝 `src/lib/i18n/locales/fa-IR/translation.json` (+7 -0)
📝 `src/lib/i18n/locales/fi-FI/translation.json` (+7 -0)
📝 `src/lib/i18n/locales/fr-CA/translation.json` (+7 -0)
_...and 23 more files_
</details>
### 📄 Description
# Pull Request Checklist
### Note to first-time contributors: Please open a discussion post in [Discussions](https://github.com/open-webui/open-webui/discussions) and describe your changes before submitting a pull request.
**Before submitting, make sure you've checked the following:**
- [x] **Target branch:** Please verify that the pull request targets the `dev` branch.
- [x] **Description:** Provide a concise description of the changes made in this pull request.
- [x] **Changelog:** Ensure a changelog entry following the format of [Keep a Changelog](https://keepachangelog.com/) is added at the bottom of the PR description.
- [ ] **Documentation:** Have you updated relevant documentation [Open WebUI Docs](https://github.com/open-webui/docs), or other documentation sources?
- [ ] **Dependencies:** Are there any new dependencies? Have you updated the dependency versions in the documentation?
- [x] **Testing:** Have you written and run sufficient tests for validating the changes?
- [x] **Code review:** Have you performed a self-review of your code, addressing any coding standard issues and ensuring adherence to the project's coding standards?
- [x] **Label:** To cleary categorize this pull request, assign a relevant label to the pull request title, using one of the following:
- **BREAKING CHANGE**: Significant changes that may affect compatibility
- **build**: Changes that affect the build system or external dependencies
- **ci**: Changes to our continuous integration processes or workflows
- **chore**: Refactor, cleanup, or other non-functional code changes
- **docs**: Documentation update or addition
- **feat**: Introduces a new feature or enhancement to the codebase
- **fix**: Bug fix or error correction
- **i18n**: Internationalization or localization changes
- **perf**: Performance improvement
- **refactor**: Code restructuring for better maintainability, readability, or scalability
- **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc.)
- **test**: Adding missing tests or correcting existing tests
- **WIP**: Work in progress, a temporary label for incomplete or ongoing work
# Changelog Entry
### Description
Adds banners that are persisted into config.json. These can be configured with:
* `content` - the plaintext to display
* `type` - background of banner
* `info` - blue
* `warning` - yellow
* `error` - red
* `success` - green
* `dismissible` - can the user dismiss the banner. stored in localstorage, indexed by the content string.
Banners are set up to be only available to logged in users, as banners may contain sensitive information that shouldn't be publicly accessible.
### Added
- Notification Banners: Admins can configure banners to show information to users.
### Screenshots or Videos
<img width="770" alt="image" src="https://github.com/open-webui/open-webui/assets/818368/76463bf1-2769-474a-8f89-2567b7324152">
<img width="1840" alt="image" src="https://github.com/open-webui/open-webui/assets/818368/0e218d50-beca-45e7-9634-fc6d5fe33b63">
<img width="419" alt="image" src="https://github.com/open-webui/open-webui/assets/818368/6afd4117-f871-4237-9dae-02443d18783d">
<img width="414" alt="image" src="https://github.com/open-webui/open-webui/assets/818368/2ca5282d-6905-4426-88fb-01d3d0016fca">
---
<sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
📋 Pull Request Information
Original PR: https://github.com/open-webui/open-webui/pull/2499
Author: @cheahjs
Created: 5/22/2024
Status: ❌ Closed
Base:
banners← Head:feat/notification-banner📝 Commits (2)
4c428fffeat: add configurable notification banners09a62e1fix: run i18next📊 Changes
43 files changed (+555 additions, -1 deletions)
View changed files
📝
backend/apps/web/main.py(+2 -0)📝
backend/apps/web/routers/configs.py(+24 -0)📝
backend/config.py(+19 -0)📝
src/lib/apis/configs/index.ts(+58 -0)➕
src/lib/components/admin/Settings/Banners.svelte(+128 -0)📝
src/lib/components/admin/SettingsModal.svelte(+35 -0)📝
src/lib/components/chat/Chat.svelte(+5 -0)➕
src/lib/components/common/Banner.svelte(+33 -0)📝
src/lib/i18n/locales/ar-BH/translation.json(+7 -0)📝
src/lib/i18n/locales/bg-BG/translation.json(+7 -0)📝
src/lib/i18n/locales/bn-BD/translation.json(+7 -0)📝
src/lib/i18n/locales/ca-ES/translation.json(+7 -0)📝
src/lib/i18n/locales/de-DE/translation.json(+7 -0)📝
src/lib/i18n/locales/dg-DG/translation.json(+7 -0)📝
src/lib/i18n/locales/en-GB/translation.json(+7 -0)📝
src/lib/i18n/locales/en-US/translation.json(+7 -0)📝
src/lib/i18n/locales/es-ES/translation.json(+7 -0)📝
src/lib/i18n/locales/fa-IR/translation.json(+7 -0)📝
src/lib/i18n/locales/fi-FI/translation.json(+7 -0)📝
src/lib/i18n/locales/fr-CA/translation.json(+7 -0)...and 23 more files
📄 Description
Pull Request Checklist
Note to first-time contributors: Please open a discussion post in Discussions and describe your changes before submitting a pull request.
Before submitting, make sure you've checked the following:
devbranch.Changelog Entry
Description
Adds banners that are persisted into config.json. These can be configured with:
content- the plaintext to displaytype- background of bannerinfo- bluewarning- yellowerror- redsuccess- greendismissible- can the user dismiss the banner. stored in localstorage, indexed by the content string.Banners are set up to be only available to logged in users, as banners may contain sensitive information that shouldn't be publicly accessible.
Added
Screenshots or Videos
🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.