doc updates (#243)

* Update getting-started.md (#242) * docs(api): fix order type in the portal component (#240) * Props Message text correction (#246) * fix(docs): `passengers` is a required argument (#248) * fix(docs): add missing argument for Wormhole.open Co-authored-by: Raphael Kieling <[email protected]> Co-authored-by: Lúcio Rubens <[email protected]> Co-authored-by: Arif Hussain <[email protected]>
LinusBorg · Jul 28, 2019 · a067b47 · a067b47
1 parent d6ff30b
commit a067b47
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 10 deletions.
diff --git a/docs/api/portal-target.md b/docs/api/portal-target.md
@@ -264,7 +264,7 @@ Example:
 ```html {1-3}
 <portal-target name="destination" :slotScope="{ message: 'Hi!' }">
   <p slot-scope="props">
-    {{props.mesage}} This is rendered when no other content is available.
+    {{props.message}} This is rendered when no other content is available.
   </p>
 </portal-target>
 ```

diff --git a/docs/api/portal.md b/docs/api/portal.md
@@ -69,9 +69,9 @@ But it might be a good idea to name your `<Portal>` components so you can debug
 
 ### `order` <Badge text="1.2.0+"/>
 
-| Type              | Required | Default         |
-| ----------------- | -------- | --------------- |
-| `[String,Number]` | no\*     | a random String |
+| Type     | Required | Default |
+| -------- | -------- | ------- |
+| `Number` | no\*     | 0       |
 
 This prop defines the order position in the output of the `<PortalTarget>`.
 

diff --git a/docs/api/wormhole.md b/docs/api/wormhole.md
@@ -24,11 +24,12 @@ The `open` method accepts one argument, an object with the following properties:
 
 `Wormhole.open({to, from, passengers})`
 
-| Property   | Required | Default | Explanation                                                         |
-| ---------- | -------- | ------- | ------------------------------------------------------------------- |
-| to         | yes      |         | The name of the `<PortalTarget>` to send to                         |
-| from       | yes      |         | The name of the `<Portal>` this content comes from.                 |
-| passengers | no       |         | An array of vNodes - the content to be sent to the `<PortalTarget>` |
+| Property   | Required | Default  | Explanation                                                         |
+| ---------- | -------- | -------- | ------------------------------------------------------------------- |
+| to         | yes      |          | The name of the `<PortalTarget>` to send to                         |
+| from       | yes      |          | The name of the `<Portal>` this content comes from.                 |
+| passengers | yes      |          | An array of vNodes - the content to be sent to the `<PortalTarget>` |
+| order      | no       | Infinity | a number indicating the order when multipe sources for a target are used |
 
 Even if you use this method programmatically and there is not source `<Portal>`, you still have to provide `from` - every content sent through the wormhole needs a source.
 

diff --git a/docs/guide/getting-started.md b/docs/guide/getting-started.md
@@ -156,7 +156,7 @@ In older browsers, `position: fixed` works unreliably when the element with that
 
 But we normally need it to render components like modals, dialogs, notifications, snackbars and similar UI elements in a fixed position.
 
-Also, z-indices can be a problem when trying to render things on top of each other somehwere in the DOM.
+Also, z-indices can be a problem when trying to render things on top of each other somewhere in the DOM.
 
 With PortalVue, you can render your modal/overlay/dropdown component to a `<portal-target>` that you can position as the very last in the page's `body`, making styling and positioning much easier and less error-prone.