filament-comments - GitLite

KO | EN

gitlite — search

#python #react #ai #golang #linux #docker #awesome #cli #kubernetes #security #pytorch #mcp #ios #openai

filament-comments

(★ 135)

Add comments to your Filament Resources

파일 탐색기

최종 버전 다운로드 (.zip)

- filament-comments.jpg
- filament-comments.php
- - add_index_to_subject.php.stub
  - create_filament_comments_table.php.stub
- - index.css
- - .gitkeep
  - filament-comments.css
- - .gitkeep
  - comments.blade.php
  - component.blade.php
- - CommentsAction.php
- - CommentsComponent.php
- - FilamentComment.php
- - FilamentCommentPolicy.php
- - TestsFilamentComments.php
- FilamentCommentsPlugin.php
- FilamentCommentsServiceProvider.php
.editorconfig
.gitattributes
.gitignore
.prettierrc
CHANGELOG.md
composer.json
LICENSE.md
package-lock.json
package.json
README.md
yarn.lock

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/parallax/filament-comments

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd filament-comments

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Node.js

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.

npm install

package.json에 명시된 라이브러리들을 내려받아 설치합니다.

npm start

개발/실행 서버를 켭니다.

✅ 명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

3. PHP (Composer)

쉬움

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
PHP PHP 실행 환경이 필요합니다.
Composer PHP 라이브러리 설치를 위한 패키지 매니저입니다.

composer require parallax/filament-comments

이 명령어를 터미널에 그대로 입력해 실행하세요.

✅ php -S localhost:8000 같은 내장 서버로 실행한 뒤 브라우저에서 http://localhost:8000 으로 접속해보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Filament Comments

[![Latest Version on Packagist](https://img.shields.io/packagist/v/parallax/filament-comments?style=flat-square)](https://packagist.org/packages/parallax/filament-comments)
[![Software License](https://img.shields.io/packagist/l/parallax/filament-comments?style=flat-square)](https://raw.githubusercontent.com/parallax/filament-comments/main/LICENSE.md)
[![Total Downloads](https://img.shields.io/packagist/dt/parallax/filament-comments?style=flat-square)](https://packagist.org/packages/parallax/filament-comments)
![Stars](https://img.shields.io/github/stars/parallax/filament-comments?style=flat-square)

Add comments to your Filament Resources.

<img class="filament-hidden" src="https://github.com/parallax/filament-comments/raw/main/assets/filament-comments.jpg"/>

## Installation

Install the package via composer:

```bash
composer require parallax/filament-comments
```

Publish and run the migrations:

```bash
php artisan vendor:publish --tag="filament-comments-migrations"
php artisan migrate
```

You can publish the config file with:

```bash
php artisan vendor:publish --tag="filament-comments-config"
```

You can publish the language files with:

```bash
php artisan vendor:publish --tag="filament-comments-translations"
```

Optionally, you can publish the views using

```bash
php artisan vendor:publish --tag="filament-comments-views"
```

## Quickstart

### 1. Add model trait

First open the eloquent model you wish to add Filament Comments to.

```php
namespace App\Models;

use Parallax\FilamentComments\Models\Traits\HasFilamentComments;

class Product extends Model
{
    use HasFilamentComments;
}
```

### 2. Add comments to Filament Resource

There are 3 ways of using this plugin in your Filament Resources:

#### 1. Page actions

Open the page where you want the comments action to appear, this will most likely be the `ViewResource` page.

Add the `CommentsAction` to the `getHeaderActions()` method.

```php
<?php

namespace App\Filament\Resources\ProductResource\Pages;

use Parallax\FilamentComments\Actions\CommentsAction;

class ViewProduct extends ViewRecord
{
    protected function getHeaderActions(): array
    {
        return [
            CommentsAction::make(),
        ];
    }
}
```

You may customise the page action as you would any other action.

#### 2. Table actions

Open the resource where you want the comments table action to appear.

Add the `CommentsAction` to the `$table->actions()` method.

```php
<?php

namespace App\Filament\Resources;

use Parallax\FilamentComments\Tables\Actions\CommentsAction;

class ProductResource extends Resource
{
    public static function table(Table $table): Table
    {
        return $table
            ->actions([
                CommentsAction::make(),
            ]);
    }
}
```

You may customise the table action as you would any other action.

#### 3. Infolist entry

It's also possible to use the comments component within your infolist.

Add the `CommentsEntry` to the `$infolist->schema()` method.

```php
<?php

namespace App\Filament\Resources;

use Parallax\FilamentComments\Infolists\Components\CommentsEntry;

class ProductResource extends Resource
{
    public static function infolist(Infolist $infolist): Infolist
    {
        return $infolist
            ->schema([
                CommentsEntry::make('filament_comments'),
            ]);
    }
}
```

Please note that this cannot be used in combination with a comments action on the same page.

## Authorisation

By default, all users can view & create comments as well as only delete their own comments.

If you would like to change this behaviour you can create your own eloquent model policy for the `Parallax\FilamentComments\Models\FilamentComment` model.

You should define the policy class in the `filament-comments` config file.

```php
return [
    'model_policy' => \Parallax\FilamentComments\Policies\FilamentCommentPolicy::class,
];
```

## Pruning deleted comments

Comment records are set to be pruned after 30 days of being soft-deleted by default. You may change this value in the config file:

```php
return [
    'prune_after_days' => 30,
];
```

After configuring the model, you should schedule the `model:prune` Artisan command in your application's `Kernel` class. Don't forget to explicitly mention the `FilamentComment` class. You are free to choose the appropriate interval at which this command should be run:

```php
namespace App\Console;

use Illuminate\Foundation\Console\Kernel as ConsoleKernel;
use Parallax\FilamentComments\Models\FilamentComment;

class Kernel extends ConsoleKernel
{
    protected function schedule(Schedule $schedule)
    {
        $schedule->command('model:prune', [
            '--model' => [FilamentComment::class],
        ])->daily();
    
        // This will not work, as models in a package are not used by default
        // $schedule->command('model:prune')->daily();
    }
}
```

## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

## Credits

- [Parallax](https://parall.ax)
- [Contributors](https://github.com/parallax/filament-comments/graphs/contributors)

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.