Skip to content
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

[WIP] docs(navigation): initial rewrite of Navigation docs (#330) #331

Draft
wants to merge 1 commit into
base: v2
Choose a base branch
from
Draft
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
6 changes: 5 additions & 1 deletion build/plugins/remark.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
const low = require('lowlight');
low.registerAlias('xml', [ 'vue', 'Vue' ]);

const remark = require('remark');
const lint = require('remark-preset-lint-recommended');
const html = require('remark-html');
Expand All @@ -10,6 +13,7 @@ const remarkPing = require('remark-ping');
const shortcodes = require('remark-shortcodes');
const report = require('vfile-reporter');


function processMarkdown(contents) {
return new Promise((resolve, reject) => {
remark()
Expand Down Expand Up @@ -101,4 +105,4 @@ module.exports = function permalinks(options = {}) {

done();
}
};
};
71 changes: 71 additions & 0 deletions content/docs/en/routing/navigation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
---
title: Navigation
contributors: [rigor789]
---

Most apps are made of multiple screens the users can interact with. In order to present these different screens to the user, we need a way to navigate between them. NativeScript-Vue provides the following methods to achieve this:
* [`$navigateTo`](#)
* [`$navigateBack`](#)
* [`$showModal`](#)

In NativeScript-Vue different screens are denoted by the [`<Page>`](#) tag.

// todo: emphasize early on that `<Page>` tags are mandatory

## A basic scenario: navigating to a different `<Page>`

Let's say the user is presented with the default `<Page>` in our `Home.vue` component and we would like to navigate to a component we defined in `Settings.vue`:
```vue
<template>
<Page>
<ActionBar title="Settings" />
<StackLayout>
<!-- page content goes here -->
</StackLayout>
</Page>
</template>
```

In our Home component, we first need to import the `<Settings>` component. Most navigation is triggered by the user, in this case we will attach a `@tap` handler to a `<Button>` and call our navigation in the handler.
```vue
<template>
<Page>
<ActionBar title="Home" />
<StackLayout>
<Button text="Go to Settings" @tap="onSettingsTap" />
<!-- page content goes here -->
</StackLayout>
</Page>
</template>

<script>
import Settings from './Settings'

export default {
methods: {
onSettingsTap() {
this.$navigateTo(Settings)
}
}
}
</script>
```

[You can try this example in the Playground](https://play.nativescript.org/?template=play-vue&id=Gsxbge)

// todo: incorporate $navigateBack into the basic guide

## A basic scenario: showing a modal `<Page>`

Often times, we need to present the user with data that doesn't fit in the navigation flow. In these cases we can show a `<Page>` in a modal, completely independent of the current navigation history.

// todo: create example and walkthrough

# Troubleshooting

// todo

```js
this.$navigateTo(Component).catch(error => console.log(error))
```

Loading