Function SafeInclude

Render another file's Markdown/MDX as data — no author JavaScript executes. Reached via <Include mode="interpreted"> or <IncludeModeContext value="interpreted">.

  • SafeInclude(
        __namedParameters: {
            components?: Record<string, unknown>;
            ErrorComponent?: (props: FallbackProps) => ReactNode;
            filename: string;
            LoadingComponent?: () => Element;
            readSource?: SourceReader;
        },
    ): Element

    Parameters

    • __namedParameters: {
          components?: Record<string, unknown>;
          ErrorComponent?: (props: FallbackProps) => ReactNode;
          filename: string;
          LoadingComponent?: () => Element;
          readSource?: SourceReader;
      }
      • Optionalcomponents?: Record<string, unknown>

        Extra/override components, merged OVER the surrounding MDXProvider map.

      • OptionalErrorComponent?: (props: FallbackProps) => ReactNode
      • filename: string
      • OptionalLoadingComponent?: () => Element
      • OptionalreadSource?: SourceReader

        Read the raw bytes yourself — e.g. from a content mount rather than the app repo.

    Returns Element

Settings

Member Visibility