FastComments.com

Add Comments to Your Laravel App


Este é o pacote oficial do Laravel para o FastComments.

Adicione comentários ao vivo, chat e mais à sua aplicação Laravel.

Repositório

Ver no GitHub


Requisitos Internal Link


  • PHP 8.1+
  • Laravel 10, 11, ou 12

Instalação Internal Link

composer require fastcomments/laravel

Publique o arquivo de configuração:

php artisan vendor:publish --tag=fastcomments-config

Adicione suas credenciais ao .env:

FASTCOMMENTS_TENANT_ID=your-tenant-id
FASTCOMMENTS_API_KEY=your-api-key

Para a região da UE:

FASTCOMMENTS_REGION=eu

Componentes Blade Internal Link


Widget de Comentários

<x-fastcomments />

{{-- Com opções --}}
<x-fastcomments
    url-id="my-page-id"
    url="https://example.com/my-page"
    locale="en_us"
    :has-dark-background="true"
    default-sort-direction="MR"
/>

Chat ao Vivo

<x-fastcomments-live-chat url-id="chat-room-1" />

Contagem de Comentários

<x-fastcomments-comment-count url-id="my-page-id" />
<x-fastcomments-comment-count url-id="my-page-id" :number-only="true" />

SSO Internal Link

Habilite SSO no seu .env:

FASTCOMMENTS_API_KEY=your-api-key
FASTCOMMENTS_SSO_ENABLED=true
FASTCOMMENTS_SSO_MODE=secure

A chave de API é necessária para SSO seguro — ela é usada para assinar o payload de SSO.

Mapeamento baseado em configuração

Em config/fastcomments.php, mapeie os campos do FastComments para os atributos do seu modelo User:

'sso' => [
    'enabled' => true,
    'mode' => 'secure',
    'user_map' => [
        'id' => 'id',
        'email' => 'email',
        'username' => 'name',
        'avatar' => 'profile.avatar_url', // notação de ponto suportada
    ],
    'is_admin' => fn ($user) => $user->hasRole('admin'),
    'is_moderator' => fn ($user) => $user->hasRole('moderator'),
],

Mapeamento baseado em Interface

Para mais controle, implemente a interface MapsToFastCommentsUser no seu modelo User:

use FastComments\Laravel\SSO\Contracts\MapsToFastCommentsUser;

class User extends Authenticatable implements MapsToFastCommentsUser
{
    public function toFastCommentsUserData(): array
    {
        return [
            'id' => (string) $this->id,
            'email' => $this->email,
            'username' => $this->display_name,
            'avatar' => $this->avatar_url,
            'is_admin' => $this->hasRole('admin'),
        ];
    }
}

Quando a interface for implementada, ela tem precedência sobre o mapeamento baseado em configuração.

SSO no Blade

Quando o SSO está habilitado, o <x-fastcomments /> component automaticamente injeta os dados de SSO para o usuário autenticado.

Acesso à API Internal Link

Via Facade

use FastComments\Laravel\Facades\FastComments;

// API de administrador (requer chave de API)
$comments = FastComments::admin()->getComments('tenant-id');

// API pública
$comments = FastComments::publicApi()->getCommentsPublic('tenant-id', 'url-id');

// SSO
$ssoPayload = FastComments::sso()->forWidget();
$token = FastComments::sso()->tokenFor($user);

Via Injeção de Dependência

use FastComments\Laravel\FastCommentsManager;

class CommentController extends Controller
{
    public function index(FastCommentsManager $fc)
    {
        $comments = $fc->admin()->getComments($fc->tenantId());
        // ...
    }
}

Acesso Direto ao SDK

use FastComments\Client\Api\DefaultApi;

class CommentController extends Controller
{
    public function index(DefaultApi $api)
    {
        $comments = $api->getComments('tenant-id');
        // ...
    }
}

Referência de Configuração Internal Link


Chave Variável de Ambiente Padrão Descrição
tenant_id FASTCOMMENTS_TENANT_ID '' Seu ID de tenant do FastComments
api_key FASTCOMMENTS_API_KEY '' Chave de API para chamadas do lado do servidor
region FASTCOMMENTS_REGION null null (EUA) ou 'eu'
sso.enabled FASTCOMMENTS_SSO_ENABLED false Ativar SSO
sso.mode FASTCOMMENTS_SSO_MODE 'secure' 'secure' ou 'simple'
sso.login_url FASTCOMMENTS_SSO_LOGIN_URL null URL de login (usa a rota do Laravel como fallback)
sso.logout_url FASTCOMMENTS_SSO_LOGOUT_URL null URL de logout (usa a rota do Laravel como fallback)
widget_defaults [] Opções de configuração padrão do widget
---

Personalizando visualizações Internal Link

Para personalizar o template Blade:

php artisan vendor:publish --tag=fastcomments-views

Os templates serão publicados em resources/views/vendor/fastcomments/.

Precisa de ajuda?

Se você encontrar algum problema ou tiver perguntas sobre o Laravel Package, por favor:

Contribuindo

Contribuições são bem-vindas! Por favor, visite o repositório do GitHub para as diretrizes de contribuição.