Change 'order' prop to 'propertyOrder'

Author: jamesej

README.md

@@ -154,7 +154,7 @@ JSON schema is an extremely powerful descriptive language and this package while
 | object: maxProperties | Implemented as validation |
 | object: dependencies | Not supported |
 | object: patternProperties | Not supported |
-| object: order | NON-STANDARD. This custom keyword should be followed by a list of property names as strings or sublists of the same. It has no effect on validation. It allows specification of the order in which properties are displayed in the data entry form. See below for how orders are merged with combined schemas. Sublists are rendered contained within an outer div to allow more control over layout. |
+| object: propertyOrder | NON-STANDARD. This custom keyword should be followed by a list of property names as strings or sublists of the same. It has no effect on validation. It allows specification of the order in which properties are displayed in the data entry form. See below for how orders are merged with combined schemas. Sublists are rendered contained within an outer div to allow more control over layout. |
 | object: currencySymbol | NON-STANDARD. This custom keyword can only be present on the top-level schema object. It determines the string used as a currency prefix for the currency editor. |
 | object: additionalProperties | Assumed to be true when validating, and false when constructing a UI. See below for more. This means that additionalProperties: false in a schema is not supported. |
 | array: items | This schema is used to render each subsection of the array. Tuple validation (where items is a list of schemas) is not supported. |

example/src/App.js

@@ -48,7 +48,7 @@ const schema = {
       required: [ "postcode" ]
     }
   },
-  order: [ "salutation", [ "firstName", "lastName" ], "canContact", "preferredContact", "dateOfBirth", "password", "comments", "files", "things", "address" ],
+  propertyOrder: [ "salutation", [ "firstName", "lastName" ], "canContact", "preferredContact", "dateOfBirth", "password", "comments", "files", "things", "address" ],
   if: {
     type: "object", properties: {
       salutation: { type: "string", const: "Dr" }
@@ -58,7 +58,7 @@ const schema = {
     type: "object", properties: {
       isMedical: { type: "boolean" }
     },
-    order: [ "canContact", "isMedical" ]
+    propertyOrder: [ "canContact", "isMedical" ]
   }
 }
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@restspace/schema-form",
-  "version": "1.0.14",
+  "version": "1.0.15",
   "description": "JSON Schema based form generator in React",
   "author": "James Ellis-Jones",
   "license": "MIT",

src/components/schema-form-object.tsx

@@ -60,10 +60,10 @@ export function SchemaFormObject({
         return <></>;
     }
 
-    let topOrder: NestedListArray = schema['order'] || Object.keys(schema['properties'] || {});
+    let topOrder: NestedListArray = schema['propertyOrder'] || Object.keys(schema['properties'] || {});
     let properties = Object.entries(schema['properties'] || {});
     let requireds = schema['required'];
-    if (schema['order'] && _.flatten(schema['order']).length < properties.length) {
+    if (schema['propertyOrder'] && _.flatten(schema['propertyOrder']).length < properties.length) {
         console.log('fewer items in order than properties at ' + path.join('.'));
     }
     const collapsible = (context.collapsible && path.length > 0) || false;

src/schema/schema.ts

@@ -125,11 +125,11 @@ export function conjoin(schema0: object | null, schema1: object | null): object
                     }
                 }
                 break;
-            case 'order': 
-                if (!schema['order']) {
-                    schema['order'] = schema1['order']
+            case 'propertyOrder': 
+                if (!schema['propertyOrder']) {
+                    schema['propertyOrder'] = schema1['propertyOrder']
                 } else {
-                    schema['order'] = mergeOrders(schema['order'], schema1['order']);
+                    schema['propertyOrder'] = mergeOrders(schema['propertyOrder'], schema1['propertyOrder']);
                 }
                 break;
             case 'items':