feat(guide): [guide] replace x with close-icon #2121
Conversation
WalkthroughThe pull request introduces a new SVG cancel icon to the Shepherd tour component, enhancing the user interface. It includes updates to the styling of the icon, modifying CSS variables for color and dimensions, and adjusting margins for a more compact design. These changes collectively improve the visual representation and functionality of the cancel button within the guide component. Changes
Possibly related PRs
Suggested labels
Poem
Tip OpenAI O1 model for chat
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
github-actions
bot
added
enhancement
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (3)
- packages/renderless/src/guide/index.ts (1 hunks)
- packages/theme/src/guide/index.less (3 hunks)
- packages/theme/src/guide/vars.less (2 hunks)
Additional context used
Biome
packages/renderless/src/guide/index.ts
[error] 136-136: Change to an optional chain.
Unsafe fix: Change to an optional chain.
(lint/complexity/useOptionalChain)
Additional comments not posted (10)
packages/theme/src/guide/vars.less (7)
29-29: LGTM!The change reduces the font size of the cancel icon, which is consistent with the PR objective of updating the guide component.
31-31: LGTM!The change reduces the width of the cancel icon, which is consistent with the PR objective of updating the guide component.
33-33: LGTM!The change reduces the height of the cancel icon, which is consistent with the PR objective of updating the guide component.
41-41: LGTM!The change reduces the top margin of the cancel icon, which is consistent with the PR objective of updating the guide component.
43-43: LGTM!The change reduces the right margin of the cancel icon, which is consistent with the PR objective of updating the guide component.
47-47: LGTM!The change replaces the hover color of the cancel icon from a variable to a fixed color value, which is consistent with the PR objective of updating the guide component.
125-125: LGTM!The change replaces the border radius of the shepherd element from a variable to a fixed value, which is consistent with the PR objective of updating the guide component.
packages/renderless/src/guide/index.ts (1)
135-151: LGTM!The addition of the SVG icon for the cancel button within the Shepherd tour component is implemented correctly. The SVG markup is properly assigned to the
innerHTMLproperty of thecancelIconelement.Tools
Biome
[error] 136-136: Change to an optional chain.
Unsafe fix: Change to an optional chain.
(lint/complexity/useOptionalChain)
packages/theme/src/guide/index.less (2)
14-14: Approved: Empty line enhances readability.The addition of the empty line within the
.shepherd-arrowclass enhances readability without altering functionality.
72-72: Approved: Shift fromcolortofillfor the cancel icon.The changes at lines 72 and 82 modify the color properties for the cancel icon from
colortofill. This shift indicates an accommodation for SVG or similar graphic formats, ensuring that the intended color is applied correctly to the icon, especially on hover.The modifications align with the alterations listed in the summary and contribute to the proper visual rendering of the cancel icon.
Also applies to: 82-82
| @@ -132,6 +132,23 @@ const itemStep = (item, state, deepCopy, index, Shepherd) => { | |||
| const currentStep = Shepherd.activeTour && Shepherd.activeTour.getCurrentStep() | |||
| const currentStepElement = currentStep && currentStep.getElement() | |||
| const footer = currentStepElement && currentStepElement.querySelector('.shepherd-footer') | |||
| const cancelIcon = | |||
| currentStepElement && currentStepElement.querySelector('.shepherd-header .shepherd-cancel-icon span') | |||
There was a problem hiding this comment.
Use an optional chain for the cancelIcon element selection.
To prevent potential errors if the cancelIcon element is not found, consider using an optional chain for the element selection.
Apply this diff to use an optional chain:
-const cancelIcon =
- currentStepElement && currentStepElement.querySelector('.shepherd-header .shepherd-cancel-icon span')
+const cancelIcon = currentStepElement?.querySelector('.shepherd-header .shepherd-cancel-icon span')Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| currentStepElement && currentStepElement.querySelector('.shepherd-header .shepherd-cancel-icon span') | |
| const cancelIcon = currentStepElement?.querySelector('.shepherd-header .shepherd-cancel-icon span') |
Tools
Biome
[error] 136-136: Change to an optional chain.
Unsafe fix: Change to an optional chain.
(lint/complexity/useOptionalChain)
PR
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
Issue Number: N/A
What is the new behavior?
Does this PR introduce a breaking change?
Other information
Summary by CodeRabbit
New Features
Style