@frontfactory/vitepress-theme 1.6.0 → 1.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +214 -0
- package/README.md +160 -8
- package/config.d.ts +26 -1
- package/config.js +165 -21
- package/dist/style.css +1 -1
- package/node/llms.js +31 -0
- package/node/og.js +159 -0
- package/node/pages.js +154 -0
- package/node/rss.js +81 -0
- package/package.json +49 -26
- package/src/blog/posts.data.ts +46 -0
- package/src/components/FfBackToTop.vue +33 -10
- package/src/components/FfBanner.vue +42 -8
- package/src/components/FfCopyStatus.vue +64 -0
- package/src/components/FfDocMeta.vue +50 -46
- package/src/components/FfFeature.vue +18 -7
- package/src/components/FfFeedback.vue +96 -0
- package/src/components/FfFooter.vue +11 -5
- package/src/components/FfHero.vue +20 -10
- package/src/components/FfHeroCommand.vue +24 -27
- package/src/components/FfHomeSponsors.vue +2 -2
- package/src/components/FfNavBarTitle.vue +63 -0
- package/src/components/FfPost.vue +49 -0
- package/src/components/FfProgress.vue +69 -0
- package/src/components/FfVersionSwitcher.vue +20 -0
- package/src/composables/blog.ts +38 -0
- package/src/composables/options.ts +19 -14
- package/src/composables/relativeTime.ts +59 -0
- package/src/composables/tabs.ts +155 -0
- package/src/content/Api.vue +6 -2
- package/src/content/Badge.vue +26 -0
- package/src/content/Callout.vue +27 -0
- package/src/content/FileTree.vue +118 -0
- package/src/content/Tab.vue +11 -0
- package/src/content/Tabs.vue +74 -0
- package/src/content/Timeline.vue +19 -0
- package/src/content/TimelineItem.vue +37 -0
- package/src/content/timeline.ts +4 -0
- package/src/index.ts +37 -1
- package/src/internal.ts +7 -2
- package/src/layout/FfBlog.vue +62 -0
- package/src/layout/FfLayout.vue +17 -1
- package/src/styles/_base.scss +20 -5
- package/src/styles/_blocks.scss +25 -1
- package/src/styles/_blog.scss +131 -0
- package/src/styles/_breakpoints.scss +26 -0
- package/src/styles/_code.scss +5 -5
- package/src/styles/_content.scss +280 -12
- package/src/styles/_doc.scss +18 -5
- package/src/styles/_home.scss +37 -17
- package/src/styles/_motion.scss +22 -2
- package/src/styles/_nav.scss +81 -8
- package/src/styles/_print.scss +77 -0
- package/src/styles/_sidebar.scss +2 -2
- package/src/styles/_tokens.scss +75 -9
- package/src/styles/index.scss +2 -0
- package/src/types.ts +140 -2
- package/types/blog/posts.data.d.ts +14 -0
- package/types/components/FfBackToTop.vue.d.ts +3 -0
- package/types/components/FfBanner.vue.d.ts +3 -0
- package/types/components/FfCopyStatus.vue.d.ts +3 -0
- package/types/components/FfDocMeta.vue.d.ts +3 -0
- package/types/components/FfFeature.vue.d.ts +13 -0
- package/types/components/FfFeedback.vue.d.ts +3 -0
- package/types/components/FfFooter.vue.d.ts +3 -0
- package/types/components/FfHero.vue.d.ts +42 -0
- package/types/components/FfHeroCommand.vue.d.ts +9 -0
- package/types/components/FfHomeSponsors.vue.d.ts +19 -0
- package/types/components/FfNavBarTitle.vue.d.ts +17 -0
- package/types/components/FfPost.vue.d.ts +3 -0
- package/types/components/FfProgress.vue.d.ts +3 -0
- package/types/components/FfVersionSwitcher.vue.d.ts +3 -0
- package/types/composables/blog.d.ts +10 -0
- package/types/composables/link.d.ts +12 -0
- package/types/composables/options.d.ts +15 -0
- package/types/composables/relativeTime.d.ts +2 -0
- package/types/composables/tabs.d.ts +15 -0
- package/types/content/Api.vue.d.ts +27 -0
- package/types/content/Badge.vue.d.ts +21 -0
- package/types/content/Callout.vue.d.ts +24 -0
- package/types/content/Card.vue.d.ts +23 -0
- package/types/content/CardGrid.vue.d.ts +20 -0
- package/types/content/FileTree.vue.d.ts +6 -0
- package/types/content/Kbd.vue.d.ts +15 -0
- package/types/content/Steps.vue.d.ts +15 -0
- package/types/content/Tab.vue.d.ts +19 -0
- package/types/content/Tabs.vue.d.ts +7 -0
- package/types/content/Timeline.vue.d.ts +21 -0
- package/types/content/TimelineItem.vue.d.ts +21 -0
- package/types/content/timeline.d.ts +3 -0
- package/types/index.d.ts +25 -0
- package/types/internal.d.ts +9 -0
- package/types/layout/FfBlog.vue.d.ts +3 -0
- package/types/layout/FfLayout.vue.d.ts +23 -0
- package/types/types.d.ts +256 -0
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
<script setup lang="ts">
|
|
2
|
+
// Replica of the default theme's VPNavBarTitle, with the version switcher rendered beside the
|
|
3
|
+
// title link. Its `nav-bar-title-after` slot sits inside that link, where an interactive menu
|
|
4
|
+
// would be invalid markup and every click would navigate home.
|
|
5
|
+
import { computed } from 'vue';
|
|
6
|
+
import { useData } from 'vitepress';
|
|
7
|
+
import {
|
|
8
|
+
normalizeLink, useLangs, useLayout, VPImage
|
|
9
|
+
} from '../internal';
|
|
10
|
+
import FfVersionSwitcher from './FfVersionSwitcher.vue';
|
|
11
|
+
|
|
12
|
+
const { site, theme } = useData();
|
|
13
|
+
const { hasSidebar } = useLayout();
|
|
14
|
+
const { currentLang } = useLangs();
|
|
15
|
+
|
|
16
|
+
const logoLink = computed(() =>
|
|
17
|
+
typeof theme.value.logoLink === 'string' ? {
|
|
18
|
+
link: theme.value.logoLink
|
|
19
|
+
} : theme.value.logoLink
|
|
20
|
+
);
|
|
21
|
+
|
|
22
|
+
// Plain-text title, surfaced as a native tooltip since the sidebar column truncates it.
|
|
23
|
+
const textTitle = computed(() => {
|
|
24
|
+
if (theme.value.siteTitle === false) {
|
|
25
|
+
return undefined;
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
const raw: string = theme.value.siteTitle ?? site.value.title;
|
|
29
|
+
|
|
30
|
+
return raw.replace(/<[^>]+>/g, '').trim() || undefined;
|
|
31
|
+
});
|
|
32
|
+
</script>
|
|
33
|
+
|
|
34
|
+
<template>
|
|
35
|
+
<div
|
|
36
|
+
class="VPNavBarTitle"
|
|
37
|
+
:class="{ 'has-sidebar': hasSidebar }"
|
|
38
|
+
>
|
|
39
|
+
<a
|
|
40
|
+
class="title"
|
|
41
|
+
:href="logoLink?.link ?? normalizeLink(currentLang.link)"
|
|
42
|
+
:rel="logoLink?.rel"
|
|
43
|
+
:target="logoLink?.target"
|
|
44
|
+
:title="textTitle"
|
|
45
|
+
>
|
|
46
|
+
<slot name="nav-bar-title-before" />
|
|
47
|
+
<VPImage
|
|
48
|
+
v-if="theme.logo"
|
|
49
|
+
class="logo"
|
|
50
|
+
:image="theme.logo"
|
|
51
|
+
/>
|
|
52
|
+
<span
|
|
53
|
+
v-if="theme.siteTitle"
|
|
54
|
+
dir="auto"
|
|
55
|
+
v-html="theme.siteTitle"
|
|
56
|
+
/>
|
|
57
|
+
<span v-else-if="theme.siteTitle === undefined">{{ site.title }}</span>
|
|
58
|
+
<slot name="nav-bar-title-after" />
|
|
59
|
+
</a>
|
|
60
|
+
|
|
61
|
+
<FfVersionSwitcher />
|
|
62
|
+
</div>
|
|
63
|
+
</template>
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
<script setup lang="ts">
|
|
2
|
+
import { computed } from 'vue';
|
|
3
|
+
import { useData } from 'vitepress';
|
|
4
|
+
import {
|
|
5
|
+
formatDate, resolveAuthor, useBlog
|
|
6
|
+
} from '../composables/blog';
|
|
7
|
+
import { format, useLabels } from '../composables/options';
|
|
8
|
+
|
|
9
|
+
const { frontmatter, lang } = useData();
|
|
10
|
+
const { isPost, authors } = useBlog();
|
|
11
|
+
const labels = useLabels();
|
|
12
|
+
|
|
13
|
+
const date = computed(() => (isPost.value ? new Date(frontmatter.value.date).toISOString() : ''));
|
|
14
|
+
const author = computed(() => resolveAuthor(authors.value, frontmatter.value.author));
|
|
15
|
+
const tags = computed<string[]>(() => (Array.isArray(frontmatter.value.tags) ? frontmatter.value.tags : []));
|
|
16
|
+
</script>
|
|
17
|
+
|
|
18
|
+
<template>
|
|
19
|
+
<div
|
|
20
|
+
v-if="isPost"
|
|
21
|
+
class="ff-post ff-label"
|
|
22
|
+
>
|
|
23
|
+
<time
|
|
24
|
+
class="ff-post-item"
|
|
25
|
+
:datetime="date"
|
|
26
|
+
>{{ formatDate(date, lang) }}</time>
|
|
27
|
+
<span
|
|
28
|
+
v-if="author"
|
|
29
|
+
class="ff-post-item ff-post-author"
|
|
30
|
+
>
|
|
31
|
+
<img
|
|
32
|
+
v-if="author.avatar"
|
|
33
|
+
:src="author.avatar"
|
|
34
|
+
alt=""
|
|
35
|
+
class="ff-post-avatar"
|
|
36
|
+
>
|
|
37
|
+
<a
|
|
38
|
+
v-if="author.link"
|
|
39
|
+
:href="author.link"
|
|
40
|
+
>{{ format(labels.blogBy, author.name) }}</a>
|
|
41
|
+
<template v-else>{{ format(labels.blogBy, author.name) }}</template>
|
|
42
|
+
</span>
|
|
43
|
+
<span
|
|
44
|
+
v-for="tag in tags"
|
|
45
|
+
:key="tag"
|
|
46
|
+
class="ff-post-item ff-post-tag"
|
|
47
|
+
>{{ tag }}</span>
|
|
48
|
+
</div>
|
|
49
|
+
</template>
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
<script setup lang="ts">
|
|
2
|
+
import {
|
|
3
|
+
computed, onMounted, ref, watchEffect
|
|
4
|
+
} from 'vue';
|
|
5
|
+
import { useData } from 'vitepress';
|
|
6
|
+
import { useThemeOptions } from '../composables/options';
|
|
7
|
+
|
|
8
|
+
const { frontmatter } = useData();
|
|
9
|
+
const options = useThemeOptions();
|
|
10
|
+
|
|
11
|
+
const enabled = computed(() => options.value.progress === true && frontmatter.value.progress !== false);
|
|
12
|
+
|
|
13
|
+
const progress = ref(0);
|
|
14
|
+
|
|
15
|
+
function update() {
|
|
16
|
+
const range = document.documentElement.scrollHeight - window.innerHeight;
|
|
17
|
+
|
|
18
|
+
progress.value = range > 0 ? Math.min(Math.max(window.scrollY / range, 0), 1) : 0;
|
|
19
|
+
}
|
|
20
|
+
|
|
21
|
+
// At most one state update per frame, however many scroll events fire.
|
|
22
|
+
let frame = 0;
|
|
23
|
+
|
|
24
|
+
function onChange() {
|
|
25
|
+
if (!frame) {
|
|
26
|
+
frame = requestAnimationFrame(() => {
|
|
27
|
+
frame = 0;
|
|
28
|
+
update();
|
|
29
|
+
});
|
|
30
|
+
}
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
// Listens only while the bar is enabled, and follows the option if it changes (locale switch,
|
|
34
|
+
// per-page frontmatter). The effect is stopped with the component, which runs its cleanup.
|
|
35
|
+
onMounted(() => {
|
|
36
|
+
watchEffect((onCleanup) => {
|
|
37
|
+
if (!enabled.value) {
|
|
38
|
+
return;
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
update();
|
|
42
|
+
window.addEventListener('scroll', onChange, {
|
|
43
|
+
passive: true
|
|
44
|
+
});
|
|
45
|
+
|
|
46
|
+
window.addEventListener('resize', onChange, {
|
|
47
|
+
passive: true
|
|
48
|
+
});
|
|
49
|
+
|
|
50
|
+
onCleanup(() => {
|
|
51
|
+
cancelAnimationFrame(frame);
|
|
52
|
+
frame = 0;
|
|
53
|
+
window.removeEventListener('scroll', onChange);
|
|
54
|
+
window.removeEventListener('resize', onChange);
|
|
55
|
+
});
|
|
56
|
+
});
|
|
57
|
+
});
|
|
58
|
+
</script>
|
|
59
|
+
|
|
60
|
+
<template>
|
|
61
|
+
<ClientOnly>
|
|
62
|
+
<div
|
|
63
|
+
v-if="enabled"
|
|
64
|
+
class="ff-progress"
|
|
65
|
+
aria-hidden="true"
|
|
66
|
+
:style="{ transform: `scaleX(${progress})` }"
|
|
67
|
+
/>
|
|
68
|
+
</ClientOnly>
|
|
69
|
+
</template>
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
<script setup lang="ts">
|
|
2
|
+
import { computed } from 'vue';
|
|
3
|
+
import { VPFlyout } from '../internal';
|
|
4
|
+
import { useLabels, useThemeOptions } from '../composables/options';
|
|
5
|
+
|
|
6
|
+
const options = useThemeOptions();
|
|
7
|
+
const labels = useLabels();
|
|
8
|
+
|
|
9
|
+
const versions = computed(() => options.value.versions);
|
|
10
|
+
</script>
|
|
11
|
+
|
|
12
|
+
<template>
|
|
13
|
+
<VPFlyout
|
|
14
|
+
v-if="versions"
|
|
15
|
+
class="ff-version-switcher"
|
|
16
|
+
:button="versions.current"
|
|
17
|
+
:items="versions.items"
|
|
18
|
+
:label="`${labels.versionSwitcher} ${versions.current}`"
|
|
19
|
+
/>
|
|
20
|
+
</template>
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
import { computed } from 'vue';
|
|
2
|
+
import { useData } from 'vitepress';
|
|
3
|
+
import { useThemeOptions } from './options';
|
|
4
|
+
import type { BlogAuthor } from '../types';
|
|
5
|
+
|
|
6
|
+
/** Blog options, with the directory normalised (no slash at either end). */
|
|
7
|
+
export function useBlog() {
|
|
8
|
+
const options = useThemeOptions();
|
|
9
|
+
const { page, frontmatter } = useData();
|
|
10
|
+
|
|
11
|
+
const dir = computed(() => (options.value.blog?.dir ?? 'blog').replace(/^\/+|\/+$/g, ''));
|
|
12
|
+
|
|
13
|
+
// A post is a dated page under the blog directory, the index excluded.
|
|
14
|
+
const isPost = computed(
|
|
15
|
+
() => page.value.relativePath.startsWith(`${dir.value}/`) && !!frontmatter.value.date
|
|
16
|
+
);
|
|
17
|
+
|
|
18
|
+
return {
|
|
19
|
+
dir,
|
|
20
|
+
isPost,
|
|
21
|
+
authors: computed(() => options.value.blog?.authors ?? {})
|
|
22
|
+
};
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
/** `author` is a key of `ff.blog.authors`, or a plain name used as is. */
|
|
26
|
+
export function resolveAuthor(authors: Record<string, BlogAuthor>, value?: string): BlogAuthor | null {
|
|
27
|
+
return value ? authors[value] ?? {
|
|
28
|
+
name: value
|
|
29
|
+
} : null;
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
// UTC, so the server and the browser print the same day whatever their time zone.
|
|
33
|
+
export function formatDate(date: string, lang: string) {
|
|
34
|
+
return new Intl.DateTimeFormat(lang, {
|
|
35
|
+
dateStyle: 'long',
|
|
36
|
+
timeZone: 'UTC'
|
|
37
|
+
}).format(new Date(date));
|
|
38
|
+
}
|
|
@@ -1,8 +1,6 @@
|
|
|
1
1
|
import { computed } from 'vue';
|
|
2
2
|
import { useData } from 'vitepress';
|
|
3
|
-
import type {
|
|
4
|
-
ThemeConfig, ThemeLabels, ThemeOptions
|
|
5
|
-
} from '../types';
|
|
3
|
+
import type { ThemeLabels, ThemeOptions } from '../types';
|
|
6
4
|
|
|
7
5
|
/**
|
|
8
6
|
* Theme options declared under `themeConfig.ff`, with an empty object as a fallback so callers
|
|
@@ -11,7 +9,7 @@ import type {
|
|
|
11
9
|
export function useThemeOptions() {
|
|
12
10
|
const { theme } = useData();
|
|
13
11
|
|
|
14
|
-
return computed<ThemeOptions>(() =>
|
|
12
|
+
return computed<ThemeOptions>(() => theme.value.ff ?? {});
|
|
15
13
|
}
|
|
16
14
|
|
|
17
15
|
/** English fallbacks for every string this theme adds. */
|
|
@@ -20,13 +18,24 @@ export const defaultLabels: Required<ThemeLabels> = {
|
|
|
20
18
|
readingTime: '{0} min read',
|
|
21
19
|
lastUpdated: 'Updated {0}',
|
|
22
20
|
heroInstall: 'Install',
|
|
23
|
-
heroCopy: 'Copy',
|
|
24
21
|
heroCopied: 'Copied',
|
|
25
22
|
heroCopyLabel: 'Copy {0}',
|
|
26
23
|
backToTop: 'Top',
|
|
27
24
|
footerSocial: 'Follow',
|
|
25
|
+
newTab: 'opens in a new tab',
|
|
28
26
|
sponsors: 'Sponsors',
|
|
29
|
-
sponsorsAction: 'Become a sponsor'
|
|
27
|
+
sponsorsAction: 'Become a sponsor',
|
|
28
|
+
apiSince: 'since {0}',
|
|
29
|
+
apiDeprecated: 'deprecated',
|
|
30
|
+
bannerCta: 'Read more',
|
|
31
|
+
feedbackQuestion: 'Was this page helpful?',
|
|
32
|
+
feedbackYes: 'Yes',
|
|
33
|
+
feedbackNo: 'No',
|
|
34
|
+
feedbackThanks: 'Thanks for your feedback',
|
|
35
|
+
copyMarkdown: 'Copy as Markdown',
|
|
36
|
+
versionSwitcher: 'Version',
|
|
37
|
+
blogBy: 'By {0}',
|
|
38
|
+
blogEmpty: 'No posts yet'
|
|
30
39
|
};
|
|
31
40
|
|
|
32
41
|
/**
|
|
@@ -37,17 +46,13 @@ export function useLabels() {
|
|
|
37
46
|
const options = useThemeOptions();
|
|
38
47
|
|
|
39
48
|
return computed<Required<ThemeLabels>>(() => {
|
|
49
|
+
const overrides = options.value.labels ?? {};
|
|
40
50
|
const labels = {
|
|
41
|
-
...defaultLabels
|
|
51
|
+
...defaultLabels
|
|
42
52
|
};
|
|
43
53
|
|
|
44
|
-
for (const [
|
|
45
|
-
key
|
|
46
|
-
value
|
|
47
|
-
] of Object.entries(options.value.labels ?? {})) {
|
|
48
|
-
if (value) {
|
|
49
|
-
labels[key as keyof ThemeLabels] = value;
|
|
50
|
-
}
|
|
54
|
+
for (const key of Object.keys(defaultLabels) as (keyof ThemeLabels)[]) {
|
|
55
|
+
labels[key] = overrides[key] || labels[key];
|
|
51
56
|
}
|
|
52
57
|
|
|
53
58
|
return labels;
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
const units: [Intl.RelativeTimeFormatUnit, number][] = [
|
|
2
|
+
[
|
|
3
|
+
'year',
|
|
4
|
+
31536000000
|
|
5
|
+
],
|
|
6
|
+
[
|
|
7
|
+
'month',
|
|
8
|
+
2592000000
|
|
9
|
+
],
|
|
10
|
+
[
|
|
11
|
+
'week',
|
|
12
|
+
604800000
|
|
13
|
+
],
|
|
14
|
+
[
|
|
15
|
+
'day',
|
|
16
|
+
86400000
|
|
17
|
+
],
|
|
18
|
+
[
|
|
19
|
+
'hour',
|
|
20
|
+
3600000
|
|
21
|
+
],
|
|
22
|
+
[
|
|
23
|
+
'minute',
|
|
24
|
+
60000
|
|
25
|
+
]
|
|
26
|
+
];
|
|
27
|
+
|
|
28
|
+
const formatters = new Map<string, Intl.RelativeTimeFormat>();
|
|
29
|
+
|
|
30
|
+
function formatter(lang: string) {
|
|
31
|
+
let relative = formatters.get(lang);
|
|
32
|
+
|
|
33
|
+
if (!relative) {
|
|
34
|
+
relative = new Intl.RelativeTimeFormat(lang, {
|
|
35
|
+
numeric: 'auto'
|
|
36
|
+
});
|
|
37
|
+
|
|
38
|
+
formatters.set(lang, relative);
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
return relative;
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
/** Formats a timestamp relative to now, in the largest unit it spans: "3 days ago". */
|
|
45
|
+
export function formatRelative(timestamp: number, lang: string) {
|
|
46
|
+
const elapsed = timestamp - Date.now();
|
|
47
|
+
const relative = formatter(lang);
|
|
48
|
+
|
|
49
|
+
for (const [
|
|
50
|
+
unit,
|
|
51
|
+
ms
|
|
52
|
+
] of units) {
|
|
53
|
+
if (Math.abs(elapsed) >= ms) {
|
|
54
|
+
return relative.format(Math.round(elapsed / ms), unit);
|
|
55
|
+
}
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
return relative.format(0, 'minute');
|
|
59
|
+
}
|
|
@@ -0,0 +1,155 @@
|
|
|
1
|
+
import {
|
|
2
|
+
computed, onMounted, onUnmounted, reactive, ref, toValue, watch, type MaybeRefOrGetter
|
|
3
|
+
} from 'vue';
|
|
4
|
+
|
|
5
|
+
const STORAGE_PREFIX = 'ff-tabs:';
|
|
6
|
+
|
|
7
|
+
// Label picked for each sync key. Module-level so every tab group on the page reads the same
|
|
8
|
+
// value; the `storage` event only fires in *other* documents, which is what keeps tabs open
|
|
9
|
+
// side by side in agreement.
|
|
10
|
+
const synced = reactive<Record<string, string>>({});
|
|
11
|
+
let listening = false;
|
|
12
|
+
|
|
13
|
+
function listen() {
|
|
14
|
+
if (listening) {
|
|
15
|
+
return;
|
|
16
|
+
}
|
|
17
|
+
|
|
18
|
+
listening = true;
|
|
19
|
+
|
|
20
|
+
window.addEventListener('storage', (event) => {
|
|
21
|
+
if (event.key?.startsWith(STORAGE_PREFIX) && event.newValue !== null) {
|
|
22
|
+
synced[event.key.slice(STORAGE_PREFIX.length)] = event.newValue;
|
|
23
|
+
}
|
|
24
|
+
});
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
/**
|
|
28
|
+
* Active tab of a group of labels. With a sync key, the choice is shared by label with every
|
|
29
|
+
* group using the same key and remembered across visits.
|
|
30
|
+
*/
|
|
31
|
+
export function useTabs(labels: MaybeRefOrGetter<string[]>, syncKey?: MaybeRefOrGetter<string | undefined>) {
|
|
32
|
+
const local = ref(0);
|
|
33
|
+
|
|
34
|
+
// Client-side navigation can swap the labels without remounting the component (two pages
|
|
35
|
+
// using the same layout), so the index is reset rather than left pointing past the end.
|
|
36
|
+
watch(() => toValue(labels), () => (local.value = 0));
|
|
37
|
+
|
|
38
|
+
const active = computed(() => {
|
|
39
|
+
const list = toValue(labels);
|
|
40
|
+
const key = toValue(syncKey);
|
|
41
|
+
|
|
42
|
+
if (key && synced[key] !== undefined) {
|
|
43
|
+
const index = list.indexOf(synced[key]);
|
|
44
|
+
|
|
45
|
+
if (index !== -1) {
|
|
46
|
+
return index;
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
return Math.min(local.value, Math.max(list.length - 1, 0));
|
|
51
|
+
});
|
|
52
|
+
|
|
53
|
+
function select(index: number) {
|
|
54
|
+
local.value = index;
|
|
55
|
+
|
|
56
|
+
const key = toValue(syncKey);
|
|
57
|
+
const label = toValue(labels)[index];
|
|
58
|
+
|
|
59
|
+
if (!key || label === undefined) {
|
|
60
|
+
return;
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
synced[key] = label;
|
|
64
|
+
|
|
65
|
+
try {
|
|
66
|
+
localStorage.setItem(STORAGE_PREFIX + key, label);
|
|
67
|
+
} catch {
|
|
68
|
+
// Storage disabled: the choice still holds for this page.
|
|
69
|
+
}
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
// Read after mount only, so the server and the hydrating client both render the first tab.
|
|
73
|
+
onMounted(() => {
|
|
74
|
+
const key = toValue(syncKey);
|
|
75
|
+
|
|
76
|
+
if (!key) {
|
|
77
|
+
return;
|
|
78
|
+
}
|
|
79
|
+
|
|
80
|
+
listen();
|
|
81
|
+
|
|
82
|
+
try {
|
|
83
|
+
const stored = localStorage.getItem(STORAGE_PREFIX + key);
|
|
84
|
+
|
|
85
|
+
if (stored !== null && synced[key] === undefined) {
|
|
86
|
+
synced[key] = stored;
|
|
87
|
+
}
|
|
88
|
+
} catch {
|
|
89
|
+
// Storage disabled: fall back to the first tab.
|
|
90
|
+
}
|
|
91
|
+
});
|
|
92
|
+
|
|
93
|
+
// Roving focus across the tab list, as the ARIA tabs pattern expects: arrows wrap around, Home
|
|
94
|
+
// and End jump to the ends, and selection follows focus. Bound on the `role="tablist"` element.
|
|
95
|
+
function onKeydown(event: KeyboardEvent) {
|
|
96
|
+
const count = toValue(labels).length;
|
|
97
|
+
const targets: Record<string, number> = {
|
|
98
|
+
ArrowRight: (active.value + 1) % count,
|
|
99
|
+
ArrowLeft: (active.value - 1 + count) % count,
|
|
100
|
+
Home: 0,
|
|
101
|
+
End: count - 1
|
|
102
|
+
};
|
|
103
|
+
const next = targets[event.key];
|
|
104
|
+
|
|
105
|
+
if (next === undefined) {
|
|
106
|
+
return;
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
event.preventDefault();
|
|
110
|
+
select(next);
|
|
111
|
+
|
|
112
|
+
const tabs = (event.currentTarget as HTMLElement).querySelectorAll<HTMLElement>('[role="tab"]');
|
|
113
|
+
|
|
114
|
+
tabs[next]?.focus();
|
|
115
|
+
}
|
|
116
|
+
|
|
117
|
+
return {
|
|
118
|
+
active,
|
|
119
|
+
select,
|
|
120
|
+
onKeydown
|
|
121
|
+
};
|
|
122
|
+
}
|
|
123
|
+
|
|
124
|
+
/** Copies a string to the clipboard and flags it as copied for two seconds. */
|
|
125
|
+
export function useCopy(text: MaybeRefOrGetter<string>) {
|
|
126
|
+
const copied = ref(false);
|
|
127
|
+
let timer: ReturnType<typeof setTimeout> | undefined;
|
|
128
|
+
|
|
129
|
+
async function copy() {
|
|
130
|
+
const value = toValue(text);
|
|
131
|
+
|
|
132
|
+
if (!value) {
|
|
133
|
+
return;
|
|
134
|
+
}
|
|
135
|
+
|
|
136
|
+
try {
|
|
137
|
+
await navigator.clipboard.writeText(value);
|
|
138
|
+
} catch {
|
|
139
|
+
// Insecure context or denied permission: there is nothing to confirm.
|
|
140
|
+
return;
|
|
141
|
+
}
|
|
142
|
+
|
|
143
|
+
copied.value = true;
|
|
144
|
+
|
|
145
|
+
clearTimeout(timer);
|
|
146
|
+
timer = setTimeout(() => (copied.value = false), 2000);
|
|
147
|
+
}
|
|
148
|
+
|
|
149
|
+
onUnmounted(() => clearTimeout(timer));
|
|
150
|
+
|
|
151
|
+
return {
|
|
152
|
+
copied,
|
|
153
|
+
copy
|
|
154
|
+
};
|
|
155
|
+
}
|
package/src/content/Api.vue
CHANGED
|
@@ -1,4 +1,8 @@
|
|
|
1
1
|
<script setup lang="ts">
|
|
2
|
+
import { format, useLabels } from '../composables/options';
|
|
3
|
+
|
|
4
|
+
const labels = useLabels();
|
|
5
|
+
|
|
2
6
|
defineProps<{
|
|
3
7
|
/** Symbol being documented, e.g. `refs()`. */
|
|
4
8
|
name: string
|
|
@@ -28,11 +32,11 @@ defineProps<{
|
|
|
28
32
|
<span
|
|
29
33
|
v-if="since"
|
|
30
34
|
class="ff-api-tag ff-label"
|
|
31
|
-
>
|
|
35
|
+
>{{ format(labels.apiSince, since) }}</span>
|
|
32
36
|
<span
|
|
33
37
|
v-if="deprecated"
|
|
34
38
|
class="ff-api-tag ff-api-deprecated ff-label"
|
|
35
|
-
>
|
|
39
|
+
>{{ labels.apiDeprecated }}</span>
|
|
36
40
|
</header>
|
|
37
41
|
|
|
38
42
|
<p
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
<script setup lang="ts">
|
|
2
|
+
import { computed } from 'vue';
|
|
3
|
+
import { format, useLabels } from '../composables/options';
|
|
4
|
+
import { VPBadge } from '../internal';
|
|
5
|
+
|
|
6
|
+
const labels = useLabels();
|
|
7
|
+
|
|
8
|
+
const props = defineProps<{
|
|
9
|
+
/** Text of the badge; for `since`, the version, printed through the `apiSince` label. */
|
|
10
|
+
text?: string
|
|
11
|
+
/** `tip`, `info`, `warning` and `danger` come from VitePress; `new`, `beta`, `deprecated` and `since` from the theme. */
|
|
12
|
+
type?: string
|
|
13
|
+
}>();
|
|
14
|
+
|
|
15
|
+
const shown = computed(() => (props.type === 'since' && props.text ? format(labels.value.apiSince, props.text) : props.text));
|
|
16
|
+
</script>
|
|
17
|
+
|
|
18
|
+
<!-- VPBadge types `type` as a closed union but only uses it as a class name, hence the cast. -->
|
|
19
|
+
<template>
|
|
20
|
+
<VPBadge
|
|
21
|
+
:type="(type as 'tip' | undefined)"
|
|
22
|
+
:text="shown"
|
|
23
|
+
>
|
|
24
|
+
<slot />
|
|
25
|
+
</VPBadge>
|
|
26
|
+
</template>
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
<script setup lang="ts">
|
|
2
|
+
// Same markup as a `::: tip` container, so the margin-note styling of _blocks.scss applies as is.
|
|
3
|
+
// It exists for the places a container cannot reach: inside another component, or with a type or
|
|
4
|
+
// title bound to data.
|
|
5
|
+
withDefaults(defineProps<{
|
|
6
|
+
/** One of the container types: `tip`, `info`, `note`, `important`, `warning`, `danger`, `caution`. */
|
|
7
|
+
type?: string
|
|
8
|
+
/** Label printed above the text. Defaults to the type, like a container. */
|
|
9
|
+
title?: string
|
|
10
|
+
}>(), {
|
|
11
|
+
type: 'note',
|
|
12
|
+
title: undefined
|
|
13
|
+
});
|
|
14
|
+
</script>
|
|
15
|
+
|
|
16
|
+
<template>
|
|
17
|
+
<div
|
|
18
|
+
class="custom-block"
|
|
19
|
+
:class="type"
|
|
20
|
+
>
|
|
21
|
+
<p class="custom-block-title">
|
|
22
|
+
{{ title ?? type }}
|
|
23
|
+
</p>
|
|
24
|
+
|
|
25
|
+
<slot />
|
|
26
|
+
</div>
|
|
27
|
+
</template>
|