element-plus/docs/.vitepress/vitepress/components/vp-demo.vue
qiang a4063fd8d2
docs: accessibility improvement (#11825)
* docs: accessibility improvement for navbar

* docs: accessibility improvement for demo

* refactor: replace ElPopover with ElDropdown

* docs: accessibility improvement for nav-full

* docs: accessibility improvement for back-to-top

* feat: add skip link that jump to the content
2023-03-10 14:43:22 +08:00

256 lines
6.3 KiB
Vue

<script setup lang="ts">
import { computed, getCurrentInstance, ref, toRef } from 'vue'
import { isClient, useClipboard, useToggle } from '@vueuse/core'
import { CaretTop } from '@element-plus/icons-vue'
import { useLang } from '../composables/lang'
import { useSourceCode } from '../composables/source-code'
import { usePlayground } from '../composables/use-playground'
import demoBlockLocale from '../../i18n/component/demo-block.json'
import Example from './demo/vp-example.vue'
import SourceCode from './demo/vp-source-code.vue'
const props = defineProps<{
demos: object
source: string
path: string
rawSource: string
description?: string
}>()
const vm = getCurrentInstance()!
const { copy, isSupported } = useClipboard({
source: decodeURIComponent(props.rawSource),
read: false,
})
const [sourceVisible, toggleSourceVisible] = useToggle()
const lang = useLang()
const demoSourceUrl = useSourceCode(toRef(props, 'path'))
const sourceCodeRef = ref<HTMLButtonElement>()
const formatPathDemos = computed(() => {
const demos = {}
Object.keys(props.demos).forEach((key) => {
demos[key.replace('../../examples/', '').replace('.vue', '')] =
props.demos[key].default
})
return demos
})
const locale = computed(() => demoBlockLocale[lang.value])
const decodedDescription = computed(() =>
decodeURIComponent(props.description!)
)
const onPlaygroundClick = () => {
const { link } = usePlayground(props.rawSource)
if (!isClient) return
window.open(link)
}
const onSourceVisibleKeydown = (e: KeyboardEvent) => {
if (['Enter', 'Space'].includes(e.code)) {
e.preventDefault()
toggleSourceVisible(false)
sourceCodeRef.value?.focus()
}
}
const copyCode = async () => {
const { $message } = vm.appContext.config.globalProperties
if (!isSupported) {
$message.error(locale.value['copy-error'])
}
try {
await copy()
$message.success(locale.value['copy-success'])
} catch (e: any) {
$message.error(e.message)
}
}
</script>
<template>
<ClientOnly>
<!-- danger here DO NOT USE INLINE SCRIPT TAG -->
<p text="sm" v-html="decodedDescription" />
<div class="example">
<Example :file="path" :demo="formatPathDemos[path]" />
<ElDivider class="m-0" />
<div class="op-btns">
<ElTooltip
:content="locale['edit-in-editor']"
:show-arrow="false"
:trigger="['hover', 'focus']"
:trigger-keys="[]"
>
<ElIcon
:size="16"
:aria-label="locale['edit-in-editor']"
tabindex="0"
role="link"
class="op-btn"
@click="onPlaygroundClick"
@keydown.prevent.enter="onPlaygroundClick"
@keydown.prevent.space="onPlaygroundClick"
>
<i-ri-flask-line />
</ElIcon>
</ElTooltip>
<ElTooltip
:content="locale['edit-on-github']"
:show-arrow="false"
:trigger="['hover', 'focus']"
:trigger-keys="[]"
>
<ElIcon
:size="16"
class="op-btn github"
style="color: var(--text-color-light)"
>
<a
:href="demoSourceUrl"
:aria-label="locale['edit-on-github']"
rel="noreferrer noopener"
target="_blank"
>
<i-ri-github-line />
</a>
</ElIcon>
</ElTooltip>
<ElTooltip
:content="locale['copy-code']"
:show-arrow="false"
:trigger="['hover', 'focus']"
:trigger-keys="[]"
>
<ElIcon
:size="16"
:aria-label="locale['copy-code']"
class="op-btn"
tabindex="0"
role="button"
@click="copyCode"
@keydown.prevent.enter="copyCode"
@keydown.prevent.space="copyCode"
>
<i-ri-file-copy-line />
</ElIcon>
</ElTooltip>
<ElTooltip
:content="locale['view-source']"
:show-arrow="false"
:trigger="['hover', 'focus']"
:trigger-keys="[]"
>
<button
ref="sourceCodeRef"
:aria-label="
sourceVisible ? locale['hide-source'] : locale['view-source']
"
class="reset-btn el-icon op-btn"
@click="toggleSourceVisible()"
>
<ElIcon :size="16">
<i-ri-code-line />
</ElIcon>
</button>
</ElTooltip>
</div>
<ElCollapseTransition>
<SourceCode v-show="sourceVisible" :source="source" />
</ElCollapseTransition>
<Transition name="el-fade-in-linear">
<div
v-show="sourceVisible"
class="example-float-control"
tabindex="0"
role="button"
@click="toggleSourceVisible(false)"
@keydown="onSourceVisibleKeydown"
>
<ElIcon :size="16">
<CaretTop />
</ElIcon>
<span>{{ locale['hide-source'] }}</span>
</div>
</Transition>
</div>
</ClientOnly>
</template>
<style scoped lang="scss">
.example {
border: 1px solid var(--border-color);
border-radius: var(--el-border-radius-base);
.op-btns {
padding: 0.5rem;
display: flex;
align-items: center;
justify-content: flex-end;
height: 2.5rem;
.el-icon {
&:hover {
color: var(--text-color);
}
}
.op-btn {
margin: 0 0.5rem;
cursor: pointer;
color: var(--text-color-lighter);
transition: 0.2s;
&.github a {
transition: 0.2s;
color: var(--text-color-lighter);
&:hover {
color: var(--text-color);
}
}
}
}
&-float-control {
display: flex;
align-items: center;
justify-content: center;
border-top: 1px solid var(--border-color);
height: 44px;
box-sizing: border-box;
background-color: var(--bg-color, #fff);
border-bottom-left-radius: 4px;
border-bottom-right-radius: 4px;
margin-top: -1px;
color: var(--el-text-color-secondary);
cursor: pointer;
position: sticky;
left: 0;
right: 0;
bottom: 0;
z-index: 10;
span {
font-size: 14px;
margin-left: 10px;
}
&:hover {
color: var(--el-color-primary);
}
}
}
</style>