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

Introduce KTextTruncator component for text truncation #4591

Open
4 tasks
MisRob opened this issue Jun 14, 2024 · 21 comments
Open
4 tasks

Introduce KTextTruncator component for text truncation #4591

MisRob opened this issue Jun 14, 2024 · 21 comments
Assignees
Labels
DEV: frontend good first issue Self-contained, straightforward, low-complexity help wanted Open source contributors welcome P2 - normal Priority: Nice to have

Comments

@MisRob
Copy link
Member

MisRob commented Jun 14, 2024

🌱 Are you new to the codebase? Welcome and please see the contributing guidelines.

Expected behavior

Whenever relevant, Studio should use KTextTruncator component from the Kolibri Design System (KDS) to achieve text truncation.

One example is text truncation in the ClipboardChip.vue but there will likely be more places.

truncator

Current Behavior

Studio currently uses its own implementation for text truncation.

Impact

This is part of migrating Studio to KDS. KTextTruncator provides a robust and well-tested solution for text truncation and will eliminate the need to re-implement truncation.

Trade-Offs

Not aware of any.

Guidance

  • To locate the truncation that needs to be replaced, search for any CSS properties and values related to truncating, such as ellipsis.
  • For more information on using KTextTruncator, refer to its documentation. If working with the design system for the first time, study how other K components are used in Studio.
  • Note that depending on the context (e.g. current usage of the Vuetify library), in some places it may make more sense to not use KTextTruncator. If that's the case, please mention reasons for not using it in your pull request.

Acceptance Criteria

  • The codebase has been thoroughly searched for all occurrences of truncation.
  • The custom implementation of truncation has been replaced with KTextTruncator wherever relevant.
  • The places where KTextTruncator has been introduced have been visually reviewed and do not have any regressions.
  • A list of places where KTextTruncator is better not to be used has been provided in the pull request.
@MisRob MisRob added good first issue Self-contained, straightforward, low-complexity DEV: frontend help wanted Open source contributors welcome P3 - low Priority: Stretch goal P2 - normal Priority: Nice to have and removed P3 - low Priority: Stretch goal labels Jun 14, 2024
@lokesh-sagi125
Copy link

hey @MisRob can you assign this to me?

@AlexVelezLl
Copy link
Member

Hey @lokesh-sagi125! Thanks for your interest in contributing to this issue 👐. I just assigned it to you. Please let us know if you have any questions (:.

@MisRob
Copy link
Member Author

MisRob commented Oct 3, 2024

Hi @lokesh-sagi125, are you working on this or planning to? Just to know if we should keep the assignment or not.

@sr376
Copy link

sr376 commented Oct 13, 2024

Hi @MisRob can you assign this issue to me.

@lokesh-sagi125
Copy link

hey @MisRob sorry for the inactivity , i just raised the PR's for the issues in KDS and Kolibri, i am willing to work on this issue now

@MisRob
Copy link
Member Author

MisRob commented Oct 14, 2024

Hi @sr376 and @lokesh-sagi125. I will assign this back to @lokesh-sagi125.

@sr376 Welcome and thank you for volunteering! There are other contributing opportunities in three repositories. See the contributing guidelines including links to issues suitable for contribution for each repository here:

You can also see the list of unassigned "help wanted" or "good first issue" issues across all repositories.

@lokesh-sagi125
Copy link

lokesh-sagi125 commented Nov 12, 2024

hey @MisRob how can i test the changes i made to the frontend in studio , can you link the documentation page if there is one,
cant seem to find it  😅 .

@AlexVelezLl
Copy link
Member

Hi @lokesh-sagi125! Here you can find more information about how to test these KDS updates in Studio: https://github.com/learningequality/kolibri-design-system/blob/develop/dev_docs/03_how_to_update_library.md#2-preview-updates-in-a-product. Let me know any question :)

@lokesh-sagi125
Copy link

lokesh-sagi125 commented Nov 13, 2024

hey @AlexVelezLl i have been getting this error since i ran git reset--hard
Image i was able to run the yarn run services and yarn run devsetup commands before but now i am able to run only yarn devserver how can i fix this issue?

@AlexVelezLl
Copy link
Member

Hey @lokesh-sagi125! Can you confirm that you are indeed in the Studio folder? I see a kolibri there.

@lokesh-sagi125
Copy link

sorry that was the wrong ss Image

@AlexVelezLl
Copy link
Member

Could you try running yarn install again @lokesh-sagi125?

@lokesh-sagi125
Copy link

lokesh-sagi125 commented Nov 13, 2024

hey @AlexVelezLl i was able to fix the issue i was facing , i was using yarn@4 which was having problems downloading the aphrodite repo , i switched to yarn@1 and the issue was fixed.
thank you:)

@lokesh-sagi125
Copy link

Hi @MisRob, I am currently giving my end-semester tests, so is it fine if I raise a PR by the end of this month? Please reassign if this issue needs to be resolved before then. Thank you:)

@MisRob
Copy link
Member Author

MisRob commented Nov 18, 2024

Hi @lokesh-sagi125, first wishing you all the best for the tests :)!

Thanks a lot for letting us know. It's absolutely fine you returned to this issue later. It's not time sensitive, so happy to have it wait for you as it sounds you're interested.

@lokesh-sagi125
Copy link

Thank you @MisRob. I will get back to the issue as soon as my tests end, same with the issue in Kolibri :)

@MisRob
Copy link
Member Author

MisRob commented Dec 17, 2024

@lokesh-sagi125
Copy link

yes @MisRob i will try to close all my open issues before the 23rd.

@MisRob
Copy link
Member Author

MisRob commented Dec 17, 2024

No need to @lokesh-sagi125 :) I'm posting the message so you know we won't be responding until later in January.

@MisRob
Copy link
Member Author

MisRob commented Dec 17, 2024

@lokesh-sagi125 I doubt we'd be able to review this week anyway, some of us are already slowly transitioning to time off, me included :) Be well and hope to see you around next year!

@lokesh-sagi125
Copy link

yes, @MisRob, I wouldn't want to interrupt your time off . Happy holidays🎄🎊 :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
DEV: frontend good first issue Self-contained, straightforward, low-complexity help wanted Open source contributors welcome P2 - normal Priority: Nice to have
Projects
None yet
Development

No branches or pull requests

4 participants