docs(button): [button] update image button demo #2464
Conversation
WalkthroughThe changes in this pull request involve updates to two Vue component files ( Changes
Possibly related PRs
Suggested reviewers
Poem
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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Outside diff range and nitpick comments (3)
examples/sites/demos/pc/app/button/image.vue (3)
3-3: LGTM! Consider adding comments for better documentation.
Since this is a demo file, consider adding comments to explain the purpose of removing the inline width attribute in favor of CSS styling.
<tiny-button class="demo-button">
+ <!-- Image size is controlled via CSS for better maintainability -->
<img :src="image" />17-17: Add comments explaining the environment configuration.
Since this is a demo file, it would be helpful to document the required environment setup.
data() {
return {
+ // VITE_APP_BUILD_BASE_URL is required in the environment for proper asset loading
image: `${import.meta.env.VITE_APP_BUILD_BASE_URL}static/images/button-image.png`
}
}Line range hint 23-33: Document styling decisions for better demo clarity.
The styles are well-structured, but since this is a demo file, consider adding comments to explain the styling choices.
<style scoped>
+/* Button image styles - maintains consistent sizing and spacing */
.demo-button img {
width: 16px;
height: 16px;
margin-right: 8px;
border-radius: 2px;
}
+/* Button text styles - ensures vertical alignment with the image */
.demo-button span {
height: 16px;
line-height: 16px;
}
</style>📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
⛔ Files ignored due to path filters (2)
examples/sites/public/static/images/button-image.pngis excluded by!**/*.pngexamples/sites/public/static/images/email.pngis excluded by!**/*.png
📒 Files selected for processing (3)
- examples/sites/demos/pc/app/button/image-composition-api.vue (1 hunks)
- examples/sites/demos/pc/app/button/image.vue (2 hunks)
- packages/theme/src/button/index.less (1 hunks)
🔇 Additional comments (2)
examples/sites/demos/pc/app/button/image-composition-api.vue (1)
Line range hint 14-24: LGTM! Well-structured styles.
The addition of scoped styles and the consistent sizing of button elements are good practices. The styles are well-organized and provide a clean layout for the button component.
packages/theme/src/button/index.less (1)
11-12: Improved button content alignment with flexbox.
The change from inline-block to inline-flex along with align-items: center is a good improvement that:
- Provides better vertical alignment control for button content
- Ensures consistent centering of images, icons, and text
- Aligns with modern flexbox best practices
Please verify the button's appearance with various content combinations:
- Text only
- Icon + text
- Image + text
- Long text that wraps
- RTL text direction
| <span>图片按钮</span> | ||
| </tiny-button> | ||
| </template> | ||
|
|
||
| <script setup> | ||
| import { TinyButton } from '@opentiny/vue' | ||
|
|
||
| const image = `${import.meta.env.VITE_APP_BUILD_BASE_URL}static/images/email.png` | ||
| const image = `${import.meta.env.VITE_APP_BUILD_BASE_URL}static/images/button-image.png` |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Consider centralizing asset paths.
While using environment variables is good, consider moving the static asset paths to a centralized configuration file for better maintainability.
Create a config file for asset paths:
// constants/assets.js
export const IMAGES = {
BUTTON: {
ICON: `${import.meta.env.VITE_APP_BUILD_BASE_URL}static/images/button-image.png`
}
}Then import and use it:
-const image = `${import.meta.env.VITE_APP_BUILD_BASE_URL}static/images/button-image.png`
+import { IMAGES } from '@/constants/assets'
+const image = IMAGES.BUTTON.ICON| @@ -1,17 +1,17 @@ | |||
| <template> | |||
| <tiny-button class="demo-button"> | |||
| <img :src="image" width="26" /> | |||
| <img :src="image" /> | |||
There was a problem hiding this comment.
Add alt text for accessibility.
The image lacks an alt attribute which is important for screen readers and accessibility compliance.
- <img :src="image" />
+ <img :src="image" alt="Button icon" />📝 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.
| <img :src="image" /> | |
| <img :src="image" alt="Button icon" /> |
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
Bug Fixes
widthattribute fromimgtags to improve image rendering.Style
scopedstyles to prevent style leakage between components.