Skip to content

fix(compat): allow file/deep imports for components #6394

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.

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 3 commits into from
Sep 23, 2024
Merged
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .storybook/components/DocsHeader.tsx
Original file line number Diff line number Diff line change
@@ -48,7 +48,7 @@ export const InfoTable = ({ since, subComponents, mergeSubComponents }: InfoTabl
const wcSubComponents = useGetSubComponentsOfModule(moduleName.replace('V2', ''));
const subComps = mergeSubComponents
? [...(subComponents ?? []), ...(wcSubComponents ?? [])]
: subComponents ?? wcSubComponents;
: (subComponents ?? wcSubComponents);

const supportsClipboardApi = typeof ClipboardItem !== 'undefined';

94 changes: 69 additions & 25 deletions .storybook/components/Import.tsx
Original file line number Diff line number Diff line change
@@ -11,11 +11,41 @@ interface ImportStatementPropTypes {
*/
packageName: string;
}
interface DeepPath {
path: string;
moduleName: string;
}
interface FromPathPropTypes extends Pick<ImportStatementPropTypes, 'packageName'> {
deepPath?: null | undefined | DeepPath;
}

function FromPath({ packageName, deepPath }: FromPathPropTypes) {
return (
<>
<span style={{ color: 'rgb(0, 0, 136)', fontSize: '14px' }}>from</span>
<span> </span>
<span style={{ color: 'rgb(0, 136, 0)', fontSize: '14px' }}>
{deepPath ? packageName.slice(0, -1) : packageName}
{deepPath && deepPath.path}
{deepPath && "'"}
</span>
<span style={{ fontSize: '14px' }}>;</span>
{deepPath && <br />}
</>
);
}

export const ImportStatement = ({ moduleNames, packageName }: ImportStatementPropTypes) => {
if (!moduleNames) {
return null;
}
const isCompat = packageName.includes('compat');
const paths = isCompat
? moduleNames.map((item) => {
return { path: `/dist/components/${item}/index.js`, moduleName: item };
})
: [null];

return (
<pre
data-import
@@ -31,32 +61,46 @@ export const ImportStatement = ({ moduleNames, packageName }: ImportStatementPro
}}
>
<code style={{ whiteSpace: 'pre' }}>
<span style={{ color: 'rgb(0, 0, 136)', fontSize: '14px' }}>import</span>
<span style={{ fontSize: '14px' }}>
{' '}
{'{'}
{moduleNames.length > 2 ? (
<>
{moduleNames.map((item) => {
return (
<Fragment key={item}>
{!paths[0] && <span style={{ color: 'rgb(0, 0, 136)', fontSize: '14px' }}>import</span>}
{paths.map((deepPath) => {
if (!deepPath) {
return (
<span style={{ fontSize: '14px' }}>
{' '}
{'{'}
{moduleNames.length > 2 ? (
<>
{moduleNames.map((item) => {
return (
<Fragment key={item}>
<br />
&nbsp;&nbsp;
{item},
</Fragment>
);
})}
<br />
&nbsp;&nbsp;
{item},
</Fragment>
);
})}
<br />
</>
) : (
<>&nbsp;{moduleNames.join(', ')}&nbsp;</>
)}
{'}'}{' '}
</span>
<span style={{ color: 'rgb(0, 0, 136)', fontSize: '14px' }}>from</span>
<span> </span>
<span style={{ color: 'rgb(0, 136, 0)', fontSize: '14px' }}>{packageName}</span>
<span style={{ fontSize: '14px' }}>;</span>
</>
) : (
<>&nbsp;{moduleNames.join(', ')}&nbsp;</>
)}
{'}'}{' '}
</span>
);
} else {
return (
<>
<span style={{ color: 'rgb(0, 0, 136)', fontSize: '14px' }}>import</span>
<span style={{ fontSize: '14px' }}>
{' '}
{'{'}&nbsp;{deepPath.moduleName}&nbsp;{'}'}{' '}
</span>
<FromPath packageName={packageName} deepPath={deepPath} />
</>
);
}
})}
{!paths[0] && <FromPath packageName={packageName} />}
</code>
</pre>
);
4 changes: 3 additions & 1 deletion packages/compat/package.json
Original file line number Diff line number Diff line change
@@ -12,7 +12,9 @@
"default": "./dist/index.js"
},
"./package.json": "./package.json",
"./styles.css": "./dist/css/index.css"
"./styles.css": "./dist/css/index.css",
"./dist/*": "./dist/*",
"./dist/*.js": "./dist/*.js"
},
"homepage": "https://sap.github.io/ui5-webcomponents-react",
"repository": {
Loading