[docs] ❗️BREAKING ❗️ various theme config options was renamed

[dimaMachina]

fixes #676 #669

also, add new option toc.component to fix #564

and fixes project.link behaviour #383

nextra/packages/nextra-theme-docs/src/types.ts

Lines 15 to 82 in bbfe8a3

	export interface DocsThemeConfig {
	banner: {
	key: string
	text: ReactNode | FC
	}
	bodyExtraContent: ReactNode | FC
	components: Record<string, FC>
	darkMode: boolean
	direction: 'ltr' | 'rtl'
	docsRepositoryBase: string
	editLink: ReactNode | FC
	feedback: {
	labels: string
	link: ReactNode | FC
	}
	font: boolean
	footer: {
	component: ReactNode | FC<{ menu: boolean }>
	text: ReactNode | FC
	}
	gitTimestamp: ReactNode | FC<{ timestamp: Date }>
	github: string
	head: () => ReactElement
	i18n: { direction?: string; locale: string; text: string }[]
	logo: ReactNode | FC
	navigation: {
	next: boolean
	prev: boolean
	}
	nextThemes: Pick<
	ThemeProviderProps,
	'defaultTheme' | 'storageKey' | 'forcedTheme'
	>
	notFound: {
	labels: string
	link: ReactNode | FC
	}
	project: {
	icon: ReactNode | FC
	link: string
	}
	projectChat: {
	icon: ReactNode | FC
	link: string
	}
	search: {
	component: ReactNode | FC<{ directories: Item[] }>
	emptyResult: ReactNode | FC
	// Can't be React component
	placeholder: string | (() => string)
	}
	serverSideError: {
	labels: string
	link: ReactNode | FC
	}
	sidebar: {
	defaultMenuCollapsed: boolean
	subtitle: ReactNode | FC<{ title: string }>
	}
	// Can't be React component, otherwise will get Warning: A title element received an array with more than 1 element as children.
	titleSuffix: string | (() => string)
	toc: {
	extraContent: ReactNode | FC
	float: boolean
	title: ReactNode | FC
	}
	unstable_faviconGlyph: string
	}

@shuding it was hard to implement without too monkey-business code for some options like

 search: boolean | FC | ReactNode | {
   placeholder?: string | (() => string)
   emptyResult?: ReactNode | FC
 }

So I made the following

 search: { 
     component: ReactNode | FC<{ directories: Item[] }> 
     emptyResult: ReactNode | FC  // will be ignored if component was specified
     placeholder: string | (() => string)  // will be ignored if component was specified
   } 

or more complex usage

  toc: {
    component: ReactNode | FC<TOCProps>
    extraContent: ReactNode | FC // will be ignored if component was specified
    float: boolean // ❗️ headings will be passed in `toc.component` as props based on `headings: config.toc.float ? headings : []` condition
    title: ReactNode | FC // will be ignored if component was specified
  }

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated
nextra-theme-docs-dev	✅ Ready (Inspect)	Visit Preview	Aug 20, 2022 at 4:27PM (UTC)

1 Ignored Deployment

Name	Status	Preview	Updated
nextra	⬜️ Ignored (Inspect)		Aug 20, 2022 at 4:27PM (UTC)

[changeset-bot]

🦋 Changeset detected

Latest commit: 323ada9

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[shuding]

Thank you this is so much cleaner!

[Filsommer]

Regarding this change:
placeholder: string | (() => string)
How can we change that placeholder depending on the locale now?