Pinkesh/navigation #38

pinkeshmars · 2024-06-11T08:34:15Z

Description

Navigation & Routing

Linear ticket and magic word Fixes DEVR-384

Type of change

Typo fix
New feature
Removed outdated references

…umentation into pinkesh/navigation

bolt-new-by-stackblitz · 2024-06-11T08:34:18Z

Run & review this pull request in StackBlitz Codeflow.

PoojaB26

Nit changes mostly, but one big change is questioning the Passing Data page since its mostly copy paste and we already have Navigation section in Pages that we can move to here and remove any copy paste content for this topic.

PoojaB26 · 2024-06-25T06:30:55Z

docs/ff-concepts/navigation-routing/nav-overview.md

+
+## What are Routes?
+
+**Routing** refers to the mechanism of defining paths or routes for different screens in an app. Each screen is associated with a unique route name, making it easier to navigate to that screen on events like button clicks. In FlutterFlow, routes are automatically assigned to pages when they are created.


Routing or Routes?

Updated to 'Routing'

It was Routing before as well. But the confusion is you write the heading with "What are Routes" but start the paragraph with "Routing is..." and maybe you explain routing but not what routes are (you do explain what we can do with routes, or how its assigned etc but some fundamental starting points are missing in this paragraph)

Please add a starting line like "Routes are ..... and Routing is the process of ...." or something similar.

Ok, updated. I think this is more clear now. Also, removed routing to avoid any confusion.

PoojaB26 · 2024-06-25T06:31:56Z

docs/ff-concepts/navigation-routing/nav-overview.md

+
+**Routing** refers to the mechanism of defining paths or routes for different screens in an app. Each screen is associated with a unique route name, making it easier to navigate to that screen on events like button clicks. In FlutterFlow, routes are automatically assigned to pages when they are created.
+
+For example, if you have a home screen, a login screen, and a profile screen, each of these screens will be defined as separate routes in your FlutterFlow project.


Mention routing name examples too

Sorry, I didn't get this!

give an example like in the ecommerce demo app, product list page has route name like /productListPage. So provide such examples of how the route names are written.

docs/ff-concepts/navigation-routing/nav-overview.md

PoojaB26 · 2024-06-25T06:38:05Z

docs/ff-concepts/navigation-routing/passing-data.md

+
+The figure below illustrates the data passing flow:
+
+![passing-data-2](imgs/passing-data-2.avif)


This image is very tiny btw, is this from old docs directly? Or we merged the 3 imgs together for the new docs? If latter, can we increase the size and maybe move the 3rd step to next row?

The image is directly from the old docs.

Update: This is removed now and updated with your page navigation content.

PoojaB26 · 2024-06-25T06:41:08Z

docs/ff-concepts/navigation-routing/passing-data.md

+
+Let's see what all types of data you can pass and when to use them:
+
+- **Integer**: To pass numbers such as 100, 4302, 50000, etc.


Im wondering if we need this section. This is a given in almost any section that takes a parameter or argument and its impossible or redundant to mention this list everywhere and also constantly update it as we add more types. I feel should just remove this section.

Done! removed.

PoojaB26 · 2024-06-25T07:02:59Z

docs/ff-concepts/navigation-routing/passing-data.md

+Let's see how to send the typed message to the next page.
+![passing-data-next-page](imgs/passing-data-next-page.gif)
+
+The steps to pass data from one page to another are as follows:


I'm confused why we need this Page copy pasted, doesnt the "Navigation betweeen Pages" section also talk about page parameters? Maybe we move the section from there to here and add any small bits if left? (and add a small note in Pages section about navigation like we did for test / run mode section). Maybe add only one example for data type passing or document passing and it should be good to go, the examples here also dont have great UI so maybe we just skip the page here and take it from Pages section? Wdyt?

Agree! Moved the "Navigation betweeen Pages" content here + some refactoring + minor content tweaks so the pages mix well here.

