feat: add mini sponsor component (#648)

close #648

docs/guide/theme-introduction.md

@@ -172,7 +172,14 @@ export default {
 
 Full list of slots available in the default theme layout:
 
-- Only when `layout: 'home'` is enabled via frontmatter:
+- When `layout: 'doc'` (default) is enabled via frontmatter:
+  - `aside-top`
+  - `aside-bottom`
+  - `aside-outline-before`
+  - `aside-outline-after`
+  - `aside-ads-before`
+  - `aside-ads-after`
+- When `layout: 'home'` is enabled via frontmatter:
   - `home-hero-before`
   - `home-hero-after`
   - `home-features-before`

src/client/theme-default/Layout.vue

@@ -33,6 +33,13 @@ provide('close-sidebar', closeSidebar)
       <template #home-hero-after><slot name="home-hero-after" /></template>
       <template #home-features-before><slot name="home-features-before" /></template>
       <template #home-features-after><slot name="home-features-after" /></template>
+
+      <template #aside-top><slot name="aside-top" /></template>
+      <template #aside-bottom><slot name="aside-bottom" /></template>
+      <template #aside-outline-before><slot name="aside-outline-before" /></template>
+      <template #aside-outline-after><slot name="aside-outline-after" /></template>
+      <template #aside-ads-before><slot name="aside-ads-before" /></template>
+      <template #aside-ads-after><slot name="aside-ads-after" /></template>
     </VPContent>
 
     <VPFooter />

src/client/theme-default/components/VPBox.vue

@@ -36,7 +36,7 @@ defineProps<{
 }
 
 .dark .icon {
-  background-color: var(--vp-c-bg-soft);
+  background-color: var(--vp-c-bg);
 }
 
 .title {

src/client/theme-default/components/VPCarbonAds.vue

@@ -47,13 +47,13 @@ if (carbonOptions) {
   justify-content: center;
   align-items: center;
   padding: 24px;
-  border-radius: 8px;
+  border-radius: 12px;
   min-height: 240px;
   text-align: center;
   line-height: 18px;
   font-size: 12px;
   font-weight: 500;
-  background-color: var(--vp-c-bg-alt);
+  background-color: var(--vp-c-bg-soft);
   transition: color 0.5s, background-color 0.5s;
 }
 

src/client/theme-default/components/VPContent.vue

@@ -34,7 +34,14 @@ useCopyCode()
       <template #home-features-after><slot name="home-features-after" /></template>
     </VPHome>
 
-    <VPDoc v-else />
+    <VPDoc v-else>
+      <template #aside-top><slot name="aside-top" /></template>
+      <template #aside-outline-before><slot name="aside-outline-before" /></template>
+      <template #aside-outline-after><slot name="aside-outline-after" /></template>
+      <template #aside-ads-before><slot name="aside-ads-before" /></template>
+      <template #aside-ads-after><slot name="aside-ads-after" /></template>
+      <template #aside-bottom><slot name="aside-bottom" /></template>
+    </VPDoc>
   </div>
 </template>
 

src/client/theme-default/components/VPDoc.vue

@@ -20,7 +20,14 @@ const pageName = computed(() => {
         <div class="aside-curtain" />
         <div class="aside-container">
           <div class="aside-content">
-            <VPDocAside />
+            <VPDocAside>
+              <template #aside-top><slot name="aside-top" /></template>
+              <template #aside-bottom><slot name="aside-bottom" /></template>
+              <template #aside-outline-before><slot name="aside-outline-before" /></template>
+              <template #aside-outline-after><slot name="aside-outline-after" /></template>
+              <template #aside-ads-before><slot name="aside-ads-before" /></template>
+              <template #aside-ads-after><slot name="aside-ads-after" /></template>
+            </VPDocAside>
           </div>
         </div>
       </div>
@@ -126,8 +133,8 @@ const pageName = computed(() => {
   bottom: 0;
   z-index: 10;
   width: 224px;
-  height: 64px;
-  background: linear-gradient(transparent, var(--vp-c-bg) 80%);
+  height: 88px;
+  background: linear-gradient(transparent, var(--vp-c-bg) 70%);
 }
 
 .aside-content {

src/client/theme-default/components/VPDocAside.vue

@@ -8,13 +8,27 @@ const { page, theme } = useData()
 
 <template>
   <div class="VPDocAside">
+    <slot name="aside-top" />
+
+    <slot name="aside-outline-before" />
     <VPDocAsideOutline v-if="page.headers.length" />
+    <slot name="aside-outline-after" />
+
+    <slot name="aside-ads-before" />
     <VPDocAsideCarbonAds v-if="theme.carbonAds" />
+    <slot name="aside-ads-after" />
+
+    <slot name="aside-bottom" />
   </div>
 </template>
 
 <style scoped>
+.VPDocAside :deep(.VPDocAsideOutline + .VPDocAsideSponsors),
 .VPDocAside :deep(.VPDocAsideOutline + .VPDocAsideCarbonAds) {
   margin-top: 24px;
 }
+
+.VPDocAside :deep(.VPDocAsideSponsors + .VPDocAsideCarbonAds) {
+  margin-top: 16px;
+}
 </style>

src/client/theme-default/components/VPDocAsideSponsors.vue

@@ -0,0 +1,32 @@
+<script setup lang="ts">
+import VPSponsors from './VPSponsors.vue'
+
+export interface Sponsors {
+  tier?: string
+  size?: 'xmini' | 'mini' | 'small'
+  items: Sponsor[]
+}
+
+export interface Sponsor {
+  name: string
+  img: string
+  url: string
+}
+
+defineProps<{
+  tier?: string
+  size?: 'xmini' | 'mini' | 'small'
+  data: Sponsors[] | Sponsor[]
+}>()
+</script>
+
+<template>
+  <div class="VPDocAsideSponsors">
+    <VPSponsors
+      mode="aside"
+      :tier="tier"
+      :size="size"
+      :data="data"
+    />
+  </div>
+</template>

src/client/theme-default/components/VPMenuLink.vue

@@ -27,6 +27,10 @@ defineProps<{
 
 .VPMenuLink:hover {
   color: var(--vp-c-brand);
+  background-color: var(--vp-c-bg-mute);
+}
+
+.dark .VPMenuLink:hover {
   background-color: var(--vp-c-bg-soft);
 }
 </style>

src/client/theme-default/components/VPSponsors.vue

@@ -15,13 +15,16 @@ export interface Sponsor {
 }
 
 const props = defineProps<{
+  mode?: 'normal' | 'aside'
   tier?: string
-  size?: 'small' | 'medium' | 'big'
+  size?: 'xmini' | 'small' | 'medium' | 'big'
   data: Sponsors[] | Sponsor[]
 }>()
 
 const sponsors = computed(() => {
-  const isSponsors = props.data.some((s: any) => s.items)
+  const isSponsors = props.data.some((s) => {
+    return !!(s as Sponsors).items
+  })
 
   if (isSponsors) {
     return props.data
@@ -36,42 +39,14 @@ const sponsors = computed(() => {
 </script>
 
 <template>
-  <div class="VPSponsors">
-    <section v-for="(sponsor, index) in sponsors" :key="index" class="section">
-      <h3 v-if="sponsor.tier" class="tier">{{ sponsor.tier }}</h3>
+  <div class="VPSponsors vp-sponsor" :class="[mode ?? 'normal']">
+    <section
+      v-for="(sponsor, index) in sponsors"
+      :key="index"
+      class="vp-sponsor-section"
+    >
+      <h3 v-if="sponsor.tier" class="vp-sponsor-tier">{{ sponsor.tier }}</h3>
       <VPSponsorsGrid :size="sponsor.size" :data="sponsor.items" />
     </section>
   </div>
 </template>
-
-<style scoped>
-.VPSponsors {
-  border-radius: 16px;
-  overflow: hidden;
-}
-
-.section + .section {
-  margin-top: 4px;
-}
-
-.tier {
-  margin-bottom: 4px;
-  padding: 13px 0 11px;
-  text-align: center;
-  letter-spacing: 1px;
-  line-height: 24px;
-  width: 100%;
-  font-size: 14px;
-  font-weight: 600;
-  color: var(--vp-c-text-2);
-  background-color: var(--vp-c-white-soft);
-}
-
-.dark .tier {
-  background-color: var(--vp-c-black-mute);
-}
-
-.VPSponsorsGrid + .tier {
-  margin-top: 4px;
-}
-</style>

src/client/theme-default/components/VPSponsorsGrid.vue

@@ -9,7 +9,7 @@ export interface Sponsor {
 }
 
 const props = defineProps<{
-  size?: 'small' | 'medium' | 'big'
+  size?: 'xmini' | 'mini' | 'small' | 'medium' | 'big'
   data: Sponsor[]
 }>()
 

src/client/theme-default/composables/sponsor-grid.ts

@@ -5,7 +5,7 @@ export interface GridSetting {
   [size: string]: [number, number][]
 }
 
-export type GridSize = 'small' | 'medium' | 'big'
+export type GridSize = 'xmini' | 'mini' | 'small' | 'medium' | 'big'
 
 export interface UseSponsorsGridOprions {
   el: Ref<HTMLElement | null>
@@ -17,14 +17,16 @@ export interface UseSponsorsGridOprions {
  *
  * [Screen widh, Column size]
  *
- * It sets grid size on matching screen size. For example, `[768, 5]` will set
- * 5 columns when screen size is bigger or equal to 768px.
+ * It sets grid size on matching screen size. For example, `[768, 5]` will
+ * set 5 columns when screen size is bigger or equal to 768px.
  *
  * Column will set only when item size is bigger than the column size. For
- * example, even we want 5 columns, if we only have 1 sponsor yet, we would
- * like to show it in 1 column.
+ * example, even we define 5 columns, if we only have 1 sponsor yet, we would
+ * like to show it in 1 column to make it stand out.
  */
 const GridSettings: GridSetting = {
+  xmini: [[0, 2]],
+  mini: [],
   small: [
     [920, 6],
     [768, 5],

src/client/theme-default/index.ts

@@ -15,6 +15,7 @@ export { DefaultTheme } from './config'
 export { default as VPHomeHero } from './components/VPHomeHero.vue'
 export { default as VPHomeFeatures } from './components/VPHomeFeatures.vue'
 export { default as VPHomeSponsors } from './components/VPHomeSponsors.vue'
+export { default as VPDocAsideSponsors } from './components/VPDocAsideSponsors.vue'
 
 const theme: Theme = {
   Layout,

src/client/theme-default/styles/components/vp-sponsor.css

@@ -1,9 +1,57 @@
+/**
+ * VPSponsors styles are defined as global because a new class gets
+ * allied in onMounted` hook and we can't use socped style.
+ */
+.vp-sponsor {
+  border-radius: 16px;
+  overflow: hidden;
+}
+
+.vp-sponsor.aside {
+  border-radius: 12px;
+}
+
+.vp-sponsor-section + .vp-sponsor-section {
+  margin-top: 4px;
+}
+
+.vp-sponsor-tier {
+  margin-bottom: 4px;
+  text-align: center;
+  letter-spacing: 1px;
+  line-height: 24px;
+  width: 100%;
+  font-weight: 600;
+  color: var(--vp-c-text-2);
+  background-color: var(--vp-c-bg-soft);
+}
+
+.vp-sponsor.normal .vp-sponsor-tier {
+  padding: 13px 0 11px;
+  font-size: 14px;
+}
+
+.vp-sponsor.aside .vp-sponsor-tier {
+  padding: 9px 0 7px;
+  font-size: 12px;
+}
+
+.vp-sponsor-grid + .vp-sponsor-tier {
+  margin-top: 4px;
+}
+
 .vp-sponsor-grid {
   display: flex;
   flex-wrap: wrap;
   gap: 4px;
 }
 
+.vp-sponsor-grid.xmini .vp-sponsor-grid-link   { height: 64px; }
+.vp-sponsor-grid.xmini .vp-sponsor-grid-image  { max-width: 64px; max-height: 22px }
+
+.vp-sponsor-grid.mini .vp-sponsor-grid-link   { height: 72px; }
+.vp-sponsor-grid.mini .vp-sponsor-grid-image  { max-width: 96px; max-height: 24px }
+
 .vp-sponsor-grid.small .vp-sponsor-grid-link   { height: 96px; }
 .vp-sponsor-grid.small .vp-sponsor-grid-image  { max-width: 96px; max-height: 24px }
 
@@ -36,12 +84,12 @@
 .vp-sponsor-grid-item {
   flex-shrink: 0;
   width: 100%;
-  background-color: var(--vp-c-white-soft);
+  background-color: var(--vp-c-bg-soft);
   transition: background-color 0.25s;
 }
 
 .vp-sponsor-grid-item:hover {
-  background-color: var(--vp-c-white-mute);
+  background-color: var(--vp-c-bg-mute);
 }
 
 .vp-sponsor-grid-item:hover .vp-sponsor-grid-image {
@@ -49,11 +97,7 @@
 }
 
 .vp-sponsor-grid-item.empty:hover {
-  background-color: var(--vp-c-white-soft);
-}
-
-.dark .vp-sponsor-grid-item {
-  background-color: var(--vp-c-black-mute);
+  background-color: var(--vp-c-bg-soft);
 }
 
 .dark .vp-sponsor-grid-item:hover {

theme.d.ts

@@ -4,6 +4,7 @@ import { ComponentOptions } from 'vue'
 export const VPHomeHero = ComponentOptions
 export const VPHomeFeatures = ComponentOptions
 export const VPHomeSponsors = ComponentOptions
+export const VPDocAsideSponsors = ComponentOptions
 
 declare const theme: {
   Layout: ComponentOptions