logo标签列表

使用 TypeScript 扩展一个带有可选属性的类型

javascripttypescripttypesextend
5

我正在使用NextJS，并需要扩展他们的AppProps类型，其中包含我自己添加的可选参数Layout。但是AppProps类型由许多其他类型组成，例如：

AppProps：

export declare type AppProps<P = {}> = AppPropsType<Router, P>;

AppPropsType:

export declare type AppPropsType<R extends NextRouter = NextRouter, P = {}> = AppInitialProps & {
    Component: NextComponentType<NextPageContext, any, P>;
    router: R;
    __N_SSG?: boolean;
    __N_SSP?: boolean;
};

下一个组件类型：

export declare type NextComponentType<C extends BaseContext = NextPageContext, IP = {}, P = {}> = ComponentType<P> & {
    /**
     * Used for initial page load data population. Data returned from `getInitialProps` is serialized when server rendered.
     * Make sure to return plain `Object` without using `Date`, `Map`, `Set`.
     * @param ctx Context of `page`
     */
    getInitialProps?(context: C): IP | Promise<IP>;
};

我希望能够从我的_app.tsx文件中，通过类似以下方式的代码向Component添加Layout：

  Component: {
    Layout?: React.FunctionComponent;
  };

是否可以从AppProps中实现这个功能，还是需要先扩展/交叉AppPropsType与Layout，然后重新声明使用扩展的AppPropsType的AppProps？

4个回答
6

我创建了一个自定义的AppProps类型，这样我就可以编辑组件类型Component。

interface CustomAppProps extends Omit<AppProps, "Component"> {
  Component: AppProps["Component"] & { Layout: JSX.Element };
}

最终结果将看起来像这样：
import type { AppProps } from "next/app";

interface CustomAppProps extends Omit<AppProps, "Component"> {
  Component: AppProps["Component"] & { Layout: JSX.Element };
}

function CustomApp({ Component, pageProps }: CustomAppProps) {
  return <Component {...pageProps} />;
}

export default CustomApp;
3

我对Pablo Verduzco的答案进行了一些修改，我认为它更易读和可扩展。

import type { AppProps } from "next/app"

interface CustomAppProps {
  Component: AppProps["Component"] & {
    auth: {
      role: string
    }
  }
  pageProps: AppProps["pageProps"]
}

function MyApp({ Component, pageProps }: CustomAppProps) {
  return <Component {...pageProps} />;
}

export default MyApp;
3

起初，我有一个丑陋的混乱来停止错误：

import { AppProps } from 'next/app'    

export default function App({ Component, pageProps }: AppProps) {
  const RedeclaredAndHacky_Component = Component as any
  const Layout = RedeclaredAndHacky_Component.layoutProps?.Layout || Fr
  /* Rest of the function */
}

我并不是特别喜欢这个，所以最终得到的结果更接近于你所描述的那样：

import { NextComponentType, NextPageContext } from 'next'

type AppProps = {
  pageProps: any
  Component: NextComponentType<NextPageContext, any, {}> & { layoutProps: any }
}

export default function App({ Component, pageProps }: AppProps) {
  const Layout = Component.layoutProps?.Layout || Shell
  /* Rest of the function */
}
2
在 material-ui 的示例中，有些代码可能也能帮助到这个问题的读者：https://github.com/mui/material-ui/blob/3c528113f47cfddf2504ea02ba3065e7c5c46928/examples/nextjs-with-typescript/pages/_app.tsx#L13-L15 
import * as React from 'react';
import Head from 'next/head';
import { AppProps } from 'next/app';
import { ThemeProvider } from '@mui/material/styles';
import CssBaseline from '@mui/material/CssBaseline';
import { CacheProvider, EmotionCache } from '@emotion/react';
import theme from '../src/theme';
import createEmotionCache from '../src/createEmotionCache';

// Client-side cache, shared for the whole session of the user in the browser.
const clientSideEmotionCache = createEmotionCache();

interface MyAppProps extends AppProps {
  emotionCache?: EmotionCache;
}

export default function MyApp(props: MyAppProps) {
  const { Component, emotionCache = clientSideEmotionCache, pageProps } = props;
  return (
    <CacheProvider value={emotionCache}>
      <Head>
        <meta name="viewport" content="initial-scale=1, width=device-width" />
      </Head>
      <ThemeProvider theme={theme}>
        {/* CssBaseline kickstart an elegant, consistent, and simple baseline to build upon. */}
        <CssBaseline />
        <Component {...pageProps} />
      </ThemeProvider>
    </CacheProvider>
  );
}
网页内容由stack overflow 提供, 点击上面的
可以查看英文原文，
原文链接