https://github.com/strophe/strophejs-plugin-dataforms

https://github.com/strophe/strophejs-plugin-dataforms

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/strophe/strophejs-plugin-dataforms
• Owner: strophe
• Created: 2017-01-25T13:41:34.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2020-04-24T11:09:02.000Z (about 6 years ago)
• Last Synced: 2025-06-06T20:43:13.350Z (11 months ago)
• Size: 70.3 KB
• Stars: 0
• Watchers: 13
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.markdown

Awesome Lists containing this project

README

          
# strophe.x.js

strophe.x.js is a plugin to provide Data Forms

( [XEP-0004](http://xmpp.org/extensions/xep-0004.html) ).

## Usage

### Creating data elements

Creating a form is easy:

    new Strophe.x.Form({

      type: "submit",

      title: "myTitle",

      instructions: "Tell something",

      fields: [f1, f2]

    });

You can call the constructor for Forms directly with $form:

    $form({

      ...

    });

You can also use items within the form:

    $form({

      type: "result",

      title: "Search result",

      items: [ item1, { fields: [f1,f5]}, item3 ]

    });

Here you don't have to define the `reported` property (it is generated

automatically).

Creating fields is similar

    new Strophe.x.Field({

      type: "text-single",

      "var": "myVariableName",

      desc: "a description",

      label: "My Label",

      required: true,

      value: 1234

    });

Fields also have a shorthand:

    $field({

      ...

    });

You can also use options

    $field({

      type: "list-multi",

      "var": "myVariableName",

      desc: "a description",

      label: "My Label",

      required: true,

      values: ["a", "c"],

      options: [

        {label:"One", value: "a"},

        {label:"Two", value: "b"},

        {label:"Three", value: "c"}

    ]});

### Convert to XML, HTML or JSON

Every object can be converted to xml by using the `toXML`, `toHML` or `toJSON` function

### Parse XML

You can easily create a form by parsing XML:

    var Form = Strophe.x.Form.fromXML(xml);

The same can be done with `fromHML` for HTML as source.

## Dependencies

- jQuery