Skip to content

Documentation updates#1217

Open
MisRob wants to merge 3 commits intolearningequality:developfrom
MisRob:doc-updates
Open

Documentation updates#1217
MisRob wants to merge 3 commits intolearningequality:developfrom
MisRob:doc-updates

Conversation

@MisRob
Copy link
Member

@MisRob MisRob commented Mar 9, 2026

Description

  • Align snackbar documentation with the latest guidance from designers
  • Improves guidance for recently added KCard thumbnail slot
  • Improves useKLiveRegion guidance

Issue addressed

  • Updates obsolete specifications
  • Improves and adds guidance in areas that I needed to explain few times

Changelog

  • Description: Improve snackbar, KCard, and useKLiveRegion documentation pages
  • Products impact: Documentation
  • Addresses: -
  • Components: Snackbar, KCard, useKLiveRegion
  • Breaking: no
  • Impacts a11y: no
  • Guidance: -

Steps to test

Preview updated areas on the following pages:

@github-actions
Copy link
Contributor

Percy Visual Test Results

Percy Dashboard: View Detailed Report

Environment:

  • Node.js Version: 18.x
  • OS: Ubuntu-latest

Instructions for Reviewers:

  • Click on the Percy Dashboard link to view detailed visual diffs.
  • Review the visual changes highlighted in the report.
  • Approve or request changes based on the visual differences.

@MisRob MisRob added the TODO: needs review Waiting for review label Mar 16, 2026
@MisRob MisRob requested a review from AlexVelezLl March 17, 2026 17:04
@AlexVelezLl AlexVelezLl self-assigned this Mar 24, 2026
Copy link
Member

@AlexVelezLl AlexVelezLl left a comment

Choose a reason for hiding this comment

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

Thanks @MisRob! Updates make sense to me, just a couple of comments/questions, but nothing blocking! :)

<ul>
<li>Set <code>isDecorative</code> on <code>KImg</code> for correct accessibility</li>
<li>
Utilize <code>KImg</code>'s <code>placeholder</code> slot for placeholder content (<code>thumbnailPlaceholder</code>
Copy link
Member

Choose a reason for hiding this comment

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

I got a (little) bit confused because of the thumbnail placeholder slot, thumbnail slot, and this KImg's placeholder slot. But I think I finally got it, the thumbnail-placeholder is only applicable for thubmnailSrc, right?

I think it is this paragraph that isn't entirely clear to me, that this is talking specifically about the thumbnailSrc and not about the thumbnail slot.

When KCard is set to display the thumbnail, the thumbnail area acts as a placeholder if the image is missing, fails to load, or is still loading. In such cases, a light gray background is shown in place of the image.

Also, something that isn't clear to me by just reading this, if we set KCard to display the thumbnail using the thumbnail slot, we also get this gray background when the image is missing, fails to load or still loading? (im not completely profficient with KImg yet) 😅

<li>Background color: $k-grey-900</li>
<li>Text: 14px white and bolded</li>
<li>Height: 48px</li>
<li>Timeout: 5 seconds</li>
Copy link
Member

Choose a reason for hiding this comment

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

In the current KSnackbar PR, we are using 4000 ms as the default. Should we already update this in the scope of that PR, right? (i.e., are planning to do this in a follow-up?)

Comment on lines +43 to +44
<strong>Use assertive messages only for critical information that requires immediate
attention.</strong>
Copy link
Member

Choose a reason for hiding this comment

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

For me, as a developer, it is still a bit abstract what a "critical information that requires immediate attention" is; it'd be great if we had some examples here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

TODO: needs review Waiting for review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants