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

feat(Toast, SingleToast): add ability to show close cross #3596

Open
wants to merge 6 commits into
base: next
Choose a base branch
from

Conversation

SchwJ
Copy link
Member

@SchwJ SchwJ commented Feb 10, 2025

Проблема

Нет возможности отрисовать крестик закрытия отдельно от кнопки действия

Как должно быть с точки зрения дизайна

image
image
image

Решение

  1. Изменила margin'ы у крестика и link (это кнопка действия) так, чтобы при отрисовке кнопки и крестика визуально ничего не изменилось.
  2. Добавила в ToastView проп для показа крестика и добавила его в условие, по которому показывается крестик
  3. Обработалf различные случаи:
  • статический вызов Toast.push
  • вызов от экземпляра
  1. Добавила тесты
  • creevey -- проверили наличие и отрисовку крестика в случаях статического вызова Toast.push и вызова от экземпляра
  • selenium -- проверили, что в SingleInput наследуется, работает и переключается показывание крестика
  1. Добавила примеры в доку Toast и SingleToast

Ссылки

IF-1982

Чек-лист перед запросом ревью

  1. Добавлены тесты на все изменения
    ✅ unit-тесты для логики
    ✅ скриншоты для верстки и кросс-браузерности
    ⬜ нерелевантно

  2. Добавлена (обновлена) документация
    ✅ styleguidist для пропов и примеров использования компонентов
    ⬜ jsdoc для утилит и хелперов
    ⬜ комментарии для неочевидных мест в коде
    ⬜ прочие инструкции (README.md, contributing.md и др.)
    ⬜ нерелевантно

  3. Изменения корректно типизированы
    ✅ без использования any (см. PR 2856)
    ⬜ нерелевантно

  4. Прочее
    ✅ все тесты и линтеры на CI проходят
    ✅ в коде нет лишних изменений
    ✅ заголовок PR кратко и доступно отражает суть изменений (он попадет в changelog)

Copy link
Member Author

Choose a reason for hiding this comment

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

Изменила margin'ы у крестика и link (это кнопка действия) так, чтобы при отрисовке кнопки и крестика визуально ничего не изменилось

Copy link
Member Author

@SchwJ SchwJ Feb 11, 2025

Choose a reason for hiding this comment

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

Добавила проп для показа крестика и добавила его в условие по которому показывается крестик

Copy link
Member Author

Choose a reason for hiding this comment

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

Проверили, что в SingleInput наследуется, работает и переключается показывание крестика (это последний аргумент в функции SingleToast.push)

public static push(notification: string, action?: Nullable<Action>, showTime?: number) {
ToastStatic.push(notification, action, showTime);
public static push(notification: string, action?: Nullable<Action>, showTime?: number, showCloseCross?: boolean) {
ToastStatic.push(notification, action, showTime, showCloseCross);
}
Copy link
Member Author

Choose a reason for hiding this comment

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

Добавили аргумент для показа крестика в статический вызов Toast.push

Copy link
Member Author

Choose a reason for hiding this comment

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

Проверяем наличие и отрисовку крестика в случаях статического вызова Toast.push и вызова от экземпляра

Copy link
Member Author

Choose a reason for hiding this comment

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

Поочередно проверили случаи статического вызова Toast.push и вызова от экземпляра

Copy link
Member Author

Choose a reason for hiding this comment

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

Обрабатываем кейс, когда вызвали статический push

Copy link
Member Author

Choose a reason for hiding this comment

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

То, что здесь тост отрендеривается черным -- нормально, так как у нас при статическом вызове тостов не работает кастомизация. Это ограничение указано в документации.

Copy link
Member Author

Choose a reason for hiding this comment

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

То, что здесь тост отрендеривается черным -- нормально, так как у нас при статическом вызове тостов не работает кастомизация. Это ограничение указано в документации.

Comment on lines 70 to 73
<Button data-tid="with-cross" onClick={() => SingleToast.push('Static SingleToast', null, 5000, true)}>
Показать статический тост c крестиком
</Button>
<Button data-tid="without-cross" onClick={() => SingleToast.push('Static SingleToast', null, 5000, false)}>
Copy link
Member

Choose a reason for hiding this comment

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

Наверное, эти data-tid можно удалить, раз они не используются

Comment on lines 57 to 58
const showStaticToastButton = context.webdriver.findElement({ css: '[data-tid~="show-static-toast"]' });
const showInstanceToastButton = context.webdriver.findElement({ css: '[data-tid~="show-instance-toast"]' });
Copy link
Member

Choose a reason for hiding this comment

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

А давай уберём из селектора тильду ~, чтобы упростить и искать целиком?

@@ -26,6 +26,7 @@ export interface ToastState {
action: Nullable<Action>;
id: number;
showTime: Nullable<number>;
showCloseCross: boolean | undefined;
Copy link
Member

Choose a reason for hiding this comment

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

Давай упростим showCloseCross?: boolean

@sashachabin
Copy link
Member

В самом конце попробовал посмотреть по сторонам:

И думаю предложить вместо конкретного closeCross предложить более абстрактный и простой closeIcon, либо closeButton.

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

Successfully merging this pull request may close these issues.

2 participants