Skip to content

Links to TS docs from the API section #2141

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 2, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion src/api/built-in-special-attributes.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,10 @@ Denotes a [template ref](/guide/essentials/template-refs.html).

`this.$refs` is also non-reactive, therefore you should not attempt to use it in templates for data-binding.

- **See also:** [Template Refs](/guide/essentials/template-refs.html)
- **See also:**
- [Guide - Template Refs](/guide/essentials/template-refs.html)
- [Guide - Typing Template Refs](/guide/typescript/composition-api.html#typing-template-refs) <sup class="vt-badge ts" />
- [Guide - Typing Component Template Refs](/guide/typescript/composition-api.html#typing-component-template-refs) <sup class="vt-badge ts" />

## is {#is}

Expand Down
4 changes: 2 additions & 2 deletions src/api/composition-api-dependency-injection.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Provides a value that can be injected by descendant components.

- **See also**:
- [Guide - Provide / Inject](/guide/components/provide-inject.html)
- [Guide - Typing Provide / Inject](/guide/typescript/composition-api.html#typing-provide-inject)
- [Guide - Typing Provide / Inject](/guide/typescript/composition-api.html#typing-provide-inject) <sup class="vt-badge ts" />

## inject() {#inject}

Expand Down Expand Up @@ -103,4 +103,4 @@ Injects a value provided by an ancestor component or the application (via `app.p

- **See also**:
- [Guide - Provide / Inject](/guide/components/provide-inject.html)
- [Guide - Typing Provide / Inject](/guide/typescript/composition-api.html#typing-provide-inject)
- [Guide - Typing Provide / Inject](/guide/typescript/composition-api.html#typing-provide-inject) <sup class="vt-badge ts" />
12 changes: 9 additions & 3 deletions src/api/options-state.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,9 @@ Declare the props of a component.
}
```

- **See also:** [Props](/guide/components/props.html)
- **See also:**
- [Guide - Props](/guide/components/props.html)
- [Guide - Typing Component Props](/guide/typescript/options-api.html#typing-component-props) <sup class="vt-badge ts" />

## computed {#computed}

Expand Down Expand Up @@ -205,7 +207,9 @@ Declare computed properties to be exposed on the component instance.
}
```

- **See also:** [Computed Properties](/guide/essentials/computed.html)
- **See also:**
- [Guide - Computed Properties](/guide/essentials/computed.html)
- [Guide - Typing Computed Properties](/guide/typescript/options-api.html#typing-computed-properties) <sup class="vt-badge ts" />

## methods {#methods}

Expand Down Expand Up @@ -429,7 +433,9 @@ Declare the custom events emitted by the component.
}
```

* **See also:** [Fallthrough Attributes](/guide/components/attrs.html)
- **See also:**
- [Guide - Fallthrough Attributes](/guide/components/attrs.html)
- [Guide - Typing Component Emits](/guide/typescript/options-api.html#typing-component-emits) <sup class="vt-badge ts" />

## expose {#expose}

Expand Down
6 changes: 3 additions & 3 deletions src/api/reactivity-core.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Takes an inner value and returns a reactive and mutable ref object, which has a

- **See also:**
- [Guide - Reactive Variables with `ref()`](/guide/essentials/reactivity-fundamentals.html#reactive-variables-with-ref)
- [Guide - Typing `ref()`](/guide/typescript/composition-api.html#typing-ref)
- [Guide - Typing `ref()`](/guide/typescript/composition-api.html#typing-ref) <sup class="vt-badge ts" />

## computed() {#computed}

Expand Down Expand Up @@ -111,7 +111,7 @@ Takes a getter function and returns a readonly reactive [ref](#ref) object for t
- **See also:**
- [Guide - Computed Properties](/guide/essentials/computed.html)
- [Guide - Computed Debugging](/guide/extras/reactivity-in-depth.html#computed-debugging)
- [Guide - Typing `computed()`](/guide/typescript/composition-api.html#typing-computed)
- [Guide - Typing `computed()`](/guide/typescript/composition-api.html#typing-computed) <sup class="vt-badge ts" />

## reactive() {#reactive}

Expand Down Expand Up @@ -188,7 +188,7 @@ Returns a reactive proxy of the object.

- **See also:**
- [Guide - Reactivity Fundamentals](/guide/essentials/reactivity-fundamentals.html)
- [Guide - Typing `reactive()`](/guide/typescript/composition-api.html#typing-reactive)
- [Guide - Typing `reactive()`](/guide/typescript/composition-api.html#typing-reactive) <sup class="vt-badge ts" />

## readonly() {#readonly}

Expand Down