netflex/newsletter-foundation

Netflex新闻通讯的模板和组件

v1.0.10 2024-08-23 07:56 UTC

README

文档和功能仍在开发中!

用于新闻通讯和组件的模板和标记,便于与Netflex营销集成。

安装

使用composer安装,命令为composer require netflex/newsletter-foundation。该软件包将安装标准组件,但不包括页眉和页脚。

编辑配置

要编辑配置,首先使用php artisan vendor:publish --tag=config将配置文件复制到您的项目。配置可以在config/newsletter-foundation.php中找到。配置对不同的设置提供了上下文。

在Netflex中设置模板和组件

要在Netflex中注册默认模板,使用artisan命令php artisan nnf:register:template (尚未实现) 这将在resources/views/newsletters中创建一个视图,并在Netflex中将其注册为默认新闻通讯模板。

要在Netflex中注册该软件包中的所有组件,使用命令php artisan nnf:register:components (尚未实现) 请注意,必须手动在netflex中添加组件图像,因为不支持通过API添加。

要手动注册使用基础模板的模板,在您的resources/views/newsletters文件夹中添加以下内容的视图

@include('netflex-newsletter-foundation::templates.foundation')

这包括来自软件包的基础模板。您可以在Netflex中正常注册该模板。

您还可以使用以下方式扩展基础布局:

@extends('netflex-newsletter-foundation::layouts.foundation')

如果您想在Netflex中注册软件包中的一个组件,应使用前缀netflex-newsletter-foundation::作为路径的一部分,例如netflex-newsletter-foundation::one-column

请记住,在Netflex中注册的所有组件以及所有添加到新闻通讯模板的块构建区域中,都要在代码字段中填写“newsletter_component”,以从页面构建模板中过滤这些组件。

基本组件

基本组件是作为组件内部构建块使用的基础块。它们不能直接添加为可编辑的组件。

默认组件

以下组件作为默认值包含在内

自定义默认组件

您可以使用命令php artisan vendor:publish --tag=views将资产发布到您的项目。这将复制模板、布局和组件到resources/views/vendor/netflex-newsletter-foundation

扩展

要实现您自己的组件,您可以在使用项目中的组件时,使用前缀netflex-newsletter-foundation::重用现有的匿名基础组件,例如<x-netflex-newsletter-foundation::default-content />。对于使用类组件,请使用x-netflex-newsletter-foundation-,例如<x-netflex-newsletter-foundation-image />