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

Resource discovery: Implement folder card #12318

Closed
8 tasks done
MisRob opened this issue Jun 19, 2024 · 2 comments · Fixed by #12418
Closed
8 tasks done

Resource discovery: Implement folder card #12318

MisRob opened this issue Jun 19, 2024 · 2 comments · Fixed by #12418
Assignees

Comments

@MisRob
Copy link
Member

MisRob commented Jun 19, 2024

Blocked by

Summary

In support of coach resource discovery, we need to implement a new folder card. This will be one of the first cards in Kolibri built on top of KCard.

The final card is expected to look like:

Screenshot from 2024-06-18 19-56-50

It needs to show:

  • Folder title
  • Folder icon and label
  • Folder thumbnail picture
  • Folder thumbnail placeholder when a picture is not available

References

Guidance

  • Create a completely new component <AccessibleFolderCard> and use <KCard> as its basis
  • Regarding the structure of production data that the card should display, examine existing folder cards in the Library and also see the useSearch composable. In the scope of this issue, assume that data for the new card will have the same structure.
  • For the purpose of development and review, display the new card at any place in Kolibri and remove the preview shortly before the final merge. It may be handy to work on the Library page because it has access to all data.
  • Even though any of the existing cards shouldn’t be changed, they may contain some useful pieces of code for the new card so it’s recommended to examine them (see ResourceCard.vue when contentNode.is_leaf is false)
  • It is possible that KCard will need further updates to support all Kolibri cards. If there’s something that KCard doesn’t support yet, discuss with relevant people and determine next steps.

Out of scope

  • Anything grid-related (this includes the card’s min and max width which will be the grid’s responsibility, as well as checkboxes)
  • Refactoring existing card components in Kolibri
  • Implementing other parts of the coach resource discovery such as the side panel where cards will be displayed

Acceptance criteria

  • The card is built on top of the KCard and contains elements listed above
  • It follows the designs closely (or discrepancies get discussed)
  • It is content tolerant (renders well for short strings, long strings, missing information, missing thumbnail picture, etc.)
  • It is responsive
  • It supports RTL (note that KCard will be responsible for basic layout RTL support, but some additional tweaks may be needed for content that is provided to it via slots etc.)
  • It is ready to receive production data, meaning it doesn’t use hardcoded data inside the card but rather receives data from outside like it would in the final feature, for example in the form of an object passed via prop (or any other relevant manner)
  • For the purpose of preview and QA, please include at least a couple of <AccessibleFolderCard>'s in <ul> and feed them with data that have the same structure as production data and enough variance (see content tolerance criteria)
  • If some components used in the current cards are re-used in this new card and tweaked for the purpose, there are no regressions in the old cards
@Spoorthy1423
Copy link

Hey!! I would like to work on this issue @MisRob please assign me this issue!!

@MisRob
Copy link
Member Author

MisRob commented Aug 23, 2024

Hi @Spoorthy1423, thanks for volunteering. This issue is not available for assignment. See #12319 (comment).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants