Sort order for object properties

[kdavy]

It would be handy to be able to specify the order in which an object's properties are displayed. For example:

{"type": "object",
"options" {"properties-order": ["prop1", "prop2"]},
"properties": {"prop1" {"type": "string"}
"prop2": {"type": "string"}}}

would display prop1 before prop2. Note that if the properties are displayed in tabs (see my previous issue) then the tabs should be displayed in order as well.

[jdorn]

It currently displays properties in the order they are defined in the object, so "prop1" would already be first in your example.

As far as supporting alternative orderings, I can't do properties-order like you're suggesting because of merging problems with oneOf and $ref. What might work is an order key for each of the properties though. It would look something like this:

{
  "type": "object",
  "properties": {
    "prop1": {
      "type": "string",
      "order": 2
    },
    "prop2": {
      "type": "string",
      "order": 1
    }
  }
}

[kdavy]

That would certainly work for me.

[jdorn]

I decided to use propertyOrder instead of just order. Documentation and an example schema is here: https://github.com/jdorn/json-editor#property-ordering

There's talk of adding support for this into the next version of JSON Schema (https://groups.google.com/forum/#!topic/json-schema/rgkxYocPSVg). Their implementation might end up being different from mine. I'll keep an eye on it.

[brettz9]

I raised a concern at f7fc844#commitcomment-6596595 (Github doesn't auto-cross link such comments independently here apparently) that if editors is not an array, the iteration order may not be respected in some implementations like Chrome.

[Reggino]

@brettz9 your concern seems sound.

This schema:

{
    "type": "object",
    "properties": {
        "prop01": {
            "type": "string"
        },
        "prop02": {
            "type": "string"
        },
        "prop03": {
            "type": "string"
        },
        "prop04": {
            "type": "string"
        },
        "prop05": {
            "type": "string"
        },
        "prop06": {
            "type": "string"
        },
        "prop07": {
            "type": "string"
        },
        "prop08": {
            "type": "string"
        },
        "prop09": {
            "type": "string"
        },
        "prop10": {
            "type": "string"
        },
        "prop11": {
            "type": "string"
        }
    }
}

Renders in my up-to-date Google Chrome (35.0.1916.153) as

When prop11 is removed, the order is correct again.

@jdorn could you consider to re-open this issue?