Custom element providing a XMPP client
Based on strophe.js
Install the component using Bower:
$ bower install xmpp-client --save
Or download as ZIP.
-
Import Web Components polyfill:
<script src="bower_components/platform/platform.js"></script>
-
Import Custom Element:
<link rel="import" href="bower_components/xmpp-client/dist/xmpp-client.html">
-
Start using it!
<xmpp-client jid="test@jabber.org" password="xyz" />
Attribute | Options | Default | Description |
---|---|---|---|
jid |
string | `` | The jid to use |
pass |
string | `` | The password (you probably want to set this imperatively) |
endpoint |
string | '/xmpp-httpbind' | endpoint to connect |
online |
boolean | true |
start connected? |
Method | Parameters | Returns | Description |
---|---|---|---|
connect() |
None. | Nothing. | Open connection |
disconnect() |
None. | Nothing. | Close connection |
send(jid,msg) |
jid target, msg (string) |
Nothing. | send text message |
sendRaw(jid,xml) |
jid target, xml Raw stanza as XML string |
Nothing. | send custom stanza |
setPresence(msg) |
msg presence string |
Nothing. | set presence |
Event | Description |
---|---|
onStanza |
Triggers when incoming stanza |
onConnect |
Triggers when connection status changes |
In order to run it locally you'll need to fetch some dependencies and a basic server setup.
-
$ [sudo] npm install -g bower grunt-cli
-
Install local dependencies:
$ bower install && npm install
-
To test your project, start the development server and open
http://localhost:8000
.$ grunt server
-
To build the distribution files before releasing a new version.
$ grunt build
-
To provide a live demo, send everything to
gh-pages
branch.$ grunt deploy
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature
- Commit your changes:
git commit -m 'Add some feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull request :D
For detailed changelog, check Releases.