跳转到主要内容

未提供项目描述

项目描述

django-one-time-notices

如果用户尚未查看,则显示包含通知内容的模态框。

安装

pip install django-one-time-notices

设置

添加到 INSTALLED_APPS

django.contrib.auth
django.contrib.admin
...
notices

添加到 TEMPLATES['OPTIONS']

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [],
        'APP_DIRS': True,
        'OPTIONS': {
            'context_processors': [
                ...
                'django.core.context_processors.request'
                ...
                'notices.context_processors.notices',
            ]
        }
    }
]

要自定义通知颜色(按钮和标题边框),请添加

NOTICES_COLOUR=<colour>  # any css-acceptable colour

静态资源

notices/css/notices.cssnotices/js/notices.js 添加到您的标记中。

使用方法

在模板中,加载标签

{% load notices_tags %}

并添加模态框

{% notices_modal %} 

模态框将显示。一旦取消,它将不会再次显示,除非通知版本更改(见下文),删除 notice_seen cookie,或者达到通知超时。

通过模型和django admin设置/更新通知

在django admin中添加一个 Notice 实例。

通知具有 titlecontentversion 以及可选的 timeout_secondsstarts_atexpires_at 字段。

版本可以是任何正数;它默认为递增最后版本号。将 expires_at 日期时间设置为避免在指定的日期之后显示此通知,即使用户从未查看/取消,也是如此。将 starts_at 日期时间设置为避免在特定日期/时间之前显示通知。

请注意,只有最新版本的公告才会显示。如果最新版本尚未开始,则不会显示以前的版本,即使它尚未到期。

timeout_seconds 设置为设置cookie超时;这意味着通知将重新显示。

要显示新的通知,请添加另一个具有递增版本号的 Notice 实例。

配置设置

NOTICES_COLOUR:更改弹出窗口的颜色,可以是任何CSS颜色NOTICES_SAFE:将通知内容标记为安全 - 允许任何任意HTML。默认为False。

通过Django设置

通过向您的 settings.py 添加来覆盖通知模型:NOTICES_VERSION # 一个整数 NOTICES_TITLE # 可选,默认为 "New!" NOTICES_CONTENT # 可选,默认为 "" NOTICES_TIMEOUT_SECONDS # 可选,默认为 None

设置 NOTICES_VERSION = 0 以清除cookie并禁用显示所有通知。

项目详情


下载文件

下载适用于您的平台的文件。如果您不确定选择哪个,请了解更多关于 安装包 的信息。

源分发

django_one_time_notices-1.0.0.tar.gz (9.6 kB 查看哈希值)

上传时间

构建分发

django_one_time_notices-1.0.0-py3-none-any.whl (14.5 kB 查看哈希值)

上传时间 Python 3

由以下支持