Skip to content

docs: fix error re: default segment naming #13022

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.

Sign up for GitHub

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 3 commits into from
Mar 9, 2018
Merged

docs: fix error re: default segment naming #13022

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9ed2d8a
docs: fix error re: default segment naming
jamesgroat Sep 29, 2017
13e661b
fix formatting
jamesgroat Sep 29, 2017
a0ebfea
fix punctuation
jamesgroat Sep 29, 2017
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
10 changes: 6 additions & 4 deletions src/navigation/ionic-page.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,8 @@ export interface IonicPageMetadata {
*
* The `@IonicPage` decorator accepts a `DeepLinkMetadataType` object. This object accepts
* the following properties: `name`, `segment`, `defaultHistory`, and `priority`. All of them
* are optional but can be used to create complex navigation links.
* are optional but can be used to create complex navigation links. The `name` and `segment`
* values must be unique.
*
*
* ### Changing Name
Expand Down Expand Up @@ -108,9 +109,10 @@ export interface IonicPageMetadata {
* ### Setting URL Path
*
* The `segment` property is used to set the URL to the page. If this property isn't provided, the
* `segment` will use the value of `name`. Since components can be loaded anywhere in the app, the
* `segment` doesn't require a full URL path. When a page becomes the active page, the `segment` is
* appended to the URL.
* `segment` will use the value of source file name without the extension (`'my-page.ts'` results
* in segment name `'my-page'`). Since components can be loaded anywhere in the app, the `segment`
* doesn't require a full URL path. When a page becomes the active page, the `segment` is appended
* to the URL.
*
* The `segment` can be changed to anything and doesn't have to match the `name`. For example, passing
* a value for `name` and `segment`:
Expand Down