Thanks to visit codestin.com
Credit goes to github.com

Skip to content

feat(template): make virtual views not set a height by default #1849

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(template): make virtual views not set a height by default #1849

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
30 changes: 14 additions & 16 deletions apps/docs/docs/template/virtual-view-directive.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,23 +47,18 @@ RxVirtualView is designed to work in combination with related directives:
### Show a widget when it's visible, otherwise show a placeholder

```typescript
import {
RxVirtualView,
RxVirtualViewContent,
RxVirtualViewObserver,
RxVirtualViewPlaceholder,
} from '@rx-angular/template/virtual-view';
import { RxVirtualView, RxVirtualViewContent, RxVirtualViewObserver, RxVirtualViewPlaceholder } from '@rx-angular/template/virtual-view';
// Other imports...

@Component({
selector: 'my-list',
imports: [RxVirtualView, RxVirtualViewContent, RxVirtualViewObserver, RxVirtualViewPlaceholder],
imports: [RxVirtualView, RxVirtualViewContent, RxVirtualViewObserver, RxVirtualViewPlaceholder],
templateUrl: './my-list.component.html',
styleUrls: ['./my-list.component.scss'],
changeDetection: ChangeDetectionStrategy.OnPush,
})
export class MyListComponent {
// Component code
// Component code
}
```

Expand Down Expand Up @@ -96,6 +91,14 @@ an empty container which has just the same dimensions as its content it should r

This will make sure you don't run into stuttery scrolling behavior and layout shifts.

You can use the `--rx-vw-h` and `--rx-vw-w` CSS variables in order to define the placeholder dimensions after the virtual view is rendered at least once.

```html
<div style="min-height: var(--rx-vw-h, 100px); min-width: var(--rx-vw-w, 50px);"></div>
```

If the virtual view is not rendered at least once, the 100px and 50px values will be used as fallback the first time, and after that, the values will be updated to the actual dimensions of the virtual view.

Comment on lines +94 to +101
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe this deserves its own headline

:::

### Optimize lists with @for
Expand All @@ -104,23 +107,18 @@ This example demonstrates how to use RxVirtualView to optimize lists by only ren
We are only rendering the `item` component when it's visible to the user. Otherwise, it gets replaced by an empty div.

```typescript
import {
RxVirtualView,
RxVirtualViewContent,
RxVirtualViewObserver,
RxVirtualViewPlaceholder,
} from '@rx-angular/template/virtual-view';
import { RxVirtualView, RxVirtualViewContent, RxVirtualViewObserver, RxVirtualViewPlaceholder } from '@rx-angular/template/virtual-view';
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

meh formatting?

// Other imports...

@Component({
selector: 'my-list',
imports: [RxVirtualView, RxVirtualViewContent, RxVirtualViewObserver, RxVirtualViewPlaceholder],
imports: [RxVirtualView, RxVirtualViewContent, RxVirtualViewObserver, RxVirtualViewPlaceholder],
templateUrl: './my-list.component.html',
styleUrls: ['./my-list.component.scss'],
changeDetection: ChangeDetectionStrategy.OnPush,
})
export class MyListComponent {
// Component code
// Component code
}
```

Expand Down
4 changes: 2 additions & 2 deletions libs/template/virtual-view/src/lib/virtual-view.directive.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,11 +173,11 @@ export class RxVirtualView
readonly size = signal({ width: 0, height: 0 });

readonly width = computed(() =>
this.size().width ? `${this.size().width}px` : 'auto',
this.size().width ? `${this.size().width}px` : null,
);

readonly height = computed(() =>
this.size().height ? `${this.size().height}px` : 'auto',
this.size().height ? `${this.size().height}px` : null,
);

readonly containment = computed(() => {
Expand Down
Loading