\n\nFor further documentation please read [the old package's documentation](https://github.com/ExMachinaSAGL/sentioo).\n\n## Package installation and use\nInstall in your project as a NPM dependency:\n```\n#Install in your project as a NPM dependency:\nyarn add sentioo-vue-3\n``` \n\n```\n# In your \"main.ts\" (or main.js) file:\nimport 'sentioo-vue-3/dist/lib/sentioo.css';\nimport ExmSentioo from 'sentioo-vue-3';\ncreateApp(App).use(ExmSentioo).mount('#app');\n\n# In your \"component.vue\" file:\n\n```\n\nWhere ```serverUrl``` is the endpoint pointing to your server's SSE notification service.\n\n```\n# In a Quasar Framework boot file:\nimport 'sentioo-vue-3/dist/lib/sentioo.css';\nimport ExmSentioo from 'sentioo-vue-3';\n\nexport default ({ app }) => {\n app.use(ExmSentioo);\n};\n```\n\n## Development\n```\n# install dependencies\nyarn install\n```\n\n## Compiles and hot-reloads for development\n```App.vue``` file instantiate the component in two ways:\n1. the deployed NPM package version: (useful to test the deployed version)\n2. the local component implementation: (useful during development)\n\n```\n# Run in develoment mode:\nyarn serve\n```\nThe default configuration starts a local dev server on ```http://localhost:8080```.\n\n## Developing, building, and deploying a release\n```\n# 1. Write your code, then update the package version in package.json\n\"version\": \"0.8.3\"\n\n# 2. Build as a library:\nyarn build:lib\n\n# 3. Commit and push your changes on git repo\n\n# 4. Publish on NPM\nnpm publish\n\n# 5. Update your project's dependency, depending on your needs:\nyarn remove sentioo-vue-3\nyarn add sentioo-vue-3\n```\n\n## Test server\nYou can run a test server, which sends a predefined notification, using the ```test_see_server.js```file.\nJust run in your terminal:\n```\nnode test_sse_server.js\n```\n\nThe NodeJs server starts on port 3000, and listens for connections (CORS enabled) from origin ```http://localhost:8080```.\nThe policy is defined by: 'Access-Control-Allow-Origin': 'http://localhost:8080'.\n\n## Server response body\n[Event stream format](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format)\n```\n:\\n\n:\\n\n:\\n\\n\n```\n\nExample response\n```\nevent: notify\\n\nid: 123\\n\ndata: { \"title\": \"Notification Title\",\n \"text\": \"Lorem ipsum.\",\n \"priority\": 2,\n \"id\": \"1345f488-5aaa-4c4b-9076-f3eb12905556\",\n \"unread\": true,\n \"time\": \"Fri, 15 Dec 2017 08:53:12 GMT\" }\\n\\n\n```\n\nThe connection is kept open, and new events should be sent\nto the same connection using the specified format.\n\n### Notification format\n```js\n{\n \"title\": \"Notification Title\",\n \"text\": \"Notification text content\",\n \"priority\": 2, // priority level of the notification\n \"id\": \"unique ID\",\n \"unread\": true,\n \"time\": \"Fri, 15 Dec 2017 08:53:12 GMT\",\n \"type\": \"broadcast\" // OPTIONAL\n}\n```\nAll fields are mandatory, except for the type.\n\nThe `text` field can contain html tags and they will be rendered (e.g. links). Be aware that this may be unsafe if the notification contents are user generated.\n\nThe `type` field is completely optional, and in our implementation is used to avoid potential collisions between notification IDs generated by the backend, since in our case they are stored in multiple tables. This issue is very implementation-specific, and therefore for most use cases that field can be left empty.\n\n## Possible additional requirements for older browsers\nSee [EventSource polyfill docs](https://github.com/Yaffle/EventSource#server-side-requirements)\n\n## EventSource references\nhttps://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events\nhttps://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events\nhttps://developer.mozilla.org/en-US/docs/Web/API/EventSource\n\n## License\nCopyright 2018 ExMachina SAGL (http://www.exmachina.ch)\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.","readmeFilename":"README.md"}
![\"The](\"https://github.com/ExMachinaSAGL/sentioo-next/blob/main/dropdown.png\")
\n