Skip to content

API

NameDescTypeDefaultVue OnlyReact Only
renderIntro介绍区渲染函数() => Elementtrue
renderDemo展示区渲染函数() => Elementtrue
intro介绍区插槽Slottrue
demo展示区插槽Slottrue

Usage

Markdown

需要使用 YTUI 的定制主题 vitepress-theme-ytui 才有效。

最简用法:

默认文字区

自定义展示区和文字区:

  • 展示区可使用 design-decode-demo
  • 注意此时 design-decode 要用 :::: 四个冒号。

此处是展示区

默认文字区

md
最简用法:

::: design-decode
默认文字区
:::

自定义展示区和文字区:
- 展示区可使用 `design-decode-demo`
- 注意此时 design-decode 要用 `::::` 四个冒号。

:::: design-decode
::: design-decode-demo
此处是展示区
:::
默认文字区
::::

Vue SFC

展示区
描述区
vue
<script setup>
import { DesignDecode } from 'ytui'
</script>
<template>
  <div>
    <DesignDecode>
      <template #intro>描述区</template>
      <template #demo>展示区</template>
    </DesignDecode>
  </div>
</template>

JSX

展示区
文字区
jsx
import { DesignDecode } from "ytui"

export default function () {
  return (
    <DesignDecode
      layout="x"
      introPosition="right"
      renderIntro={() => "文字区"}
      renderDemo={() => "展示区"}
    ></DesignDecode>
  )
}