-
-
Notifications
You must be signed in to change notification settings - Fork 970
g:flashMessages tag #15560
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.
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
Open
codeconsole
wants to merge
2
commits into
apache:7.1.x
Choose a base branch
from
codeconsole:7.1.x-flashMessages
base: 7.1.x
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+414
−13
Open
g:flashMessages tag #15560
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,120 @@ | ||
| //// | ||
| Licensed to the Apache Software Foundation (ASF) under one | ||
| or more contributor license agreements. See the NOTICE file | ||
| distributed with this work for additional information | ||
| regarding copyright ownership. The ASF licenses this file | ||
| to you under the Apache License, Version 2.0 (the | ||
| "License"); you may not use this file except in compliance | ||
| with the License. You may obtain a copy of the License at | ||
|
|
||
| https://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, | ||
| software distributed under the License is distributed on an | ||
| "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| KIND, either express or implied. See the License for the | ||
| specific language governing permissions and limitations | ||
| under the License. | ||
| //// | ||
|
|
||
|
|
||
| == flashMessages | ||
|
|
||
|
|
||
|
|
||
| === Purpose | ||
|
|
||
|
|
||
| Renders `flash.message`, `flash.error`, and `flash.warning` as dismissible Bootstrap alert divs with appropriate styling. Automatically prevents duplicate rendering when used in both pages and layouts. | ||
|
|
||
|
|
||
| === Examples | ||
|
|
||
|
|
||
| Basic usage in a view: | ||
|
|
||
| [source,xml] | ||
| ---- | ||
| <g:flashMessages /> | ||
| ---- | ||
|
|
||
| In a layout (safe to use alongside page-level usage -- the tag skips rendering if already called): | ||
|
|
||
| [source,xml] | ||
| ---- | ||
| <g:flashMessages /> | ||
| <g:layoutBody/> | ||
| ---- | ||
|
|
||
| Non-dismissible alerts: | ||
|
|
||
| [source,xml] | ||
| ---- | ||
| <g:flashMessages dismissible="false" /> | ||
| ---- | ||
|
|
||
| Custom ARIA role: | ||
|
|
||
| [source,xml] | ||
| ---- | ||
| <g:flashMessages role="status" /> | ||
| ---- | ||
|
|
||
| Custom styling for success messages: | ||
|
|
||
| [source,xml] | ||
| ---- | ||
| <g:flashMessages messageClass="alert alert-info" messageIcon="bi bi-info-circle me-2" /> | ||
| ---- | ||
|
|
||
| Setting flash messages in a controller: | ||
|
|
||
| [source,groovy] | ||
| ---- | ||
| // Success message (renders as green alert) | ||
| flash.message = "Book '${book.title}' saved successfully." | ||
|
|
||
| // Error message (renders as red alert) | ||
| flash.error = "Unable to delete the record." | ||
|
|
||
| // Warning message (renders as yellow alert) | ||
| flash.warning = "You have unsaved changes." | ||
| ---- | ||
|
|
||
|
|
||
| === Description | ||
|
|
||
|
|
||
| The `flashMessages` tag renders any combination of `flash.message`, `flash.error`, and `flash.warning` as Bootstrap 5 alert divs. Each flash key maps to a different alert style: | ||
|
|
||
| [cols="1,2,2"] | ||
| |=== | ||
| | Flash Key | Default Alert Class | Default Icon | ||
|
|
||
| | `flash.message` | ||
| | `alert alert-success alert-dismissible fade show` | ||
| | `bi bi-check-circle me-2` | ||
|
|
||
| | `flash.error` | ||
| | `alert alert-danger alert-dismissible fade show` | ||
| | `bi bi-exclamation-triangle me-2` | ||
|
|
||
| | `flash.warning` | ||
| | `alert alert-warning alert-dismissible fade show` | ||
| | `bi bi-exclamation-circle me-2` | ||
| |=== | ||
|
|
||
| The tag automatically sets a `_flashRendered` request attribute after rendering. On subsequent calls within the same request, the tag detects this attribute and outputs nothing. This allows both pages and layouts to include `<g:flashMessages />` without producing duplicate alerts -- whichever renders first wins. | ||
|
|
||
| All flash message content is HTML-encoded to prevent XSS. | ||
|
|
||
| Attributes | ||
|
|
||
| * `messageClass` (optional) - CSS class for `flash.message` alerts. Default: `alert alert-success alert-dismissible fade show` | ||
| * `messageIcon` (optional) - Icon class for `flash.message` alerts. Default: `bi bi-check-circle me-2` | ||
| * `errorClass` (optional) - CSS class for `flash.error` alerts. Default: `alert alert-danger alert-dismissible fade show` | ||
| * `errorIcon` (optional) - Icon class for `flash.error` alerts. Default: `bi bi-exclamation-triangle me-2` | ||
| * `warningClass` (optional) - CSS class for `flash.warning` alerts. Default: `alert alert-warning alert-dismissible fade show` | ||
| * `warningIcon` (optional) - Icon class for `flash.warning` alerts. Default: `bi bi-exclamation-circle me-2` | ||
| * `role` (optional) - ARIA role for alert divs. Default: `alert` | ||
| * `dismissible` (optional) - Whether to show a close button. Default: `true` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We discussed this in the weekly and we need to release 7.1 soon. For a quick resolution here and to make it in 7.1, we should either make this configurable at the app level or move it to the scaffolding project with a custom tag lib. Otherwise, we can revisit this in 8.0.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jdaugherty I don't think it is really has anything to do with scaffolding, so I can introduce config values with bootstrap defaults.