Skip to content
This repository has been archived by the owner on Aug 8, 2022. It is now read-only.

docs: update blod symbols #49

Closed
wants to merge 12 commits into from
36 changes: 18 additions & 18 deletions src/api/application-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,16 @@ const app = createApp({})

## component

- **参数:**
- **参数**:

- `{string} name`
- `{Function | Object} [definition]`

- **用法:**
- **用法**:

注册或检索全局组件。注册还会使用给定的 `name` 参数自动设置组件的 `name`。

- **示例:**
- **示例**:

```js
import { createApp } from 'vue'
Expand All @@ -43,11 +43,11 @@ const MyComponent = app.component('my-component', {})

## config

- **用法:**
- **用法**:

包含应用程序配置的对象。

- **示例:**
- **示例**:

```js
import { createApp } from 'vue'
Expand All @@ -60,16 +60,16 @@ app.config = {...}

## directive

- **参数:**
- **参数**:

- `{string} name`
- `{Function | Object} [definition]`

- **用法:**
- **用法**:

注册或检索全局指令。

- **示例:**
- **示例**:

```js
import { createApp } from 'vue'
Expand Down Expand Up @@ -152,28 +152,28 @@ app.directive('focus', {

## mixin

- **参数:**
- **参数**:

- `{Object} mixin`

- **用法:**
- **用法**:

在整个应用程序范围内应用 mixin,一旦注册,它们就可以在当前的 app 中任何组件模板内使用它。插件作者可以使用此方法将自定义行为注入组件。**不建议在应用程序代码中**。

- **参考** [Global Mixin](../guide/mixins.html#global-mixin)

## mount

- **参数:**
- **参数**:

- `{Element | string} rootContainer`
- `{boolean} isHydrate`

- **用法:**
- **用法**:

将应用程序实例的根组件挂载在提供的 DOM 元素上。

- **示例:**
- **示例**:

```html
<body>
Expand All @@ -194,15 +194,15 @@ app.mount('#my-app')

## unmount

- **参数:**
- **参数**:

- `{Element | string} rootContainer`

- **用法:**
- **用法**:

在提供的 DOM 元素上卸载应用程序实例的根组件。

- **示例:**
- **示例**:

```html
<body>
Expand All @@ -223,11 +223,11 @@ setTimeout(() => app.unmount('#my-app'), 5000)

## use

- **参数:**
- **参数**:

- `{Object | Function} plugin`

- **用法:**
- **用法**:

安装 Vue.js 插件。如果插件是一个对象,它必须暴露一个 `install` 方法。如果它本身是一个函数,它将被视为安装方法。将以 Vue 作为参数调用 install 方法。

Expand Down
2 changes: 1 addition & 1 deletion src/api/basic-reactivity.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ const obj = reactive({ count: 0 })

响应式转换是“深”的——它影响所有嵌套 property。在基于 [ES2015 Proxy](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Proxy) 的实现中,返回的代理是**不**等于原始对象。建议只使用响应式代理,避免依赖原始对象。

**类型声明:**
**类型声明**:

```ts
function reactive<T extends object>(target: T): UnwrapNestedRefs<T>
Expand Down
38 changes: 19 additions & 19 deletions src/api/built-in-components.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

## component

- **Props:**
- **Props**:

- `is` - `string | ComponentDefinition | ComponentConstructor`

- **用法:**
- **用法**:

渲染一个“元组件”为动态组件。依 `is` 的值,来决定哪个组件被渲染。

Expand All @@ -18,11 +18,11 @@
<component :is="$options.components.child"></component>
```

- **参考:** [动态组件](../guide/component-dynamic-async.html)
- **参考**:[动态组件](../guide/component-dynamic-async.html)

## transition

- **Props:**
- **Props**:

- `name` - `string` 用于自动生成 CSS 过渡类名。例如:`name: 'fade'` 将自动拓展为 `.fade-enter`,`.fade-enter-active` 等。
- `appear` - `boolean`,是否在初始渲染时使用过渡。默认为 `false`。
Expand All @@ -41,7 +41,7 @@
- `leave-active-class` - `string`
- `appear-active-class` - `string`

- **事件:**
- **事件**:

- `before-enter`
- `before-leave`
Expand All @@ -55,7 +55,7 @@
- `leave-cancelled` (仅 `v-show`)
- `appear-cancelled`

- **用法:**
- **用法**:

`<transition>` 元素作为**单个**元素/组件的过渡效果。`<transition>` 只会把过渡效果应用到其包裹的内容上,而不会额外渲染 DOM 元素,也不会出现在可被检查的组件层级中。

Expand Down Expand Up @@ -92,21 +92,21 @@
app.mount('#transition-demo')
```

