miel.truyen/nx
1
0
Fork 0
Code Issues Pull Requests Actions 5 Packages Projects Releases Wiki Activity

docs(core): add flavor picker non-flavor specific routes (#5831)

Browse Source
This commit is contained in:
Jack Hsu 2021-05-28 23:34:46 -04:00 committed by GitHub
parent e85172ed21
commit ea9bf19cb0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 97 additions and 66 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
nx-dev/nx-dev/next.config.js
View File

@ -1,14 +1,4 @@
// eslint-disable-next-line @typescript-eslint/no-var-requires
const withNx = require('@nrwl/next/plugins/with-nx');
module.exports = withNx({
async redirects() {
return [
{
source: '/:version',
destination: '/',
permanent: true,
},
];
},
});
module.exports = withNx({});

123
nx-dev/nx-dev/pages/[...segments].tsx
View File

@ -1,3 +1,4 @@
import { Dialog } from '@headlessui/react';
import type {
DocumentData,
Menu,
@ -9,7 +10,8 @@ import { useRouter } from 'next/router';
import { documentsApi, menuApi } from '../lib/api';
import { useStorage } from '../lib/use-storage';
import { useEffect } from 'react';
import React, { useEffect, useState } from 'react';
import Link from 'next/link';
const versionList = documentsApi.getVersions();
const defaultVersion = versionList[0];
@ -18,7 +20,7 @@ const defaultFlavor = {
value: 'react',
};
interface DocumentationProps {
interface DocumentationPageProps {
version: VersionMetadata;
flavor: { label: string; value: string };
flavors: { label: string; value: string }[];
@ -28,11 +30,7 @@ interface DocumentationProps {
isFallback: boolean;
}
interface DocumentationParams {
params: { segments: string[] };
}
export function Documentation({
export function DocumentationPage({
document,
menu,
version,
@ -40,33 +38,39 @@ export function Documentation({
flavor,
flavors,
isFallback,
}: DocumentationProps) {
}: DocumentationPageProps) {
const router = useRouter();
const { value: storedFlavor, setValue: setStoredFlavor } = useStorage(
'flavor'
);
const [dialogOpen, setDialogOpen] = useState(false);
useEffect(() => {
if (!isFallback) setStoredFlavor(flavor.value);
if (!isFallback) {
setStoredFlavor(flavor.value);
}
}, [flavor, isFallback, setStoredFlavor]);
useEffect(() => {
if (!isFallback || !storedFlavor) return;
// If the stored flavor is different then navigate away.
// Otherwise replace current URL _if_ it is missing version+flavor.
if (flavor.value !== storedFlavor) {
// If the stored flavor is different then navigate away.
router.push(`/${version.id}/${storedFlavor}${router.asPath}`);
} else if (!router.asPath.startsWith(`/${version.id}`)) {
// Otherwise replace current URL if it is missing version+flavor.
router.push(`/${version.id}/${storedFlavor}${router.asPath}`, undefined, {
shallow: true,
});
}
}, [router, version, flavor, storedFlavor, isFallback]);
useEffect(() => {
setDialogOpen(isFallback && !storedFlavor);
}, [setDialogOpen, isFallback, storedFlavor]);
return (
<>
{/* TODO: Display message for fallback without stored flavor */}
<DocViewer
version={version}
versionList={versions}
@ -76,11 +80,68 @@ export function Documentation({
menu={menu}
toc={null}
/>
<Dialog
as="div"
className="fixed z-50 inset-0 overflow-y-auto"
open={dialogOpen}
onClose={() => {}}
>
<div className="flex items-center justify-center min-h-screen">
<Dialog.Overlay className="fixed inset-0 backdrop-filter backdrop-blur" />
<div className="z-50 bg-white rounded w-11/12 max-w-xl filter drop-shadow-2xl">
<Dialog.Title
as="h3"
className="text-xl sm:text-2xl lg:text-2xl leading-6 m-5"
>
Before You Continue...
</Dialog.Title>
<Dialog.Description className="m-5 text-gray-700">
Please select the flavor you want to learn more about.
</Dialog.Description>
<div className="my-5 p-5 w-full grid grid-cols-1 lg:grid-cols-3 gap-3 justify-items-center">
<Link href={`${version.id}/react${router.asPath}`}>
<a className="w-6/12 lg:w-full bg-white border border-gray-100 shadow-sm hover:shadow-md transition-all ease-out duration-180 rounded py-4 px-3 space-x-1 text-base tracking-tight font-bold leading-tight text-center flex flex-col justify-center items-center px-2 py-4 space-y-4">
<svg viewBox="0 0 24 24" className="w-1/2" fill="#52C1DE">
<path d="M14.23 12.004a2.236 2.236 0 0 1-2.235 2.236 2.236 2.236 0 0 1-2.236-2.236 2.236 2.236 0 0 1 2.235-2.236 2.236 2.236 0 0 1 2.236 2.236zm2.648-10.69c-1.346 0-3.107.96-4.888 2.622-1.78-1.653-3.542-2.602-4.887-2.602-.41 0-.783.093-1.106.278-1.375.793-1.683 3.264-.973 6.365C1.98 8.917 0 10.42 0 12.004c0 1.59 1.99 3.097 5.043 4.03-.704 3.113-.39 5.588.988 6.38.32.187.69.275 1.102.275 1.345 0 3.107-.96 4.888-2.624 1.78 1.654 3.542 2.603 4.887 2.603.41 0 .783-.09 1.106-.275 1.374-.792 1.683-3.263.973-6.365C22.02 15.096 24 13.59 24 12.004c0-1.59-1.99-3.097-5.043-4.032.704-3.11.39-5.587-.988-6.38-.318-.184-.688-.277-1.092-.278zm-.005 1.09v.006c.225 0 .406.044.558.127.666.382.955 1.835.73 3.704-.054.46-.142.945-.25 1.44-.96-.236-2.006-.417-3.107-.534-.66-.905-1.345-1.727-2.035-2.447 1.592-1.48 3.087-2.292 4.105-2.295zm-9.77.02c1.012 0 2.514.808 4.11 2.28-.686.72-1.37 1.537-2.02 2.442-1.107.117-2.154.298-3.113.538-.112-.49-.195-.964-.254-1.42-.23-1.868.054-3.32.714-3.707.19-.09.4-.127.563-.132zm4.882 3.05c.455.468.91.992 1.36 1.564-.44-.02-.89-.034-1.345-.034-.46 0-.915.01-1.36.034.44-.572.895-1.096 1.345-1.565zM12 8.1c.74 0 1.477.034 2.202.093.406.582.802 1.203 1.183 1.86.372.64.71 1.29 1.018 1.946-.308.655-.646 1.31-1.013 1.95-.38.66-.773 1.288-1.18 1.87-.728.063-1.466.098-2.21.098-.74 0-1.477-.035-2.202-.093-.406-.582-.802-1.204-1.183-1.86-.372-.64-.71-1.29-1.018-1.946.303-.657.646-1.313 1.013-1.954.38-.66.773-1.286 1.18-1.868.728-.064 1.466-.098 2.21-.098zm-3.635.254c-.24.377-.48.763-.704 1.16-.225.39-.435.782-.635 1.174-.265-.656-.49-1.31-.676-1.947.64-.15 1.315-.283 2.015-.386zm7.26 0c.695.103 1.365.23 2.006.387-.18.632-.405 1.282-.66 1.933-.2-.39-.41-.783-.64-1.174-.225-.392-.465-.774-.705-1.146zm3.063.675c.484.15.944.317 1.375.498 1.732.74 2.852 1.708 2.852 2.476-.005.768-1.125 1.74-2.857 2.475-.42.18-.88.342-1.355.493-.28-.958-.646-1.956-1.1-2.98.45-1.017.81-2.01 1.085-2.964zm-13.395.004c.278.96.645 1.957 1.1 2.98-.45 1.017-.812 2.01-1.086 2.964-.484-.15-.944-.318-1.37-.5-1.732-.737-2.852-1.706-2.852-2.474 0-.768 1.12-1.742 2.852-2.476.42-.18.88-.342 1.356-.494zm11.678 4.28c.265.657.49 1.312.676 1.948-.64.157-1.316.29-2.016.39.24-.375.48-.762.705-1.158.225-.39.435-.788.636-1.18zm-9.945.02c.2.392.41.783.64 1.175.23.39.465.772.705 1.143-.695-.102-1.365-.23-2.006-.386.18-.63.406-1.282.66-1.933zM17.92 16.32c.112.493.2.968.254 1.423.23 1.868-.054 3.32-.714 3.708-.147.09-.338.128-.563.128-1.012 0-2.514-.807-4.11-2.28.686-.72 1.37-1.536 2.02-2.44 1.107-.118 2.154-.3 3.113-.54zm-11.83.01c.96.234 2.006.415 3.107.532.66.905 1.345 1.727 2.035 2.446-1.595 1.483-3.092 2.295-4.11 2.295-.22-.005-.406-.05-.553-.132-.666-.38-.955-1.834-.73-3.703.054-.46.142-.944.25-1.438zm4.56.64c.44.02.89.034 1.345.034.46 0 .915-.01 1.36-.034-.44.572-.895 1.095-1.345 1.565-.455-.47-.91-.993-1.36-1.565z" />
</svg>
<div className="sm:text-base md:text-sm lg:text-base">
React
</div>
</a>
</Link>
<Link href={`${version.id}/angular${router.asPath}`}>
<a className="w-6/12 lg:w-full bg-white border border-gray-100 shadow-sm hover:shadow-md transition-all ease-out duration-180 rounded py-4 px-3 space-x-1 text-base tracking-tight font-bold leading-tight text-center flex flex-col justify-center items-center px-2 py-4 space-y-4">
<svg viewBox="0 0 24 24" className="w-1/2" fill="#E23236">
<path d="M9.931 12.645h4.138l-2.07-4.908m0-7.737L.68 3.982l1.726 14.771L12 24l9.596-5.242L23.32 3.984 11.999.001zm7.064 18.31h-2.638l-1.422-3.503H8.996l-1.422 3.504h-2.64L12 2.65z" />
</svg>
<div className="sm:text-base md:text-sm lg:text-base">
Angular
</div>
</a>
</Link>
<Link href={`${version.id}/node${router.asPath}`}>
<a className="w-6/12 lg:w-full bg-white border border-gray-100 shadow-sm hover:shadow-md transition-all ease-out duration-180 rounded py-4 px-3 space-x-1 text-base tracking-tight font-bold leading-tight text-center flex flex-col justify-center items-center px-2 py-4 space-y-4">
<svg viewBox="0 0 24 24" className="w-1/2" fill="#77AE64">
<path d="M11.998,24c-0.321,0-0.641-0.084-0.922-0.247l-2.936-1.737c-0.438-0.245-0.224-0.332-0.08-0.383 c0.585-0.203,0.703-0.25,1.328-0.604c0.065-0.037,0.151-0.023,0.218,0.017l2.256,1.339c0.082,0.045,0.197,0.045,0.272,0l8.795-5.076 c0.082-0.047,0.134-0.141,0.134-0.238V6.921c0-0.099-0.053-0.192-0.137-0.242l-8.791-5.072c-0.081-0.047-0.189-0.047-0.271,0 L3.075,6.68C2.99,6.729,2.936,6.825,2.936,6.921v10.15c0,0.097,0.054,0.189,0.139,0.235l2.409,1.392 c1.307,0.654,2.108-0.116,2.108-0.89V7.787c0-0.142,0.114-0.253,0.256-0.253h1.115c0.139,0,0.255,0.112,0.255,0.253v10.021 c0,1.745-0.95,2.745-2.604,2.745c-0.508,0-0.909,0-2.026-0.551L2.28,18.675c-0.57-0.329-0.922-0.945-0.922-1.604V6.921 c0-0.659,0.353-1.275,0.922-1.603l8.795-5.082c0.557-0.315,1.296-0.315,1.848,0l8.794,5.082c0.57,0.329,0.924,0.944,0.924,1.603 v10.15c0,0.659-0.354,1.273-0.924,1.604l-8.794,5.078C12.643,23.916,12.324,24,11.998,24z M19.099,13.993 c0-1.9-1.284-2.406-3.987-2.763c-2.731-0.361-3.009-0.548-3.009-1.187c0-0.528,0.235-1.233,2.258-1.233 c1.807,0,2.473,0.389,2.747,1.607c0.024,0.115,0.129,0.199,0.247,0.199h1.141c0.071,0,0.138-0.031,0.186-0.081 c0.048-0.054,0.074-0.123,0.067-0.196c-0.177-2.098-1.571-3.076-4.388-3.076c-2.508,0-4.004,1.058-4.004,2.833 c0,1.925,1.488,2.457,3.895,2.695c2.88,0.282,3.103,0.703,3.103,1.269c0,0.983-0.789,1.402-2.642,1.402 c-2.327,0-2.839-0.584-3.011-1.742c-0.02-0.124-0.126-0.215-0.253-0.215h-1.137c-0.141,0-0.254,0.112-0.254,0.253 c0,1.482,0.806,3.248,4.655,3.248C17.501,17.007,19.099,15.91,19.099,13.993z" />
</svg>
<div className="sm:text-base md:text-sm lg:text-base">
Node
</div>
</a>
</Link>
</div>
</div>
</div>
</Dialog>
</>
);
}
export async function getStaticProps({ params }: DocumentationParams) {
export async function getStaticProps({
params,
}: {
params: { segments: string[] };
}) {
const version =
versionList.find((item) => item.id === params.segments[0]) ??
defaultVersion;
@ -88,7 +149,7 @@ export async function getStaticProps({ params }: DocumentationParams) {
flavorList.find((item) => item.value === params.segments[1]) ??
defaultFlavor;
const { document, menu, fallback } = findDocumentAndMenu(
const { document, menu, isFallback } = findDocumentAndMenu(
version,
flavor,
params.segments
@ -103,7 +164,7 @@ export async function getStaticProps({ params }: DocumentationParams) {
flavors: flavorList,
document,
menu,
isFallback: fallback,
isFallback: isFallback,
},
};
} else {
@ -118,31 +179,21 @@ export async function getStaticProps({ params }: DocumentationParams) {
}
export async function getStaticPaths() {
const versions = documentsApi.getVersions().map((x) => x.id);
const allPaths = versions.reduce((acc, v) => {
acc.push(...documentsApi.getStaticDocumentPaths(v));
return acc;
}, []);
return {
paths: allPaths,
/*
* Block rendering until the page component resolves with either:
* 1. The content of the document if it exists.
* 2. A redirect to another page if document is not found.
*/
paths: versionList.flatMap((v) =>
documentsApi.getStaticDocumentPaths(v.id)
),
fallback: 'blocking',
};
}
function findDocumentAndMenu(
version,
flavor,
segments
): { menu?: Menu; document?: DocumentData; fallback?: boolean } {
const fallback = segments[0] !== version.id;
const path = fallback ? segments : segments.slice(2);
version: VersionMetadata,
flavor: { label: string; value: string },
segments: string[]
): { menu?: Menu; document?: DocumentData; isFallback?: boolean } {
const isFallback = segments[0] !== version.id;
const path = isFallback ? segments : segments.slice(2);
let menu: Menu;
let document: DocumentData;
@ -154,7 +205,7 @@ function findDocumentAndMenu(
// nothing
}
return { document, menu, fallback };
return { document, menu, isFallback };
}
export default Documentation;
export default DocumentationPage;

10
nx-dev/nx-dev/pages/index.tsx
View File

@ -89,10 +89,7 @@ export function Index() {
<div className="mt-32 mb-20 flex sm:flex-row flex-col justify-center">
<div className="w-full sm:w-1/2 grid grid-cols-3 gap-10 items-center">
<Link href="/react">
<a
href="#"
className="w-full bg-white border border-gray-100 shadow-sm hover:shadow-md transition-all ease-out duration-180 rounded py-4 px-3 space-x-1 text-base tracking-tight font-bold leading-tight text-center flex flex-col justify-center items-center px-2 py-4 space-y-4"
>
<a className="w-full bg-white border border-gray-100 shadow-sm hover:shadow-md transition-all ease-out duration-180 rounded py-4 px-3 space-x-1 text-base tracking-tight font-bold leading-tight text-center flex flex-col justify-center items-center px-2 py-4 space-y-4">
<svg viewBox="0 0 24 24" className="w-1/2" fill="#52C1DE">
<path d="M14.23 12.004a2.236 2.236 0 0 1-2.235 2.236 2.236 2.236 0 0 1-2.236-2.236 2.236 2.236 0 0 1 2.235-2.236 2.236 2.236 0 0 1 2.236 2.236zm2.648-10.69c-1.346 0-3.107.96-4.888 2.622-1.78-1.653-3.542-2.602-4.887-2.602-.41 0-.783.093-1.106.278-1.375.793-1.683 3.264-.973 6.365C1.98 8.917 0 10.42 0 12.004c0 1.59 1.99 3.097 5.043 4.03-.704 3.113-.39 5.588.988 6.38.32.187.69.275 1.102.275 1.345 0 3.107-.96 4.888-2.624 1.78 1.654 3.542 2.603 4.887 2.603.41 0 .783-.09 1.106-.275 1.374-.792 1.683-3.263.973-6.365C22.02 15.096 24 13.59 24 12.004c0-1.59-1.99-3.097-5.043-4.032.704-3.11.39-5.587-.988-6.38-.318-.184-.688-.277-1.092-.278zm-.005 1.09v.006c.225 0 .406.044.558.127.666.382.955 1.835.73 3.704-.054.46-.142.945-.25 1.44-.96-.236-2.006-.417-3.107-.534-.66-.905-1.345-1.727-2.035-2.447 1.592-1.48 3.087-2.292 4.105-2.295zm-9.77.02c1.012 0 2.514.808 4.11 2.28-.686.72-1.37 1.537-2.02 2.442-1.107.117-2.154.298-3.113.538-.112-.49-.195-.964-.254-1.42-.23-1.868.054-3.32.714-3.707.19-.09.4-.127.563-.132zm4.882 3.05c.455.468.91.992 1.36 1.564-.44-.02-.89-.034-1.345-.034-.46 0-.915.01-1.36.034.44-.572.895-1.096 1.345-1.565zM12 8.1c.74 0 1.477.034 2.202.093.406.582.802 1.203 1.183 1.86.372.64.71 1.29 1.018 1.946-.308.655-.646 1.31-1.013 1.95-.38.66-.773 1.288-1.18 1.87-.728.063-1.466.098-2.21.098-.74 0-1.477-.035-2.202-.093-.406-.582-.802-1.204-1.183-1.86-.372-.64-.71-1.29-1.018-1.946.303-.657.646-1.313 1.013-1.954.38-.66.773-1.286 1.18-1.868.728-.064 1.466-.098 2.21-.098zm-3.635.254c-.24.377-.48.763-.704 1.16-.225.39-.435.782-.635 1.174-.265-.656-.49-1.31-.676-1.947.64-.15 1.315-.283 2.015-.386zm7.26 0c.695.103 1.365.23 2.006.387-.18.632-.405 1.282-.66 1.933-.2-.39-.41-.783-.64-1.174-.225-.392-.465-.774-.705-1.146zm3.063.675c.484.15.944.317 1.375.498 1.732.74 2.852 1.708 2.852 2.476-.005.768-1.125 1.74-2.857 2.475-.42.18-.88.342-1.355.493-.28-.958-.646-1.956-1.1-2.98.45-1.017.81-2.01 1.085-2.964zm-13.395.004c.278.96.645 1.957 1.1 2.98-.45 1.017-.812 2.01-1.086 2.964-.484-.15-.944-.318-1.37-.5-1.732-.737-2.852-1.706-2.852-2.474 0-.768 1.12-1.742 2.852-2.476.42-.18.88-.342 1.356-.494zm11.678 4.28c.265.657.49 1.312.676 1.948-.64.157-1.316.29-2.016.39.24-.375.48-.762.705-1.158.225-.39.435-.788.636-1.18zm-9.945.02c.2.392.41.783.64 1.175.23.39.465.772.705 1.143-.695-.102-1.365-.23-2.006-.386.18-.63.406-1.282.66-1.933zM17.92 16.32c.112.493.2.968.254 1.423.23 1.868-.054 3.32-.714 3.708-.147.09-.338.128-.563.128-1.012 0-2.514-.807-4.11-2.28.686-.72 1.37-1.536 2.02-2.44 1.107-.118 2.154-.3 3.113-.54zm-11.83.01c.96.234 2.006.415 3.107.532.66.905 1.345 1.727 2.035 2.446-1.595 1.483-3.092 2.295-4.11 2.295-.22-.005-.406-.05-.553-.132-.666-.38-.955-1.834-.73-3.703.054-.46.142-.944.25-1.438zm4.56.64c.44.02.89.034 1.345.034.46 0 .915-.01 1.36-.034-.44.572-.895 1.095-1.345 1.565-.455-.47-.91-.993-1.36-1.565z" />
</svg>
@ -101,10 +98,7 @@ export function Index() {
</div>
</a>
</Link>
<a
href="#"
className="w-full bg-white border border-gray-100 shadow-sm hover:shadow-md transition-all ease-out duration-180 rounded py-4 px-3 space-x-1 text-base tracking-tight font-bold leading-tight text-center flex flex-col justify-center items-center px-2 py-4 space-y-4"
>
<a className="w-full bg-white border border-gray-100 shadow-sm hover:shadow-md transition-all ease-out duration-180 rounded py-4 px-3 space-x-1 text-base tracking-tight font-bold leading-tight text-center flex flex-col justify-center items-center px-2 py-4 space-y-4">
<svg viewBox="0 0 24 24" className="w-1/2" fill="#E23236">
<path d="M9.931 12.645h4.138l-2.07-4.908m0-7.737L.68 3.982l1.726 14.771L12 24l9.596-5.242L23.32 3.984 11.999.001zm7.064 18.31h-2.638l-1.422-3.503H8.996l-1.422 3.504h-2.64L12 2.65z" />
</svg>

2
nx-dev/nx-dev/tsconfig.app.json
View File

@ -3,7 +3,7 @@
"compilerOptions": {
"outDir": "../../dist/out-tsc",
"types": ["node", "jest"],
"lib": ["dom"]
"lib": ["dom", "es2019"]
},
"exclude": ["**/*.spec.ts", "**/*.spec.tsx"],
"include": ["**/*.js", "**/*.ts", "**/*.tsx", "next-env.d.ts"]

2
nx-dev/nx-dev/tsconfig.spec.json
View File

@ -4,7 +4,7 @@
"outDir": "../../dist/out-tsc",
"module": "commonjs",
"types": ["jest", "node"],
"lib": ["dom"],
"lib": ["dom", "es2019"],
"jsx": "react"
},
"include": [

4
nx-dev/ui/common/src/lib/header.tsx
View File

@ -54,12 +54,12 @@ export function Header({ showSearch }: HeaderProps) {
{/*NAVIGATION*/}
<div className="text-sm flex-shrink-0">
<nav className="flex items-justified justify-center space-x-1">
<Link href="/latest/react/getting-started/getting-started">
<Link href="/getting-started/getting-started">
<a className="font-bold px-3 py-2 text-white leading-tight">
Get Started
</a>
</Link>
<Link href="/latest/react/core-concepts/plugins">
<Link href="/core-concepts/plugins">
<a className="px-3 py-2 text-white leading-tight">Plugins</a>
</Link>
<Link href="/community">

10
nx-dev/ui/common/src/lib/selector.tsx
View File

@ -10,21 +10,17 @@ export interface SelectorProps {
}
export function Selector(props: SelectorProps) {
const [selectedItem, setSelectedItem] = useState(props.selected);
return (
<div className="w-full">
<Listbox
value={selectedItem}
onChange={(selection) => {
setSelectedItem(selection);
props.onChange(selection);
}}
value={props.selected}
onChange={(selection) => props.onChange(selection)}
>
{({ open }) => (
<>
<div className="relative mt-1">
<Listbox.Button className="relative w-full py-2 pl-3 pr-10 text-left bg-white rounded border border-gray-200 cursor-pointer focus:outline-none focus-visible:ring-2 focus-visible:ring-opacity-75 focus-visible:ring-white focus-visible:ring-offset-blue-300 focus-visible:ring-offset-2 focus-visible:border-blue-500 sm:text-sm font-medium">
<span className="block truncate">{selectedItem.label}</span>
<span className="block truncate">{props.selected.label}</span>
<span className="absolute inset-y-0 right-0 flex items-center pr-2 pointer-events-none">
<SelectorIcon
className="w-5 h-5 text-gray-500"