Add ability to show component in alert #1118
Draft
Conversation
This file contains 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
matthew-white
commented
Dec 20, 2024
|
|
||
| <script setup> | ||
| defineOptions({ | ||
| name: 'Alert40917' |
There was a problem hiding this comment.
I tried naming this Alert409_17, but the linter complained whenever I imported it:
Identifier 'Alert409_17' is not in camel case
There was a problem hiding this comment.
other options to consider:
Alert409Dot17- AlertDuplicateProperties (semantic names)
|
@sadiqkhoja, would you mind taking a quick first look at the approach in this PR? If it looks good, I can add more tests and get it ready for a full review. |
|
I haven't looked at this yet, will do it tomorrow |
sadiqkhoja
approved these changes
Jan 30, 2025
|
|
||
| <script setup> | ||
| defineOptions({ | ||
| name: 'Alert40917' |
There was a problem hiding this comment.
other options to consider:
Alert409Dot17- AlertDuplicateProperties (semantic names)
| // `true` if the alert should be visible and `false` if not. | ||
| state: false, | ||
| // The time at which the alert was last set | ||
| // Either a string or an array with a component and props for the |
There was a problem hiding this comment.
What do you think about having object instead of array? or add component and props getter so that alert.vue can access them without bracket notation.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Right now, alerts can only show text. However, I've long wanted to lift that restriction in order to make it possible to show other content. I think lifting that restriction would make it easier to solve issues like getodk/central#775.
What got me thinking about this again was #1075. There, the alert lists one or more entity properties. It would've been nice if we could have shown a
<ul>, but because the alert had to be text, that wasn't possible. Instead, we added bullet points to the text. With the change in this PR, it's now possible to show a<ul>in the alert in that case. That's done by passing a component to the alert.What has been done to verify that this works as intended?
I've updated existing tests. If this approach looks good, I'll add some new tests as well.
Why is this the best possible solution? Were any other approaches considered?
The approach in this PR is to pass a component to the alert. I also thought about passing HTML or Markdown. However, a component gives us the most flexibility. It also gives us an easy way to escape user content and not render user content as HTML.
Before submitting this PR, please make sure you have:
npm run testandnpm run lintand confirmed all checks still pass OR confirm CircleCI build passes