Основні типи повідомлень: success, error, warning, info

Уявіть: ви зайшли на сайт, ввели невірний пароль, і перед вами з'являється нічого не кажучий напис "Щось пішло не так!". Неприємно, правда? А тепер уявіть більш дружній спосіб сповіщення: "Помилка: ви ввели неправильний пароль. Спробуйте ще раз." Це одразу покращує взаємодію.

Django Message Framework надає чотири основні типи повідомлень — success, error, warning і info — кожен з яких призначений для конкретного сценарію. Разом вони допомагають розробнику структурувати сповіщення так, щоб користувач розумів, що відбувається, і правильно реагував.

Типи повідомлень: знайомимось ближче

Django підтримує такі типи повідомлень, які нам належить вивчити:

1. Success (Успіх)

   Це повідомлення використовується, щоб повідомити користувача про те, що дія успішно виконана. Приклади:

   • "Ваше замовлення успішно оформлено."
   • "Форму успішно надіслано."

Коли його застосовувати?
Використовуйте цей тип, якщо ваші дії йдуть за планом і користувач виконав завдання правильно.

Приклад:

from django.contrib import messages

def my_view(request):
    # Додаємо повідомлення типу success
    messages.success(request, "Ваш профіль оновлено!")
    return redirect('profile')

2. Error (Помилка)

   Повідомляє користувача про проблему. Це може бути помилка введення даних, брак прав доступу або збій системи. Приклади:

   • "Помилка: Неправильний пароль."
   • "Не вдалося додати товар до кошика."

Коли його застосовувати?
Використовуйте тип error, щоб дати користувачу зрозуміти, що він зробив щось не так або щось пішло не за планом.

Приклад:

from django.contrib import messages

def my_view(request):
    # Додаємо повідомлення типу error
    messages.error(request, "Сталася помилка під час збереження даних.")
    return redirect('home')

3. Warning (Попередження)

   Це повідомлення для потенційно важливих проблем, які користувач повинен враховувати. Але це ще не помилка. Приклади:

   • "Ваш пароль застарів, оновіть його для більшої безпеки."
   • "На вашому акаунті залишилося мало коштів."

Коли його застосовувати?
Використовуйте тип warning, якщо хочете звернути увагу користувача на щось, що не є критичним, але важливим.

Приклад:

from django.contrib import messages

def my_view(request):
    # Додаємо повідомлення типу warning
    messages.warning(request, "Термін дії вашої підписки закінчується через 3 дні.")
    return redirect('dashboard')

4. Info (Інформація)

   Цей тип використовується для відображення загальної інформації, яка не потребує негайних дій. Приклади:

   • "На сайті з'явилися нові можливості."
   • "Сьогодні доставка безкоштовна!"

Коли його застосовувати?
Повідомлення типу info ідеально підходить для сповіщення про якісь новини, оновлення чи зміни.

Приклад:

from django.contrib import messages

def my_view(request):
    # Додаємо повідомлення типу info
    messages.info(request, "У нас оновилася політика конфіденційності.")
    return redirect('about')

Використання кількох типів повідомлень

Багато сценаріїв вимагають використання одразу кількох повідомлень. Наприклад, ви обробляєте форму реєстрації, і якщо все пройшло успішно, показуєте success. Але якщо щось пішло не так, користувач побачить error.

Давайте розберемо це на прикладі:

from django.contrib import messages

def register_user(request):
    if request.method == "POST":
        # Логіка реєстрації користувача
        form = UserRegistrationForm(request.POST)
        if form.is_valid():
            form.save()
            messages.success(request, "Ви успішно зареєструвалися!")
            return redirect('login')
        else:
            messages.error(request, "Будь ласка, перевірте введені дані.")
    else:
        form = UserRegistrationForm()
    return render(request, 'register.html', {'form': form})

Тут success з'являється при успішній реєстрації, а error — при виникненні помилки валідації.

Рендеринг повідомлень у шаблонах

Додати повідомлення у представлення — це лише половина завдання. Важливо також правильно відобразити їх у HTML-шаблонах. Django надає вбудований шаблонний тег messages, який можна використовувати у циклі для рендерингу всіх повідомлень.

Приклад базового шаблону:

{% if messages %}
    <ul class="messages">
        {% for message in messages %}
            <li class="{% if message.tags %}{{ message.tags }}{% endif %}">
                {{ message }}
            </li>
        {% endfor %}
    </ul>
{% endif %}

Якщо ви хочете додати стилі для кожного типу повідомлення, використовуйте вбудовану властивість tags. Наприклад:

<li class="alert alert-{{ message.tags }}">
    {{ message }}
</li>

А тепер уявіть, як гарно це буде виглядати з підключенням Bootstrap! Ось приклад:

{% if messages %}
    <div class="container mt-3">
        {% for message in messages %}
            <div class="alert alert-{{ message.tags }} alert-dismissible fade show" role="alert">
                {{ message }}
                <button type="button" class="btn-close" data-bs-dismiss="alert" aria-label="Close"></button>
            </div>
        {% endfor %}
    </div>
{% endif %}

Приклади випадків використання

Щоб закріпити матеріал, давайте розглянемо кілька реальних сценаріїв:

Сценарій 1: додавання товару в кошик

• Success: "Товар додано до кошика."
• Warning: "Ми додали останній доступний екземпляр цього товару до вашого кошика."
• Error: "Не вдалося додати товар до кошика."

Код:

def add_to_cart(request, product_id):
    product = get_object_or_404(Product, id=product_id)
    if product.stock > 0:
        messages.success(request, "Товар додано до кошика.")
        product.stock -= 1
        product.save()
    else:
        messages.error(request, "Товару більше немає в наявності.")
    return redirect('cart')

Сценарій 2: редагування профілю

• Info: "Для оновлення даних може знадобитися вихід із системи."
• Success: "Ваш профіль успішно оновлено."
• Error: "Помилка при оновленні профілю. Перевірте введені дані."

Код:

def update_profile(request):
    if request.method == "POST":
        form = ProfileForm(request.POST, instance=request.user.profile)
        if form.is_valid():
            form.save()
            messages.success(request, "Ваш профіль успішно оновлено.")
        else:
            messages.error(request, "Помилка при оновленні профілю.")
    else:
        form = ProfileForm(instance=request.user.profile)
        messages.info(request, "Для оновлення даних може знадобитися вихід із системи.")
    return render(request, 'profile.html', {'form': form})

Типові помилки при використанні повідомлень

• Амнезія повідомлень. Якщо ти додав повідомлення, але забув відрендерити його у шаблоні, користувач нічого не побачить. Переконайся, що цикл {% for message in messages %} є у твоїх шаблонах.
• Перевантаження повідомлень. Не забувай, що користувачу складно сприймати весь потік сповіщень одразу. Не відправляй більше 2-3 повідомлень одночасно.
• Неправильний тип. Іноді розробники використовують info там, де потрібен error, або навпаки. Переконайся, що повідомлення відповідає ситуації.

Вивід

Тепер ви знаєте, які типи повідомлень існують у Django Message Framework, як і коли їх використовувати. Ви можете додати у свій застосунок сповіщення, які будуть інформативними, естетичними та корисними для користувача.

Час починати практикуватися — напишіть код, який буде радувати ваших користувачів успіхами та попереджати про їхні помилки!