[Enhance] Implement Validation for Icon Input Source & Set Default Icon to Beaker
#1137
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
Signed-off-by: Willie Hung <[email protected]>
willie-hung
force-pushed
the
feature/beaker
branch
from
694e481 to
303d5a4
Compare
Signed-off-by: Willie Hung <[email protected]>
Signed-off-by: Willie Hung <[email protected]>
Signed-off-by: Willie Hung <[email protected]>
willie-hung
requested review from
seanneumann,
AMoo-Miki,
rednaksi91,
KrooshalUX,
BSFishy,
bandinib-amzn,
ashwin-pc,
joshuarrrr,
andreymyssak and
SergeyMyssak
as code owners
Signed-off-by: Willie Hung <[email protected]>
willie-hung
force-pushed
the
feature/beaker
branch
from
8487f6f to
80a1741
Compare
Signed-off-by: Willie Hung <[email protected]>
willie-hung
changed the title
BeakerBeaker
BSFishy
approved these changes
Dec 5, 2023
Comment on lines
+628
to
642
| // Category 1: cached oui icons | ||
| if (isCachedIcon(type)) { | ||
| initialIcon = iconComponentCache[type as string]; | ||
| // Category 2: URL (relative, absolute) | ||
| } else if (isUrl(type)) { | ||
| initialIcon = type; | ||
| // Category 3: non-cached oui icon or new icon | ||
| } else if (typeof type === 'string') { | ||
| isLoading = true; | ||
| this.loadIconComponent(type); | ||
| this.loadIconComponent(type as OuiIconType); | ||
| } else { | ||
| // Category 4: custom icon component | ||
| initialIcon = type; | ||
| this.onIconLoad(); | ||
| } |
There was a problem hiding this comment.
This could be rewritten to not use a mutable variable. I'll make a followup issue, no need to worry about pushing it in this PR
joshuarrrr
approved these changes
Dec 8, 2023
Comment on lines
+184
to
+187
| it('renders custom svg from relative url', () => { | ||
| const component = mount(<OuiIcon type="./assets/beaker.svg" />); | ||
| expect(prettyHtml(component.html())).toMatchSnapshot(); | ||
| }); |
There was a problem hiding this comment.
nit - maybe it's better to test custom svg rendering with an asset that isn't used as a fallback.
There was a problem hiding this comment.
@joshuarrrr should I raise an issue so that we can revise this unit test or just leave it as it is?
There was a problem hiding this comment.
Sure, if you think it's a worthwhile change.
opensearch-trigger-bot bot
pushed a commit
that referenced
this pull request
Dec 8, 2023
…on to `Beaker` (#1137) * Revise the logic to handle default icon Signed-off-by: Willie Hung <[email protected]> * Categorize different input icon types Signed-off-by: Willie Hung <[email protected]> * Remove unused code Signed-off-by: Willie Hung <[email protected]> * Update CHANGELOG.md Signed-off-by: Willie Hung <[email protected]> * Use readable parameter name Signed-off-by: Willie Hung <[email protected]> * Handle different input cases and add tests Signed-off-by: Willie Hung <[email protected]> --------- Signed-off-by: Willie Hung <[email protected]> Co-authored-by: Josh Romero <[email protected]> (cherry picked from commit 0d3b6cc) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> # Conflicts: # CHANGELOG.md
ashwin-pc
pushed a commit
that referenced
this pull request
Dec 12, 2023
…on to `Beaker` (#1137) (#1171) * Revise the logic to handle default icon Signed-off-by: Willie Hung <[email protected]> * Categorize different input icon types Signed-off-by: Willie Hung <[email protected]> * Remove unused code Signed-off-by: Willie Hung <[email protected]> * Update CHANGELOG.md Signed-off-by: Willie Hung <[email protected]> * Use readable parameter name Signed-off-by: Willie Hung <[email protected]> * Handle different input cases and add tests Signed-off-by: Willie Hung <[email protected]> --------- Signed-off-by: Willie Hung <[email protected]> Co-authored-by: Josh Romero <[email protected]> (cherry picked from commit 0d3b6cc) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> # Conflicts: # CHANGELOG.md Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
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.
Description
Beakeras the new default icon.Issues Resolved
Resolves #951
Screenshot
For demonstration purposes, when an input iconType is not present in the original
OuiIconType, theBeakericon will be used as a fallback. This behavior can be tested by removing specific keys from thetypeToPathMapdictionary manually or checkout the test I wrote.Check List
yarn lintyarn test-unit