Show title and description on schemas, fix #598.

This commit is contained in:
Jarosław Rzeszótko 2018-08-10 16:01:35 +02:00
parent 822d038190
commit ec3b260056
5 changed files with 156 additions and 128 deletions

View File

@ -3,13 +3,6 @@
import styled, { extensionsHook, withProps } from '../styled-components'; import styled, { extensionsHook, withProps } from '../styled-components';
import { deprecatedCss } from './mixins'; import { deprecatedCss } from './mixins';
export const PropertiesTableCaption = styled.caption`
text-align: right;
font-size: 0.9em;
font-weight: normal;
color: ${props => props.theme.colors.text.secondary};
`;
export const PropertyCell = styled.td` export const PropertyCell = styled.td`
border-left: 1px solid ${props => props.theme.schema.linesColor}; border-left: 1px solid ${props => props.theme.schema.linesColor};
box-sizing: border-box; box-sizing: border-box;

View File

@ -74,7 +74,6 @@ export class Field extends React.Component<FieldProps> {
schema={field.schema} schema={field.schema}
skipReadOnly={this.props.skipReadOnly} skipReadOnly={this.props.skipReadOnly}
skipWriteOnly={this.props.skipWriteOnly} skipWriteOnly={this.props.skipWriteOnly}
showTitle={this.props.showTitle}
/> />
</InnerPropertiesWrap> </InnerPropertiesWrap>
</PropertyCellWithInner> </PropertyCellWithInner>

View File

@ -1,10 +1,15 @@
import { observer } from 'mobx-react'; import { observer } from 'mobx-react';
import * as React from 'react'; import * as React from 'react';
import styled from '../../styled-components';
import { SchemaModel } from '../../services/models'; import { SchemaModel } from '../../services/models';
import { PropertiesTable, PropertiesTableCaption } from '../../common-elements/fields-layout'; import { PropertiesTable } from '../../common-elements/fields-layout';
import { H3 } from '../../common-elements/headers';
import { Field } from '../Fields/Field'; import { Field } from '../Fields/Field';
import { Markdown } from '../Markdown/Markdown';
import { DiscriminatorDropdown } from './DiscriminatorDropdown'; import { DiscriminatorDropdown } from './DiscriminatorDropdown';
import { SchemaProps } from './Schema'; import { SchemaProps } from './Schema';
@ -17,6 +22,18 @@ export interface ObjectSchemaProps extends SchemaProps {
}; };
} }
export const ObjectSchemaDetails = styled.div`
margin: 0 0 0.5em 0;
`;
export const ObjectSchemaTitle = styled(H3)`
margin: 0.5em 0 0 0;
`;
export const ObjectSchemaDescription = styled.div`
margin: 0.5em 0 0 0;
`;
@observer @observer
export class ObjectSchema extends React.Component<ObjectSchemaProps> { export class ObjectSchema extends React.Component<ObjectSchemaProps> {
get parentSchema() { get parentSchema() {
@ -26,7 +43,6 @@ export class ObjectSchema extends React.Component<ObjectSchemaProps> {
render() { render() {
const { const {
schema: { fields = [] }, schema: { fields = [] },
showTitle,
discriminator, discriminator,
} = this.props; } = this.props;
@ -42,8 +58,16 @@ export class ObjectSchema extends React.Component<ObjectSchemaProps> {
: fields; : fields;
return ( return (
<div>
<ObjectSchemaDetails>
<ObjectSchemaTitle>{this.props.schema.title}</ObjectSchemaTitle>
<ObjectSchemaDescription>
<Markdown dense={true} source={this.props.schema.description} />
</ObjectSchemaDescription>
</ObjectSchemaDetails>
<PropertiesTable> <PropertiesTable>
{showTitle && <PropertiesTableCaption>{this.props.schema.title}</PropertiesTableCaption>}
<tbody> <tbody>
{mapWithLast(filteredFields, (field, isLast) => { {mapWithLast(filteredFields, (field, isLast) => {
return ( return (
@ -66,12 +90,12 @@ export class ObjectSchema extends React.Component<ObjectSchemaProps> {
showExamples={false} showExamples={false}
skipReadOnly={this.props.skipReadOnly} skipReadOnly={this.props.skipReadOnly}
skipWriteOnly={this.props.skipWriteOnly} skipWriteOnly={this.props.skipWriteOnly}
showTitle={this.props.showTitle}
/> />
); );
})} })}
</tbody> </tbody>
</PropertiesTable> </PropertiesTable>
</div>
); );
} }
} }

View File

@ -11,7 +11,6 @@ import { ObjectSchema } from './ObjectSchema';
import { OneOfSchema } from './OneOfSchema'; import { OneOfSchema } from './OneOfSchema';
export interface SchemaOptions { export interface SchemaOptions {
showTitle?: boolean;
skipReadOnly?: boolean; skipReadOnly?: boolean;
skipWriteOnly?: boolean; skipWriteOnly?: boolean;
} }

View File

@ -1,7 +1,19 @@
// Jest Snapshot v1, https://goo.gl/fbAQLP // Jest Snapshot v1, https://goo.gl/fbAQLP
exports[`Components SchemaView discriminator should correctly render discriminator dropdown 1`] = ` exports[`Components SchemaView discriminator should correctly render discriminator dropdown 1`] = `
<styled.table> <div>
<styled.div>
<Styled(styled.h2)>
Dog
</Styled(styled.h2)>
<styled.div>
<Markdown
dense={true}
source=""
/>
</styled.div>
</styled.div>
<styled.table>
<tbody> <tbody>
<Field <Field
field={ field={
@ -101,5 +113,6 @@ exports[`Components SchemaView discriminator should correctly render discriminat
showExamples={false} showExamples={false}
/> />
</tbody> </tbody>
</styled.table> </styled.table>
</div>
`; `;