crowetic/protocol
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Make rendering of individually exported functions lighter-weight

Browse Source
This commit is contained in:
Fabio Berger
2018-08-03 19:45:09 +02:00
parent 9337d207a1
commit d9f09b5e1e
2 changed files with 20 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
packages/react-docs/src/components/documentation.tsx
View File

@@ -211,6 +211,14 @@ export class Documentation extends React.Component<DocumentationProps, Documenta
return null;
}
const isExportedFunctionSection =
docSection.functions.length === 1 &&
_.isEmpty(docSection.types) &&
_.isEmpty(docSection.methods) &&
_.isEmpty(docSection.constructors) &&
_.isEmpty(docSection.properties) &&
_.isEmpty(docSection.events);
const sortedTypes = _.sortBy(docSection.types, 'name');
const typeDefs = _.map(sortedTypes, customType => {
return (
@@ -279,7 +287,7 @@ export class Documentation extends React.Component<DocumentationProps, Documenta
)}
{!_.isEmpty(docSection.functions) && (
<div>
<h2 style={headerStyle}>Functions</h2>
{!isExportedFunctionSection && <h2 style={headerStyle}>Functions</h2>}
<div>{functionDefs}</div>
</div>
)}

11
packages/react-docs/src/docs_info.ts
View File

@@ -52,10 +52,20 @@ export class DocsInfo {
return; // no-op
}
const isExportedFunctionSection =
docSection.functions.length === 1 &&
_.isEmpty(docSection.types) &&
_.isEmpty(docSection.methods) &&
_.isEmpty(docSection.constructors) &&
_.isEmpty(docSection.properties) &&
_.isEmpty(docSection.events);
if (!_.isUndefined(this.sections.types) && sectionName === this.sections.types) {
const sortedTypesNames = _.sortBy(docSection.types, 'name');
const typeNames = _.map(sortedTypesNames, t => t.name);
menuSubsectionsBySection[sectionName] = typeNames;
} else if (isExportedFunctionSection) {
// Noop so that we don't have the method listed underneath itself.
} else {
let eventNames: string[] = [];
if (!_.isUndefined(docSection.events)) {
@@ -76,6 +86,7 @@ export class DocsInfo {
];
}
});
console.log('menuSubsectionsBySection', menuSubsectionsBySection);
return menuSubsectionsBySection;
}
public getTypeDefinitionsByName(docAgnosticFormat: DocAgnosticFormat): { [name: string]: TypeDefinitionByName } {