Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 0470769

Browse filesBrowse files
evanyeungfacebook-github-bot
authored andcommitted
Remove "TBD" sections from the docs
Reviewed By: monicatang Differential Revision: D72891071 fbshipit-source-id: a6ecee7638310140d1643a6d9177eb64a50ede56
1 parent 9ba58eb commit 0470769
Copy full SHA for 0470769

2 files changed

+2-56Lines changed: 2 additions & 56 deletions

File tree

Expand file treeCollapse file tree
Open diff view settings
Filter options
Expand file treeCollapse file tree
Open diff view settings
Collapse file

‎website/docs/guided-tour/list-data/advanced-pagination.md‎

Copy file name to clipboardExpand all lines: website/docs/guided-tour/list-data/advanced-pagination.md
-43Lines changed: 0 additions & 43 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -155,46 +155,3 @@ function FriendsListComponent(props: Props) {
155155
156156
* The APIs for both *"forward"* and *"backward"* are exactly the same, they're only named differently. When paginating forward, then the `after` and `first` connection arguments will be used, when paginating backward, the `before` and `last` connection arguments will be used.
157157
* Note that the primitives for both *"forward"* and *"backward"* pagination are exposed from a single call to `usePaginationFragment`, so both *"forward"* and *"backward"* pagination can be performed simultaneously in the same component.
158-
159-
160-
161-
## Custom Connection State
162-
163-
By default, when using `usePaginationFragment` and `@connection`, Relay will *append* new pages of items to the connection when paginating *"forward",* and *prepend* new pages of items when paginating *"backward"*. This means that your component will always render the *full* connection, with *all* of the items that have been accumulated so far via pagination, and/or items that have been added or removed via mutations or subscriptions.
164-
165-
However, it is possible that you'd need different behavior for how to merge and accumulate pagination results (or other updates to the connection), and/or derive local component state from changes to the connection. Some examples of this might be:
166-
167-
* Keeping track of different *visible* slices or windows of the connection.
168-
* Visually separating each *page* of items. This requires knowledge of the exact set of items inside each page that has been fetched.
169-
* Displaying different ends of the same connection simultaneously, while keeping track of the "gaps" between them, and being able to merge results when preforming pagination between the gaps. For example, imagine rendering a list of comments where the oldest comments are displayed at the top, then a "gap" that can be interacted with to paginate, and then a section at the bottom which shows the most recent comments that have been added by the user or by real-time subscriptions.
170-
171-
172-
To address these more complex use cases, Relay is still working on a solution:
173-
174-
175-
> TBD
176-
177-
178-
179-
180-
## Refreshing connections
181-
182-
> TBD
183-
184-
185-
186-
187-
## Prefetching Pages of a Connection
188-
189-
> TBD
190-
191-
192-
193-
194-
## Rendering One Page of Items at a Time
195-
196-
> TBD
197-
198-
199-
200-
<DocsRating />
Collapse file

‎website/docs/guided-tour/updating-data/updating-connections.md‎

Copy file name to clipboardExpand all lines: website/docs/guided-tour/updating-data/updating-connections.md
+2-13Lines changed: 2 additions & 13 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -553,11 +553,9 @@ function updater(store: RecordSourceSelectorProxy) {
553553
554554
555555
556-
_Managing connections with many filters:_
556+
### Managing connections with many filters
557557
558-
As you can see, just adding a few filters to a connection can make the complexity and number of connection records that need to be managed explode. In order to more easily manage this, Relay provides 2 strategies:
559-
560-
1) Specify exactly *which* filters should be used as connection identifiers.
558+
As you can see, just adding a few filters to a connection can make the complexity and number of connection records that need to be managed explode. In order to more easily manage this, Relay allows you to specify exactly *which* filters should be used as connection identifiers.
561559
562560
By default, *all* non-pagination filters will be used as part of the connection identifier. However, when declaring a `@connection`, you can specify the exact set of filters to use for connection identity:
563561
@@ -591,13 +589,4 @@ const storyFragment = graphql`
591589
* Conceptually, this means that we're specifying which arguments affect the output of the connection from the server, or in other words, which arguments are *actually* *filters*. If one of the connection arguments doesn't actually change the set of items that are returned from the server, or their ordering, then it isn't really a filter on the connection, and we don't need to identify the connection differently when that value changes. In our example, changing the `language` of the comments we request doesn't change the set of comments that are returned by the connection, so it is safe to exclude it from `filters`.
592590
* This can also be useful if we know that any of the connection arguments will never change in our app, in which case it would also be safe to exclude from `filters`.
593591
594-
595-
596-
2) An easier API alternative to manage multiple connections with multiple filter values is still pending
597-
598-
599-
> TBD
600-
601-
602-
603592
<DocsRating />

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.