Skip to content

Latest commit

 

History

History
59 lines (39 loc) · 1.69 KB

README.md

File metadata and controls

59 lines (39 loc) · 1.69 KB

NotifiedPhoenix

Build Status hex.pm version

Phoenix live views for notified

workbench-notifications

Installation

Add the notified_phoenix package to your list of dependencies in mix.exs:

def deps do
  [
    {:notified_phoenix, "~> 0.0.6"}
  ]
end

Usage

Live Badge

<%= live_render(@socket, NotifiedPhoenix.BadgeLive, [] %>

badge

Live List

<%= live_render(@socket, NotifiedPhoenix.ListLive, class: "my-custom-style" %>

list

Receivers

NotifiedPhoenix ships with extra receivers that can be used within modern web browsers

  • NotifiedPhoenix.Receivers.Speech - Uses the experimental SpeechSynthesis API to read the subject of the notification
  • NotifiedPhoenix.Receivers.BrowserNotification - Uses the browsers native Notification API to display a notification on the host system
config :notified, receivers: [
  {NotifiedPhoenix.Receivers.Speech, []}
  {NotifiedPhoenix.Receivers.BrowserNotification, []}
]

Authors

License

notified_phoenix is released under the MIT license