carbon/notification

此包提供了一个用于通知的微小融合助手。

3.0.0 2024-03-13 08:47 UTC

README

Latest stable version Total downloads License GitHub forks GitHub stars GitHub watchers

Neos CMS 的 Carbon.Notification 包

此包提供了一个用于通知的微小融合助手

类型 info 信息截图

类型 warning 警告截图

类型 alert 警报截图

类型 success 成功截图

除了这四种类型,还有类型 backend,它以 Neos 后端颜色显示,非常适合通知。 后端截图

Carbon.Notification:Tag

添加通知。 type 可以是 alertwarning(默认)、infosuccessbackend。您需要设置 content 以显示通知。如果您想添加/更改样式,可以传递一个键/值对。例如,您想更改 padding 并将 font-weight 更改为 bold,则可以输入

notification = Carbon.Notification:Tag {
    padding = '12px'
    font-weight = 'bold'

    content = 'Here comes your content'
}

使用 lang 属性可以设置替代语言。如果您的界面和网站语言不同,则非常有用。

Carbon.Notification:Backend

这是从 Carbon.Notification:Tag 变化而来的。此通知仅在后台显示。非常适合需要输入检查器的 NodeTypes。它具有与 Carbon.Notification:Tag 相同的功能,只是扩展了 @if.inBackend = ${node.context.inBackend}

Carbon.Notification:Data

将通知添加到后台视图。您需要设置 content 以显示通知。这对于需要输入检查器的 NodeTypes 非常有用。将此原型添加到 data-carbon-alertdata-carbon-warningdata-carbon-infodata-carbon-backend 的元素作为属性。您还可以直接将 data-carbon-* 传递给元素。如果 HTML 元素没有内容,则显示消息,否则将隐藏。这是通过 CSS 选择器 :not(:empty) 实现的

如果您想显示一个空的内容集合通知,这是一个用例。

Carbon.Notification:Document

此代码包围了 Carbon.Notification:Tag 和文档所需的 HTML 标记。

自定义

每次加载通知时,都会从设置中加载默认样式 Carbon.Notification.default。如果您想更改某些值或添加新的值,您可以在您的 Settings.yaml 中编辑它们。

默认情况下,已配置了五种通知类型。如果您想添加自己的类型,您可以通过添加自己的条目来扩展设置 Carbon.Notification.types

有关更多详细信息,请参阅文件 Settings.Carbon.yaml

安装

通常您需要对包进行一些小的调整(例如,在 Settings.yaml 中的配置)。正因为如此,将相应的包添加到您的主题包的 composer 中很重要。通常这位于 Packages/Sites/ 下的站点包。要正确安装,请转到您的主题包(例如 Packages/Sites/Foo.Bar)并运行以下命令

composer require carbon/notification --no-update

--no-update 命令阻止依赖项的自动更新。将包添加到您的主题 composer.json 后,返回 Neos 安装的根目录并运行 composer update。就这样!您所需的包现在已正确安装。