Skip to content

feat: add skipTopLevelDescription option #206

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 14, 2022
Merged

feat: add skipTopLevelDescription option #206

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 34 additions & 1 deletion src/__tests__/__snapshots__/index.spec.tsx.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -659,7 +659,40 @@ exports[`HTML Output given write mode, should populate proper nodes 1`] = `
"
`;

exports[`HTML Output should render top-level description on allOf 1`] = `
exports[`HTML Output top level descriptions should not render top-level description when skipTopLevelDescription=true 1`] = `
"<div class=\\"\\" id=\\"mosaic-provider-react-aria-0-1\\">
<div data-overlay-container=\\"true\\">
<div class=\\"JsonSchemaViewer\\">
<div></div>
<div data-level=\\"0\\">
<div data-id=\\"862ab7c3a6663\\">
<div>
<div>
<div>
<div>foo</div>
<span>string</span>
</div>
</div>
</div>
</div>
<div data-id=\\"3d3ab69efb5e7\\">
<div>
<div>
<div>
<div>baz</div>
<span>string</span>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
"
`;

exports[`HTML Output top level descriptions should render top-level description on allOf 1`] = `
"<div class=\\"\\" id=\\"mosaic-provider-react-aria-0-1\\">
<div data-overlay-container=\\"true\\">
<div class=\\"JsonSchemaViewer\\">
Expand Down
12 changes: 10 additions & 2 deletions src/__tests__/index.spec.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ describe('HTML Output', () => {
expect(dumpDom(<JsonSchemaViewer schema={schema} />)).toMatchSnapshot();
});

it('should render top-level description on allOf', () => {
describe('top level descriptions', () => {
const schema: JSONSchema4 = {
description: 'This is a description that should be rendered',
allOf: [
Expand All @@ -188,7 +188,15 @@ describe('HTML Output', () => {
],
};

expect(dumpDom(<JsonSchemaViewer schema={schema} defaultExpandedDepth={Infinity} />)).toMatchSnapshot();
it('should render top-level description on allOf', () => {
expect(dumpDom(<JsonSchemaViewer schema={schema} defaultExpandedDepth={Infinity} />)).toMatchSnapshot();
});

it('should not render top-level description when skipTopLevelDescription=true', () => {
expect(
dumpDom(<JsonSchemaViewer schema={schema} defaultExpandedDepth={Infinity} skipTopLevelDescription />),
).toMatchSnapshot();
});
});
});

Expand Down
17 changes: 14 additions & 3 deletions src/components/JsonSchemaViewer.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ export type JsonSchemaProps = Partial<JSVOptions> & {
onTreePopulated?: (props: { rootNode: RootNode; nodeCount: number }) => void;
maxHeight?: number;
parentCrumbs?: string[];
skipTopLevelDescription?: boolean;
};

const JsonSchemaViewerComponent = ({
Expand All @@ -37,6 +38,7 @@ const JsonSchemaViewerComponent = ({
renderRootTreeLines,
disableCrumbs,
nodeHasChanged,
skipTopLevelDescription,
...rest
}: JsonSchemaProps & ErrorBoundaryForwardedProps) => {
const options = React.useMemo(
Expand Down Expand Up @@ -66,7 +68,7 @@ const JsonSchemaViewerComponent = ({
<MosaicProvider>
<JSVOptionsContextProvider value={options}>
<Provider>
<JsonSchemaViewerInner viewMode={viewMode} {...rest} />
<JsonSchemaViewerInner viewMode={viewMode} skipTopLevelDescription={skipTopLevelDescription} {...rest} />
</Provider>
</JSVOptionsContextProvider>
</MosaicProvider>
Expand All @@ -82,9 +84,18 @@ const JsonSchemaViewerInner = ({
onTreePopulated,
maxHeight,
parentCrumbs,
skipTopLevelDescription,
}: Pick<
JsonSchemaProps,
'schema' | 'viewMode' | 'className' | 'resolveRef' | 'emptyText' | 'onTreePopulated' | 'maxHeight' | 'parentCrumbs'
| 'schema'
| 'viewMode'
| 'className'
| 'resolveRef'
| 'emptyText'
| 'onTreePopulated'
| 'maxHeight'
| 'parentCrumbs'
| 'skipTopLevelDescription'
>) => {
const setHoveredNode = useUpdateAtom(hoveredNodeAtom);
const onMouseLeave = React.useCallback(() => {
Expand Down Expand Up @@ -153,7 +164,7 @@ const JsonSchemaViewerInner = ({
style={{ maxHeight }}
>
<PathCrumbs parentCrumbs={parentCrumbs} />
<TopLevelSchemaRow schemaNode={jsonSchemaTreeRoot.children[0]} />
<TopLevelSchemaRow schemaNode={jsonSchemaTreeRoot.children[0]} skipDescription={skipTopLevelDescription} />
</Box>
);
};
Expand Down
7 changes: 5 additions & 2 deletions src/components/SchemaRow/TopLevelSchemaRow.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,10 @@ import { getInternalSchemaError } from '../shared/Validations';
import { SchemaRow, SchemaRowProps } from './SchemaRow';
import { useChoices } from './useChoices';

export const TopLevelSchemaRow = ({ schemaNode }: Pick<SchemaRowProps, 'schemaNode'>) => {
export const TopLevelSchemaRow = ({
schemaNode,
skipDescription,
}: Pick<SchemaRowProps, 'schemaNode'> & { skipDescription?: boolean }) => {
const { selectedChoice, setSelectedChoice, choices } = useChoices(schemaNode);
const childNodes = React.useMemo(() => calculateChildrenToShow(selectedChoice.type), [selectedChoice.type]);
const nestingLevel = 0;
Expand All @@ -27,7 +30,7 @@ export const TopLevelSchemaRow = ({ schemaNode }: Pick<SchemaRowProps, 'schemaNo
return (
<>
<ScrollCheck />
<Description value={schemaNode.annotations.description} />
{!skipDescription ? <Description value={schemaNode.annotations.description} /> : null}
<ChildStack
schemaNode={schemaNode}
childNodes={childNodes}
Expand Down