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 · 2 comments
Open
4 tasks

Introduce KTextTruncator component for text truncation #4591

MisRob opened this issue Jun 14, 2024 · 2 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 (:.

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

3 participants