From d1a896c856e9233a4444a14f9dfe240214d18cfd Mon Sep 17 00:00:00 2001 From: Divyansh Singh <40380293+brc-dd@users.noreply.github.com> Date: Sat, 2 Jul 2022 17:52:39 +0530 Subject: [PATCH] feat: allow changing prev/next placeholders --- docs/config/theme-configs.md | 26 ++++++++++++++++++- .../theme-default/components/VPDocFooter.vue | 4 +-- types/default-theme.d.ts | 23 ++++++++++++++++ 3 files changed, 50 insertions(+), 3 deletions(-) diff --git a/docs/config/theme-configs.md b/docs/config/theme-configs.md index 4ebfdc87..eb40afdf 100644 --- a/docs/config/theme-configs.md +++ b/docs/config/theme-configs.md @@ -247,9 +247,33 @@ export default { ```ts export interface CarbonAds { - code: string, + code: string placement: string } ``` Learn more in [Theme: Carbon Ads](../guide/theme-carbon-ads) + +## docFooter + +- Type: `DocFooter` + +Can be used to customize text appearing above previous and next links. Helpful if not writing docs in English. + +```js +export default { + themeConfig: { + docFooter: { + prev: 'Pagina prior', + next: 'Proxima pagina' + } + } +} +``` + +```ts +export interface DocFooter { + prev?: string + next?: string +} +``` diff --git a/src/client/theme-default/components/VPDocFooter.vue b/src/client/theme-default/components/VPDocFooter.vue index 29890e75..48d01d68 100644 --- a/src/client/theme-default/components/VPDocFooter.vue +++ b/src/client/theme-default/components/VPDocFooter.vue @@ -36,13 +36,13 @@ const hasLastUpdated = computed(() => {
diff --git a/types/default-theme.d.ts b/types/default-theme.d.ts index f19f4395..2689f0ca 100644 --- a/types/default-theme.d.ts +++ b/types/default-theme.d.ts @@ -43,6 +43,11 @@ export namespace DefaultTheme { */ lastUpdatedText?: string + /** + * Set custom prev/next placeholders. + */ + docFooter?: DocFooter + /** * The social links to be displayed at the end of the nav bar. Perfect for * placing links to social services such as GitHub, Twitter, Facebook, etc. @@ -157,6 +162,24 @@ export namespace DefaultTheme { text?: string } + // prev-next ----------------------------------------------------------------- + + export interface DocFooter { + /** + * Custom text for previous page placeholder. + * + * @default 'Previous Page' + */ + prev?: string + + /** + * Custom text for next page placeholder. + * + * @default 'Next Page' + */ + next?: string + } + // social link --------------------------------------------------------------- export interface SocialLink {