Skip to content

Commit

Permalink
fix(docs): typo for advanced syntax (#276)
Browse files Browse the repository at this point in the history
* Fix API and Guide links that were mixed around (#193)

In the migration guide for transitions, the more info links for "Guide" was pointing to the API docs, and the "API Docs" link was pointing to the guide.

* Improve docs wording

* Fix some typos (#236)

* Update getting-started.md (#245)

Typo in somehwere > somewhere

* fix(typo): fixed advanced syntax typo

Co-authored-by: Jess Archer <jess@jessarcher.com>
Co-authored-by: Danilo Cabello <cabello@users.noreply.github.com>
Co-authored-by: Simon Knox <psimyn@users.noreply.github.com>
Co-authored-by: marcopetersamazing <marco@amazing.nl>
  • Loading branch information
5 people authored and LinusBorg committed Dec 27, 2019
1 parent 180d251 commit 90eed41
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
8 changes: 4 additions & 4 deletions docs/guide/advanced.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,11 @@ The `to` prop of `<portal>` and the `name` prop of `<portal-target>` can be chan

## "Slim" - removing the wrapper

Vue components always need a single root element. Since `<portal-target>` can't know in advance weither or not it will receive content with more than one root element, it will render a wrapper element around the content to provide a single root node.
Vue components always need a single root element. Since `<portal-target>` can't know in advance whether or not it will receive content with more than one root element, it will render a wrapper element around the content to provide a single root node.

However, if you know that you will send content with a single root element only, you can use the `slim` prop to tell `<portal-target>` to render that element only and do without the wrapper element.

This can be useful if `<portal-target>`s wrapper element is creating problem for your styling.
This can be useful if `<portal-target>`s wrapper element is creating problems for your styling.

<!-- prettier-ignore -->
```html
Expand All @@ -44,7 +44,7 @@ This can be useful if `<portal-target>`s wrapper element is creating problem for
<portal-target name="destination" slim />
```

The `slim` property also works on `<portal>` components when the are `disabled` (see [here](../api/portal.md#slim)).
The `slim` property also works on `<portal>` components when they are `disabled` (see [here](../api/portal.md#slim)).

## Scoped Slots <Badge text="1.3.0+" />

Expand Down Expand Up @@ -88,7 +88,7 @@ You can pass transitions to a `<portal>` without problems. It will behave just t
However, if you use a `<portal-target>` for multiple `<portal>`s, you likely want to define the transition on the target end instead. This is also supported.

::: warning
This API underwent a significant change in the 2.0.0 release. Below, examples for both old and new snytax are given. Keep an eye on the version badges next to them.
This API underwent a significant change in the 2.0.0 release. Below, examples for both old and new syntax are given. Keep an eye on the version badges next to them.
:::

#### New Syntax <Badge text="2.0.0+" />
Expand Down
4 changes: 2 additions & 2 deletions docs/guide/migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@ Setting a Transition for the `<PortalTarget>` now requires a locally or globally

More info:

- [Guide](../api/portal-target.md#transistion)
- [API Docs](./advanced.md#transitions)
- [Guide](./advanced.md#transitions)
- [API Docs](../api/portal-target.md#transistion)

### PortalTarget `@change` event

Expand Down

0 comments on commit 90eed41

Please sign in to comment.