Add direction prop to StatePropsOfLayout (#1404)

* Add direction prop to LayoutProps
* Update layout default props
* [material] Update group renderer

Author: Lily

packages/core/src/util/renderer.ts

@@ -202,6 +202,10 @@ export interface OwnPropsOfEnum {
   options?: any[];
 }
 
+export interface OwnPropsOfLayout extends OwnPropsOfRenderer {
+  direction?: 'row' | 'column';
+}
+
 /**
  * State-based props of a {@link Renderer}.
  */
@@ -319,6 +323,11 @@ export interface StatePropsOfLayout extends StatePropsOfRenderer {
    * All available renderers.
    */
   renderers?: any[];
+
+  /**
+   * Direction for the layout to flow
+   */
+  direction: 'row' | 'column';
 }
 
 export interface LayoutProps extends StatePropsOfLayout {}
@@ -609,10 +618,16 @@ export interface ArrayControlProps
   extends StatePropsOfArrayControl,
     DispatchPropsOfArrayControl {}
 
-export const layoutDefaultProps = {
+export const layoutDefaultProps: {
+  visible: boolean;
+  enabled: boolean;
+  path: string;
+  direction: 'row' | 'column';
+} = {
   visible: true,
   enabled: true,
-  path: ''
+  path: '',
+  direction: 'column'
 };
 
 /**
@@ -623,8 +638,8 @@ export const layoutDefaultProps = {
  */
 export const mapStateToLayoutProps = (
   state: JsonFormsState,
-  ownProps: OwnPropsOfJsonFormsRenderer
-): StatePropsOfLayout => {
+  ownProps: OwnPropsOfLayout
+): LayoutProps => {
   const rootData = getData(state);
   const visible: boolean = has(ownProps, 'visible')
     ? ownProps.visible
@@ -640,7 +655,8 @@ export const mapStateToLayoutProps = (
     enabled,
     path: ownProps.path,
     uischema: ownProps.uischema,
-    schema: ownProps.schema
+    schema: ownProps.schema,
+    direction: ownProps.direction || layoutDefaultProps.direction
   };
 };
 

packages/material/src/layouts/MaterialGroupLayout.tsx

@@ -58,15 +58,15 @@ const GroupComponent = React.memo(({ visible, uischema, ...props }: MaterialLayo
   );
 });
 
-export const MaterializedGroupLayoutRenderer = ({ uischema, schema, path, visible, renderers }: LayoutProps) => {
+export const MaterializedGroupLayoutRenderer = ({ uischema, schema, path, visible, renderers, direction }: LayoutProps) => {
   const groupLayout = uischema as GroupLayout;
 
   return (
     <GroupComponent
       elements={groupLayout.elements}
       schema={schema}
       path={path}
-      direction={'column'}
+      direction={direction}
       visible={visible}
       uischema={uischema}
       renderers={renderers}

packages/material/test/renderers/MaterialGroupLayout.test.tsx

@@ -0,0 +1,52 @@
+import * as React from 'react';
+import Enzyme, { mount } from 'enzyme';
+import Adapter from 'enzyme-adapter-react-16';
+import MaterialGroupLayout from '../../src/layouts/MaterialGroupLayout';
+import { MaterialLayoutRenderer } from '../../src/util/layout';
+
+Enzyme.configure({ adapter: new Adapter() });
+
+const schema = {
+  type: 'object',
+  properties: {
+    name: {
+      type: 'string',
+      minLength: 3,
+      description: 'Please enter your name'
+    },
+    birthDate: {
+      type: 'string',
+      format: 'date',
+      description: 'Please enter your birth date.'
+    }
+  }
+};
+
+const uischema = {
+  type: 'Group',
+  label: 'My Group',
+  elements: [
+    {
+      type: 'Control',
+      label: 'Name',
+      scope: '#/properties/name'
+    },
+    {
+      type: 'Control',
+      label: 'Birth Date',
+      scope: '#/properties/birthDate'
+    }
+  ]
+};
+
+describe('Material group layout', () => {
+  it('should render a GroupComponent with direction column when given no direction LayoutProp', () => {
+    const wrapper = mount(<MaterialGroupLayout schema={schema} uischema={uischema} />)
+    expect(wrapper.find(MaterialLayoutRenderer).props().direction).toBe('column')
+  })
+
+  it('should render a GroupComponent with direction row when this is provided as a direction prop', () => {
+    const wrapper = mount(<MaterialGroupLayout schema={schema} uischema={uischema} direction={'row'} />)
+    expect(wrapper.find(MaterialLayoutRenderer).props().direction).toBe('row')
+  })
+})

packages/react/src/JsonFormsContext.tsx

@@ -54,6 +54,7 @@ import {
   OwnPropsOfEnumCell,
   OwnPropsOfJsonFormsRenderer,
   OwnPropsOfMasterListItem,
+  OwnPropsOfLayout,
   rendererReducer,
   StatePropsOfCombinator,
   StatePropsOfControlWithDetail,
@@ -135,7 +136,7 @@ export const ctxToArrayLayoutProps = (ctx: JsonFormsStateContext, props: OwnProp
 export const ctxToArrayControlProps = (ctx: JsonFormsStateContext, props: OwnPropsOfControl) =>
   mapStateToArrayControlProps({ jsonforms: { ...ctx } }, props);
 
-export const ctxToLayoutProps = (ctx: JsonFormsStateContext, props: OwnPropsOfJsonFormsRenderer): LayoutProps =>
+export const ctxToLayoutProps = (ctx: JsonFormsStateContext, props: OwnPropsOfLayout): LayoutProps =>
   mapStateToLayoutProps({ jsonforms: { ...ctx } }, props);
 
 export const ctxToControlProps = (ctx: JsonFormsStateContext, props: OwnPropsOfControl) =>
@@ -207,7 +208,7 @@ export const ctxToCellProps = (
   return mapStateToCellProps({ jsonforms: { ...ctx } }, ownProps);
 }
 
-export const withJsonFormsLayoutProps = (Component: ComponentType<LayoutProps>): ComponentType<OwnPropsOfJsonFormsRenderer> => (props: LayoutProps) => {
+export const withJsonFormsLayoutProps = (Component: ComponentType<LayoutProps>): ComponentType<OwnPropsOfLayout> => (props: LayoutProps) => {
   const ctx = useJsonForms();
   const layoutProps = ctxToLayoutProps(ctx, props);
   return (

packages/vanilla/src/complex/categorization/CategorizationRenderer.tsx

@@ -1,19 +1,19 @@
 /*
   The MIT License
-  
+
   Copyright (c) 2017-2019 EclipseSource Munich
   https://github.com/eclipsesource/jsonforms
-  
+
   Permission is hereby granted, free of charge, to any person obtaining a copy
   of this software and associated documentation files (the "Software"), to deal
   in the Software without restriction, including without limitation the rights
   to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   copies of the Software, and to permit persons to whom the Software is
   furnished to do so, subject to the following conditions:
-  
+
   The above copyright notice and this permission notice shall be included in
   all copies or substantial portions of the Software.
-  
+
   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
@@ -26,7 +26,7 @@ import React from 'react';
 import {
   Categorization,
   Category,
-  RendererProps
+  LayoutProps
 } from '@jsonforms/core';
 import { RendererComponent, withJsonFormsLayoutProps } from '@jsonforms/react';
 import { CategorizationList } from './CategorizationList';
@@ -40,7 +40,7 @@ export interface CategorizationState {
 }
 
 class CategorizationRenderer extends RendererComponent<
-  RendererProps & VanillaRendererProps,
+  LayoutProps & VanillaRendererProps,
   CategorizationState
 > {
   onCategorySelected = (category: Category) => () => {