File size: 3,811 Bytes
1e92f2d |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 |
import { map, chunk } from 'lodash';
import { Children } from 'react';
import { useInView } from 'react-intersection-observer';
import ReadmeViewer from 'calypso/components/readme-viewer';
import ComponentPlayground from 'calypso/devdocs/design/component-playground';
import Placeholder from 'calypso/devdocs/devdocs-async-load/placeholder';
import { camelCaseToSlug, getComponentName } from 'calypso/devdocs/docs-example/util';
import DocsExampleWrapper from 'calypso/devdocs/docs-example/wrapper';
import { getExampleCodeFromComponent } from './playground-utils';
const shouldShowInstance = ( example, filter, component ) => {
const name = getComponentName( example );
// let's show only one instance
if ( component ) {
const slug = camelCaseToSlug( name );
return component === slug;
}
let searchPattern = name;
if ( example.props.searchKeywords ) {
searchPattern += ' ' + example.props.searchKeywords;
}
return ! filter || searchPattern.toLowerCase().indexOf( filter ) > -1;
};
const getReadmeFilePath = ( section, example ) => {
let path = example.props.readmeFilePath;
if ( ! path ) {
return null;
}
if ( ! path.startsWith( '/' ) ) {
path = `/client/${ section === 'design' ? 'components' : section }/${ path }`;
}
if ( ! path.endsWith( 'README.md' ) ) {
path = `${ path }/README.md`;
}
return path;
};
const Collection = ( {
children,
component,
examplesToMount = 10,
filter,
section = 'design',
} ) => {
let showCounter = 0;
const summary = [];
const scroll = () => {
window.scrollTo( 0, 0 );
};
const examples = Children.map( children, ( example ) => {
if ( ! example || ! shouldShowInstance( example, filter, component ) ) {
return null;
}
const exampleName = getComponentName( example );
const exampleLink = `/devdocs/${ section }/${ encodeURIComponent(
camelCaseToSlug( exampleName )
) }`;
const readmeFilePath = getReadmeFilePath( section, example );
showCounter++;
if ( filter ) {
summary.push(
<span key={ `instance-link-${ showCounter }` } className="design__instance-link">
<a href={ exampleLink }>{ exampleName }</a>
</span>
);
}
const exampleCode = getExampleCodeFromComponent( example );
if ( exampleCode ) {
return (
<div>
<ComponentPlayground
code={ exampleCode }
name={ exampleName }
unique={ !! component }
url={ exampleLink }
component={ component }
section={ section }
/>
{ component && <ReadmeViewer readmeFilePath={ readmeFilePath } /> }
</div>
);
}
return (
<div>
<DocsExampleWrapper
name={ exampleName }
unique={ !! component }
url={ exampleLink }
onTitleClick={ scroll }
>
{ example }
</DocsExampleWrapper>
{ component && <ReadmeViewer readmeFilePath={ readmeFilePath } /> }
</div>
);
} );
return (
<div className="design__collection">
{ showCounter > 1 && filter && (
<div className="design__instance-links">
<span className="design__instance-links-label">Results:</span>
{ summary }
</div>
) }
{ /* Load first chunk, lazy load all others as needed. */ }
{ examples.slice( 0, examplesToMount ) }
{ map( chunk( examples.slice( examplesToMount ), examplesToMount ), ( exampleGroup ) => {
const groupKey = map( exampleGroup, ( example ) => example.key ).join( '_' );
return (
<LazyExampleGroup
key={ groupKey }
exampleGroup={ exampleGroup }
examplesToMount={ examplesToMount }
/>
);
} ) }
</div>
);
};
function LazyExampleGroup( { exampleGroup, examplesToMount } ) {
const { ref, inView } = useInView( {
triggerOnce: true,
} );
return (
<div ref={ ref }>{ inView ? exampleGroup : <Placeholder count={ examplesToMount } /> }</div>
);
}
export default Collection;
|