Skip to content

update and unify removeClippedSubviews prop description #4818

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
Simek merged 1 commit into from
Sep 23, 2025
Merged

update and unify removeClippedSubviews prop description #4818

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 3 additions & 3 deletions docs/flatlist.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -638,12 +638,12 @@ Set this true while waiting for new data from a refresh.

### `removeClippedSubviews`

This may improve scroll performance for large lists. On Android the default value is `true`.

:::warning
May have bugs (missing content) in some circumstances - use at your own risk.
Using this property may lead to bugs (missing content) in some circumstances - use at your own risk.
:::

When `true`, offscreen child views are removed from their native backing superview when offscreen. This may improve scroll performance for large lists. On Android the default value is `true`.

| Type |
| ------- |
| boolean |
Expand Down
9 changes: 4 additions & 5 deletions docs/optimizing-flatlist-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: optimizing-flatlist-configuration
title: Optimizing Flatlist Configuration
title: Optimizing FlatList Configuration
---

## Terms
Expand All @@ -23,9 +23,9 @@ Here are a list of props that can help to improve `FlatList` performance:

### `removeClippedSubviews`

| Type | Default |
| ------- | ------- |
| Boolean | False |
| Type | Default |
| ------- | ------------------------------------ |
| Boolean | `true` on Android, otherwise `false` |

If `true`, views that are outside of the viewport are detached from the native view hierarchy.

Expand Down Expand Up @@ -148,7 +148,6 @@ const renderItem = useCallback(({item}) => (

return (
// ...

<FlatList data={items} renderItem={renderItem} />;
// ...
);
Expand Down
12 changes: 8 additions & 4 deletions docs/scrollview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -550,11 +550,15 @@ See [RefreshControl](refreshcontrol).

### `removeClippedSubviews`

Experimental: When `true`, offscreen child views (whose `overflow` value is `hidden`) are removed from their native backing superview when offscreen. This can improve scrolling performance on long lists.
:::warning
Using this property may lead to bugs (missing content) in some circumstances - use at your own risk.
:::

| Type | Default |
| ---- | ------- |
| bool | `false` |
When `true`, offscreen child views are removed from their native backing superview when offscreen. This may improve scroll performance for large lists. On Android the default value is `true`.

| Type |
| ------- |
| boolean |

---

Expand Down
8 changes: 4 additions & 4 deletions docs/sectionlist.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -253,11 +253,11 @@ Set this true while waiting for new data from a refresh.
Using this property may lead to bugs (missing content) in some circumstances - use at your own risk.
:::

This may improve scroll performance for large lists.
When `true`, offscreen child views are removed from their native backing superview when offscreen. This may improve scroll performance for large lists. On Android the default value is `true`.

| Type | Default |
| ------- | ------- |
| boolean | `false` |
| Type |
| ------- |
| boolean |

---

Expand Down
4 changes: 2 additions & 2 deletions docs/virtualizedlist.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -521,12 +521,12 @@ Set this true while waiting for new data from a refresh.

### `removeClippedSubviews`

This may improve scroll performance for large lists.

:::warning
Using this property may lead to bugs (missing content) in some circumstances - use at your own risk.
:::

When `true`, offscreen child views are removed from their native backing superview when offscreen. This may improve scroll performance for large lists. On Android the default value is `true`.

| Type |
| ------- |
| boolean |
Expand Down
6 changes: 4 additions & 2 deletions website/versioned_docs/version-0.81/flatlist.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -638,9 +638,11 @@ Set this true while waiting for new data from a refresh.

### `removeClippedSubviews`

This may improve scroll performance for large lists. On Android the default value is `true`.
:::warning
Using this property may lead to bugs (missing content) in some circumstances - use at your own risk.
:::

> Note: May have bugs (missing content) in some circumstances - use at your own risk.
When `true`, offscreen child views are removed from their native backing superview when offscreen. This may improve scroll performance for large lists. On Android the default value is `true`.

| Type |
| ------- |
Expand Down
9 changes: 4 additions & 5 deletions website/versioned_docs/version-0.81/optimizing-flatlist-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: optimizing-flatlist-configuration
title: Optimizing Flatlist Configuration
title: Optimizing FlatList Configuration
---

## Terms
Expand All @@ -23,9 +23,9 @@ Here are a list of props that can help to improve `FlatList` performance:

### removeClippedSubviews

| Type | Default |
| ------- | ------- |
| Boolean | False |
| Type | Default |
| ------- | ------------------------------------ |
| Boolean | `true` on Android, otherwise `false` |

If `true`, views that are outside of the viewport are detached from the native view hierarchy.

Expand Down Expand Up @@ -148,7 +148,6 @@ const renderItem = useCallback(({item}) => (

return (
// ...

<FlatList data={items} renderItem={renderItem} />;
// ...
);
Expand Down
12 changes: 8 additions & 4 deletions website/versioned_docs/version-0.81/scrollview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -550,11 +550,15 @@ See [RefreshControl](refreshcontrol).

### `removeClippedSubviews`

Experimental: When `true`, offscreen child views (whose `overflow` value is `hidden`) are removed from their native backing superview when offscreen. This can improve scrolling performance on long lists.
:::warning
Using this property may lead to bugs (missing content) in some circumstances - use at your own risk.
:::

| Type | Default |
| ---- | ------- |
| bool | `false` |
When `true`, offscreen child views are removed from their native backing superview when offscreen. This may improve scroll performance for large lists. On Android the default value is `true`.

| Type |
| ------- |
| boolean |

---

Expand Down
12 changes: 7 additions & 5 deletions website/versioned_docs/version-0.81/sectionlist.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -249,13 +249,15 @@ Set this true while waiting for new data from a refresh.

### `removeClippedSubviews`

> Note: may have bugs (missing content) in some circumstances - use at your own risk.
:::warning
Using this property may lead to bugs (missing content) in some circumstances - use at your own risk.
:::

This may improve scroll performance for large lists.
When `true`, offscreen child views are removed from their native backing superview when offscreen. This may improve scroll performance for large lists. On Android the default value is `true`.

| Type | Default |
| ------- | ------- |
| boolean | `false` |
| Type |
| ------- |
| boolean |

---

Expand Down
6 changes: 4 additions & 2 deletions website/versioned_docs/version-0.81/virtualizedlist.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -519,9 +519,11 @@ Set this true while waiting for new data from a refresh.

### `removeClippedSubviews`

This may improve scroll performance for large lists.
:::warning
Using this property may lead to bugs (missing content) in some circumstances - use at your own risk.
:::

> Note: May have bugs (missing content) in some circumstances - use at your own risk.
When `true`, offscreen child views are removed from their native backing superview when offscreen. This may improve scroll performance for large lists. On Android the default value is `true`.

| Type |
| ------- |
Expand Down