- **参考:** [进入 & 离开过渡](/guide/transitions-enterleave.html#transitioning-single-elements-components)
- **参考**:[进入 & 离开过渡](/guide/transitions-enterleave.html#transitioning-single-elements-components)

## transition-group

- **Props:**
- **Props**:

- `tag` - `string`,默认为 `span`。
- `move-class` - 覆盖移动过渡期间应用的 CSS 类。
- 除了 `mode`,其他 attribute 和 `<transition>` 相同。

- **事件:**
- **事件**:

- 事件和 `<transition>` 相同。

- **用法:**
- **用法**:

`<transition-group>` 元素作为**多个**元素/组件的过渡效果。`<transition-group>` 渲染一个真实的 DOM 元素。默认渲染 `<span>`,可以通过 `tag` attribute 配置哪个元素应该被渲染。

Expand All @@ -122,17 +122,17 @@
</transition-group>
```

- **参考:** [列表过渡](/guide/transitions-list.html)
- **参考**:[列表过渡](/guide/transitions-list.html)

## keep-alive

- **Props:**
- **Props**:

- `include` - `string | RegExp | Array`。只有名称匹配的组件会被缓存。
- `exclude` - `string | RegExp | Array`。任何名称匹配的组件都不会被缓存。
- `max` - `number | string`。最多可以缓存多少组件实例。

- **用法:**
- **用法**:

`<keep-alive>` 包裹动态组件时,会缓存不活动的组件实例,而不是销毁它们。和 `<transition>` 相似,`<keep-alive>` 是一个抽象组件:它自身不会渲染一个 DOM 元素,也不会出现在组件的父组件链中。

Expand Down Expand Up @@ -200,25 +200,25 @@
`<keep-alive>` 不会在函数式组件中正常工作,因为它们没有缓存实例。
:::

- **参考:** [动态组件 - keep-alive](../guide/component-dynamic-async.html#dynamic-components-with-keep-alive)
- **参考**:[动态组件 - keep-alive](../guide/component-dynamic-async.html#dynamic-components-with-keep-alive)

## slot

- **Props:**
- **Props**:

- `name` - `string`,用于具名插槽

- **用法:**
- **用法**:

`<slot>` 元素作为组件模板之中的内容分发插槽。`<slot>` 元素自身将被替换。

详细用法,请参考下面教程的链接。

- **参考:** [通过插槽分发内容](../guide/component-basics.html#content-distribution-with-slots)
- **参考**:[通过插槽分发内容](../guide/component-basics.html#content-distribution-with-slots)

## teleport

- **Props:**
- **Props**:

- `to` - `string`。需要 prop,必须是有效的查询选择器或 HTMLElement (如果在浏览器环境中使用)。指定将在其中移动 `<teleport>` 内容的目标元素

Expand All @@ -243,4 +243,4 @@

请注意,这将移动实际的 DOM 节点,而不是被销毁和重新创建,并且它还将保持任何组件实例的活动状态。所有有状态的 HTML 元素 (即播放的视频) 都将保持其状态。

- **参考:** [Teleport 组件](../guide/teleport.html#teleport)
- **参考**:[Teleport 组件](../guide/teleport.html#teleport)
4 changes: 2 additions & 2 deletions src/api/composition-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

一个组件选项,在创建组件**之前**执行,一旦 `props` 被解析,并作为组合 API 的入口点

- **入参:**
- **入参**:

- `{Data} props`
- `{SetupContext} context`
Expand All @@ -31,7 +31,7 @@ function setup(props: Data, context: SetupContext): Data
若要获取传递给 `setup()` 的参数的类型推断,请使用 [defineComponent](global-api.html#definecomponent) 是需要的。
:::

- **示例:**
- **示例**:

使用模板:

Expand Down
6 changes: 3 additions & 3 deletions src/api/computed-watch-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ plusOne.value = 1
console.log(count.value) // 0
```

**类型声明:**
**类型声明**:

```ts
// read-only
Expand All @@ -56,7 +56,7 @@ setTimeout(() => {
}, 100)
```

**类型声明:**
**类型声明**:

```ts
function watchEffect(
Expand Down Expand Up @@ -130,7 +130,7 @@ watch([fooRef, barRef], ([foo, bar], [prevFoo, prevBar]) => {

`watch` 与 [`watchEffect`](#watcheffect) 在[手动停止](stopping-the-watcher),[副作用无效](side-effect-invalidation) (将 `onInvalidate` 作为第三个参数传递给回调),[flush timing](#effect-flush-timing) 和 [debugging](#watcher-debugging)。

**类型声明:**
**类型声明**:

```ts
// 侦听单一源
Expand Down
Loading