PoojaB26 · 2024-06-25T07:06:07Z

docs/ff-concepts/navigation-routing/special-page-navigation/pageview-widget.md

+2. [Customize the PageView](#customizing) widget and add buttons to go to the previous and next pages.
+3. Now select any button and define the [Control Page View action](#).
+
+### Show/Hide widget


For now lets remove these links, we will add a note admonition later to most widgets once we have all the sections written and it will look like:

See more:
Responsivenes....
etc
etc

PoojaB26 · 2024-06-25T07:06:52Z

docs/ff-concepts/navigation-routing/special-page-navigation/tabbar-widget.md

+    </iframe>
+</div>
+
+### Show/Hide widget


Same comment as page view.

PoojaB26 · 2024-06-25T07:10:20Z

docs/ff-concepts/navigation-routing/webview-widget.md

+    </iframe>
+</div>
+
+### Show/Hide widget


Same comment as pageview

PoojaB26 · 2024-06-25T07:11:56Z

docs/ff-concepts/navigation-routing/launch-url-action.md

+
+This URL scheme for loading up a webpage can be defined in this format:
+
+#### Scheme


One liner explanation of what scheme is should complete this section.

maybe add in the top before this

…umentation into pinkesh/navigation

pinkeshmars · 2024-06-26T07:01:35Z

Hey @PoojaB26 I am done addressing the review comments. You can take a look now. Thanks.

PoojaB26

Minor changes requested! you can merge after addressing them

PoojaB26 · 2024-06-26T22:05:36Z

docs/resources/ui-building-blocks/pages/pages-configuration.md

@@ -20,15 +20,15 @@ This section allows you to define and manage parameters that your page can
 receive from other pages of the app. Parameters are essentially variables that
 hold values which can be passed between pages. For example, you might pass a
 user ID from a list page to a detail page to display specific information about
-that user.
+that user. Learn more about passing data between pages [here](../../../ff-concepts/navigation-routing/passing-data).


Should be a admonition
:::info[LEARN MORE]

PoojaB26 · 2024-06-26T22:05:42Z

docs/resources/ui-building-blocks/pages/pages-configuration.md


 ### Route Settings

 In FlutterFlow, Route Settings are essential for defining how pages within your
 application are accessed and interacted with. These settings allow you to
 customize the URL paths for web and mobile deep linking, set meaningful Page
 Names as unique identifiers, integrate dynamic parameters into your routes, and
-set access restrictions based on user authentication.
+set access restrictions based on user authentication. Learn more about Routing [here](../../../ff-concepts/navigation-routing/overview).


Should be a admonition
:::info[LEARN MORE]

PoojaB26 · 2024-06-26T22:09:30Z

docs/ff-concepts/navigation-routing/passing-data.md

+
+As you build your app, you'll often encounter the need to pass through or transfer data from one page to another. For instance, when a user taps on a product item, you may want to send product data to the next page to display its details.
+
+## How to pass data


Instead of a question, we should name it the "Page parameters" header because its easier to find via SEO (people will mostly search for page parameters when they encounter it in FF) and also straightaway defines what the section is about.

PoojaB26 · 2024-06-26T22:11:35Z

docs/ff-concepts/navigation-routing/passing-data.md

+enabling the new page to function as intended based on the specific needs and
+inputs from a previous interaction.
+
+## What you can pass


Maybe rename it to "Allowed Data Types" or something similar?

Ok, updated.

PoojaB26 · 2024-06-26T22:15:23Z

docs/ff-concepts/navigation-routing/nav-overview.md

+
+## What are Routes?
+
+**Routing** refers to the mechanism of defining paths or routes for different screens in an app. Each screen is associated with a unique route name, making it easier to navigate to that screen on events like button clicks. In FlutterFlow, routes are automatically assigned to pages when they are created.


It was Routing before as well. But the confusion is you write the heading with "What are Routes" but start the paragraph with "Routing is..." and maybe you explain routing but not what routes are (you do explain what we can do with routes, or how its assigned etc but some fundamental starting points are missing in this paragraph)

Please add a starting line like "Routes are ..... and Routing is the process of ...." or something similar.

PoojaB26 · 2024-06-26T22:17:28Z

docs/ff-concepts/navigation-routing/nav-overview.md

+
+**Routing** refers to the mechanism of defining paths or routes for different screens in an app. Each screen is associated with a unique route name, making it easier to navigate to that screen on events like button clicks. In FlutterFlow, routes are automatically assigned to pages when they are created.
+
+For example, if you have a home screen, a login screen, and a profile screen, each of these screens will be defined as separate routes in your FlutterFlow project.


give an example like in the ecommerce demo app, product list page has route name like /productListPage. So provide such examples of how the route names are written.

docs/ff-concepts/navigation-routing/nav-overview.md

pinkeshmars · 2024-06-27T06:00:17Z

@PoojaB26 your latest review comments are incorporated now! Going to merge this.

pinkeshmars added 7 commits June 6, 2024 18:13

added navigation overview

6cfe1f8

passing data section added

f805f8a

Added TabBar widget

c9c73fc

Merge branch 'main' of https://github.com/FlutterFlow/flutterflow-doc…

86bec44

…umentation into pinkesh/navigation

Added pageview widget

6c99ca1

Added webview widget

eb3d1c7

Added launch url action

c191767

pinkeshmars requested a review from PoojaB26 June 11, 2024 08:34

github-actions bot requested a review from leighajarett June 11, 2024 08:34

PoojaB26 requested changes Jun 25, 2024

View reviewed changes

PoojaB26 and others added 2 commits June 25, 2024 12:44

Nit fixes

0938f99

Merge branch 'main' of https://github.com/FlutterFlow/flutterflow-doc…

379bbba

…umentation into pinkesh/navigation

pinkeshmars added 2 commits June 26, 2024 12:32

Addressed review comments

4499b7b

Sidebar fix: change 'I' to 'i' in integration folder in this branch

f6219f9

PoojaB26 approved these changes Jun 26, 2024

View reviewed changes

Address review comments

8ac81dc

pinkeshmars merged commit 1b09a35 into main Jun 27, 2024

PoojaB26 deleted the pinkesh/navigation branch October 2, 2024 06:35


		## What are Routes?

		Routing refers to the mechanism of defining paths or routes for different screens in an app. Each screen is associated with a unique route name, making it easier to navigate to that screen on events like button clicks. In FlutterFlow, routes are automatically assigned to pages when they are created.


		Routing refers to the mechanism of defining paths or routes for different screens in an app. Each screen is associated with a unique route name, making it easier to navigate to that screen on events like button clicks. In FlutterFlow, routes are automatically assigned to pages when they are created.

		For example, if you have a home screen, a login screen, and a profile screen, each of these screens will be defined as separate routes in your FlutterFlow project.


		The figure below illustrates the data passing flow:

		![passing-data-2](imgs/passing-data-2.avif)


		Let's see what all types of data you can pass and when to use them:

		- Integer: To pass numbers such as 100, 4302, 50000, etc.


		This URL scheme for loading up a webpage can be defined in this format:

		#### Scheme


		As you build your app, you'll often encounter the need to pass through or transfer data from one page to another. For instance, when a user taps on a product item, you may want to send product data to the next page to display its details.

		## How to pass data

Pinkesh/navigation #38

Pinkesh/navigation #38

Uh oh!

Conversation

pinkeshmars commented Jun 11, 2024

Description

Type of change

Uh oh!

bolt-new-by-stackblitz bot commented Jun 11, 2024

Uh oh!

PoojaB26 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pinkeshmars Jun 26, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pinkeshmars commented Jun 26, 2024

Uh oh!

PoojaB26 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

pinkeshmars Jun 26, 2024 •

edited

Loading