Download the PHP package xcoorp/laravel-webpush-notifications without Composer
On this page you can find all versions of the php package xcoorp/laravel-webpush-notifications. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download xcoorp/laravel-webpush-notifications
More information about xcoorp/laravel-webpush-notifications
Files in xcoorp/laravel-webpush-notifications
Package laravel-webpush-notifications
Short Description Web Push Notifications channel for Laravel.
License MIT
Homepage https://github.com/xcoorp/laravel-webpush-notifications
Informations about the package laravel-webpush-notifications
WebPush - Laravel Notification Channel
This package makes it easy to send notifications using Web Push API ``
Contents
- Installation
- Publish Configuration and Migrations
- Configuration
- Usage
- API Overview
- WebPush Message
- Testing
- License
Installation
The Web Push notification channel can be installed easily via Composer:
`
Publishing Configuration and Migrations
After installing the package, you can publish the configuration file and migrations by running the following command:
`
After publishing the migrations you should migrate your database:
`
After publishing the configuration file, you should configure the vapid
keys in your .env
file:
`
You can generate the vapid keys using the following command:
`
Configuration
The config/webpush-notifications.php
configuration file allows you to configure the default Web Push options for your application.
You can define custom Models to use, and the vapid keys to use for the Web Push API.
If you define a custom UsereWebPushSubscription
model you need to make sure it extends the UsereWebPushSubscription
model shipped with this package.
Usage
In order to send a notification via the WebPush channel, you'll need to specify the channel in the via()
method of your notification:
``
API Overview
WebPush Message
Namespace: NotificationChannels\WebPush\WebPushMessage
The WebPushMessage
class encompasses an entire message that will be sent to the Web Push API.
title(string $title)
Set thetitle
of the messageaction(string $title, string $action, ?string $icon = null))
Set theaction
of the messagebadge(string $badge)
Set the url to thebadge
image of the messagebody(string $body)
Set thebody
of the messagedir(string $dir)
Set the text-directiondir
of the messageicon(string $icon)
Set the url to theicon
of the messageimage(string $image)
Set the url to theimage
of the messagelang(string $lang)
Set the Languagelang
of the messagerenotify(bool $renotify)
specifies whether the user should be notified after a new notification replaces an old onerequireInteraction(bool $requireInteraction)
specifies whether the notification requires interactiontag(string $value)
Set thetag
of the messagevibrate(array $vibrate)
Set the vibration patternvibrate
of the messagedata(mixed $value)
Set thedata
of the messageoptions(array $options)
Set theoptions
of the message (See here for more information)toArray()
Returns the data that will be sent to the WebPush API as an array
Code of Conduct
In order to ensure that the community is welcoming to all, please review and abide by the Code of Conduct.
Security Vulnerabilities
Please review the security policy on how to report security vulnerabilities.
License
The MIT License (MIT). Please see License File for more information.
All versions of laravel-webpush-notifications with dependencies
illuminate/notifications Version ^11
illuminate/support Version ^11
illuminate/contracts Version ^11.0
illuminate/container Version ^11.0
illuminate/config Version ^11.0
minishlink/web-push Version ^9