Skip to content
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

UserIconにalt, width, heightをつけた #350

Merged
merged 1 commit into from
Aug 15, 2024
Merged

Conversation

ogu-kazemiya
Copy link
Contributor

@ogu-kazemiya ogu-kazemiya commented Aug 14, 2024

User description

close #292
CLSを防ぐ、改善する原理がわからなかったので、ひとまずUIの方と同じようにしました


PR Type

Enhancement


Description

  • UserIconコンポーネントのimgタグにaltwidthheight属性を追加しました。
  • widthheight属性はsizeプロパティを使用し、画像のサイズを指定します。
  • alt属性はuserNameプロパティを使用し、画像の代替テキストを指定します。

Changes walkthrough 📝

Relevant files
Enhancement
UserIcon.vue
`UserIcon`コンポーネントに画像属性を追加                                                               

src/components/UI/UserIcon.vue

  • imgタグにwidthheightalt属性を追加
  • widthheightsizeプロパティを使用
  • altuserNameプロパティを使用
  • +8/-1     

    💡 PR-Agent usage:
    Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

    Copy link
    Contributor

    PR Reviewer Guide 🔍

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ No key issues to review

    Copy link
    Contributor

    github-actions bot commented Aug 14, 2024

    PR Code Suggestions ✨

    CategorySuggestion                                                                                                                                    Score
    Accessibility
    <img> タグの :alt 属性にデフォルトの代替テキストを追加します。

    タグの :alt
    属性には、ユーザー名が空の場合に備えてデフォルトの代替テキストを設定することをお勧めします。これにより、画像が読み込まれない場合やテキストが空の場合に、ユーザーにとってよりアクセシビリティが向上します。

    src/components/UI/UserIcon.vue [25]

     <img
       :class="$style.icon"
       :src="src"
       :style="styles"
       :width="size"
       :height="size"
    -  :alt="userName"
    +  :alt="userName || 'ユーザー画像'"
     />
     
    Suggestion importance[1-10]: 9

    Why: Adding a default alt text improves accessibility by providing a fallback description if the userName is empty, which is a significant enhancement for users relying on screen readers.

    9

    @Pugma
    Copy link
    Collaborator

    Pugma commented Aug 15, 2024

    今回の改善は、ページを読み込む際のユーザー体験の向上を目指して行われたものです

    CLS については、以下のサイトを見てもらえればと思います
    https://kinsta.com/jp/blog/cumulative-layout-shift/

    一言でいうと、ページの読み込み中にページ内要素の位置がずれてしまうことを指します
    例えば今回扱った画像においても、変更前の状態であれば以下のようなことが起きます

    1. 画像が読み込まれるまでは表示がされず、またその部分を詰めるようにして他の要素が表示される
    2. 画像の読み込みが完了したタイミングで、他の要素を下に押し出しながら描画が行われる

    ただ、height width の指定によって、画像の読み込み前から予め画像の表示領域を確保した状態で描画させることができるようになります
    詳細は以下のサイトを見てもらえれば分かりやすいと思います
    https://developer.mozilla.org/ja/docs/Web/HTML/Element/img#height

    Copy link
    Collaborator

    @Pugma Pugma left a comment

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    やってくれてありがとうございました
    okです!

    @ogu-kazemiya ogu-kazemiya merged commit 42bfc4d into main Aug 15, 2024
    10 checks passed
    @ogu-kazemiya ogu-kazemiya deleted the fix/userIcon branch August 15, 2024 06:41
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    UserIconにalt, width, heightをつける
    2 participants