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

Implement the RecommendedResourceCard component in Studio to display recommended resources #4450

Closed
Tracked by #4044
akolson opened this issue Feb 22, 2024 · 1 comment
Assignees
Labels
DEV: frontend P1 - important Priority: High impact on UX

Comments

@akolson
Copy link
Member

akolson commented Feb 22, 2024

Overview

This task involves implementing a component named RecommendedResourceCard in Studio to display recommended resources to users within the recommended resources side panel. The implementation wraps around the KCard component.

Description and outcomes

  • Design requirements
    Screenshot 2024-02-22 at 08 27 43

  • Markup requirements

    • The outermost element is <KCard>
      <KCard ...>
           // Other Recommended resources relevant code
           ...
      </KCard>
  • Styling requirements

    • This card inherits from the KCard component.
  • Architecture requirements

    • Is built as a single component
    • Wraps around the KCard component
    • Has appropriate props to pass data into KCard
    • Uses KIcon to render icons
    • Uses KIconButton to render clickable icons
    • Uses the learningActivity to dynamically set the learning activity and its corresponding icon
    • It uses the the horizontal layout and the small thumbnailDisplay. See KCard specifications
      image
  • Props

Name Description Type Required Default
to Router-link object that enables user navigation to the intended route. Object true -
title Sets the value of the title text. String false null
level Sets the value of the level text. String false null
thumbnailSrc Source URL of a thumbnail image String false null
thumbnailScaleType Specifies how an image should be scaled within the thumbnail area. See KImg for supported types. String false 'centerInside'
learningActivity Sets the value of the learning activity. String false null
  • Events
Name Description
focus Emitted when the card element has received focus.
hover Emitted when the mouse pointer enters or leaves the card element

Acceptance Criteria

  • Conforms fully to the specification above

Assumptions and Dependencies

Scope

The scope of this task is limited to;

  • A card component for recommended resources only.

This task doesn’t include;

  • Implementing the KCard component
  • Implementing the actions for the pop-out link and thumbs down icons.

Accessibility Requirements

  • Card inherits KCard’s accessibility features

Resources

@akolson akolson changed the title [WIP - DO NOT ASSIGN]: Implement the RecommendedResourceCard component in Studio to display recommended resources Implement the RecommendedResourceCard component in Studio to display recommended resources Feb 26, 2024
@akolson akolson added P1 - important Priority: High impact on UX and removed work-in-progress TODO: needs updates labels Feb 26, 2024
@MisRob MisRob removed their assignment Apr 29, 2024
@akolson akolson closed this as completed May 9, 2024
@akolson
Copy link
Member Author

akolson commented May 9, 2024

Completed and merged in #4480

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
DEV: frontend P1 - important Priority: High impact on UX
Projects
None yet
Development

No branches or pull requests

3 participants