Skip to content

Welcoming kcard to studio#4466

Closed
AllanOXDi wants to merge 29 commits intolearningequality:unstablefrom
AllanOXDi:welcoming-kcard-to-studio
Closed

Welcoming kcard to studio#4466
AllanOXDi wants to merge 29 commits intolearningequality:unstablefrom
AllanOXDi:welcoming-kcard-to-studio

Conversation

@AllanOXDi
Copy link
Member

Summary

Description of the change(s) you made

Manual verification steps performed

  1. Step 1
  2. Step 2
  3. ...

Screenshots (if applicable)

Does this introduce any tech-debt items?


Reviewer guidance

How can a reviewer test these changes?

Are there any risky areas that deserve extra testing?

References

Comments


Contributor's Checklist

PR process:

  • If this is an important user-facing change, PR or related issue the CHANGELOG label been added to this PR. Note: items with this label will be added to the CHANGELOG at a later time
  • If this includes an internal dependency change, a link to the diff is provided
  • The docs label has been added if this introduces a change that needs to be updated in the user docs?
  • If any Python requirements have changed, the updated requirements.txt files also included in this PR
  • Opportunities for using Google Analytics here are noted
  • Migrations are safe for a large db

Studio-specifc:

  • All user-facing strings are translated properly
  • The notranslate class been added to elements that shouldn't be translated by Google Chrome's automatic translation feature (e.g. icons, user-generated text)
  • All UI components are LTR and RTL compliant
  • Views are organized into pages, components, and layouts directories as described in the docs
  • Users' storage used is recalculated properly on any changes to main tree files
  • If there new ways this uses user data that needs to be factored into our Privacy Policy, it has been noted.

Testing:

  • Code is clean and well-commented
  • Contributor has fully tested the PR manually
  • If there are any front-end changes, before/after screenshots are included
  • Critical user journeys are covered by Gherkin stories
  • Any new interactions have been added to the QA Sheet
  • Critical and brittle code paths are covered by unit tests

Reviewer's Checklist

This section is for reviewers to fill out.

  • Automated test coverage is satisfactory
  • PR is fully functional
  • PR has been tested for accessibility regressions
  • External dependency files were updated if necessary (yarn and pip)
  • Documentation is updated
  • Contributor is in AUTHORS.md

<li class="remove-list-style">
<component
:is="'h' + headingLevel"
v-if="title !== null"
Copy link
Member

Choose a reason for hiding this comment

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

  • I don't think conditional display is necessary since heading level is a required prop. If you need to add conditional display, i think it would be best suited for TextTuncator component that holds the title. I'm not entirely sure but I think hiding the h<2-6> component would hinder click event propagation since we are looking at having the entire card responding to clicks. This we can clarify with Misha
  • It's also worth considering using a computed prop for the :is value

Copy link
Member Author

Choose a reason for hiding this comment

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

Okay-Thanks!

<div
:class="$computedClass({ ':focus': $coreOutline })"
>
<li class="remove-list-style">
Copy link
Member

Choose a reason for hiding this comment

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

According to the spec, I think this should be the outer most layer, for accessibility reasons

v-if="layout === 'horizontal'"
>
<component
:is="'div'"
Copy link
Member

@akolson akolson Mar 7, 2024

Choose a reason for hiding this comment

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

I think simply just is="div" would eliminate the need to pass a wrapped string('div')

Copy link
Member

Choose a reason for hiding this comment

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

I think more generally we could improve how we are swapping the layouts and thumbnails. I feel this is quite verbose and we may run into maintainability issues pretty quickly. Maybe we can start by asking a few questions on the dynamicity of the proposed layouts.

  • Which of the components in the layouts is dynamic (keeps on changing their position)?
  • How can we structure our markup to meet the ever changing demands of the identified component?
  • What changes when the different layouts are specified?
    I think would help us implement a more maintainable structure.

@MisRob MisRob assigned MisRob and unassigned MisRob Mar 27, 2024
@AllanOXDi
Copy link
Member Author

AllanOXDi commented Apr 22, 2024

This needs to be closed to make way for #4480

@AllanOXDi AllanOXDi closed this Apr 22, 2024
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 this pull request may close these issues.

3 participants