wulfheart/lxcd

Blade x-component 文档

维护者

详细信息

github.com/Wulfheart/lxcd

源代码

问题

安装数: 2,427

依赖项: 0

建议者: 0

安全性: 0

星星: 0

关注者: 2

分支: 0

开放问题: 0

语言：HTML

v0.1.4 2020-03-23 14:04 UTC

MIT 12a8b07cf1c10c06d95f8753c4cbc8a41546a854

  • Wulfheart <dev.woop@alexfwulf.de>

This package is auto-updated.

Last update: 2024-08-29 05:13:03 UTC

README

LXCD，即 Laravel x-Components Discovery，是一个旨在使新的 Laravel Blade x-components 可发现性的包，这样您就不必记住每一个参数。

先决条件

在开始之前，请确保您已经满足以下要求

  • 您正在使用 Laravel 7.x 或更高版本。
  • 您使用 phpDocumentor 记录代码或根本不使用系统。
  • 您没有选择退出 Laravel 的包发现。如果您可以自己注册包，我假设您能够自己注册。

安装

composer require wulfheart/lxcd

用法

基本

LXCD 集成到 phpDocumentor 的代码内文档中。要记录代码，请在组件类的 __construct 方法上添加以下注释。

/**
     * Label
     * 
     * Description
     *
     * @param   string  $var_with_default  Parameter Description {@default default_val}
     * @param   string  $var_without_default     Parameter description.
     *
     */
    public function __construct(string $var_with_default = 'default_val', string $var_without_default)
    {
        #code...
    }

这将导致以下文档

Rendered component card

您可以通过 <your-app.url>/lxcd 访问 LXCD。请注意，LXCD 还会发现组件的子文件夹。

高级

如果您使用的是与 App\View\Components 不同的组件基础命名空间或与 ./vendor/wulfheart/lxcd 不同的包安装位置，您可以通过 .env 文件覆盖 LXCD 的默认设置。

LXCD_COMPONENTS_PATH = this\is\your\custom\path\to\your\components\root
LXCD_COMPONENTS_NAMESPACE = your\custom\base\namespace

贡献

欢迎拉取请求。对于主要更改，请先打开一个问题来讨论您想要更改的内容。

如果您遇到任何问题、错误或功能请求，请随时 打开一个问题。

路线图 🚧

  • 使 blade 组件易于复制
  • 可视化预览组件（这可能相当复杂 😅）
  • ❓ 提出功能请求 [feature request]。

联系

在 Twitter 上关注我或 打开一个问题。

许可

本项目采用 MIT 许可证。请参阅 LICENSE 文件。